diff --git a/content/config_rb_manage.md b/content/config_rb_manage.md deleted file mode 100644 index c907c4c8ed..0000000000 --- a/content/config_rb_manage.md +++ /dev/null @@ -1,260 +0,0 @@ -+++ -title = "manage.rb" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/config_rb_manage.html"] - -[menu] - [menu.legacy] - title = "manage.rb" - identifier = "legacy/manage/config_rb_manage.md manage.rb Configuration" - parent = "legacy/manage" - weight = 100 -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< danger >}} - -{{< readfile file="content/reusable/md/EOL_a1.md" >}} - -{{< /danger >}} - -{{< readfile file="content/reusable/md/chef_manager.md" >}} - -The manage.rb file is the default configuration file used by Chef -management console. These settings are applied every time -`chef-manage-ctl reconfigure` is run. - -The configuration file is located at: `/etc/chef-manage/manage.rb`. - -## Settings - -{{< warning >}} - -All of the following settings should be specified without using the -equals symbol (`=`). For example: - -```ruby -chef_documentation_url 'https://docs.chef.io' -``` - -{{< /warning >}} - -This configuration file has the following settings: - -`backbone_paginator_timeout` - -: The amount of time (in milliseconds) after which search requests made using the web client will timeout and cause an error. Default value: `120000`. - -`chef_documentation_url` - -: The URL at which documentation for Chef is located. Default value: `https://docs.chef.io`. - -`disable_sign_up` - -: Use to disable sign-up and only allow sign-in. Default value: `false`. - -`email_from_address` - -: The email address from which Chef Infra Server notifications are sent. Default value: `'Chef Notifications '`. - -`events.port` - -: The port on which the events services run. Default value: `11001`. - -`logging.chef_log_level` - -: The log level used for requests to the Chef Infra Server from the web application. Default value: `info`. - -`logging.log_level` - -: The log level for Ruby on Rails services. Default value: `info`. - -`max_login_failures` - -: The the maximum number of failed login attempts allowed before the user must use the password reset link to reset their password (has no effect when using external authentication/LDAP). Default value: `7`. - -`nginx_addon_prefix` - -: The prefix used by Chef management console. Default value: `30`. - -`org_creation_enabled` - -: Whether or not users can create new organizations from Chef management console. Default value: `true`. - -`platform.user` - -: The name of the privileged user that manages requests to the Chef Infra Server. Default value: `'pivotal'`. - -`public_port` - -: The port on which the external load balancer will listen. Default value: `443`. - -`recaptcha.enabled` - -: Enable reCAPTCHA for the sign-up page. Default value: `false`. - -`recaptcha.fail_open` - -: If the reCAPTCHA service cannot be reached, allow to sign-up? Default value: `true`. - -`recaptcha.verify_url` - -: Verify-URL of reCAPTCHA service to be used. Default value: `https://www.google.com/recaptcha/api/siteverify`. - -`recaptcha.site_key` - -: The Site Key received from reCAPTCHA. - -`recaptcha.secret_key` - -: The Secret Key received from reCAPTCHA. - -`redis.host` - -: The host on which Redis runs. Default value: `localhost`. - -`redis.port` - -: The port on which Redis listens. Default value: `11002`. - -`redis.url` - -: The URL used by Redis. Default value: `redis://#{redis.host}:#{redis.port}/0`. - -`runit_timeout` - -: The amount of time (in seconds) to wait before timing out. Default value: `30`. - -`secret_token` - -: The secret token used by Ruby on Rails to prevent session tampering. See: . Default value: **generated**. - - To override the default value, use the [Secrets Management](/ctl_chef_server/#ctl-chef-server-secrets-management) commands: `chef-server-ctl set-secret manage secret_token`. - -`services['opscode-manage-events'].enable` - -: Use to enable the `opscode-manage-events` service. Default value: `true`. - -`services['opscode-manage-webapp'].enable` - -: Use to enable the `opscode-manage-webapp` service. Default value: `true`. - -`services['opscode-manage-worker'].enable` - -: Use to enable the `opscode-manage-worker` service. Default value: `true`. - -`session_timeout` - -: The amount of time (in minutes) of inactivity before a user is logged out. When not set (or set to 0), a browser session will not have a timed expiration and will expire when the browser session ends, quits, or when the computer restarts, or when the absolute session time limit is hit (see `session_timeout_absolute`). Default value: `1440` (one day). - -`session_timeout_absolute` - -: The amount of time (in minutes) after which a user will be logged out, regardless of activity. When not set (or set to 0), a browser session will not have a timed expiration unless a session is inactive longer than the session time limit (see `session_timeout`). Default value: `10080` (one week). - -`sign_in_page_message` - -: A message to display on the sign-in page. If present, the message will show up in a box on the sign in page. Any valid HTML is allowed here. Default value: `nil`. - -`ssl_verify_mode` - -: Enable or disable SSL verification for the connection to the Chef Infra -Server. Valid settings: `:verify_none` and `:verify_peer`. Default value: `:verify_none` - -`trusted_certs_dir` - -: Path to a directory containing trusted SSL certificates for verification -when connecting to the Infra Server. Most common setting: `"/etc/chef/trusted_certs"` Default value: `""` - -`support_email_address` - -: The email address used to send feedback. Default value: `support@chef.io`. - -`support_site_url` - -: The URL at which links to Chef support are located. Default value: `http://chef.io/support`. - -`support_tickets_url` - -: The URL at which Chef support tickets are created. Default value: `https://chef.io/support/tickets`. - -`webapp.backlog` - -: The size of the backlog. Default value: `1024`. - -`webapp.listen` - -: The port on which Chef management console services listen. Default value: `{ '127.0.0.1:#{port}' }`. - -`webapp.port` - -: The port on which Chef management console services run. Default value: `9462`. - -`webapp.tcp_nodelay` - -: Enable the Nagle buffering algorithm. Default value: `true`. - -`webapp.worker_processes` - -: The number of allowed worker processes. Default value: - `node['cpu.total'].to_i`. - -`webapp.worker_timeout` - -: The amount of time (in seconds) that a worker can be silent before it is killed and restarted. Default value: `3600`. - -## Web UI Private Key - -Chef Manage uses the Web UI private key for signing requests sent to the Chef Infra Server. The key is subject to Chef server's [Secrets Management](/ctl_chef_server/#ctl-chef-server-secrets-management), and will be stored in `/etc/opscode/private-chef-secrets.json`. - -Any run of `chef-server-ctl reconfigure` will ensure the key exists and is stored without any additional steps. - -To verify that the key is stored and ready to use by manage, run: - -```bash -chef-server-ctl show-secret chef-server webui_key ------BEGIN RSA PRIVATE KEY----- -MIIEpgIBAAKCAQEA3fJ+U+5prsJ8PtnbYzWAq+J2cE48u+iT7t/M9JS+3tlEgf3r -1PTl70cW9jOI+kGGvayTKb8Dzqtm0tpQJo7Bv+XX42OylyVF2SN4WvMusT+jtJuF -... ------END RSA PRIVATE KEY----- -``` - -## Example - -The following example shows how the settings look when added to the configuration file: - -```ruby -chef_documentation_url '' -disable_sign_up false -events.port 11001 -logging.chef_log_level 'info' -logging.log_level 'info' -nginx_addon_prefix 30 -platform.user 'pivotal' -public_port 443 -redis.host 'localhost' -redis.port 11002 -# redis.url derived from redis.host and redis.port -runit_timeout 30 -services['opscode-manage-events'].enable true -services['opscode-manage-webapp'].enable true -services['opscode-manage-worker'].enable true -support_email_address 'support@chef.io' -support_site_url 'http://chef.io/support' -support_tickets_url 'https://chef.io/support/tickets' -webapp.backlog 1024 -# webapp.listen derived from webapp.port -webapp.port 9462 -webapp.tcp_nodelay true -webapp.worker_processes 2 -webapp.worker_timeout 3600 -``` diff --git a/content/ctl_manage.md b/content/ctl_manage.md deleted file mode 100644 index e2be7a7a0e..0000000000 --- a/content/ctl_manage.md +++ /dev/null @@ -1,84 +0,0 @@ -+++ -title = "chef-manage-ctl (executable)" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/ctl_manage.html"] -product = [] - -[menu] - [menu.legacy] - title = "chef-manage-ctl" - identifier = "legacy/manage/ctl_manage.md chef-manage-ctl" - parent = "legacy/manage" - weight = 110 -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< danger >}} - -{{< readfile file="content/reusable/md/EOL_a1.md" >}} - -{{< /danger >}} - -The Chef management console includes a command-line utility named -`chef-manage-ctl`. This command-line tool is used to reconfigure, -cleanse (reset the Chef management console to initial configuration -settings), and uninstall the Chef management console. - -## help - -The `help` subcommand is used to print a list of all available -`chef-manage-ctl` commands. - -This subcommand has the following syntax: - -```bash -chef-manage-ctl help -``` - -## reconfigure - -The `reconfigure` subcommand is used when changes are made to the -manage.rb file to reconfigure the server. When changes are made to the -manage.rb file, they will not be applied to the Chef management console -configuration until after this command is run. - -This subcommand has the following syntax: - -```bash -chef-manage-ctl reconfigure -``` - -## show-config - -The `show-config` subcommand is used to view the configuration that will -be generated by the `reconfigure` subcommand. This command is most -useful in the early stages of a deployment to ensure that everything is -built properly before installation. - -This subcommand has the following syntax: - -```bash -chef-manage-ctl show-config -``` - -## uninstall - -The `uninstall` subcommand is used to manage the hooks between runit and -`sysvinit` or `upstart`. This subcommand does not [uninstall the Chef -management console](/uninstall/#chef-manage) or remove `.rpm` or -`.deb` files. - -This subcommand has the following syntax: - -```bash -chef-manage-ctl uninstall -``` diff --git a/content/legacy_uninstall.md b/content/legacy_uninstall.md index 1ddcb2ab8e..05929dc054 100644 --- a/content/legacy_uninstall.md +++ b/content/legacy_uninstall.md @@ -11,12 +11,9 @@ gh_repo = "chef-web-docs" weight = 999 +++ - ## Chef Analytics -Use the `uninstall` subcommand to remove the Chef Analytics -application, but without removing any of the data. This subcommand will -shut down all services (including the `runit` process supervisor). +Use the `uninstall` subcommand to remove the Chef Analytics application, but without removing any of the data. This subcommand will shut down all services (including the `runit` process supervisor). This subcommand has the following syntax: @@ -26,16 +23,13 @@ opscode-analytics-ctl uninstall {{< note >}} -To revert the `uninstall` subcommand, run the `reconfigure` subcommand -(because the `start` subcommand is disabled by the `uninstall` command). +To revert the `uninstall` subcommand, run the `reconfigure` subcommand (because the `start` subcommand is disabled by the `uninstall` command). {{< /note >}} ## Reporting -Use the `uninstall` subcommand to remove the Reporting add-on to the -Chef Infra Server, but without removing any of the data. This subcommand -will shut down all services (including the `runit` process supervisor). +Use the `uninstall` subcommand to remove the Reporting add-on to the Chef Infra Server, but without removing any of the data. This subcommand will shut down all services (including the `runit` process supervisor). This subcommand has the following syntax: @@ -45,7 +39,26 @@ opscode-reporting-ctl uninstall {{< note >}} -To revert the `uninstall` subcommand, run the `reconfigure` subcommand -(because the `start` subcommand is disabled by the `uninstall` command). +To revert the `uninstall` subcommand, run the `reconfigure` subcommand (because the `start` subcommand is disabled by the `uninstall` command). + +{{< /note >}} + +## Uninstall Chef management console + +To uninstall the Chef management console, do the following: + +1. Run the following command: + + ```bash + chef-manage-ctl cleanse + rm -fr /var/opt/opscode/nginx/etc/addon.d/*manage* + chef-server-ctl restart nginx + ``` + +1. Use the package manager for the platform on which the Chef management console is installed, and then uninstall the package named `chef-manage`. + +{{< note >}} + +This package used to be named `opscode-manage` and the command line tool used to be named `opscode-manage-ctl`. {{< /note >}} diff --git a/content/manage.md b/content/manage.md deleted file mode 100644 index 63780700aa..0000000000 --- a/content/manage.md +++ /dev/null @@ -1,113 +0,0 @@ -+++ -title = "Chef Manage" -draft = false -gh_repo = "chef-web-docs" -aliases = ["/manage.html"] -product = [] - -[menu] - [menu.legacy] - title = "About the Management Console" - identifier = "legacy/manage/manage.md About the Management Console" - parent = "legacy/manage" - weight = 10 -+++ -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< note >}} - -Chef Automate 2 does not deploy Chef Manage alongside Chef Infra Server. - -{{< /note >}} - -The Chef management console enables the management of nodes, data bags, roles, environments, and cookbooks by using a web user interface. In addition, access to nodes, data bags, roles, environments, and cookbooks is configurable using role-based access control (RBAC). - -## Nodes - -{{< readfile file="content/reusable/md/node.md" >}} - -The Chef management console provides ways for users to [delete nodes and reset their private keys](/server_manage_nodes/#manage), [edit node attributes](/server_manage_nodes/#node-attributes), [manage the run-lists](/server_manage_nodes/#run-lists), [configure user and group permissions](/server_manage_nodes/#permissions), and [manage tags](/server_manage_nodes/#manage-tags). - -![image](/images/step_manage_webui_nodes.png) - -### Search - -{{< readfile file="content/reusable/md/search.md" >}} - -{{< note >}} - -The syntax for search queries in the Chef management console is identical to the syntax for search queries used with knife, the command line tool used to manage objects on the Chef Infra Server. - -{{< /note >}} - -#### Query Syntax - -{{< readfile file="content/reusable/md/search_query_syntax.md" >}} - -#### Keys - -{{< readfile file="content/reusable/md/search_key.md" >}} - -##### Nested Fields - -{{< readfile file="content/reusable/md/search_key_nested.md" >}} - -#### About Patterns - -{{< readfile file="content/reusable/md/search_pattern.md" >}} - -##### Exact Matching - -{{< readfile file="content/reusable/md/search_pattern_exact.md" >}} - -##### Wildcard Matching - -{{< readfile file="content/reusable/md/search_pattern_wildcard.md" >}} - -##### Range Matching - -{{< readfile file="content/reusable/md/search_pattern_range.md" >}} - -##### Fuzzy Matching - -{{< readfile file="content/reusable/md/search_pattern_fuzzy.md" >}} - -#### About Operators - -{{< readfile file="content/reusable/md/search_boolean_operators.md" >}} - -{{< readfile file="content/reusable/md/search_boolean_operators_andnot.md" >}} - -#### Special Characters - -{{< readfile file="content/reusable/md/search_special_characters.md" >}} - -## Policy - -{{< readfile file="content/reusable/md/policy_summary.md" >}} - -The Chef management console provides ways for users to manage [data bags](/server_manage_data_bags/), [environments](/server_manage_environments/), [roles](/server_manage_roles/), [cookbooks](/server_manage_cookbooks/), [clients](/server_manage_clients/), and [managing tags](/server_manage_nodes/#manage-tags.html). - -![image](/images/step_manage_webui_policy.png) - -## Admin - -Organizations, users, and groups can be managed from the Chef management console, including role-based access control for any user and group to any of the objects saved to the Chef Infra Server. - -{{< readfile file="content/server/reusable/md/server_rbac.md" >}} - -![image](/images/step_manage_webui_admin.png) - -## Install Chef Manage - -{{< readfile file="content/server/reusable/md/ctl_chef_server_install_features_download.md" >}} - -### Chef Manage Local Installation - -{{< readfile file="content/server/reusable/md/ctl_chef_server_install_features_manual.md" >}} diff --git a/content/manage_uninstall.md b/content/manage_uninstall.md deleted file mode 100644 index ea5cbb8d3c..0000000000 --- a/content/manage_uninstall.md +++ /dev/null @@ -1,33 +0,0 @@ -+++ -title = "Uninstall Chef Manage" -draft = false -gh_repo = "chef-web-docs" - -[menu] - [menu.legacy] - title = "Uninstall" - identifier = "legacy/manage/uninstall" - parent = "legacy/manage" - weight = 15 -+++ - -To uninstall the Chef management console, do the following: - -1. Run the following command: - - ```bash - chef-manage-ctl cleanse - rm -fr /var/opt/opscode/nginx/etc/addon.d/*manage* - chef-server-ctl restart nginx - ``` - -2. Use the package manager for the platform on which the Chef - management console is installed, and then uninstall the package - named `chef-manage`. - -{{< note >}} - -This package used to be named `opscode-manage` and the command line tool -used to be named `opscode-manage-ctl`. - -{{< /note >}} diff --git a/content/server_configure_saml.md b/content/server_configure_saml.md deleted file mode 100644 index aeb72c7ad9..0000000000 --- a/content/server_configure_saml.md +++ /dev/null @@ -1,69 +0,0 @@ -+++ -title = "Configuring for SAML Authentication" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/server_configure_saml.html", "/release/automate/server_configure_saml.html"] -product = [] - -[menu] - [menu.legacy] - title = "Configure SAML" - identifier = "legacy/manage/server_configure_saml.md Configure SAML" - parent = "legacy/manage" -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -Chef Manage can support logging in users using SAML authentication. In -order to do so, there must be a Chef Automate Server that is configured -to act as a SAML Identity Provider (IdP). When the Chef Automate Server -is configured to do so, it will provide an OpenID Connect (OIDC) -protocol end-point that Chef Manage can use to initiate authentication. - -## Configuring Chef Manage - -To configure the Chef Infra Server management console, first add the -following code to `/etc/chef-manage/manage.rb`: - -```ruby -saml.enabled true -saml.issuer_url '' -``` - -Second, store your OIDC client credentials with using the [Secrets -Management](/ctl_chef_server/#ctl-chef-server-secrets-management) -commands: - -```bash -chef-server-ctl set-secret saml client_id '' -chef-server-ctl set-secret saml client_secret '' -``` - -The `issuer_url` property should be set to something like -`'https:///api/v0'`. Also, the `client_id` must -be known to the Chef Automate server. For development purposes only, you -may also need to turn off the TLS verification for the OIDC client by -adding - -```ruby -saml.verify_tls false -``` - -to your Chef Manage configuration. - -Finally, run `chef-manage-ctl reconfigure` to apply these settings. - -{{< warning >}} - -You cannot have both LDAP and SAML authentication enabled at the same -time. If you do, the reconfigure will fail with an appropriate error -message. - -{{< /warning >}} diff --git a/content/server_ldap.md b/content/server_ldap.md deleted file mode 100644 index bc69e297bd..0000000000 --- a/content/server_ldap.md +++ /dev/null @@ -1,321 +0,0 @@ -+++ -title = "Active Directory and LDAP" -draft = false -gh_repo = "chef-web-docs" -aliases = ["/server_ldap.html", "/install_server_post.html"] -product = ["server"] - -[menu] - [menu.legacy] - title = "Active Directory & LDAP" - identifier = "legacy/manage/server_ldap.md Active Directory & LDAP" - parent = "legacy/manage" -+++ - -The Chef Infra Server supports Active Directory and LDAP authentication, -which enables users to log in to the Chef Infra Server using their -corporate credential and the Manage interface. Without the Manage interface add-on installed, -there is no need to enable the Chef Infra Server LDAP functionality. LDAP is not used with -Supermarket logins, nor with any Chef Infra Client related authentication. - -## Configure LDAP - -The Chef Infra Server supports using Active Directory or LDAP for any -user that has an email address in the LDAP directory. This allows those -users to log in to the Chef Infra Server by using their corporate -credentials instead of having a separate username and password. - -{{< warning >}} - -The following attributes **MUST** be in the user LDAP record: - -- `mail:` -- `sAMAccountName:` or `uid:` - -The following attributes **SHOULD** be in the user LDAP record: - -- `displayname:` -- `givenname:` -- `sn:` -- `c:` -- `l:` - -{{< /warning >}} - -To configure the Chef Infra Server to use Active Directory or LDAP do -the following: - -1. Install the Chef management console (if it's not already). - -1. Add the following settings to the `/etc/opscode/chef-server.rb` - file. These settings must be added to the `chef-server.rb` file on - each machine in the Chef Infra Server frontend deployment of a High - Availability installation as well as on Chef servers in a standalone - installation. - - {{< warning >}} - - The following settings **MUST** be in the config file for LDAP - authentication to Active Directory to work: - - - `base_dn` - - `bind_dn` - - `group_dn` - - `host` - - If those settings are missing, you will get authentication errors and be - unable to proceed. - - {{< /warning >}} - - This configuration file has the following settings for `ldap`: - - `ldap['base_dn']` - - : The root LDAP node under which all other nodes exist in the - directory structure. For Active Directory, this is typically - `cn=users` and then the domain. For example: - - ```ruby - 'OU=Employees,OU=Domain users,DC=example,DC=com' - ``` - - Default value: `nil`. - - `ldap['bind_dn']` - - : The distinguished name used to bind to the LDAP server. The user the - Chef Infra Server will use to perform LDAP searches. This is often - the administrator or manager user. This user needs to have read - access to all LDAP users that require authentication. The Chef Infra - Server must do an LDAP search before any user can log in. Many - Active Directory and LDAP systems don't allow an anonymous bind. If - anonymous bind is allowed, leave the `bind_dn` and `bind_password` - settings blank. If anonymous bind isn't allowed, a user with `READ` - access to the directory is required. This user must be specified as - an LDAP distinguished name similar to: - - ```ruby - 'CN=user,OU=Employees,OU=Domainuser,DC=example,DC=com' - ``` - - {{< note >}} - - If you need to escape characters in a distinguished name, such as - when using Active Directory, they must be [escaped with a backslash - escape - character](https://social.technet.microsoft.com/wiki/contents/articles/5312.active-directory-characters-to-escape.aspx). - - ```ruby - 'CN=example\\user,OU=Employees,OU=Domainuser,DC=example,DC=com' - ``` - - {{< /note >}} - - Default value: `nil`. - - `ldap['bind_password']` - - : Legacy configuration for the password of the binding user. The - password for the user specified by `ldap['bind_dn']`. Leave this - value and `ldap['bind_dn']` unset if anonymous bind is sufficient. - Default value: `nil`. As of Chef Infra Server 12.14, this is no longer the - preferred command. - - Please use `chef-server-ctl set-secret ldap bind_password` from the - [Secrets Management](/server/ctl_chef_server/#secrets-management) commands. - - ```bash - chef-server-ctl set-secret ldap bind_password - Enter ldap bind_password: (no terminal output) - Re-enter ldap bind_password: (no terminal output) - ``` - - Remove a set password using - - ```bash - chef-server-ctl remove-secret ldap bind_password - ``` - - `ldap['group_dn']` - - : The distinguished name for a group. When set to the distinguished - name of a group, only members of that group can log in. This feature - filters based on the `memberOf` attribute and only works with LDAP - servers that provide such an attribute. In OpenLDAP, the `memberOf` - overlay provides this attribute. For example, if the value of the - `memberOf` attribute is `CN=common_name,OU=users,DC=company,DC=com`, then - use: - - ```ruby - ldap['group_dn'] = 'CN=abcxyz,OU=users,DC=company,DC=com' - ``` - - `ldap['host']` - - : The name (or IP address) of the LDAP server. The hostname of the - LDAP or Active Directory server. Be sure the Chef Infra Server is - able to resolve any host names. Default value: `ldap-server-host`. - - `ldap['login_attribute']` - - : The LDAP attribute that holds the user's login name. Use to specify - the Chef Infra Server user name for an LDAP user. Default value: - `sAMAccountName`. - - `ldap['port']` - - : An integer that specifies the port on which the LDAP server listens. - The default value is an appropriate value for most configurations. - Default value: `389` or `636` when `ldap['encryption']` is set to - `:simple_tls`. - - `ldap['ssl_enabled']` - - : Cause the Chef Infra Server to connect to the LDAP server using SSL. Synonymous with simple_tls - Default value: `false`. Must be `false` when `ldap['tls_enabled']` - is `true`. - - {{< note >}} - - Enable SSL for Active Directory. - - {{< /note >}} - - {{< note >}} - - Previous versions of the Chef Infra Server used the - `ldap['ssl_enabled']` setting to first enable SSL, and then the - `ldap['encryption']` setting to specify the encryption type. These - settings are deprecated. - - {{< /note >}} - - `ldap['system_adjective']` - - : A descriptive name for the login system that's displayed to users - in the Chef Infra Server management console. If a value like - "corporate" is used, then the Chef management console user interface - will display strings like "the corporate login server," "corporate - login," or "corporate password." Default value: `AD/LDAP`. - - {{< warning >}} - - This setting **isn't** used by the Chef Infra Server. It's used only by the Chef management console. - - {{< /warning >}} - - `ldap['timeout']` - - : The amount of time (in seconds) to wait before timing out. Default - value: `60000`. - - `ldap['tls_enabled']` - - : Enable TLS. When enabled, communication with the LDAP server is done - using a secure SSL connection on a dedicated port. Synonymous with STARTTLS. This mode is rarely used. When `true`, - `ldap['port']` is also set to `636`. Default value: `false`. Must be - `false` when `ldap['ssl_enabled']` is `true`. - - {{< note >}} - - Previous versions of the Chef Infra Server used the - `ldap['ssl_enabled']` setting to first enable SSL, and then the - `ldap['encryption']` setting to specify the encryption type. These - settings are deprecated. - - {{< /note >}} - - {{< note >}} - - If the `chef-server.rb` file doesn't exist, create a file called - `chef-server.rb` and put it in the `/etc/opscode/` directory. - - {{< /note >}} - -1. {{< readfile file="content/server/reusable/md/install_chef_server_reconfigure.md" >}} - -At this point, all users should be able to use their Active Directory or -LDAP usernames and passwords to log in to the Chef Infra Server. - -## Test LDAP Connectivity - -Use `ldapsearch` to test the ability of the Chef Infra Server to use -Active Directory or LDAP. First, translate the Chef Infra Server LDAP -settings into `ldapsearch` parameters: - - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Chef Infra Server Settingldapsearch Parameter
ldap['host'] and ldap['port']-H [HOST:PORT]
ldap['bind_dn']-D [BIND_DN]
ldap['bind_password']-W; ldapsearch will prompt for this parameter
ldap['base_dn']-b [BASE_DN]
ldap['login_attribute']Defaults to SAMAccountName
- -And then from a front end machine (in a high availability or tiered -configuration) or from the Chef Infra Server in a standalone -configuration, run the following command. Be sure to replace the -uppercase placeholders with the values for your organization: - -```bash -ldapsearch -LLL -H ldap://HOST:PORT -b 'BASE_DN' -D 'BIND_DN' -W '(LOGIN_ATTRIBUTE=YOUR_LDAP_ACCOUNT_USERNAME)' -``` - -For example: - -```bash -ldapsearch -LLL -H ldap://win-ad1.chef.co:389 -b 'OU=Employees,OU=Domain users,DC=opscodecorp,DC=com' -D 'CN=Robert Forster,OU=Employees,OU=Domain users,DC=opscodecorp,DC=com' -W '(sAMAccountName=rforster)' -``` - -Output similar to the following is returned: - -```bash -ldapsearch -LLL -H ldap://win-ad1.chef.co:389 -b 'OU=Employees,OU=Domain users,DC=opscodecorp,DC=com' -D 'CN=Robert Forster,OU=Employees,OU=Domain users,DC=opscodecorp,DC=com' -W '(sAMAccountName=rforster)' -Enter LDAP Password: - -dn: CN=Robert Forster,OU=Employees,OU=Domain users,DC=opscodecorp,DC=com -objectClass: top -objectClass: person -objectClass: organizationalPerson -objectClass: user -cn: Robert Forster -sn: Forster -c: 0 -givenName: Robert -distinguishedName: CN=Robert Forster,OU=Employees,OU=Domain users,DC=opscodecorp,DC - =com -``` - -{{< note >}} - -The `ldapsearch` command may need to be installed on the platform. It is -not included as part of the Chef Infra Server package. - -{{< /note >}} diff --git a/content/server_manage_clients.md b/content/server_manage_clients.md deleted file mode 100644 index 7ebb6fae48..0000000000 --- a/content/server_manage_clients.md +++ /dev/null @@ -1,271 +0,0 @@ -+++ -title = "Manage Client Keys" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/server_manage_clients.html"] -product = [] - -[menu] - [menu.legacy] - title = "Clients" - identifier = "legacy/manage/server_manage_clients.md Clients" - parent = "legacy/manage" -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< note >}} - -This topic is about using the Chef management console to manage keys. - -{{< /note >}} - -A client is an actor that has permission to access the Chef Infra -Server. A client is most often a node (on which the Chef Infra Client -runs), but is also a workstation (on which knife runs), or some other -machine that is configured to use the Chef Infra Server API. Each -request to the Chef Infra Server that is made by a client uses a private -key for authentication that must be authorized by the public key on the -Chef Infra Server. - -Use the Chef management console to create a key pair, download the -private key, and then set permissions, to delete a key, or to reset a -key. - -## Manage Client Keys - -Client keys can be managed from the Chef management console. - -{{< warning >}} - -The images below refer to client keys as a "Client". - -{{< /warning >}} - -### Add - -To add a client key: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Clients**. - -4. Click **Create**. - -5. In the **Create Client** dialog box, enter the name of the client - key. - - ![image](/images/step_manage_webui_policy_client_add.png) - - Click **Create Client**. - -6. Copy the private key: - - ![image](/images/step_manage_webui_policy_client_add_private_key.png) - - or download and save the private key locally: - - ![image](/images/step_manage_webui_policy_client_add_private_key_download.png) - -### Delete - -To delete a client key: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Clients**. - -4. Select a client key. - -5. Click **Delete**. - - ![image](/images/step_manage_webui_policy_client_delete.png) - -### Reset Key - -To regenerate a client key: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Clients**. - -4. Select a client key. - -5. Click the **Details** tab. - -6. Click **Reset Key**. - -7. In the **Reset Key** dialog box, confirm that the key should be - regenerated and click the **Reset Key** button: - - ![image](/images/step_manage_webui_admin_organization_reset_key.png) - -8. Copy the private key: - - ![image](/images/step_manage_webui_policy_client_reset_key_copy.png) - - or download and save the private key locally: - - ![image](/images/step_manage_webui_policy_client_reset_key_download.png) - -### View Details - -To view client key details: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Clients**. -4. Select a client key. -5. Click the **Details** tab. - -### Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions.md" >}} - -{{< readfile file="content/server/reusable/md/server_rbac_permissions_object.md" >}} - -#### Set - -To set permissions list for a client key: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Clients**. -4. Select a client key. -5. Click the **Permissions** tab. -6. For each group listed under **Name**, select or de-select the - **Read**, **Update**, **Delete**, and **Grant** permissions. - -#### Update - -{{< readfile file="content/reusable/md/manage_webui_policy_client_permissions_add.md" >}} - -#### View - -To view permissions for a client key: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Clients**. -4. Select a client key. -5. Click the **Permissions** tab. -6. Set the appropriate permissions: **Delete**, **Grant**, **Read**, - and/or **Update**. - -## chef-validator Keys - -{{< readfile file="content/reusable/md/security_chef_validator.md" >}} - -{{< readfile file="content/reusable/md/security_chef_validator_context.md" >}} - -### Add - -To add a chef-validator key: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Clients**. - -4. Click **Create**. - -5. In the **Create Client** dialog box, enter the name of the - chef-validator key. - - ![image](/images/step_manage_webui_policy_validation_add.png) - - Select the **Validation Client** option. Click **Create Client**. - -6. Copy the private key: - - ![image](/images/step_manage_webui_policy_client_add_private_key.png) - - or download and save the private key locally: - - ![image](/images/step_manage_webui_policy_client_add_private_key_download.png) - -### Delete - -To delete a chef-validator key: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Clients**. - -4. Select a chef-validator key. - -5. Click **Delete**. - - ![image](/images/step_manage_webui_policy_validation_delete.png) - -### Reset Key - -{{< readfile file="content/reusable/md/manage_webui_policy_validation_reset_key.md" >}} - -### View Details - -To view details for a chef-validator key: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Clients**. - -4. Select a chef-validator key. - - ![image](/images/step_manage_webui_policy_validation_view_details.png) - -5. Click the **Details** tab. - -### Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions.md" >}} - -{{< readfile file="content/server/reusable/md/server_rbac_permissions_object.md" >}} - -#### Set - -To update the permissions list for a chef-validator key: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Clients**. -4. Select a chef-validator key. -5. Click the **Permissions** tab. -6. Click the **+ Add** button and enter the name of the user or group - to be added. -7. Select or de-select **Delete**, **Grant**, **Read**, and/or - **Update** to update the permissions list for the user or group. - -#### Update - -{{< readfile file="content/reusable/md/manage_webui_policy_client_permissions_add.md" >}} - -#### View - -To view permissions for a chef-validator key: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Clients**. -4. Select a chef-validator key. -5. Click the **Permissions** tab. -6. Set the appropriate permissions: **Delete**, **Grant**, **Read**, - and/or **Update**. diff --git a/content/server_manage_cookbooks.md b/content/server_manage_cookbooks.md deleted file mode 100644 index 9c249cd4f7..0000000000 --- a/content/server_manage_cookbooks.md +++ /dev/null @@ -1,184 +0,0 @@ -+++ -title = "Manage Cookbooks" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/server_manage_cookbooks.html"] -product = [] - -[menu] - [menu.legacy] - title = "Cookbooks" - identifier = "legacy/manage/server_manage_cookbooks.md Cookbooks" - parent = "legacy/manage" -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< note >}} - -This topic is about using the Chef management console to manage -cookbooks. - -{{< /note >}} - -{{< readfile file="content/reusable/md/cookbooks_summary.md" >}} - -## Manage - -Cookbooks can be viewed from the Chef management console web user -interface. Cookbooks are managed using knife. - -### View Cookbook Details - -To view cookbook details: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Cookbooks**. - -4. Select a cookbook. - -5. Click the **Details** tab: - - ![image](/images/step_manage_webui_policy_cookbook_view_details.png) - -## Cookbook Files - -A cookbook can contain the following types of files: - - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
File TypeDescription
Attributes{{< readfile file="content/reusable/md/cookbooks_attribute.md" >}}
Files{{< readfile file="content/reusable/md/resource_cookbook_file_summary.md" >}}
Libraries{{< readfile file="content/reusable/md/libraries_summary.md" >}}
Recipes{{< readfile file="content/reusable/md/cookbooks_recipe.md" >}}
Resources{{< readfile file="content/reusable/md/resources_common.md" >}}
Templates{{< readfile file="content/reusable/md/template.md" >}}
- -All of the file types that are part of any cookbook uploaded to the Chef -Infra Server are visible from the Chef management console. - -### Download File - -To download a file that is located in a cookbook: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Cookbooks**. - -4. Select the file type: **Attributes**, **Definitions**, **Files**, - **Recipes**, **Templates**, or **Root Files**. - -5. Select a file. - -6. Click **Download File**: - - ![image](/images/step_manage_webui_policy_cookbook_download.png) - -7. Specify the location to which the file should be saved. - -### View a File - -To view a cookbook file: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Cookbooks**. - -4. Select a cookbook. - -5. Click the **Content** tab. - -6. Select the file type: **Attributes**, **Definitions**, **Files**, - **Recipes**, **Templates**, or **Root Files**. - -7. Select a file: - - ![image](/images/step_manage_webui_policy_cookbook_file_view.png) - -## Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions.md" >}} - -{{< readfile file="content/server/reusable/md/server_rbac_permissions_object.md" >}} - -### Set - -To set permissions list for a cookbook object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Cookbooks**. -4. Select a cookbook. -5. Click the **Permissions** tab. -6. For each group listed under **Name**, select or de-select the - **Read**, **Update**, **Delete**, and **Grant** permissions. - -### Update - -To update the permissions list for a cookbook object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Cookbooks**. -4. Select a cookbook. -5. Click the **Permissions** tab. -6. Click the **+ Add** button and enter the name of the user or group - to be added. -7. Select or de-select **Read**, **Update**, **Delete**, and **Grant** - to update the permissions list for the user or group. - -### View - -To view permissions for a cookbook object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Cookbooks**. -4. Select a cookbook. -5. Click the **Permissions** tab. -6. Set the appropriate permissions: **Delete**, **Grant**, **Read**, - and/or **Update**. diff --git a/content/server_manage_data_bags.md b/content/server_manage_data_bags.md deleted file mode 100644 index 9e0333a9a8..0000000000 --- a/content/server_manage_data_bags.md +++ /dev/null @@ -1,167 +0,0 @@ -+++ -title = "Manage Data Bags" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/server_manage_data_bags.html"] -product = [] - -[menu] - [menu.legacy] - title = "Data Bags" - identifier = "legacy/manage/server_manage_data_bags.md Data Bags" - parent = "legacy/manage" -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< note >}} - -This topic is about using the Chef management console to manage data -bags. - -{{< /note >}} - -{{< readfile file="content/reusable/md/data_bag.md" >}} - -## Manage - -Data bags can be managed from the Chef management console web user -interface. - -### Add Data Bag - -To add a data bag: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Data Bags**. -1. Click **Create**. -1. In the **Create a Data Bag** dialog box, enter the name of the data - bag. - - ![image](/images/step_manage_webui_policy_data_bag_add.png) - -1. Click **Create Data Bag**. - -### Delete Data Bag - -To delete a data bag: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Data Bags**. -1. Select a data bag. -1. Click **Delete**. - - ![image](/images/step_manage_webui_policy_data_bag_delete.png) - -## Manage Items - -{{< readfile file="content/reusable/md/data_bag_item.md" >}} - -### Add Item - -To add a data bag item: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Data Bags**. -1. Select a data bag. -1. Click **Create Item**. -1. In the **Create a Data Bag Item** dialog box, enter the data bag - identifier, and then JSON data that defines the data bag item. - - ![image](/images/step_manage_webui_policy_data_bag_add_item.png) - -1. Click **Create Data Bag Item**. - -### Delete Item - -To delete a data bag item: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Data Bags**. -1. Select a data bag. -1. Select the **Items** tab. -1. Select an item. -1. Click **Delete**. - - ![image](/images/step_manage_webui_policy_data_bag_delete_item.png) - -### Edit Item - -To edit a data bag item: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Data Bags**. -1. Select a data bag. -1. Select the **Items** tab. -1. Select an item. -1. Click **Edit**. - ![image](/images/step_manage_webui_policy_data_bag_edit_item.png) - -1. Make your changes. -1. Click **Save Item**. - -### View Item - -To view data bag items for a data bag: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Data Bags**. -4. Select a data bag. -5. Select the **Items** tab. - -## Manage Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions.md" >}} - -{{< readfile file="content/server/reusable/md/server_rbac_permissions_object.md" >}} - -### Set - -To set permissions list for a data bag object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Data Bags**. -4. Select a data bag. -5. Click the **Permissions** tab. -6. For each group listed under **Name**, select or de-select the - **Read**, **Update**, **Delete**, and **Grant** permissions. - -### Update - -To update the permissions list for a data bag object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Data Bags**. -4. Select a data bag. -5. Click the **Permissions** tab. -6. Click the **+ Add** button and enter the name of the user or group - to be added. -7. Select or de-select **Read**, **Update**, **Delete**, and **Grant** - to update the permissions list for the user or group. - -### View - -To view permissions for a data bag object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Data Bags**. -4. Select a data bag. -5. Click the **Permissions** tab. -6. Set the appropriate permissions: **Read**, **Update**, **Delete**, - and **Grant**. diff --git a/content/server_manage_environments.md b/content/server_manage_environments.md deleted file mode 100644 index 2730223069..0000000000 --- a/content/server_manage_environments.md +++ /dev/null @@ -1,255 +0,0 @@ -+++ -title = "Manage Environments" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/server_manage_environments.html"] -product = [] - -[menu] - [menu.legacy] - title = "Environments" - identifier = "legacy/manage/server_manage_environments.md Environments" - parent = "legacy/manage" -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< note >}} - -This topic is about using the Chef management console to manage -environments. - -{{< /note >}} - -{{< note >}} - -Chef Manage in all versions can only display 20 Environment items from the Chef Server search index. - -{{< /note >}} - -{{< readfile file="content/reusable/md/environment.md" >}} - -## Manage - -Environments can be managed from the Chef management console web user -interface. - -### Add Environment - -To add an environment: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Environments**. - -4. Click **Create**. - -5. In the **Create an Environment** dialog box, enter the name of the - environment and a description. - - ![image](/images/step_manage_webui_policy_environment_add.png) - - Click **Next**. - -6. Optional. Set a constraint by choosing a name, an operator, and a - version: - - ![image](/images/step_manage_webui_policy_environment_add_constraint.png) - - Click **Add**. Continue this process until all constraints are - added. When finished, click **Next**. - -7. Optional. Add default attributes as JSON data: - - ![image](/images/step_manage_webui_policy_environment_add_default_attribute.png) - - Click **Next**. - -8. Optional. Add override attributes as JSON data: - - ![image](/images/step_manage_webui_policy_environment_add_override_attribute.png) - -9. Click **Create Environment**. - -### Delete Environment - -To delete an environment: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Environments**. - -4. Select an environment. - -5. Click **Delete**. - - ![image](/images/step_manage_webui_policy_environment_delete.png) - -### Edit Details - -To edit the details of an environment: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Environments**. -4. Select an environment. -5. Click the **Details** tab. -6. Click **Edit**. - -### Set - -To set the environment for a node: - -1. Open the Chef management console. - -2. Click **Nodes**. - -3. Select a node. - -4. Click the **Details** tab. - -5. In the top right, from the **Environment** drop-down, select the - environment: - - ![image](/images/step_manage_webui_node_details_set_environment.png) - -6. Click **Save**. - -### View Details - -To view environment details: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Environments**. -4. Select an environment. -5. Click the **Details** tab. - -## Default Attributes - -{{< readfile file="content/reusable/md/node_attribute_type_default.md" >}} - -### Edit - -To edit default attributes for an environment: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Environments**. - -4. Select an environment. - -5. Click the **Attributes** tab. - -6. Under **Default Attributes**, click **Edit**. - -7. In the **Edit Environment Attributes** dialog box, enter the JSON - data that defines the attribute (or attributes). - - ![image](/images/step_manage_webui_policy_environment_edit_attribute.png) - -8. Click **Save**. - -### View - -To view default attributes for an environment: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Environments**. -4. Select an environment. -5. Click the **Attributes** tab. - -## Override Attributes - -{{< readfile file="content/reusable/md/node_attribute_type_override.md" >}} - -### Edit - -To edit override attributes for an environment: - -1. Open the Chef management console. - -2. Click **Policy**. - -3. Click **Environments**. - -4. Select an environment. - -5. Click the **Attributes** tab. - -6. Under **Override Attributes**, click **Edit**. - -7. In the **Edit Environment Attributes** dialog box, enter the JSON - data that defines the attribute (or attributes). - - ![image](/images/step_manage_webui_policy_environment_edit_attribute.png) - -8. Click **Save Attributes**. - -### View - -To view override attributes for an environment: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Environments**. -4. Select an environment. -5. Click the **Attributes** tab. - -## Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions.md" >}} - -{{< readfile file="content/server/reusable/md/server_rbac_permissions_object.md" >}} - -### Set - -To set permissions list for an environment object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Environments**. -4. Select an environment. -5. Click the **Permissions** tab. -6. For each group listed under **Name**, select or de-select the - **Read**, **Update**, **Delete**, and **Grant** permissions. - -### Update - -To update the permissions list for an environment object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Environments**. -4. Select an environment. -5. Click the **Permissions** tab. -6. Click the **+ Add** button and enter the name of the user or group - to be added. -7. Select or de-select **Read**, **Update**, **Delete**, and **Grant** - to update the permissions list for the user or group. - -### View - -To view permissions for an environment object: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Environments**. -4. Select an environment. -5. Click the **Permissions** tab. -6. Set the appropriate permissions: **Read**, **Update**, **Delete**, - and **Grant**. diff --git a/content/server_manage_nodes.md b/content/server_manage_nodes.md deleted file mode 100644 index 08d4a8b55d..0000000000 --- a/content/server_manage_nodes.md +++ /dev/null @@ -1,289 +0,0 @@ -+++ -title = "Manage Nodes" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/server_manage_nodes.html"] -product = [] - -[menu] - [menu.legacy] - title = "Nodes" - identifier = "legacy/manage/server_manage_nodes.md Nodes" - parent = "legacy/manage" -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< note >}} - -This topic is about using the Chef management console to manage nodes. - -{{< /note >}} - -{{< readfile file="content/reusable/md/node.md" >}} - -## Manage - -Nodes can be managed from the Chef management console web user -interface. - -### Delete - -To delete a node: - -1. Open the Chef management console. - -1. Click **Nodes**. - -1. Select a node. - -1. Click **Delete**. - -1. Confirm: - - {{< figure src="/images/step_manage_webui_node_delete.png" alt="Dialog box asking user if they want to delete a node." class="no-shadow">}} - -### Reset Key - -To reset the validation key for a node: - -1. Open the Chef management console. - -1. Click **Nodes**. - -1. Select a node. - -1. Click **Edit Run List**. - -1. In the **Reset Key** dialog box, confirm that the key should be - regenerated and click the **Regenerate Key** button: - - {{< figure src="/images/step_manage_webui_admin_organization_reset_key.png" alt="Dialog box asking user to confirm that they want to delete a key." class="no-shadow">}} - -1. In the **Reset Key** dialog box, copy the key directly from the - dialog box or click the **Download** button to download the key - your local machine: - - {{< figure src="/images/step_manage_webui_admin_organization_reset_key_regenerated.png" alt="Dialog box showing newly generated key." class="no-shadow">}} - -### Search - -To search nodes: - -1. Open the Chef management console. - -1. Click **Nodes**. - -1. In the search box in the upper right, enter the search query and - click the search icon. - - ![image](/images/step_manage_webui_nodes_search.png) - -1. The results will appear in the list below. - -## Node Attributes - -An attribute is a specific detail about a node. Attributes are used by Chef Infra Client to understand: - -- The current state of the node -- What the state of the node was at the end of the previous Chef Infra Client run -- What the state of the node should be at the end of the current Chef Infra Client run - -Attributes are defined by: - -- The node as saved on the Chef Infra Server -- Attributes passed using JSON on the command line -- Cookbooks (in attribute files and/or recipes) -- Policyfiles - -During every Chef Infra Client run, Chef Infra Client builds the attribute list using: - -- Attributes passed using JSON on the command line -- Data about the node collected by [Ohai](/ohai.html). -- The node object that was saved to the Chef Infra Server at the end of the previous Chef Infra Client run. -- The rebuilt node object from the current Chef Infra Client run, after it is updated for changes to cookbooks (attribute files and/or recipes) and/or Policyfiles, and updated for any changes to the state of the node itself. - -After the node object is rebuilt, all of the attributes are compared, and then the node is updated based on attribute precedence. At the end of every Chef Infra Client run, the node object that defines the current state of the node is uploaded to the Chef Infra Server so that it can be indexed for search. - -### Edit Attribute - -To edit node attributes: - -1. Open the Chef management console. - -1. Click **Nodes**. - -1. Select a node. - -1. Click the **Attributes** tab. - -1. Click **Edit**. - -1. In the **Edit Node Attributes** dialog box, make your changes: - - ![image](/images/step_manage_webui_node_attributes_edit.png) - -1. Click **Save Attributes**. - -### View Attributes - -To view the attributes for a node: - -1. Open the Chef management console. -1. Click **Nodes**. -1. Select a node. -1. Click the **Attributes** tab. -1. Click **Edit**. - -## Run-lists - -{{< readfile file="content/reusable/md/node_run_list.md" >}} - -### Add Recipe - -{{< readfile file="content/reusable/md/manage_webui_node_run_list_add_role_or_recipe.md" >}} - -### Add Role - -{{< readfile file="content/reusable/md/manage_webui_node_run_list_add_role_or_recipe.md" >}} - -### Edit - -To edit a run-list: - -1. Open the Chef management console. -1. Click **Nodes**. -1. Select a node. -1. Click **Edit Run List**. -1. In the **Edit Node Run List** dialog box, make your changes. -1. Click **Save Run List**. - -### Remove Recipe - -{{< readfile file="content/reusable/md/manage_webui_node_run_list_remove_role_or_recipe.md" >}} - -### Remove Role - -{{< readfile file="content/reusable/md/manage_webui_node_run_list_remove_role_or_recipe.md" >}} - -### View Current - -To view the current run-list for a node: - -1. Open the Chef management console. - -1. Click **Nodes**. - -1. Select a node. - -1. Click the **Details** tab. - -1. The current run-list is shown in the lower right: - - ![image](/images/step_manage_webui_node_run_list_view_current.png) - -## Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions.md" >}} - -{{< readfile file="content/server/reusable/md/server_rbac_permissions_object.md" >}} - -### Set - -To set permissions list for a node object: - -1. Open the Chef management console. -1. Click **Nodes**. -1. Select a node. -1. Click the **Permissions** tab. -1. For each group listed under **Name**, select or de-select the - **Read**, **Update**, **Delete**, and **Grant** permissions. - -### Update - -To update the permissions list for a node object: - -1. Open the Chef management console. -1. Click **Nodes**. -1. Select a node. -1. Click the **Permissions** tab. -1. Click the **+ Add** button and enter the name of the user or group - to be added. -1. Select or de-select **Read**, **Update**, **Delete**, and **Grant** - to update the permissions list for the user or group. - -### View - -To view permissions for a node: - -1. Open the Chef management console. -1. Click **Nodes**. -1. Select a node. -1. Click the **Permissions** tab. -1. Set the appropriate permissions: **Delete**, **Grant**, **Read**, - and/or **Update**. - -## Manage Tags - -{{< readfile file="content/reusable/md/chef_tags.md" >}} - -### Add - -To add tags to a node (or a group of nodes): - -1. Open the Chef management console. - -1. Click **Nodes**. - -1. Select a node (or a group of nodes). - -1. Click **Manage Tags**. - -1. In the **Manage Node Tags** dialog box, enter the name of the tag - and then select **Add Tags** from the drop-down. - - ![image](/images/step_manage_webui_node_tags_add.png) - -1. Click **Update Tags**. - -### Delete - -To delete tags for a node (or a group of nodes): - -1. Open the Chef management console. - -1. Click **Nodes**. - -1. Select a node (or a group of nodes). - -1. Click **Manage Tags**. - -1. In the **Manage Node Tags** dialog box, enter the name of the tag - and then select **Delete Tags** from the drop-down. - - ![image](/images/step_manage_webui_node_tags_delete.png) - -1. Click **Update Tags**. - -### View - -To view all of the nodes: - -1. Open the Chef management console. - -1. Click **Nodes**. - -1. Select a node. - -1. Select the **Details** tab. - -1. The tags for the node appear under the **Tags** header: - - ![image](/images/step_manage_webui_nodes_view_tags.png) diff --git a/content/server_manage_roles.md b/content/server_manage_roles.md deleted file mode 100644 index 7568894940..0000000000 --- a/content/server_manage_roles.md +++ /dev/null @@ -1,239 +0,0 @@ -+++ -title = "Manage Roles" -draft = false -gh_repo = "chef-web-docs" -robots = "noindex" -aliases = ["/server_manage_roles.html"] -product = [] - -[menu] - [menu.legacy] - title = "Roles" - identifier = "legacy/manage/server_manage_roles.md Roles" - parent = "legacy/manage" -+++ - -{{< chef_automate_mark >}} - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -{{< note >}} - -This topic is about using the Chef management console to manage roles. - -{{< /note >}} - -{{< readfile file="content/reusable/md/role.md" >}} - -## Manage - -Roles can be managed from the Chef management console web user -interface. - -### Add Role - -To add a role: - -1. Open the Chef management console. - -1. Click **Policy**. - -1. Click **Roles**. - -1. Click **Create**. - -1. In the **Create Role** dialog box, enter the name of the role and a - description. - - ![image](/images/step_manage_webui_policy_role_add.png) - - Click **Next**. - -1. Optional. Build the run-list from the list of available roles and - recipes: - - ![image](/images/step_manage_webui_policy_role_add_run_list.png) - - Click **Next**. - -1. Optional. Add default attributes as JSON data: - - ![image](/images/step_manage_webui_policy_role_add_default_attribute.png) - - Click **Next**. - -1. Optional. Add override attributes as JSON data: - - ![image](/images/step_manage_webui_policy_role_add_override_attribute.png) - -1. Click **Create Role**. - -### Delete Role - -To delete a role: - -1. Open the Chef management console. - -1. Click **Policy**. - -1. Click **Roles**. - -1. Select a role. - -1. Click **Delete**. - - ![image](/images/step_manage_webui_policy_role_delete.png) - -### View All Roles - -To view all roles uploaded to the Chef Infra Server organization: - -1. Open the Chef management console. -2. Click **Policy**. -3. Click **Roles**. - -## Run-lists - -{{< readfile file="content/reusable/md/node_run_list.md" >}} - -### Edit Role Run-list - -To edit the run-list for a role: - -1. Open the Chef management console. - -1. Click **Policy**. - -1. Click **Roles**. - -1. Select a role. - -1. Click **Edit Run List**. - - ![image](/images/step_manage_webui_policy_role_edit_run_list.png) - -1. Make your changes. - -1. Click **Save Run List**. - -## Default Attributes - -{{< readfile file="content/reusable/md/node_attribute_type_default.md" >}} - -### Edit Default Attributes - -To edit default attributes for a role: - -1. Open the Chef management console. - -1. Click **Policy**. - -1. Click **Roles**. - -1. Select a role. - -1. Click the **Attributes** tab. - -1. Under **Default Attributes**, click **Edit**. - -1. In the **Edit Role Attributes** dialog box, enter the JSON data that - defines the attribute (or attributes). - - ![image](/images/step_manage_webui_policy_role_edit_attribute.png) - -1. Click **Save Attributes**. - -### View Default Attributes - -To view default attributes for a role: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Roles**. -1. Select a role. -1. Click the **Attributes** tab. - -## Override Attributes - -{{< readfile file="content/reusable/md/node_attribute_type_override.md" >}} - -### Edit Override Attributes - -To edit override attributes for a role: - -1. Open the Chef management console. - -1. Click **Policy**. - -1. Click **Roles**. - -1. Select a role. - -1. Click the **Attributes** tab. - -1. Under **Override Attributes**, click **Edit**. - -1. In the **Edit Role Attributes** dialog box, enter the JSON data that - defines the attribute (or attributes). - - ![image](/images/step_manage_webui_policy_role_edit_attribute.png) - -1. Click **Save Attributes**. - -### View Override Attributes - -To view role details: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Roles**. -1. Select a role. -1. Click the **Details** tab. - -## Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions.md" >}} - -{{< readfile file="content/server/reusable/md/server_rbac_permissions_object.md" >}} - -### Set - -To set permissions list for a role object: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Roles**. -1. Select a role. -1. Click the **Permissions** tab. -1. For each group listed under **Name**, select or de-select the - **Read**, **Update**, **Delete**, and **Grant** permissions. - -### Update - -To update the permissions list for a role object: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Roles**. -1. Select a role. -1. Click the **Permissions** tab. -1. Click the **+ Add** button and enter the name of the user or group - to be added. -1. Select or de-select **Read**, **Update**, **Delete**, and **Grant** - to update the permissions list for the user or group. - -### View - -To view permissions for a role object: - -1. Open the Chef management console. -1. Click **Policy**. -1. Click **Roles**. -1. Select a role. -1. Click the **Permissions** tab. -1. Set the appropriate permissions: **Delete**, **Grant**, **Read**, - and/or **Update**. diff --git a/content/server_orgs.md b/content/server_orgs.md deleted file mode 100644 index 8528786335..0000000000 --- a/content/server_orgs.md +++ /dev/null @@ -1,725 +0,0 @@ -+++ -title = "Organizations and Groups" -draft = false -gh_repo = "chef-web-docs" -aliases = ["/server_orgs.html", "/auth_authorization.html"] -product = ["client", "server"] - -[menu] - [menu.legacy] - title = "Organizations & Groups" - identifier = "legacy/manage/server_orgs.md Organizations & Groups" - parent = "legacy/manage" -+++ - -{{< readfile file="content/server/reusable/md/server_rbac.md" >}} - -The Chef Infra Server uses organizations, groups, and users to define -role-based access control: - - ---- - - - - - - - - - - - - - - - - - - - - - - - - -
FeatureDescription

