diff options
author | jamescott <jscott@Ettores-MacBook-Pro-2.local> | 2014-09-25 12:14:53 -0700 |
---|---|---|
committer | jamescott <jscott@Ettores-MacBook-Pro-2.local> | 2014-09-25 12:14:53 -0700 |
commit | 791232c8e08743447fd2a1bf4eb69b87e5d24c00 (patch) | |
tree | fc2ad49e29c026639537189a1b0d233614deed81 /distro/common/html/_sources | |
parent | 6d634e95f3eac17db3c86283b703a9a255c88c05 (diff) | |
download | chef-791232c8e08743447fd2a1bf4eb69b87e5d24c00.tar.gz |
update HTML man pages
Diffstat (limited to 'distro/common/html/_sources')
-rw-r--r-- | distro/common/html/_sources/ctl_chef_server.txt | 317 |
1 files changed, 307 insertions, 10 deletions
diff --git a/distro/common/html/_sources/ctl_chef_server.txt b/distro/common/html/_sources/ctl_chef_server.txt index 9c38c30ef6..bc55662531 100644 --- a/distro/common/html/_sources/ctl_chef_server.txt +++ b/distro/common/html/_sources/ctl_chef_server.txt @@ -4,23 +4,320 @@ chef-server-ctl .. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server.rst -Options +backup-recover ===================================================== -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_options.rst +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_backup_recover.rst +cleanse +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_cleanse.rst + +gather-logs +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_gather_logs.rst + +ha-status +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_ha_status.rst + +help +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_help.rst + +install +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_install.rst + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_install_table.rst + +master-recover +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_master_recover.rst + +org-associate +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_associate.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_associate_syntax.rst + +**Examples** + +.. code-block:: bash + + $ chef-server-ctl org-associate prod john_smith + + +.. code-block:: bash + + $ chef-server-ctl org-associate preprod testmaster + + +org-create +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_create.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_create_syntax.rst + +**Options** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_create_options.rst + +**Examples** + +.. code-block:: bash + + $ chef-server-ctl org-create prod Production + + +.. code-block:: bash + + $ chef-server-ctl org-create staging Staging -a chef-admin + + +.. code-block:: bash + + $ chef-server-ctl org-create dev Development -f /tmp/id-dev.key + + +org-delete +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_delete.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_delete_syntax.rst + +**Examples** + +.. code-block:: bash + + $ chef-server-ctl org-delete infra-testing-20140909 + + +.. code-block:: bash + + $ chef-server-ctl org-delete pedant-testing-org + + +org-disassociate +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_disassociate.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_disassociate_syntax.rst + +**Examples** + +.. code-block:: bash + + $ chef-server-ctl org-disassociate prod john_smith + + +.. code-block:: bash + + $ chef-server-ctl org-disassociate prod testmaster + + +org-list +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list_syntax.rst + +**Options** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list_options.rst + +org-show +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_show.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_show_syntax.rst + +password +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_password.rst + +reconfigure +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_reconfigure.rst + +show-config +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_show_config.rst + +uninstall +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_uninstall.rst + +upgrade +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_upgrade.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_upgrade_syntax.rst + +**Options** + +.. note:: Options for the ``upgrade`` subcommand may only be used when upgrading from |chef server osc| 11 to |chef server| 12. + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_upgrade_options.rst + +user-create +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_create.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_create_syntax.rst -Examples +**Options** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_create_options.rst + +**Examples** + +.. code-block:: bash + + $ chef-server-ctl user-create john_smith John Smith john_smith@example.com insecure-passord + + +.. code-block:: bash + + $ chef-server-ctl user-create jane_doe Jane Doe jane_doe@example.com PaSSword -f /tmp/jane_doe.key + + +.. code-block:: bash + + $ chef-server-ctl user-create waldendude Henry David Thoreau waldendude@example.com excursions + + +user-delete ===================================================== -The following examples show how to use |chef server ctl| to manage services. +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_delete.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_delete_syntax.rst + +**Examples** + +.. code-block:: bash + + $ chef-server-ctl user-delete john_smith + + +.. code-block:: bash + + $ chef-server-ctl user-delete jane_doe + +user-edit +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_edit.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_edit_syntax.rst + +**Examples** + +.. code-block:: bash + + $ chef-server-ctl user-edit john_smith + + +.. code-block:: bash + + $ chef-server-ctl user-edit jane_doe + + +user-list +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_list.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_list_syntax.rst + +**Options** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_list_options.rst + +user-show +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_show.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_show_syntax.rst + +**Options** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_user_show_options.rst + +Service Subcommands +===================================================== +The |chef server| has a built in process supervisor, which ensures that all of the required services are in the appropriate state at any given time. The supervisor starts two processes per service. + +hup +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_hup.rst + +int +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_int.rst + +kill +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_kill.rst + +once +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_once.rst + +restart +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_restart.rst + +service-list +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_service_list.rst + +start +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_start.rst + +status +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_status.rst -**View the status of a service** +High Availability ++++++++++++++++++++++++++++++++++++++++++++++++++++++ +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_status_ha.rst -.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_view_service_status.rst +Log Files ++++++++++++++++++++++++++++++++++++++++++++++++++++++ +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_status_logs.rst -**Restart a service** +stop +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_stop.rst -.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_restart_service.rst +tail +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_tail.rst -**Restart all services** +term +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_term.rst -.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_restart_all_services.rst |