From f30124328000fb90be44d6ceee2f1b0be9472e33 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Thu, 5 May 2022 16:18:28 -0400 Subject: [PATCH] Add notes to each shortcode migrating to server (#3825) Signed-off-by: Ian Maddaus --- layouts/shortcodes/EOL_backend.md | 4 +++- layouts/shortcodes/adopted_platforms_server.md | 3 +++ layouts/shortcodes/all_directory_chef.md | 4 +++- layouts/shortcodes/chef_auth.md | 2 ++ layouts/shortcodes/chef_auth_authentication.md | 3 +++ layouts/shortcodes/chef_server.md | 2 ++ layouts/shortcodes/chef_server_component_bookshelf.md | 4 +++- layouts/shortcodes/chef_server_component_elasticsearch.md | 3 +++ layouts/shortcodes/chef_server_component_erchef.md | 3 +++ layouts/shortcodes/chef_server_component_nginx.md | 4 +++- layouts/shortcodes/chef_server_component_postgresql.md | 4 +++- layouts/shortcodes/config_add_condition.md | 3 +++ .../shortcodes/config_ocid_application_hash_supermarket.md | 3 +++ layouts/shortcodes/config_rb_backend_summary.md | 3 +++ layouts/shortcodes/config_rb_server_settings_ldap.md | 3 +++ layouts/shortcodes/config_rb_server_summary.md | 4 +++- layouts/shortcodes/ctl_chef_backend_cleanse_options.md | 4 +++- layouts/shortcodes/ctl_chef_server_backup.md | 3 +++ layouts/shortcodes/ctl_chef_server_backup_options.md | 3 +++ layouts/shortcodes/ctl_chef_server_backup_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_hup.md | 3 +++ .../shortcodes/ctl_chef_server_install_features_download.md | 2 ++ layouts/shortcodes/ctl_chef_server_install_features_manual.md | 3 +++ layouts/shortcodes/ctl_chef_server_int.md | 3 +++ layouts/shortcodes/ctl_chef_server_kill.md | 3 +++ layouts/shortcodes/ctl_chef_server_once.md | 3 +++ layouts/shortcodes/ctl_chef_server_org.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_create.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_create_options.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_create_summary.md | 3 +++ layouts/shortcodes/ctl_chef_server_org_create_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_org_delete.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_delete_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_org_list.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_list_options.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_list_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_org_show.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_show_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_org_user_add.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_user_add_options.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_user_add_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_org_user_remove.md | 4 +++- layouts/shortcodes/ctl_chef_server_org_user_remove_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_restart.md | 3 +++ layouts/shortcodes/ctl_chef_server_restore.md | 3 +++ layouts/shortcodes/ctl_chef_server_restore_options.md | 3 +++ layouts/shortcodes/ctl_chef_server_restore_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_server_admin.md | 4 +++- layouts/shortcodes/ctl_chef_server_server_admin_grant_user.md | 3 +++ layouts/shortcodes/ctl_chef_server_server_admin_list.md | 3 +++ .../shortcodes/ctl_chef_server_server_admin_remove_user.md | 3 +++ layouts/shortcodes/ctl_chef_server_service_list.md | 3 +++ layouts/shortcodes/ctl_chef_server_start.md | 3 +++ layouts/shortcodes/ctl_chef_server_status.md | 3 +++ layouts/shortcodes/ctl_chef_server_status_logs.md | 3 +++ layouts/shortcodes/ctl_chef_server_stop.md | 3 +++ layouts/shortcodes/ctl_chef_server_summary.md | 4 +++- layouts/shortcodes/ctl_chef_server_tail.md | 3 +++ layouts/shortcodes/ctl_chef_server_term.md | 3 +++ layouts/shortcodes/ctl_chef_server_uninstall.md | 2 ++ layouts/shortcodes/ctl_chef_server_user.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_create.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_create_admin.md | 3 +++ layouts/shortcodes/ctl_chef_server_user_create_options.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_create_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_user_delete.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_delete_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_user_edit.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_edit_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_user_list.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_list_options.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_list_syntax.md | 3 +++ layouts/shortcodes/ctl_chef_server_user_show.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_show_options.md | 4 +++- layouts/shortcodes/ctl_chef_server_user_show_syntax.md | 3 +++ layouts/shortcodes/ctl_common_service_subcommands.md | 3 +++ layouts/shortcodes/install_chef_server_install_package.md | 2 ++ layouts/shortcodes/install_chef_server_reconfigure.md | 3 +++ layouts/shortcodes/notes_config_rb_server_must_reconfigure.md | 3 +++ .../shortcodes/plugin_knife_using_authenticated_requests.md | 2 ++ layouts/shortcodes/server_firewalls_and_ports_fe.md | 3 +++ layouts/shortcodes/server_firewalls_and_ports_listening.md | 3 +++ layouts/shortcodes/server_firewalls_and_ports_loopback.md | 4 +++- layouts/shortcodes/server_firewalls_and_ports_summary.md | 4 +++- layouts/shortcodes/server_firewalls_and_ports_tiered.md | 3 +++ layouts/shortcodes/server_rbac.md | 4 +++- layouts/shortcodes/server_rbac_permissions.md | 2 ++ layouts/shortcodes/server_rbac_permissions_object.md | 2 ++ layouts/shortcodes/server_rbac_server_admins.md | 3 +++ layouts/shortcodes/server_rbac_server_admins_scenario.md | 3 +++ layouts/shortcodes/server_rbac_server_admins_superusers.md | 3 +++ layouts/shortcodes/server_security_ssl_cert_client.md | 2 ++ layouts/shortcodes/server_services_bifrost.md | 4 +++- layouts/shortcodes/server_services_bookshelf.md | 4 +++- layouts/shortcodes/server_services_elasticsearch.md | 2 ++ layouts/shortcodes/server_services_erchef.md | 4 +++- layouts/shortcodes/server_services_expander.md | 4 +++- layouts/shortcodes/server_services_nginx.md | 4 +++- layouts/shortcodes/server_services_nginx_tail.md | 2 ++ layouts/shortcodes/server_services_oc_id.md | 4 +++- layouts/shortcodes/server_services_postgresql.md | 4 +++- layouts/shortcodes/server_services_rabbitmq.md | 4 +++- layouts/shortcodes/server_services_redis.md | 4 +++- layouts/shortcodes/server_services_solr4.md | 3 +++ layouts/shortcodes/server_tuning_bookshelf.md | 4 +++- layouts/shortcodes/server_tuning_erchef.md | 4 +++- layouts/shortcodes/server_tuning_general.md | 3 +++ layouts/shortcodes/server_tuning_nginx.md | 2 ++ layouts/shortcodes/server_tuning_postgresql.md | 3 +++ layouts/shortcodes/server_upgrade_duration.md | 3 +++ layouts/shortcodes/settings_strict_search_result_acls.md | 4 +++- layouts/shortcodes/system_requirements_ha.md | 4 +++- layouts/shortcodes/system_requirements_server_hardware.md | 2 ++ layouts/shortcodes/system_requirements_server_software.md | 4 +++- 114 files changed, 329 insertions(+), 45 deletions(-) diff --git a/layouts/shortcodes/EOL_backend.md b/layouts/shortcodes/EOL_backend.md index d79911524a..1955236ac8 100644 --- a/layouts/shortcodes/EOL_backend.md +++ b/layouts/shortcodes/EOL_backend.md @@ -4,4 +4,6 @@ Chef Backend is [deprecated](/versions/#deprecated-products-and-versions) and no This document is no longer maintained. - \ No newline at end of file + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/adopted_platforms_server.md b/layouts/shortcodes/adopted_platforms_server.md index 79b7f7a226..5c63ed5a2b 100644 --- a/layouts/shortcodes/adopted_platforms_server.md +++ b/layouts/shortcodes/adopted_platforms_server.md @@ -46,3 +46,6 @@ The following table lists the commercially-supported platforms and versions for + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/all_directory_chef.md b/layouts/shortcodes/all_directory_chef.md index 740df19d3a..c72ee4fea4 100644 --- a/layouts/shortcodes/all_directory_chef.md +++ b/layouts/shortcodes/all_directory_chef.md @@ -1,2 +1,4 @@ The .chef directory is a hidden directory that is used to store -validation key files and optionally a [config.rb](/config_rb.html) file. \ No newline at end of file +validation key files and optionally a [config.rb](/config_rb.html) file. + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/chef_auth.md b/layouts/shortcodes/chef_auth.md index aa6ad7e316..38785d7ae0 100644 --- a/layouts/shortcodes/chef_auth.md +++ b/layouts/shortcodes/chef_auth.md @@ -1 +1,3 @@ The Chef Infra Server API handles all communication between Chef Infra Client or Chef Workstation. The Chef Infra Server API is an authenticated REST API, which means all requests require authentication and authorization. The Chef Infra tools such as `knife` and `chef-server` commands use the Chef Infra Server API for you. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/chef_auth_authentication.md b/layouts/shortcodes/chef_auth_authentication.md index 8aa0ce0050..ada0c13f59 100644 --- a/layouts/shortcodes/chef_auth_authentication.md +++ b/layouts/shortcodes/chef_auth_authentication.md @@ -6,3 +6,6 @@ The authentication process ensures that Chef Infra Server only responds to reque * Chef Infra Client saves the private key in `/etc/chef` Both Chef Infra Client and Chef Workstation communicate with the Chef Infra Server using the Chef Infra Server API. Each time that Chef Infra Client or Chef Workstation makes a request to Chef Infra Server, they use a special group of HTTP headers and sign the rest with their private key. The Chef Infra Server then uses the public key to verify the headers and the contents. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/chef_server.md b/layouts/shortcodes/chef_server.md index 0ae5cdca54..143e0b8e8a 100644 --- a/layouts/shortcodes/chef_server.md +++ b/layouts/shortcodes/chef_server.md @@ -7,3 +7,5 @@ distributions. Chef Infra Client then does as much of the configuration work as possible on the nodes themselves (and not on the Chef Infra Server). This scalable approach distributes the configuration effort throughout the organization. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/chef_server_component_bookshelf.md b/layouts/shortcodes/chef_server_component_bookshelf.md index 1250d68af8..5928e5e075 100644 --- a/layouts/shortcodes/chef_server_component_bookshelf.md +++ b/layouts/shortcodes/chef_server_component_bookshelf.md @@ -4,4 +4,6 @@ cookbook version. Cookbook content is stored by content checksum. If two different cookbooks or different versions of the same cookbook include the same file or template, Bookshelf will store that file only once. The cookbook content managed by Bookshelf is stored in flat files and is -separated from the Chef Infra Server and search index repositories. \ No newline at end of file +separated from the Chef Infra Server and search index repositories. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/chef_server_component_elasticsearch.md b/layouts/shortcodes/chef_server_component_elasticsearch.md index 2afcfac78c..77337cc393 100644 --- a/layouts/shortcodes/chef_server_component_elasticsearch.md +++ b/layouts/shortcodes/chef_server_component_elasticsearch.md @@ -1 +1,4 @@ chef-elasticsearch wraps Elastisearch and exposes its REST API for indexing and search. + + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/chef_server_component_erchef.md b/layouts/shortcodes/chef_server_component_erchef.md index 9295e15204..eb2c7560c6 100644 --- a/layouts/shortcodes/chef_server_component_erchef.md +++ b/layouts/shortcodes/chef_server_component_erchef.md @@ -18,3 +18,6 @@ Erlang is NOT a requirement for using Chef Infra. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/chef_server_component_nginx.md b/layouts/shortcodes/chef_server_component_nginx.md index 428bd9a755..048cb66a1d 100644 --- a/layouts/shortcodes/chef_server_component_nginx.md +++ b/layouts/shortcodes/chef_server_component_nginx.md @@ -1,3 +1,5 @@ Nginx is an open-source HTTP and reverse proxy server that is used as the front-end load balancer for the Chef Infra Server. All requests to -the Chef Infra Server API are routed through Nginx. \ No newline at end of file +the Chef Infra Server API are routed through Nginx. + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/chef_server_component_postgresql.md b/layouts/shortcodes/chef_server_component_postgresql.md index 01dd6cb298..a9fe7712d4 100644 --- a/layouts/shortcodes/chef_server_component_postgresql.md +++ b/layouts/shortcodes/chef_server_component_postgresql.md @@ -1 +1,3 @@ -PostgreSQL is the data storage repository for the Chef Infra Server. \ No newline at end of file +PostgreSQL is the data storage repository for the Chef Infra Server. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/config_add_condition.md b/layouts/shortcodes/config_add_condition.md index 5351c32bdc..d10d05cf28 100644 --- a/layouts/shortcodes/config_add_condition.md +++ b/layouts/shortcodes/config_add_condition.md @@ -11,3 +11,6 @@ when 'frontend' # frontend-specific configuration here end ``` + + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/config_ocid_application_hash_supermarket.md b/layouts/shortcodes/config_ocid_application_hash_supermarket.md index a2a84b3429..705f5c9980 100644 --- a/layouts/shortcodes/config_ocid_application_hash_supermarket.md +++ b/layouts/shortcodes/config_ocid_application_hash_supermarket.md @@ -7,3 +7,6 @@ oc_id['applications']['supermarket'] = { 'redirect_uri' => 'https://supermarket.mycompany.com/auth/chef_oauth2/callback', } ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/config_rb_backend_summary.md b/layouts/shortcodes/config_rb_backend_summary.md index 3085a379fa..f5926219bf 100644 --- a/layouts/shortcodes/config_rb_backend_summary.md +++ b/layouts/shortcodes/config_rb_backend_summary.md @@ -20,3 +20,6 @@ The following settings are the only settings you should modify without guidance: `publish_address` : Externally resolvable IP address of this back-end node. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/config_rb_server_settings_ldap.md b/layouts/shortcodes/config_rb_server_settings_ldap.md index 8875d33b28..51bc087db4 100644 --- a/layouts/shortcodes/config_rb_server_settings_ldap.md +++ b/layouts/shortcodes/config_rb_server_settings_ldap.md @@ -191,3 +191,6 @@ This configuration file has the following settings for `ldap`: + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/config_rb_server_summary.md b/layouts/shortcodes/config_rb_server_summary.md index 32715754fe..1374838d6d 100644 --- a/layouts/shortcodes/config_rb_server_summary.md +++ b/layouts/shortcodes/config_rb_server_summary.md @@ -5,4 +5,6 @@ only be added to the `chef-server.rb` file to apply non-default values. These configuration settings are processed when the `chef-server-ctl reconfigure` command is run. The `chef-server.rb` file is a Ruby file, which means that conditional statements can be used -within it. \ No newline at end of file +within it. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_backend_cleanse_options.md b/layouts/shortcodes/ctl_chef_backend_cleanse_options.md index 1317158c17..7f7afffea3 100644 --- a/layouts/shortcodes/ctl_chef_backend_cleanse_options.md +++ b/layouts/shortcodes/ctl_chef_backend_cleanse_options.md @@ -3,4 +3,6 @@ This subcommand has the following options: `--with-external` : Use to specify that data on an external PostgreSQL database should - be removed. \ No newline at end of file + be removed. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_backup.md b/layouts/shortcodes/ctl_chef_server_backup.md index a352ae3266..35c445aabf 100644 --- a/layouts/shortcodes/ctl_chef_server_backup.md +++ b/layouts/shortcodes/ctl_chef_server_backup.md @@ -10,3 +10,6 @@ This subcommand: backup](https://github.com/chef/knife-ec-backup) instead - Puts the initial backup in the `/var/opt/chef-backup` directory as a tar.gz file; move this backup to a new location for safe keeping + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_backup_options.md b/layouts/shortcodes/ctl_chef_server_backup_options.md index 6c3276b771..7522f6504e 100644 --- a/layouts/shortcodes/ctl_chef_server_backup_options.md +++ b/layouts/shortcodes/ctl_chef_server_backup_options.md @@ -20,3 +20,6 @@ This subcommand has the following options: `-h`, `--help` : Show help message. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_backup_syntax.md b/layouts/shortcodes/ctl_chef_server_backup_syntax.md index ced4818525..84bcd62210 100644 --- a/layouts/shortcodes/ctl_chef_server_backup_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_backup_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl backup ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_hup.md b/layouts/shortcodes/ctl_chef_server_hup.md index cf22d89c57..a933c9de8b 100644 --- a/layouts/shortcodes/ctl_chef_server_hup.md +++ b/layouts/shortcodes/ctl_chef_server_hup.md @@ -10,3 +10,6 @@ chef-server-ctl hup SERVICE_NAME where `SERVICE_NAME` represents the name of any service that is listed after running the `service-list` subcommand. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_install_features_download.md b/layouts/shortcodes/ctl_chef_server_install_features_download.md index 6bdc669661..f2a1e8033e 100644 --- a/layouts/shortcodes/ctl_chef_server_install_features_download.md +++ b/layouts/shortcodes/ctl_chef_server_install_features_download.md @@ -28,3 +28,5 @@ Finally, accept the [Chef License](https://docs.chef.io/chef_license/): ```bash sudo chef-manage-ctl reconfigure --accept-license ``` + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_install_features_manual.md b/layouts/shortcodes/ctl_chef_server_install_features_manual.md index def60ebe25..2847bc1e3e 100644 --- a/layouts/shortcodes/ctl_chef_server_install_features_manual.md +++ b/layouts/shortcodes/ctl_chef_server_install_features_manual.md @@ -12,3 +12,6 @@ sudo chef-server-ctl install chef-manage --path /root/packages The `chef-server-ctl` command will install the first `chef-manage` package found in the `/root/packages` directory. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_int.md b/layouts/shortcodes/ctl_chef_server_int.md index 5c34800fd1..22d07e50b9 100644 --- a/layouts/shortcodes/ctl_chef_server_int.md +++ b/layouts/shortcodes/ctl_chef_server_int.md @@ -10,3 +10,6 @@ chef-server-ctl int SERVICE_NAME where `SERVICE_NAME` represents the name of any service that is listed after running the `service-list` subcommand. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_kill.md b/layouts/shortcodes/ctl_chef_server_kill.md index e8134493d2..89511aa322 100644 --- a/layouts/shortcodes/ctl_chef_server_kill.md +++ b/layouts/shortcodes/ctl_chef_server_kill.md @@ -10,3 +10,6 @@ chef-server-ctl kill SERVICE_NAME where `SERVICE_NAME` represents the name of any service that is listed after running the `service-list` subcommand. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_once.md b/layouts/shortcodes/ctl_chef_server_once.md index 594d87025f..262c95fce7 100644 --- a/layouts/shortcodes/ctl_chef_server_once.md +++ b/layouts/shortcodes/ctl_chef_server_once.md @@ -18,3 +18,6 @@ chef-server-ctl once SERVICE_NAME where `SERVICE_NAME` represents the name of any service that is listed after running the `service-list` subcommand. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org.md b/layouts/shortcodes/ctl_chef_server_org.md index ef3051874c..72a7447bc8 100644 --- a/layouts/shortcodes/ctl_chef_server_org.md +++ b/layouts/shortcodes/ctl_chef_server_org.md @@ -1,2 +1,4 @@ Use the `org-create`, `org-delete`, `org-list`, `org-show`, -`org-user-add` and `org-user-remove` commands to manage organizations. \ No newline at end of file +`org-user-add` and `org-user-remove` commands to manage organizations. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_create.md b/layouts/shortcodes/ctl_chef_server_org_create.md index b2ac376597..1a9f44df42 100644 --- a/layouts/shortcodes/ctl_chef_server_org_create.md +++ b/layouts/shortcodes/ctl_chef_server_org_create.md @@ -1,3 +1,5 @@ The `org-create` subcommand is used to create an organization. (The validation key for the organization is returned to `STDOUT` when -creating an organization with this command.) \ No newline at end of file +creating an organization with this command.) + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_create_options.md b/layouts/shortcodes/ctl_chef_server_org_create_options.md index 443fe61a19..729edef970 100644 --- a/layouts/shortcodes/ctl_chef_server_org_create_options.md +++ b/layouts/shortcodes/ctl_chef_server_org_create_options.md @@ -8,4 +8,6 @@ This subcommand has the following options: `-f FILE_NAME`, `--filename FILE_NAME` : Write the ORGANIZATION-validator.pem to `FILE_NAME` instead of - printing it to `STDOUT`. \ No newline at end of file + printing it to `STDOUT`. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_create_summary.md b/layouts/shortcodes/ctl_chef_server_org_create_summary.md index cdebe8f831..3231c306ae 100644 --- a/layouts/shortcodes/ctl_chef_server_org_create_summary.md +++ b/layouts/shortcodes/ctl_chef_server_org_create_summary.md @@ -24,3 +24,6 @@ An RSA private key is generated automatically. This is the chef-validator key and should be saved to a safe location. The `--filename` option will save the RSA private key to the specified absolute path. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_create_syntax.md b/layouts/shortcodes/ctl_chef_server_org_create_syntax.md index 271ac1aaf2..1375a06276 100644 --- a/layouts/shortcodes/ctl_chef_server_org_create_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_org_create_syntax.md @@ -12,3 +12,6 @@ where: - The full name must begin with a non-white space character and must be between 1 and 1023 characters. For example: `"Chef Software, Inc."`. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_delete.md b/layouts/shortcodes/ctl_chef_server_org_delete.md index b54b719e5e..ad07769979 100644 --- a/layouts/shortcodes/ctl_chef_server_org_delete.md +++ b/layouts/shortcodes/ctl_chef_server_org_delete.md @@ -1 +1,3 @@ -The `org-delete` subcommand is used to delete an organization. \ No newline at end of file +The `org-delete` subcommand is used to delete an organization. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_delete_syntax.md b/layouts/shortcodes/ctl_chef_server_org_delete_syntax.md index 3a45bf5382..524313a931 100644 --- a/layouts/shortcodes/ctl_chef_server_org_delete_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_org_delete_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl org-delete ORG_NAME ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_list.md b/layouts/shortcodes/ctl_chef_server_org_list.md index b65457d4b2..e38e6cb900 100644 --- a/layouts/shortcodes/ctl_chef_server_org_list.md +++ b/layouts/shortcodes/ctl_chef_server_org_list.md @@ -1,2 +1,4 @@ The `org-list` subcommand is used to list all of the organizations -currently present on the Chef Infra Server. \ No newline at end of file +currently present on the Chef Infra Server. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_list_options.md b/layouts/shortcodes/ctl_chef_server_org_list_options.md index d72e6c921e..3a239c3d6d 100644 --- a/layouts/shortcodes/ctl_chef_server_org_list_options.md +++ b/layouts/shortcodes/ctl_chef_server_org_list_options.md @@ -6,4 +6,6 @@ This subcommand has the following options: `-w`, `--with-uri` -: Show the corresponding URIs. \ No newline at end of file +: Show the corresponding URIs. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_list_syntax.md b/layouts/shortcodes/ctl_chef_server_org_list_syntax.md index 162d3331d5..dfb4085485 100644 --- a/layouts/shortcodes/ctl_chef_server_org_list_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_org_list_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl org-list (options) ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_show.md b/layouts/shortcodes/ctl_chef_server_org_show.md index 0b39ccea3e..3f17fb6eb2 100644 --- a/layouts/shortcodes/ctl_chef_server_org_show.md +++ b/layouts/shortcodes/ctl_chef_server_org_show.md @@ -1,2 +1,4 @@ The `org-show` subcommand is used to show the details for an -organization. \ No newline at end of file +organization. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_show_syntax.md b/layouts/shortcodes/ctl_chef_server_org_show_syntax.md index d2a554f8d8..7f5c2af21f 100644 --- a/layouts/shortcodes/ctl_chef_server_org_show_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_org_show_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl org-show ORG_NAME ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_user_add.md b/layouts/shortcodes/ctl_chef_server_org_user_add.md index d058b34210..324f5bf883 100644 --- a/layouts/shortcodes/ctl_chef_server_org_user_add.md +++ b/layouts/shortcodes/ctl_chef_server_org_user_add.md @@ -1 +1,3 @@ -The `org-user-add` subcommand is used to add a user to an organization. \ No newline at end of file +The `org-user-add` subcommand is used to add a user to an organization. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_user_add_options.md b/layouts/shortcodes/ctl_chef_server_org_user_add_options.md index 277a9dc390..8ea5b7e67c 100644 --- a/layouts/shortcodes/ctl_chef_server_org_user_add_options.md +++ b/layouts/shortcodes/ctl_chef_server_org_user_add_options.md @@ -2,4 +2,6 @@ This subcommand has the following options: `--admin` -: Add the user to the `admins` group. \ No newline at end of file +: Add the user to the `admins` group. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_user_add_syntax.md b/layouts/shortcodes/ctl_chef_server_org_user_add_syntax.md index 441b2d24a2..ba52ebaf8f 100644 --- a/layouts/shortcodes/ctl_chef_server_org_user_add_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_org_user_add_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl org-user-add ORG_NAME USER_NAME (options) ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_user_remove.md b/layouts/shortcodes/ctl_chef_server_org_user_remove.md index 47c59b18ab..f623742acd 100644 --- a/layouts/shortcodes/ctl_chef_server_org_user_remove.md +++ b/layouts/shortcodes/ctl_chef_server_org_user_remove.md @@ -1,2 +1,4 @@ The `org-user-remove` subcommand is used to remove a user from an -organization. \ No newline at end of file +organization. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_org_user_remove_syntax.md b/layouts/shortcodes/ctl_chef_server_org_user_remove_syntax.md index 6cf10c32c5..49fc2e9823 100644 --- a/layouts/shortcodes/ctl_chef_server_org_user_remove_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_org_user_remove_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl org-user-remove ORG_NAME USER_NAME (options) ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_restart.md b/layouts/shortcodes/ctl_chef_server_restart.md index df34447c30..aac1801db6 100644 --- a/layouts/shortcodes/ctl_chef_server_restart.md +++ b/layouts/shortcodes/ctl_chef_server_restart.md @@ -28,3 +28,6 @@ successfully restarted the output should be similar to: ```bash ok: run: service_name: (pid 12345) 1s ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_restore.md b/layouts/shortcodes/ctl_chef_server_restore.md index 58d9b962a0..535381e837 100644 --- a/layouts/shortcodes/ctl_chef_server_restore.md +++ b/layouts/shortcodes/ctl_chef_server_restore.md @@ -15,3 +15,6 @@ Ideally, the restore server will have the same FQDN as the server that you backe 5. Update the `/etc/chef/client.rb` file on each client to point to the new server FQDN. 6. Run `chef-server-ctl reconfigure`. 7. Run ``chef-server-ctl restore`. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_restore_options.md b/layouts/shortcodes/ctl_chef_server_restore_options.md index da2eb89c01..cb894b93b5 100644 --- a/layouts/shortcodes/ctl_chef_server_restore_options.md +++ b/layouts/shortcodes/ctl_chef_server_restore_options.md @@ -23,3 +23,6 @@ This subcommand has the following options: `-h`, `--help` : Show help message. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_restore_syntax.md b/layouts/shortcodes/ctl_chef_server_restore_syntax.md index 0689b31373..8a155ad7a0 100644 --- a/layouts/shortcodes/ctl_chef_server_restore_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_restore_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl restore PATH_TO_BACKUP (options) ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_server_admin.md b/layouts/shortcodes/ctl_chef_server_server_admin.md index b85ced52d4..fe84a837c7 100644 --- a/layouts/shortcodes/ctl_chef_server_server_admin.md +++ b/layouts/shortcodes/ctl_chef_server_server_admin.md @@ -3,4 +3,6 @@ Membership of the `server-admins` group is managed with a set of - `chef-server-ctl grant-server-admin-permissions` - `chef-server-ctl list-server-admins` -- `chef-server-ctl remove-server-admin-permissions` \ No newline at end of file +- `chef-server-ctl remove-server-admin-permissions` + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_server_admin_grant_user.md b/layouts/shortcodes/ctl_chef_server_server_admin_grant_user.md index 146d5bd7b5..0a697a0812 100644 --- a/layouts/shortcodes/ctl_chef_server_server_admin_grant_user.md +++ b/layouts/shortcodes/ctl_chef_server_server_admin_grant_user.md @@ -23,3 +23,6 @@ User bob was added to server-admins. This user can now list, read, and create users (even for orgs they are not members of) for this Chef Infra Server. ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_server_admin_list.md b/layouts/shortcodes/ctl_chef_server_server_admin_list.md index 3ca84e3164..ee8ad9e99c 100644 --- a/layouts/shortcodes/ctl_chef_server_server_admin_list.md +++ b/layouts/shortcodes/ctl_chef_server_server_admin_list.md @@ -16,3 +16,6 @@ bob carol dan ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_server_admin_remove_user.md b/layouts/shortcodes/ctl_chef_server_server_admin_remove_user.md index cce7b55beb..d2f220b13d 100644 --- a/layouts/shortcodes/ctl_chef_server_server_admin_remove_user.md +++ b/layouts/shortcodes/ctl_chef_server_server_admin_remove_user.md @@ -24,3 +24,6 @@ User bob was removed from server-admins. This user can no longer list, read, and create users for this Chef Infra Server except for where they have default permissions (such as within an org). ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_service_list.md b/layouts/shortcodes/ctl_chef_server_service_list.md index 181bfee419..30ffc72496 100644 --- a/layouts/shortcodes/ctl_chef_server_service_list.md +++ b/layouts/shortcodes/ctl_chef_server_service_list.md @@ -6,3 +6,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl service-list ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_start.md b/layouts/shortcodes/ctl_chef_server_start.md index 73946d0af3..78beb4ee15 100644 --- a/layouts/shortcodes/ctl_chef_server_start.md +++ b/layouts/shortcodes/ctl_chef_server_start.md @@ -25,3 +25,6 @@ unless they are failing to respond to the signals at all. If a process is not responding, use a command like the `kill` subcommand to stop the process, investigate the cause (if required), and then use the `start` subcommand to re-enable it. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_status.md b/layouts/shortcodes/ctl_chef_server_status.md index 7ba51e86be..5f0e3715c3 100644 --- a/layouts/shortcodes/ctl_chef_server_status.md +++ b/layouts/shortcodes/ctl_chef_server_status.md @@ -50,3 +50,6 @@ run: oc-id run: opscode-chef: (pid 4327) 13671s; run: log: (pid 4326) 13671s run: opscode-erchef: (pid 5383) 5s; run: log: (pid 4382) 13669s ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_status_logs.md b/layouts/shortcodes/ctl_chef_server_status_logs.md index 8f4b21ecff..e59a54f4e3 100644 --- a/layouts/shortcodes/ctl_chef_server_status_logs.md +++ b/layouts/shortcodes/ctl_chef_server_status_logs.md @@ -31,3 +31,6 @@ where - `3s, normally up;` indicates that the service is normally in a run state and that the supervisor would attempt to restart this service after a reboot + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_stop.md b/layouts/shortcodes/ctl_chef_server_stop.md index 2d235c716a..c88c1fa0ea 100644 --- a/layouts/shortcodes/ctl_chef_server_stop.md +++ b/layouts/shortcodes/ctl_chef_server_stop.md @@ -32,3 +32,6 @@ ok: down: opscode-solr4: 389s, normally up ok: down: postgresql: 388s, normally up ok: down: redis_lb: 387s, normally up ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_summary.md b/layouts/shortcodes/ctl_chef_server_summary.md index c57b472b09..a0937d3fcf 100644 --- a/layouts/shortcodes/ctl_chef_server_summary.md +++ b/layouts/shortcodes/ctl_chef_server_summary.md @@ -1,4 +1,6 @@ The Chef Infra Server includes a command-line utility named chef-server-ctl. This command-line tool is used to start and stop individual services, reconfigure the Chef Infra Server, run chef-pedant, -and then tail Chef Infra Server log files. \ No newline at end of file +and then tail Chef Infra Server log files. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_tail.md b/layouts/shortcodes/ctl_chef_server_tail.md index 26468341fd..488fed0670 100644 --- a/layouts/shortcodes/ctl_chef_server_tail.md +++ b/layouts/shortcodes/ctl_chef_server_tail.md @@ -10,3 +10,6 @@ chef-server-ctl tail SERVICE_NAME where `SERVICE_NAME` represents the name of any service that is listed after running the `service-list` subcommand. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_term.md b/layouts/shortcodes/ctl_chef_server_term.md index 1d2cbe8566..a50bc08e72 100644 --- a/layouts/shortcodes/ctl_chef_server_term.md +++ b/layouts/shortcodes/ctl_chef_server_term.md @@ -10,3 +10,6 @@ chef-server-ctl term SERVICE_NAME where `SERVICE_NAME` represents the name of any service that is listed after running the `service-list` subcommand. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_uninstall.md b/layouts/shortcodes/ctl_chef_server_uninstall.md index 31e157bc44..ff452da570 100644 --- a/layouts/shortcodes/ctl_chef_server_uninstall.md +++ b/layouts/shortcodes/ctl_chef_server_uninstall.md @@ -20,3 +20,5 @@ To revert the `uninstall` subcommand, run the `reconfigure` subcommand + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user.md b/layouts/shortcodes/ctl_chef_server_user.md index 8afedb4073..7993781ca9 100644 --- a/layouts/shortcodes/ctl_chef_server_user.md +++ b/layouts/shortcodes/ctl_chef_server_user.md @@ -1,2 +1,4 @@ Use the `user-create`, `user-delete`, `user-edit`, `user-list` and -`user-show` subcommands to manage users. \ No newline at end of file +`user-show` subcommands to manage users. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_create.md b/layouts/shortcodes/ctl_chef_server_user_create.md index 686e8d8622..2061806fd9 100644 --- a/layouts/shortcodes/ctl_chef_server_user_create.md +++ b/layouts/shortcodes/ctl_chef_server_user_create.md @@ -1,3 +1,5 @@ The `user-create` subcommand is used to create a user. (The validation key for the organization may be returned to `STDOUT` when creating a -user with this command.) \ No newline at end of file +user with this command.) + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_create_admin.md b/layouts/shortcodes/ctl_chef_server_user_create_admin.md index ee786e1bf2..ae0eb8d0cc 100644 --- a/layouts/shortcodes/ctl_chef_server_user_create_admin.md +++ b/layouts/shortcodes/ctl_chef_server_user_create_admin.md @@ -13,3 +13,6 @@ For example: ```bash sudo chef-server-ctl user-create janedoe Jane Doe janed@example.com 'abc123' --filename /path/to/janedoe.pem ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_create_options.md b/layouts/shortcodes/ctl_chef_server_user_create_options.md index b5911beb43..963a6723ce 100644 --- a/layouts/shortcodes/ctl_chef_server_user_create_options.md +++ b/layouts/shortcodes/ctl_chef_server_user_create_options.md @@ -2,4 +2,6 @@ This subcommand has the following options: `-f FILE_NAME`, `--filename FILE_NAME` -: Write the USER.pem to a file instead of `STDOUT`. \ No newline at end of file +: Write the USER.pem to a file instead of `STDOUT`. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_create_syntax.md b/layouts/shortcodes/ctl_chef_server_user_create_syntax.md index c64a72a87c..47a5e3073b 100644 --- a/layouts/shortcodes/ctl_chef_server_user_create_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_user_create_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl user-create USER_NAME FIRST_NAME [MIDDLE_NAME] LAST_NAME EMAIL 'PASSWORD' (options) ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_delete.md b/layouts/shortcodes/ctl_chef_server_user_delete.md index 80eed0cfdd..7dcab9fcff 100644 --- a/layouts/shortcodes/ctl_chef_server_user_delete.md +++ b/layouts/shortcodes/ctl_chef_server_user_delete.md @@ -1 +1,3 @@ -The `user-delete` subcommand is used to delete a user. \ No newline at end of file +The `user-delete` subcommand is used to delete a user. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_delete_syntax.md b/layouts/shortcodes/ctl_chef_server_user_delete_syntax.md index bc063a26c3..6ccc5661fb 100644 --- a/layouts/shortcodes/ctl_chef_server_user_delete_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_user_delete_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl user-delete USER_NAME ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_edit.md b/layouts/shortcodes/ctl_chef_server_user_edit.md index ccc7c55c8b..520c80b49c 100644 --- a/layouts/shortcodes/ctl_chef_server_user_edit.md +++ b/layouts/shortcodes/ctl_chef_server_user_edit.md @@ -1,2 +1,4 @@ The `user-edit` subcommand is used to edit the details for a user. The -data will be made available in the \$EDITOR for editing. \ No newline at end of file +data will be made available in the \$EDITOR for editing. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_edit_syntax.md b/layouts/shortcodes/ctl_chef_server_user_edit_syntax.md index d3f87c571a..b7beb347d8 100644 --- a/layouts/shortcodes/ctl_chef_server_user_edit_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_user_edit_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl user-edit USER_NAME ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_list.md b/layouts/shortcodes/ctl_chef_server_user_list.md index 68827db42f..bbbd9ea833 100644 --- a/layouts/shortcodes/ctl_chef_server_user_list.md +++ b/layouts/shortcodes/ctl_chef_server_user_list.md @@ -1 +1,3 @@ -The `user-list` subcommand is used to view a list of users. \ No newline at end of file +The `user-list` subcommand is used to view a list of users. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_list_options.md b/layouts/shortcodes/ctl_chef_server_user_list_options.md index 00a04fdd0f..e77d241265 100644 --- a/layouts/shortcodes/ctl_chef_server_user_list_options.md +++ b/layouts/shortcodes/ctl_chef_server_user_list_options.md @@ -2,4 +2,6 @@ This subcommand has the following options: `-w`, `--with-uri` -: Show the corresponding URIs. \ No newline at end of file +: Show the corresponding URIs. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_list_syntax.md b/layouts/shortcodes/ctl_chef_server_user_list_syntax.md index bba19ac343..e5e7ac1468 100644 --- a/layouts/shortcodes/ctl_chef_server_user_list_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_user_list_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl user-list (options) ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_show.md b/layouts/shortcodes/ctl_chef_server_user_show.md index c67de22590..acff1ee541 100644 --- a/layouts/shortcodes/ctl_chef_server_user_show.md +++ b/layouts/shortcodes/ctl_chef_server_user_show.md @@ -1 +1,3 @@ -The `user-show` subcommand is used to show the details for a user. \ No newline at end of file +The `user-show` subcommand is used to show the details for a user. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_show_options.md b/layouts/shortcodes/ctl_chef_server_user_show_options.md index fd8a36cae0..6afc2f500d 100644 --- a/layouts/shortcodes/ctl_chef_server_user_show_options.md +++ b/layouts/shortcodes/ctl_chef_server_user_show_options.md @@ -2,4 +2,6 @@ This subcommand has the following options: `-l`, `--with-orgs` -: Show all organizations. \ No newline at end of file +: Show all organizations. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_chef_server_user_show_syntax.md b/layouts/shortcodes/ctl_chef_server_user_show_syntax.md index 34badf3754..36dc30fda1 100644 --- a/layouts/shortcodes/ctl_chef_server_user_show_syntax.md +++ b/layouts/shortcodes/ctl_chef_server_user_show_syntax.md @@ -3,3 +3,6 @@ This subcommand has the following syntax: ```bash chef-server-ctl user-show USER_NAME (options) ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/ctl_common_service_subcommands.md b/layouts/shortcodes/ctl_common_service_subcommands.md index 6203a48970..3c808a4bfd 100644 --- a/layouts/shortcodes/ctl_common_service_subcommands.md +++ b/layouts/shortcodes/ctl_common_service_subcommands.md @@ -4,3 +4,6 @@ supervisor starts two processes for each service and provides the following subcommands for managing services: `hup`, `int`, `kill`, `once`, `restart`, `service-list`, `start`, `status`, `stop`, `tail`, and `term`. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/install_chef_server_install_package.md b/layouts/shortcodes/install_chef_server_install_package.md index 1ef148f5d9..f70d5e4fed 100644 --- a/layouts/shortcodes/install_chef_server_install_package.md +++ b/layouts/shortcodes/install_chef_server_install_package.md @@ -13,3 +13,5 @@ sudo dpkg -i /tmp/chef-server-core-.deb ``` After a few minutes, the Chef Infra Server will be installed. + +{{/* moved to chef-server repo */}} \ No newline at end of file diff --git a/layouts/shortcodes/install_chef_server_reconfigure.md b/layouts/shortcodes/install_chef_server_reconfigure.md index 3edd681a7e..6ebaa4f17b 100644 --- a/layouts/shortcodes/install_chef_server_reconfigure.md +++ b/layouts/shortcodes/install_chef_server_reconfigure.md @@ -4,3 +4,6 @@ and frontend group members of a High Availabilty installation): ```bash chef-server-ctl reconfigure ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/notes_config_rb_server_must_reconfigure.md b/layouts/shortcodes/notes_config_rb_server_must_reconfigure.md index b3cae5ddf9..f01f12983b 100644 --- a/layouts/shortcodes/notes_config_rb_server_must_reconfigure.md +++ b/layouts/shortcodes/notes_config_rb_server_must_reconfigure.md @@ -4,3 +4,6 @@ must be reconfigured by running the following command: ```bash chef-server-ctl reconfigure ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/plugin_knife_using_authenticated_requests.md b/layouts/shortcodes/plugin_knife_using_authenticated_requests.md index b54b0dfc03..ec34f4dac4 100644 --- a/layouts/shortcodes/plugin_knife_using_authenticated_requests.md +++ b/layouts/shortcodes/plugin_knife_using_authenticated_requests.md @@ -56,3 +56,5 @@ module MyCommands end end ``` + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_firewalls_and_ports_fe.md b/layouts/shortcodes/server_firewalls_and_ports_fe.md index 9c3cfccecf..bc9acc7cc3 100644 --- a/layouts/shortcodes/server_firewalls_and_ports_fe.md +++ b/layouts/shortcodes/server_firewalls_and_ports_fe.md @@ -48,3 +48,6 @@ firewalls that are in use: + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_firewalls_and_ports_listening.md b/layouts/shortcodes/server_firewalls_and_ports_listening.md index 96fe471d81..1d5a0c1faa 100644 --- a/layouts/shortcodes/server_firewalls_and_ports_listening.md +++ b/layouts/shortcodes/server_firewalls_and_ports_listening.md @@ -7,3 +7,6 @@ the connection: ```bash telnet HOST_NAME PORT ``` + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_firewalls_and_ports_loopback.md b/layouts/shortcodes/server_firewalls_and_ports_loopback.md index 4bb1f68b02..9302c9548b 100644 --- a/layouts/shortcodes/server_firewalls_and_ports_loopback.md +++ b/layouts/shortcodes/server_firewalls_and_ports_loopback.md @@ -2,4 +2,6 @@ A single loopback interface should be configured using the `127.0.0.1` address. This ensures that all of the services are available to the Chef Infra Server, in the event that the Chef Infra Server attempts to contact itself from within a front or back end machine. All ports should -be accessible through the loopback interface of their respective hosts. \ No newline at end of file +be accessible through the loopback interface of their respective hosts. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_firewalls_and_ports_summary.md b/layouts/shortcodes/server_firewalls_and_ports_summary.md index 992402cc71..b85a88835f 100644 --- a/layouts/shortcodes/server_firewalls_and_ports_summary.md +++ b/layouts/shortcodes/server_firewalls_and_ports_summary.md @@ -1,3 +1,5 @@ All of the ports used by the Chef Infra Server are TCP ports. Refer to the operating system's manual or site systems administrators for -instructions on how to enable changes to ports, if necessary. \ No newline at end of file +instructions on how to enable changes to ports, if necessary. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_firewalls_and_ports_tiered.md b/layouts/shortcodes/server_firewalls_and_ports_tiered.md index e6d0a560c2..8c83d2e925 100644 --- a/layouts/shortcodes/server_firewalls_and_ports_tiered.md +++ b/layouts/shortcodes/server_firewalls_and_ports_tiered.md @@ -66,3 +66,6 @@ column) are open and accessible using any firewalls that are in use: + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_rbac.md b/layouts/shortcodes/server_rbac.md index fd9bd3601f..2e3c740d6f 100644 --- a/layouts/shortcodes/server_rbac.md +++ b/layouts/shortcodes/server_rbac.md @@ -5,4 +5,6 @@ Client requests to the Chef Infra Server are allowed. Access to objects on the Chef Infra Server is fine-grained, allowing access to be defined by object type, object, group, user, and organization. The Chef Infra Server uses permissions to define how a user may interact with an -object, after they have been authorized to do so. \ No newline at end of file +object, after they have been authorized to do so. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_rbac_permissions.md b/layouts/shortcodes/server_rbac_permissions.md index 53df111fb5..931ac8cc17 100644 --- a/layouts/shortcodes/server_rbac_permissions.md +++ b/layouts/shortcodes/server_rbac_permissions.md @@ -1,3 +1,5 @@ Permissions are used in the Chef Infra Server to define how users and groups can interact with objects on the server. Permissions are configured for each organization. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_rbac_permissions_object.md b/layouts/shortcodes/server_rbac_permissions_object.md index 0f9c115813..2146929d5a 100644 --- a/layouts/shortcodes/server_rbac_permissions_object.md +++ b/layouts/shortcodes/server_rbac_permissions_object.md @@ -30,3 +30,5 @@ The Chef Infra Server includes the following object permissions: + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_rbac_server_admins.md b/layouts/shortcodes/server_rbac_server_admins.md index e8e93c13cb..b88a5fb0a9 100644 --- a/layouts/shortcodes/server_rbac_server_admins.md +++ b/layouts/shortcodes/server_rbac_server_admins.md @@ -5,3 +5,6 @@ users who are responsible for day-to-day administration of the Chef Infra Server, especially user management using the `knife user` subcommand. Before members can be added to the `server-admins` group, they must already have a user account on the Chef Infra Server. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_rbac_server_admins_scenario.md b/layouts/shortcodes/server_rbac_server_admins_scenario.md index a6e4e10cbe..0f8c7cdfee 100644 --- a/layouts/shortcodes/server_rbac_server_admins_scenario.md +++ b/layouts/shortcodes/server_rbac_server_admins_scenario.md @@ -83,3 +83,6 @@ knife user edit carol -c ~/.chef/alice.rb and the \$EDITOR opens in which Alice makes changes, and then saves them. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_rbac_server_admins_superusers.md b/layouts/shortcodes/server_rbac_server_admins_superusers.md index 7b337d6ffe..127b454d80 100644 --- a/layouts/shortcodes/server_rbac_server_admins_superusers.md +++ b/layouts/shortcodes/server_rbac_server_admins_superusers.md @@ -16,3 +16,6 @@ Response: Missing read permission Alice's action is unauthorized even with membership in the `server-admins` group. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_security_ssl_cert_client.md b/layouts/shortcodes/server_security_ssl_cert_client.md index e187f87e3d..4c6cd51e13 100644 --- a/layouts/shortcodes/server_security_ssl_cert_client.md +++ b/layouts/shortcodes/server_security_ssl_cert_client.md @@ -23,3 +23,5 @@ ERROR: OpenSSL::SSL::SSLError: SSL_connect returned=1 errno=0 state=SSLv3 ... This is by design and will occur until a verifiable certificate is added to the machine from which the request is sent. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_bifrost.md b/layouts/shortcodes/server_services_bifrost.md index 8e3f7a533f..83415d66d3 100644 --- a/layouts/shortcodes/server_services_bifrost.md +++ b/layouts/shortcodes/server_services_bifrost.md @@ -1,2 +1,4 @@ The **oc_bifrost** service ensures that every request to view or manage -objects stored on the Chef Infra Server is authorized. \ No newline at end of file +objects stored on the Chef Infra Server is authorized. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_bookshelf.md b/layouts/shortcodes/server_services_bookshelf.md index 8e2c037f67..da6c451c90 100644 --- a/layouts/shortcodes/server_services_bookshelf.md +++ b/layouts/shortcodes/server_services_bookshelf.md @@ -1,4 +1,6 @@ The **bookshelf** service is an Amazon Simple Storage Service (S3)-compatible service that is used to store cookbooks, including all of the files---recipes, templates, and so on---that are associated with -each cookbook. \ No newline at end of file +each cookbook. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_elasticsearch.md b/layouts/shortcodes/server_services_elasticsearch.md index 0dedf07fc4..99e119652b 100644 --- a/layouts/shortcodes/server_services_elasticsearch.md +++ b/layouts/shortcodes/server_services_elasticsearch.md @@ -1 +1,3 @@ The **elasticsearch** service is used to create the search indexes used for searching objects like nodes, data bags, and cookbooks. (This service ensures timely search results using the Chef Infra Server API; data that is used by the Chef platform is stored in PostgreSQL.) + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_erchef.md b/layouts/shortcodes/server_services_erchef.md index 2ca525cec3..0e3fe34eba 100644 --- a/layouts/shortcodes/server_services_erchef.md +++ b/layouts/shortcodes/server_services_erchef.md @@ -8,4 +8,6 @@ the Chef Infra Server: - Nodes - Roles - Sandboxes -- Search \ No newline at end of file +- Search + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_expander.md b/layouts/shortcodes/server_services_expander.md index bc27280bee..4e9431bdfb 100644 --- a/layouts/shortcodes/server_services_expander.md +++ b/layouts/shortcodes/server_services_expander.md @@ -1,3 +1,5 @@ The **opscode-expander** service is used to process data (pulled from the **rabbitmq** service's message queue) so that it can be properly -indexed by the **opscode-solr4** service. \ No newline at end of file +indexed by the **opscode-solr4** service. + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_nginx.md b/layouts/shortcodes/server_services_nginx.md index 6c9f66cb5b..f8e54a6f0a 100644 --- a/layouts/shortcodes/server_services_nginx.md +++ b/layouts/shortcodes/server_services_nginx.md @@ -1,4 +1,6 @@ The **nginx** service is used to manage traffic to the Chef Infra Server, including virtual hosts for internal and external API request/response routing, external add-on request routing, and routing -between front- and back-end components. \ No newline at end of file +between front- and back-end components. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_nginx_tail.md b/layouts/shortcodes/server_services_nginx_tail.md index e31f4588f3..49b00d14a2 100644 --- a/layouts/shortcodes/server_services_nginx_tail.md +++ b/layouts/shortcodes/server_services_nginx_tail.md @@ -3,3 +3,5 @@ To follow the logs for the service: ```bash chef-server-ctl tail nginx ``` + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_oc_id.md b/layouts/shortcodes/server_services_oc_id.md index eb2f69fa7f..c664943267 100644 --- a/layouts/shortcodes/server_services_oc_id.md +++ b/layouts/shortcodes/server_services_oc_id.md @@ -3,4 +3,6 @@ Server by external applications, including Chef Supermarket. OAuth 2.0 uses token-based authentication, where external applications use tokens that are issued by the **oc-id** provider. No special credentials---`webui_priv.pem` or privileged keys---are stored on the -external application. \ No newline at end of file +external application. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_postgresql.md b/layouts/shortcodes/server_services_postgresql.md index 027de67cca..055d932c87 100644 --- a/layouts/shortcodes/server_services_postgresql.md +++ b/layouts/shortcodes/server_services_postgresql.md @@ -1 +1,3 @@ -The **postgresql** service is used to store node, object, and user data. \ No newline at end of file +The **postgresql** service is used to store node, object, and user data. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_rabbitmq.md b/layouts/shortcodes/server_services_rabbitmq.md index 6953338391..3652f98ef1 100644 --- a/layouts/shortcodes/server_services_rabbitmq.md +++ b/layouts/shortcodes/server_services_rabbitmq.md @@ -1,3 +1,5 @@ The **rabbitmq** service is used to provide the message queue that is used by the Chef Infra Server to get search data to Apache Solr so that -it can be indexed for search. \ No newline at end of file +it can be indexed for search. + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_redis.md b/layouts/shortcodes/server_services_redis.md index 4fdcb48d9c..ed6c9dcac6 100644 --- a/layouts/shortcodes/server_services_redis.md +++ b/layouts/shortcodes/server_services_redis.md @@ -1,2 +1,4 @@ Key-value store used in conjunction with Nginx to route requests and -populate request data used by the Chef Infra Server. \ No newline at end of file +populate request data used by the Chef Infra Server. + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_services_solr4.md b/layouts/shortcodes/server_services_solr4.md index 1613629e78..3b0be8dee1 100644 --- a/layouts/shortcodes/server_services_solr4.md +++ b/layouts/shortcodes/server_services_solr4.md @@ -2,3 +2,6 @@ The **opscode-solr4** service is used to create the search indexes used for searching objects like nodes, data bags, and cookbooks. (This service ensures timely search results using the Chef Infra Server API; data that is used by the Chef platform is stored in PostgreSQL.) + + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_tuning_bookshelf.md b/layouts/shortcodes/server_tuning_bookshelf.md index b67c0a3bf2..a600c2299f 100644 --- a/layouts/shortcodes/server_tuning_bookshelf.md +++ b/layouts/shortcodes/server_tuning_bookshelf.md @@ -3,4 +3,6 @@ tuning effort for the **bookshelf** service: `bookshelf['vip']` -: The virtual IP address. Default value: `node['fqdn']`. \ No newline at end of file +: The virtual IP address. Default value: `node['fqdn']`. + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_tuning_erchef.md b/layouts/shortcodes/server_tuning_erchef.md index f284137f95..0f130b825f 100644 --- a/layouts/shortcodes/server_tuning_erchef.md +++ b/layouts/shortcodes/server_tuning_erchef.md @@ -19,4 +19,6 @@ the tuning effort for the **opscode-erchef** service: `opscode_erchef['strict_search_result_acls']` -: {{ readFile "layouts/shortcodes/settings_strict_search_result_acls.md" | markdownify }} \ No newline at end of file +: {{ readFile "layouts/shortcodes/settings_strict_search_result_acls.md" | markdownify }} + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_tuning_general.md b/layouts/shortcodes/server_tuning_general.md index aeda886bb1..817e6e0424 100644 --- a/layouts/shortcodes/server_tuning_general.md +++ b/layouts/shortcodes/server_tuning_general.md @@ -24,3 +24,6 @@ file (no equal sign is necessary to set the value): `notification_email` : Default value: `info@example.com`. + + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_tuning_nginx.md b/layouts/shortcodes/server_tuning_nginx.md index 03599f11af..b55f5e15b2 100644 --- a/layouts/shortcodes/server_tuning_nginx.md +++ b/layouts/shortcodes/server_tuning_nginx.md @@ -62,3 +62,5 @@ nginx['ssl_certificate_key'] = '/etc/pki/tls/private/name.of.key' nginx['ssl_ciphers'] = 'HIGH:MEDIUM:!LOW:!kEDH:!aNULL:!ADH:!eNULL:!EXP:!SSLv2:!SEED:!CAMELLIA:!PSK' nginx['ssl_protocols'] = 'TLSv1 TLSv1.1 TLSv1.2' ``` + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_tuning_postgresql.md b/layouts/shortcodes/server_tuning_postgresql.md index c20ff9088f..0c92e95c0c 100644 --- a/layouts/shortcodes/server_tuning_postgresql.md +++ b/layouts/shortcodes/server_tuning_postgresql.md @@ -32,3 +32,6 @@ The following setting is often modified from the default as part of the tuning e ```ruby 550 = 350 + [(4 - 2) * (25 * 4)] ``` + + +{{/* shortcode delete. Text moved to chef-server repo */}} diff --git a/layouts/shortcodes/server_upgrade_duration.md b/layouts/shortcodes/server_upgrade_duration.md index 774558e275..644c16bd2a 100644 --- a/layouts/shortcodes/server_upgrade_duration.md +++ b/layouts/shortcodes/server_upgrade_duration.md @@ -1 +1,4 @@ The Chef Infra Server 14 upgrade process requires downtime for stopping the server, installing the new package, and then upgrading the server, which will include an automatic Elasticsearch reindexing operation for existing Solr users. We estimate the reindexing operation will take 2 minutes for each 1000 nodes, but the it could take more time, depending on your server hardware and the complexity of your Chef data. + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/settings_strict_search_result_acls.md b/layouts/shortcodes/settings_strict_search_result_acls.md index 1ac769c1d5..45c5db13f6 100644 --- a/layouts/shortcodes/settings_strict_search_result_acls.md +++ b/layouts/shortcodes/settings_strict_search_result_acls.md @@ -23,4 +23,6 @@ information. - \ No newline at end of file + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/system_requirements_ha.md b/layouts/shortcodes/system_requirements_ha.md index 48c062f57b..64a7d1767a 100644 --- a/layouts/shortcodes/system_requirements_ha.md +++ b/layouts/shortcodes/system_requirements_ha.md @@ -26,4 +26,6 @@ system. - \ No newline at end of file + + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/system_requirements_server_hardware.md b/layouts/shortcodes/system_requirements_server_hardware.md index 3e99b974bc..8b43df6d06 100644 --- a/layouts/shortcodes/system_requirements_server_hardware.md +++ b/layouts/shortcodes/system_requirements_server_hardware.md @@ -27,3 +27,5 @@ For a high availability deployment: - 1 x GigE NIC interface (if on premises) {{ readFile "layouts/shortcodes/system_requirements_ha.md" | markdownify }} + +{{/* moved to chef-server repo */}} diff --git a/layouts/shortcodes/system_requirements_server_software.md b/layouts/shortcodes/system_requirements_server_software.md index 9b0751287a..2131d846f9 100644 --- a/layouts/shortcodes/system_requirements_server_software.md +++ b/layouts/shortcodes/system_requirements_server_software.md @@ -31,4 +31,6 @@ In addition: - **Chef Infra Client communication with the Chef Infra Server** The Chef Infra Server must be able to communicate with every node that will be configured by Chef Infra Client and every workstation that - will upload data to the Chef Infra \ No newline at end of file + will upload data to the Chef Infra. + +{{/* moved to chef-server repo */}}