An organization is the top-level entity for role-based access control in the Chef Infra Server. Each organization contains the default groups (admins, clients, and users, plus billing_admins for the hosted Chef Infra Server), at least one user and at least one node (on which the Chef Infra Client is installed). The Chef Infra Server supports multiple organizations. The Chef Infra Server includes a single default organization that's defined during setup. Additional organizations can be created after the initial setup and configuration of the Chef Infra Server.

A group is used to define access to object types and objects in the Chef Infra Server and also to assign permissions that determine what types of tasks are available to members of that group who are authorized to perform them. Groups are configured by organization.

-

Individual users who are members of a group will inherit the permissions assigned to the group. The Chef Infra Server includes the following default groups: admins, clients, and users. For users of the hosted Chef Infra Server, an additional default group is provided: billing_admins.

A user is any non-administrator human being who will manage data that's uploaded to the Chef Infra Server from a workstation or who will log on to the Chef management console web user interface. The Chef Infra Server includes a single default user that's defined during setup and is automatically assigned to the admins group.

A client is an actor that has permission to access the Chef Infra Server. A client is most often a node (on which the Chef Infra Client runs), but is also a workstation (on which knife runs), or some other machine that's configured to use the Chef Infra Server API. Each request to the Chef Infra Server that's made by a client uses a private key for authentication that must be authorized by the public key on the Chef Infra Server.
- -When a user makes a request to the Chef Infra Server using the Chef -Infra Server API, permission to perform that action is determined by the -following process: - -1. Check if the user has permission to the object type -2. If no, recursively check if the user is a member of a security group - that has permission to that object -3. If yes, allow the user to perform the action - -Permissions are managed using the Chef management console add-on in the -Chef Infra Server web user interface. - -## Organizations - -A single instance of the Chef Infra Server can support many -organizations. Each organization has a unique set of groups and users. -Each organization manages a unique set of nodes, on which a Chef Infra -Client is installed and configured so that it may interact with a single -organization on the Chef Infra Server. - -![image](/images/server_rbac_orgs_groups_and_users.png) - -A user may belong to multiple organizations under the following -conditions: - -- Role-based access control is configured for each organization -- For a single user to interact with the Chef Infra Server using knife from the same chef-repo, that user may need to edit their `config.rb` file before that interaction - -Using multiple organizations within the Chef Infra Server ensures that -the same toolset, coding patterns and practices, physical hardware, and -product support effort is being applied across the entire company, even -when: - -- Multiple product groups must be supported---each product group can - have its own security requirements, schedule, and goals -- Updates occur on different schedules---the nodes in one organization - are managed completely independently from the nodes in another -- Individual teams have competing needs for object and object - types---data bags, environments, roles, and cookbooks are unique to - each organization, even if they share the same name - -### Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions.md" >}} - -#### Object Permissions - -{{< readfile file="content/server/reusable/md/server_rbac_permissions_object.md" >}} - -#### Global Permissions - -The Chef Infra Server includes the following global permissions: - - ---- - - - - - - - - - - - - - - - - -
PermissionDescription
CreateUse the Create global permission to define which users and groups may create the following server object types: cookbooks, data bags, environments, nodes, roles, and tags. This permission is required for any user who uses the knife [object] create argument to interact with objects on the Chef Infra Server.
ListUse the List global permission to define which users and groups may view the following server object types: cookbooks, data bags, environments, nodes, roles, and tags. This permission is required for any user who uses the knife [object] list argument to interact with objects on the Chef Infra Server.
- -These permissions set the default permissions for the following Chef -Infra Server object types: clients, cookbooks, data bags, environments, -groups, nodes, roles, and sandboxes. - -#### Client Key Permissions - -{{< note >}} - -This is only necessary after migrating a client from one Chef Infra -Server to another. Permissions must be reset for client keys after the -migration. - -{{< /note >}} - -Keys should have `DELETE`, `GRANT`, `READ` and `UPDATE` permissions. - -Use the following code to set the correct permissions: - -```ruby -#!/usr/bin/env ruby -require 'chef/knife' - -#previously knife.rb -Chef::Config.from_file(File.join(Chef::Knife.chef_config_dir, 'knife.rb')) - -rest = Chef::ServerAPI.new(Chef::Config[:chef_server_url]) - -Chef::Node.list.each do |node| - %w(read update delete grant).each do |perm| - ace = rest.get("nodes/#{node[0]}/_acl")[perm] - ace['actors'] << node[0] unless ace['actors'].include?(node[0]) - rest.put("nodes/#{node[0]}/_acl/#{perm}", perm => ace) - puts "Client \"#{node[0]}\" granted \"#{perm}\" access on node \"#{node[0]}\"" - end -end -``` - -Save it as a Ruby script---`chef_server_permissions.rb`, for -example---in the `.chef/scripts` directory located in the chef-repo, and -then run a knife command similar to: - -```bash -knife exec chef_server_permissions.rb -``` - -#### Knife ACL - -The knife plugin [knife-acl](https://github.com/chef/knife-acl) provides -a fine-grained approach to modifying permissions, by wrapping API calls -to the `_acl` endpoint and makes such permission changes easier to -manage. - -{{< warning >}} - -{{< readfile file="content/reusable/md/EOL_manage.md" >}} - -{{< /warning >}} - -knife-acl and the Chef Manage browser -interface are incompatible. After engaging knife-acl, you will need to discontinue using -the Chef Manage browser interface from that point forward due to -possible incompatibilities. - -## Groups - -The Chef Infra Server includes the following default groups: - - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GroupDescription
adminsThe admins group defines the list of users who have administrative rights to all objects and object types for a single organization.
billing_adminsThe billing_admins group defines the list of users who have permission to manage billing information. This permission exists only for the hosted Chef Infra Server.
clientsThe clients group defines the list of nodes on which a Chef Infra Client is installed and under management by Chef. In general, think of this permission as "all of the non-human actors---Chef Infra Client, in almost every case---that get data from, and/or upload data to, Chef Infra Server." Newly-created Chef Infra Client instances are added to this group automatically.
public_key_read_accessThe public_key_read_access group defines which users and clients have read permissions to key-related endpoints in the Chef Infra Server API.
usersThe users group defines the list of users who use knife and the Chef management console to interact with objects and object types. In general, think of this permission as "all of the non-admin human actors who work with data that's uploaded to and/or downloaded from Chef Infra Server."
- -### Example Default Permissions - -The following sections show the default permissions assigned by the Chef -Infra Server to the `admins`, `billing_admins`, `clients`, and `users` -groups. - -{{< note >}} - -The creator of an object on the Chef Infra Server is assigned `create`, -`delete`, `grant`, `read`, and `update` permission to that object. - -{{< /note >}} - -#### admins - -The `admins` group is assigned the following: - - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GroupCreateDeleteGrantReadUpdate
adminsyesyesyesyesyes
clientsyesyesyesyesyes
usersyesyesyesyesyes
- -#### billing_admins - -The `billing_admins` group is assigned the following: - -#### billing_admins - -The `billing_admins` group is assigned the following: - - ------- - - - - - - - - - - - - - - - - - - -
GroupCreateDeleteReadUpdate
billing_adminsnonoyesyes
- -#### clients - -The `clients` group is assigned the following: - - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ObjectCreateDeleteReadUpdate
clientsnononono
cookbooksnonoyesno
cookbook_artifactsnonoyesno
datanonoyesno
environmentsnonoyesno
nodesyesnoyesno
organizationnonoyesno
policiesnonoyesno
policy_groupsnonoyesno
rolesnonoyesno
sandboxesnononono
- -#### public_key_read_access - -The `public_key_read_access` group controls which users and clients have -[read permissions to the following endpoints](/api_chef_server/): - -- GET /clients/CLIENT/keys -- GET /clients/CLIENT/keys/KEY -- GET /users/USER/keys -- GET /users/USER/keys/ - -By default, the `public_key_read_access` assigns all members of the -`users` and `clients` group permission to these endpoints: - - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GroupCreateDeleteGrantReadUpdate
adminsnonononono
clientsyesyesyesyesyes
usersyesyesyesyesyes
- -#### users - -The `users` group is assigned the following: - -#### users - -The `users` group is assigned the following: - - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ObjectCreateDeleteReadUpdate
clientsnoyesyesno
cookbooksyesyesyesyes
cookbook_artifactsyesyesyesyes
datayesyesyesyes
environmentsyesyesyesyes
nodesyesyesyesyes
organizationnonoyesno
policiesyesyesyesyes
policy_groupsyesyesyesyes
rolesyesyesyesyes
sandboxesyesnonono
- -### chef-validator - -{{< readfile file="content/reusable/md/security_chef_validator.md" >}} - -The chef-validator is allowed to do the following at the start of a Chef -Infra Client run. After the Chef Infra Client is registered with Chef -Infra Server, that Chef Infra Client is added to the `clients` group: - - ------- - - - - - - - - - - - - - - - - - - -
ObjectCreateDeleteReadUpdate
clientsyesnonono
- -## Server Admins - -{{< readfile file="content/server/reusable/md/server_rbac_server_admins.md" >}} - -### Scenario - -{{< readfile file="content/server/reusable/md/server_rbac_server_admins_scenario.md" >}} - -#### Superuser Accounts - -{{< readfile file="content/server/reusable/md/server_rbac_server_admins_superusers.md" >}} - -### Manage server-admins Group - -{{< readfile file="content/server/reusable/md/ctl_chef_server_server_admin.md" >}} - -#### Add Members - -{{< readfile file="content/server/reusable/md/ctl_chef_server_server_admin_grant_user.md" >}} - -#### Remove Members - -{{< readfile file="content/server/reusable/md/ctl_chef_server_server_admin_remove_user.md" >}} - -#### List Membership - -{{< readfile file="content/server/reusable/md/ctl_chef_server_server_admin_list.md" >}} - -## Manage Organizations - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org.md" >}} - -### org-create - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_create.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_create_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_create_options.md" >}} - -### org-delete - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_delete.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_delete_syntax.md" >}} - -### org-list - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_list.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_list_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_list_options.md" >}} - -### org-show - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_show.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_show_syntax.md" >}} - -### org-user-add - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_add.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_add_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_add_options.md" >}} - -### org-user-remove - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_remove.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_remove_syntax.md" >}} diff --git a/content/server_users.md b/content/server_users.md deleted file mode 100644 index 61d9899774..0000000000 --- a/content/server_users.md +++ /dev/null @@ -1,152 +0,0 @@ -+++ -title = "Users" -draft = false - -gh_repo = "chef-web-docs" - -aliases = ["/server_users.html"] -product = ["server"] - -[menu] - [menu.legacy] - title = "Users" - identifier = "legacy/manage/server_users.md Users" - parent = "legacy/manage" -+++ - -The following tasks are available for user management in Chef Infra -Server: - -* Creating users -* Editing a user's profile -* Changing a password -* Recovering a password -* Regenerating a private key -* Viewing a user's profile - -## chef-server-ctl - -{{< readfile file="content/server/reusable/md/ctl_chef_server_summary.md" >}} - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user.md" >}} - -### org-create - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_create.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_create_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_create_options.md" >}} - -### org-delete - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_delete.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_delete_syntax.md" >}} - -### org-list - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_list.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_list_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_list_options.md" >}} - -### org-show - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_show.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_show_syntax.md" >}} - -### org-user-add - -{{< warning >}} - -Early RC candidates for the Chef Server 12 release named this command -`org-associate`. This is the same command, with the exception of the -`--admin` flag, which is added to the command (along with the rename) -for the upcoming final release of Chef Server 12. - -{{< /warning >}} - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_add.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_add_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_add_options.md" >}} - -### org-user-remove - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_remove.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_org_user_remove_syntax.md" >}} - -### user-create - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_create.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_create_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_create_options.md" >}} - -### user-delete - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_delete.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_delete_syntax.md" >}} - -### user-edit - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_edit.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_edit_syntax.md" >}} - -### user-list - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_list.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_list_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_list_options.md" >}} - -### user-show - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_show.md" >}} - -#### Syntax - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_show_syntax.md" >}} - -#### Options - -{{< readfile file="content/server/reusable/md/ctl_chef_server_user_show_options.md" >}}