From 2efe793e4828861711c4dd65702a4226342ea2fa Mon Sep 17 00:00:00 2001 From: jamescott Date: Tue, 4 Feb 2014 12:02:53 -0800 Subject: add updated html files for knife and chef- man pages --- distro/common/html/_sources/ctl_chef_client.txt | 36 ++ distro/common/html/_sources/ctl_chef_server.txt | 26 ++ distro/common/html/_sources/ctl_chef_shell.txt | 15 + distro/common/html/_sources/ctl_chef_solo.txt | 25 + distro/common/html/_sources/index.txt | 126 +++++ distro/common/html/_sources/knife.txt | 52 +-- distro/common/html/_sources/knife_bootstrap.txt | 6 - distro/common/html/_sources/knife_client.txt | 22 +- distro/common/html/_sources/knife_configure.txt | 6 - distro/common/html/_sources/knife_cookbook.txt | 54 --- .../common/html/_sources/knife_cookbook_site.txt | 18 - distro/common/html/_sources/knife_data_bag.txt | 24 - distro/common/html/_sources/knife_delete.txt | 6 - distro/common/html/_sources/knife_deps.txt | 6 - distro/common/html/_sources/knife_diff.txt | 6 - distro/common/html/_sources/knife_download.txt | 6 - distro/common/html/_sources/knife_edit.txt | 6 - distro/common/html/_sources/knife_environment.txt | 12 - distro/common/html/_sources/knife_exec.txt | 6 - distro/common/html/_sources/knife_list.txt | 6 - distro/common/html/_sources/knife_node.txt | 24 - distro/common/html/_sources/knife_raw.txt | 6 - distro/common/html/_sources/knife_role.txt | 18 - distro/common/html/_sources/knife_ssh.txt | 6 - distro/common/html/_sources/knife_status.txt | 6 - distro/common/html/_sources/knife_upload.txt | 6 - distro/common/html/_sources/knife_user.txt | 12 - distro/common/html/_sources/knife_xargs.txt | 6 - distro/common/html/_static/guide.css | 505 +++++++++++++++++++++ distro/common/html/ctl_chef_client.html | 219 +++++++++ distro/common/html/ctl_chef_server.html | 111 +++++ distro/common/html/ctl_chef_shell.html | 120 +++++ distro/common/html/ctl_chef_solo.html | 144 ++++++ distro/common/html/index.html | 185 ++++++++ distro/common/html/knife.html | 137 +----- distro/common/html/knife_bootstrap.html | 145 +----- distro/common/html/knife_client.html | 207 +-------- distro/common/html/knife_common_options.html | 100 +--- distro/common/html/knife_configure.html | 141 +----- distro/common/html/knife_cookbook.html | 426 +++-------------- distro/common/html/knife_cookbook_site.html | 262 ++--------- distro/common/html/knife_data_bag.html | 255 ++--------- distro/common/html/knife_delete.html | 131 +----- distro/common/html/knife_deps.html | 135 +----- distro/common/html/knife_diff.html | 135 +----- distro/common/html/knife_download.html | 131 +----- distro/common/html/knife_edit.html | 135 +----- distro/common/html/knife_environment.html | 204 +-------- distro/common/html/knife_exec.html | 129 +----- distro/common/html/knife_index_rebuild.html | 110 +---- distro/common/html/knife_list.html | 133 +----- distro/common/html/knife_node.html | 263 ++--------- distro/common/html/knife_raw.html | 135 +----- distro/common/html/knife_recipe_list.html | 110 +---- distro/common/html/knife_role.html | 222 +-------- distro/common/html/knife_search.html | 110 +---- distro/common/html/knife_show.html | 110 +---- distro/common/html/knife_ssh.html | 141 +----- distro/common/html/knife_status.html | 129 +----- distro/common/html/knife_tag.html | 125 +---- distro/common/html/knife_upload.html | 131 +----- distro/common/html/knife_user.html | 195 +------- distro/common/html/knife_using.html | 120 +---- distro/common/html/knife_xargs.html | 151 +----- distro/common/html/objects.inv | Bin 208 -> 214 bytes distro/common/html/search.html | 114 +---- distro/common/html/searchindex.js | 2 +- 67 files changed, 1977 insertions(+), 4829 deletions(-) create mode 100644 distro/common/html/_sources/ctl_chef_client.txt create mode 100644 distro/common/html/_sources/ctl_chef_server.txt create mode 100644 distro/common/html/_sources/ctl_chef_shell.txt create mode 100644 distro/common/html/_sources/ctl_chef_solo.txt create mode 100644 distro/common/html/_sources/index.txt create mode 100644 distro/common/html/_static/guide.css create mode 100644 distro/common/html/ctl_chef_client.html create mode 100644 distro/common/html/ctl_chef_server.html create mode 100644 distro/common/html/ctl_chef_shell.html create mode 100644 distro/common/html/ctl_chef_solo.html create mode 100644 distro/common/html/index.html (limited to 'distro/common') diff --git a/distro/common/html/_sources/ctl_chef_client.txt b/distro/common/html/_sources/ctl_chef_client.txt new file mode 100644 index 0000000000..99b0037154 --- /dev/null +++ b/distro/common/html/_sources/ctl_chef_client.txt @@ -0,0 +1,36 @@ +===================================================== +chef-client +===================================================== + +.. include:: ../../includes_chef_client/includes_chef_client.rst + +.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client.rst + +.. note:: .. include:: ../../includes_config/includes_config_rb_client.rst + +Options +===================================================== +.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_11-8_options.rst + +Run with Elevated Privileges +===================================================== +.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_elevated_privileges.rst + +Linux +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_elevated_privileges_linux.rst + +Windows +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_elevated_privileges_windows.rst + +Examples +===================================================== + +**Start a Chef run when the chef-client is running as a daemon** + +.. include:: ../../step_ctl_chef_client/step_ctl_chef_client_start_chef_run_daemon.rst + +**Start a Chef run manually** + +.. include:: ../../step_ctl_chef_client/step_ctl_chef_client_start_chef_run_manual.rst \ No newline at end of file diff --git a/distro/common/html/_sources/ctl_chef_server.txt b/distro/common/html/_sources/ctl_chef_server.txt new file mode 100644 index 0000000000..9c38c30ef6 --- /dev/null +++ b/distro/common/html/_sources/ctl_chef_server.txt @@ -0,0 +1,26 @@ +===================================================== +chef-server-ctl +===================================================== + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server.rst + +Options +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_options.rst + + +Examples +===================================================== +The following examples show how to use |chef server ctl| to manage services. + +**View the status of a service** + +.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_view_service_status.rst + +**Restart a service** + +.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_restart_service.rst + +**Restart all services** + +.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_restart_all_services.rst diff --git a/distro/common/html/_sources/ctl_chef_shell.txt b/distro/common/html/_sources/ctl_chef_shell.txt new file mode 100644 index 0000000000..75902f3141 --- /dev/null +++ b/distro/common/html/_sources/ctl_chef_shell.txt @@ -0,0 +1,15 @@ +===================================================== +chef-shell +===================================================== + +.. include:: ../../includes_chef_shell/includes_chef_shell.rst + +.. include:: ../../includes_ctl_chef_shell/includes_ctl_chef_shell.rst + +Modes +===================================================== +.. include:: ../../includes_chef_shell/includes_chef_shell_modes.rst + +Options +===================================================== +.. include:: ../../includes_ctl_chef_shell/includes_ctl_chef_shell_options.rst diff --git a/distro/common/html/_sources/ctl_chef_solo.txt b/distro/common/html/_sources/ctl_chef_solo.txt new file mode 100644 index 0000000000..a80c8bad3c --- /dev/null +++ b/distro/common/html/_sources/ctl_chef_solo.txt @@ -0,0 +1,25 @@ +===================================================== +chef-solo +===================================================== + +.. include:: ../../includes_chef_solo/includes_chef_solo.rst + +.. include:: ../../includes_ctl_chef_solo/includes_ctl_chef_solo.rst + +Options +===================================================== +.. include:: ../../includes_ctl_chef_solo/includes_ctl_chef_solo_options.rst + +Examples +===================================================== +**Use a URL** + +.. include:: ../../step_ctl_chef_solo/step_ctl_chef_solo_use_url.rst + +**Use a directory** + +.. include:: ../../step_ctl_chef_solo/step_ctl_chef_solo_use_directory.rst + +**Use a URL for cookbook and JSON data** + +.. include:: ../../step_ctl_chef_solo/step_ctl_chef_solo_url_for_cookbook_and_json.rst diff --git a/distro/common/html/_sources/index.txt b/distro/common/html/_sources/index.txt new file mode 100644 index 0000000000..1600827541 --- /dev/null +++ b/distro/common/html/_sources/index.txt @@ -0,0 +1,126 @@ +===================================================== +|chef client| Man Pages +===================================================== + +The following command line interfaces are available in the |chef client|: + +* :doc:`ctl_chef_client` +* :doc:`ctl_chef_server` +* :doc:`ctl_chef_shell` +* :doc:`ctl_chef_solo` +* :doc:`knife` + +knife +===================================================== +.. include:: ../../includes_knife/includes_knife.rst + +The following sections describe functionality common to all |knife| subcommands: + +* :doc:`knife_using` +* :doc:`knife_common_options` + +|knife| includes the following sub-commands: + +.. list-table:: + :widths: 150 450 + :header-rows: 1 + + * - Sub-command + - Description + * - :doc:`knife_bootstrap` + - .. include:: ../../includes_knife/includes_knife_bootstrap.rst + * - :doc:`knife_client` + - .. include:: ../../includes_knife/includes_knife_client.rst + * - :doc:`knife_configure` + - .. include:: ../../includes_knife/includes_knife_configure.rst + * - :doc:`knife_cookbook` + - .. include:: ../../includes_knife/includes_knife_cookbook.rst + * - :doc:`knife_cookbook_site` + - .. include:: ../../includes_knife/includes_knife_site_cookbook.rst + * - :doc:`knife_data_bag` + - .. include:: ../../includes_knife/includes_knife_data_bag.rst + * - :doc:`knife_delete` + - .. include:: ../../includes_knife/includes_knife_delete.rst + * - :doc:`knife_deps` + - .. include:: ../../includes_knife/includes_knife_deps.rst + * - :doc:`knife_diff` + - .. include:: ../../includes_knife/includes_knife_diff.rst + * - :doc:`knife_download` + - .. include:: ../../includes_knife/includes_knife_download.rst + * - :doc:`knife_edit` + - .. include:: ../../includes_knife/includes_knife_edit.rst + * - :doc:`knife_environment` + - .. include:: ../../includes_knife/includes_knife_environment.rst + * - :doc:`knife_exec` + - .. include:: ../../includes_knife/includes_knife_exec.rst + * - :doc:`knife_index_rebuild` + - .. include:: ../../includes_knife/includes_knife_index_rebuild.rst + * - :doc:`knife_list` + - .. include:: ../../includes_knife/includes_knife_list.rst + * - :doc:`knife_node` + - .. include:: ../../includes_knife/includes_knife_node.rst + * - :doc:`knife_raw` + - .. include:: ../../includes_knife/includes_knife_raw.rst + * - :doc:`knife_recipe_list` + - .. include:: ../../includes_knife/includes_knife_recipe_list.rst + * - :doc:`knife_role` + - .. include:: ../../includes_knife/includes_knife_role.rst + * - :doc:`knife_search` + - .. include:: ../../includes_knife/includes_knife_search.rst + * - :doc:`knife_show` + - .. include:: ../../includes_knife/includes_knife_show.rst + * - :doc:`knife_ssh` + - .. include:: ../../includes_knife/includes_knife_ssh.rst + * - :doc:`knife_status` + - .. include:: ../../includes_knife/includes_knife_status.rst + * - :doc:`knife_tag` + - .. include:: ../../includes_knife/includes_knife_tag.rst + * - :doc:`knife_upload` + - .. include:: ../../includes_knife/includes_knife_upload.rst + * - :doc:`knife_user` + - .. include:: ../../includes_knife/includes_knife_user.rst + * - :doc:`knife_xargs` + - .. include:: ../../includes_knife/includes_knife_xargs.rst + + +.. Hide the TOC from this file. + +.. toctree:: + :hidden: + + ctl_chef_client + ctl_chef_server + ctl_chef_shell + ctl_chef_solo + knife + knife_common_options + knife_bootstrap + knife_client + knife_configure + knife_cookbook + knife_cookbook_site + knife_data_bag + knife_delete + knife_deps + knife_diff + knife_download + knife_edit + knife_environment + knife_exec + knife_index_rebuild + knife_list + knife_node + knife_raw + knife_recipe_list + knife_role + knife_search + knife_show + knife_ssh + knife_status + knife_tag + knife_upload + knife_user + knife_using + knife_xargs + + diff --git a/distro/common/html/_sources/knife.txt b/distro/common/html/_sources/knife.txt index 22b6c2b1dd..6320825e83 100644 --- a/distro/common/html/_sources/knife.txt +++ b/distro/common/html/_sources/knife.txt @@ -1,19 +1,13 @@ ===================================================== -About Knife +knife ===================================================== .. include:: ../../includes_knife/includes_knife.rst -.. list-table:: - :widths: 150 450 - :header-rows: 1 +The following sections describe functionality common to all |knife| subcommands: - * - Topic - - Description - * - :doc:`knife_using` - - |knife| runs from a management workstation and sits in-between a |chef server| and an organization’s infrastructure. - * - :doc:`knife_common_options` - - There are many options that are available for all |knife| sub-commands. +* :doc:`knife_using` +* :doc:`knife_common_options` |knife| includes the following sub-commands: @@ -78,41 +72,3 @@ About Knife * - :doc:`knife_xargs` - .. include:: ../../includes_knife/includes_knife_xargs.rst - -.. Hide the TOC from this file. - -.. toctree:: - :hidden: - - knife - knife_common_options - knife_bootstrap - knife_client - knife_configure - knife_cookbook - knife_cookbook_site - knife_data_bag - knife_delete - knife_deps - knife_diff - knife_download - knife_edit - knife_environment - knife_exec - knife_index_rebuild - knife_list - knife_node - knife_raw - knife_recipe_list - knife_role - knife_search - knife_show - knife_ssh - knife_status - knife_tag - knife_upload - knife_user - knife_using - knife_xargs - - diff --git a/distro/common/html/_sources/knife_bootstrap.txt b/distro/common/html/_sources/knife_bootstrap.txt index 04924a35a7..ee275b58f5 100644 --- a/distro/common/html/_sources/knife_bootstrap.txt +++ b/distro/common/html/_sources/knife_bootstrap.txt @@ -18,12 +18,6 @@ Options .. include:: ../../includes_knife/includes_knife_bootstrap_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_bootstrap_settings.rst - Custom Templates ===================================================== The ``chef-full`` distribution uses the |omnibus installer|. For most bootstrap operations, regardless of the platform on which the target node is running, using the ``chef-full`` distribution is the best approach for installing the |chef client| on a target node. In some situations, using another supported distribution is necessary. And in some situations, a custom template may be required. For example, the default bootstrap operation relies on an Internet connection to get the distribution to the target node. If a target node cannot access the Internet, then a custom template can be used to define a specific location for the distribution so that the target node may access it during the bootstrap operation. diff --git a/distro/common/html/_sources/knife_client.txt b/distro/common/html/_sources/knife_client.txt index c7f24d86eb..d9d6ba62a1 100644 --- a/distro/common/html/_sources/knife_client.txt +++ b/distro/common/html/_sources/knife_client.txt @@ -34,12 +34,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_client_create_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_client_create_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -68,7 +62,7 @@ Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: -**xxxxx** +**Delete a client** .. include:: ../../step_knife/step_knife_client_delete.rst @@ -88,7 +82,7 @@ Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: -**xxxxx** +**Edit a client** .. include:: ../../step_knife/step_knife_client_edit.rst @@ -108,7 +102,7 @@ Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: -**xxxxx** +**View a list of clients** .. include:: ../../step_knife/step_knife_client_list_all.rst @@ -126,17 +120,11 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_client_reregister_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_client_reregister_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: -**xxxxx** +**Reregister clients** .. include:: ../../step_knife/step_knife_client_reregister.rst @@ -156,7 +144,7 @@ Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: -**xxxxx** +**Show clients** .. include:: ../../step_knife/step_knife_client_show.rst diff --git a/distro/common/html/_sources/knife_configure.txt b/distro/common/html/_sources/knife_configure.txt index e21ac23af6..1e0485e7fa 100644 --- a/distro/common/html/_sources/knife_configure.txt +++ b/distro/common/html/_sources/knife_configure.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_configure_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_configure_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_cookbook.txt b/distro/common/html/_sources/knife_cookbook.txt index b5ef252173..462e4dd76c 100644 --- a/distro/common/html/_sources/knife_cookbook.txt +++ b/distro/common/html/_sources/knife_cookbook.txt @@ -20,12 +20,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_bulk_delete_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_bulk_delete_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -47,12 +41,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_create_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_create_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -74,12 +62,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_delete_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_delete_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -101,12 +83,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_download_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_download_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -128,12 +104,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_list_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_list_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -155,12 +125,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_metadata_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_metadata_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -203,12 +167,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_show_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_show_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -242,12 +200,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_test_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_test_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -269,12 +221,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_cookbook_upload_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_cookbook_upload_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_cookbook_site.txt b/distro/common/html/_sources/knife_cookbook_site.txt index 90766652d0..92fadaa819 100644 --- a/distro/common/html/_sources/knife_cookbook_site.txt +++ b/distro/common/html/_sources/knife_cookbook_site.txt @@ -20,12 +20,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_site_cookbook_download_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_site_cookbook_download_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -46,12 +40,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_site_cookbook_install_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_site_cookbook_install_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -112,12 +100,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_site_cookbook_share_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_site_cookbook_share.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_data_bag.txt b/distro/common/html/_sources/knife_data_bag.txt index 91309a53b7..32888e6f8b 100644 --- a/distro/common/html/_sources/knife_data_bag.txt +++ b/distro/common/html/_sources/knife_data_bag.txt @@ -22,12 +22,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_data_bag_create_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_data_bag_create_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -72,12 +66,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_data_bag_edit_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_data_bag_edit_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -102,12 +90,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_data_bag_from_file_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_data_bag_from_file_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -153,12 +135,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_data_bag_show_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_data_bag_show_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_delete.txt b/distro/common/html/_sources/knife_delete.txt index d290bcbde0..55e239792a 100644 --- a/distro/common/html/_sources/knife_delete.txt +++ b/distro/common/html/_sources/knife_delete.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_delete_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_delete_settings.rst - Examples ===================================================== None. diff --git a/distro/common/html/_sources/knife_deps.txt b/distro/common/html/_sources/knife_deps.txt index ea50d649f0..b9c7da5e9d 100644 --- a/distro/common/html/_sources/knife_deps.txt +++ b/distro/common/html/_sources/knife_deps.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_deps_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_deps_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_diff.txt b/distro/common/html/_sources/knife_diff.txt index 3c2fd15a1c..de467b3887 100644 --- a/distro/common/html/_sources/knife_diff.txt +++ b/distro/common/html/_sources/knife_diff.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_diff_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_diff_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_download.txt b/distro/common/html/_sources/knife_download.txt index 399ebe5edc..d2497b7d3a 100644 --- a/distro/common/html/_sources/knife_download.txt +++ b/distro/common/html/_sources/knife_download.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_download_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_download_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_edit.txt b/distro/common/html/_sources/knife_edit.txt index 30e636cb21..d9e44f44bc 100644 --- a/distro/common/html/_sources/knife_edit.txt +++ b/distro/common/html/_sources/knife_edit.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_edit_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_edit_settings.rst - Examples ===================================================== None. diff --git a/distro/common/html/_sources/knife_environment.txt b/distro/common/html/_sources/knife_environment.txt index 8d71a41872..a16e102ea0 100644 --- a/distro/common/html/_sources/knife_environment.txt +++ b/distro/common/html/_sources/knife_environment.txt @@ -40,12 +40,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_environment_create_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_environment_create_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -109,12 +103,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_environment_from_file_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_environment_from_file_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_exec.txt b/distro/common/html/_sources/knife_exec.txt index fb73f7448d..85e7d9f628 100644 --- a/distro/common/html/_sources/knife_exec.txt +++ b/distro/common/html/_sources/knife_exec.txt @@ -22,12 +22,6 @@ Options .. include:: ../../includes_knife/includes_knife_exec_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_exec_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_list.txt b/distro/common/html/_sources/knife_list.txt index 5e1879f2b1..bad0be1e09 100644 --- a/distro/common/html/_sources/knife_list.txt +++ b/distro/common/html/_sources/knife_list.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_list_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_list_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_node.txt b/distro/common/html/_sources/knife_node.txt index 0f8268632e..165db5079f 100644 --- a/distro/common/html/_sources/knife_node.txt +++ b/distro/common/html/_sources/knife_node.txt @@ -105,12 +105,6 @@ Options ----------------------------------------------------- |no_options| -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_node_from_file_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -132,12 +126,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_node_list_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_node_list_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -163,12 +151,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_node_run_list_add_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_node_run_list_add_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -206,12 +188,6 @@ Options ----------------------------------------------------- |no_options| -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_node_run_list_remove_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_raw.txt b/distro/common/html/_sources/knife_raw.txt index 34a988c035..3a27c0456a 100644 --- a/distro/common/html/_sources/knife_raw.txt +++ b/distro/common/html/_sources/knife_raw.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_raw_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_raw_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_role.txt b/distro/common/html/_sources/knife_role.txt index fa78339e75..edd218ddc6 100644 --- a/distro/common/html/_sources/knife_role.txt +++ b/distro/common/html/_sources/knife_role.txt @@ -42,12 +42,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_role_create_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_role_create_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -108,12 +102,6 @@ Options ----------------------------------------------------- |no_options| -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_role_from_file_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -154,12 +142,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_role_show_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_role_show_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_ssh.txt b/distro/common/html/_sources/knife_ssh.txt index b2d5d84a37..bc7f4e5977 100644 --- a/distro/common/html/_sources/knife_ssh.txt +++ b/distro/common/html/_sources/knife_ssh.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_ssh_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_ssh_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_status.txt b/distro/common/html/_sources/knife_status.txt index 6c54946247..194b985f67 100644 --- a/distro/common/html/_sources/knife_status.txt +++ b/distro/common/html/_sources/knife_status.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_status_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_status_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_upload.txt b/distro/common/html/_sources/knife_upload.txt index 36c29233ba..bd37725108 100644 --- a/distro/common/html/_sources/knife_upload.txt +++ b/distro/common/html/_sources/knife_upload.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_upload_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_upload_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_user.txt b/distro/common/html/_sources/knife_user.txt index ea1b055056..1642d30f7b 100644 --- a/distro/common/html/_sources/knife_user.txt +++ b/distro/common/html/_sources/knife_user.txt @@ -20,12 +20,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_user_create_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_user_create_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: @@ -99,12 +93,6 @@ Options ----------------------------------------------------- .. include:: ../../includes_knife/includes_knife_user_reregister_options.rst -knife.rb Settings -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_user_reregister_settings.rst - Examples ----------------------------------------------------- The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_sources/knife_xargs.txt b/distro/common/html/_sources/knife_xargs.txt index 73914bf03a..852ba282aa 100644 --- a/distro/common/html/_sources/knife_xargs.txt +++ b/distro/common/html/_sources/knife_xargs.txt @@ -14,12 +14,6 @@ Options .. include:: ../../includes_knife/includes_knife_xargs_options.rst -knife.rb Settings ------------------------------------------------------ -.. note:: See :doc:`knife.rb ` for more information about how to add optional settings to the |knife rb| file. - -.. include:: ../../includes_knife/includes_knife_xargs_settings.rst - Examples ===================================================== The following examples show how to use this |knife| subcommand: diff --git a/distro/common/html/_static/guide.css b/distro/common/html/_static/guide.css new file mode 100644 index 0000000000..2163fdc4f4 --- /dev/null +++ b/distro/common/html/_static/guide.css @@ -0,0 +1,505 @@ +/* + * opscode.css_t + * ~~~~~~~~~~~~~~~ + * + * Sphinx stylesheet -- opscode theme. Originally created by + * Opscode for docs.opscode.com. + * + * :copyright: None. + * :license: This work is licensed under a Creative Commons + * Attribution 3.0 Unported License + * + */ + +/* + * Colors + * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + * + * #f18a20 is Opscode orange. + * #212c35 is Opscode blue. + * + * #212c35 is used for text color and header colors + * #f18a20 for header underlines and border treatments + * + * Triads for #f18a20: #273fa4 (blue) and #18b246 (green) + * Triads for #212c35: #524a31 (tan) and #523a31 (salmon) + * Triads should only be used to accent the Opscode blue or orange + * + * For div.admonition: #6bb1e1 + * For div.warning: #fcb614 + * + * For subheaders and other treatments: #7c858c, then #b5bec6, then #d8dde3 + * For table headers: #7c858c (with #000000 text color) + * For links: #6d3528, rollover #59b6b2 + * + * Alternate colors in the official color palette (but try not to use): #59b6b2, #6d3528 + * + * For regular text: 'Helvetica Neue', 'Helvetica', 'Arial', sans-serif; + * For monospace text: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + * + * For div.related, the 8px ensures that the | is spaced evenly. + * + */ + +@import url("basic.css"); + +/* -- the background color for the whole page and the borders for the topic page, header, footer */ +/* -- IMPORTANT -- color is the color of the text on div.document; must be black or Opscode blue */ + +body { + font-family: 'Helvetica Neue', 'Helvetica', 'Arial', sans-serif; + font-size: 14px; + letter-spacing: -0.00em; + line-height: 150%; + text-align: center; + background-color: #7c858c; + color: #212c35; + padding: 0; + border: 4px solid #7c858c; + border-top: 0px solid #7c858c; + border-bottom: 0px solid #7c858c; + margin: 0px 80px 0px 80px; + min-width: 740px; +} + + + +/* -- the actual topic background, must be white all the time no exceptions */ + +div.document { + background-color: #ffffff; + text-align: left; + background-image: url(contents.png); + background-repeat: repeat-x; +} + + + +/* -- the vertical line between the topics and the TOC */ + +div.bodywrapper { + margin: 0 240px 0 0; + border-right: 4px solid #d8dde3; +} + +div.body { + margin: 0; + padding: 0.5em 20px 20px 20px; +} + +div.related { + font-size: 1em; +} + + + +/* -- the borders above and below the header and footer */ + +div.related ul { + background-color: #ffffff; + height: 1.8em; + border-top: 4px solid #d8dde3; + border-bottom: 4px solid #d8dde3; +} + +div.related ul li { + margin: 0; + padding: 0; + height: 2em; + float: left; +} + +div.related ul li.right { + float: right; + margin-right: 5px; +} + + + +/* -- the Sphinx-specific navigation text located just below the header and just above the footer */ + +div.related ul li a { + margin: 0; + padding: 0 8px 0 5px; + line-height: 1.75em; + color: #7c858c; +} + +div.related ul li a:hover { + color: #b5bec6; +} + + +div.sphinxsidebarwrapper { + padding: 0; +} + +div.sphinxsidebar { + margin: 0; + padding: 0.5em 15px 15px 0; + width: 210px; + float: right; + font-size: 1em; + text-align: left; + +} + + + +/* -- The colors of the TOC sidebar; h3 is headers, a is the text links and both should be same color */ + +div.sphinxsidebar h3, div.sphinxsidebar h4 { + margin: 1em 0 0.5em 0; + font-size: 1em; + padding: 0.1em 0 0.1em 0.5em; + color: #ffffff; + border: 1px solid #ffffff; + background-color: #7c858c; +} + +div.sphinxsidebar a { + color: #212c35; + padding: 0.1em 0 0.1em 0.5em; + text-decoration: none; +} + +div.sphinxsidebar h3 a { + color: #ffffff; +} + +div.sphinxsidebar ul { + padding-left: 1.5em; + margin-top: 7px; + padding: 0; + line-height: 130%; +} + +div.sphinxsidebar ul ul { + margin-left: 20px; +} + + + + +/* + * footer + * ~~~~~~~~~~~~~~~~~~~ + * + */ + + +div.footer { + background-color: #ffffff; + color: #ffffff; + padding: 3px 8px 3px 0; + clear: both; + font-size: 0.8em; + text-align: right; +} + +div.footer a { + color: #ffffff; + text-decoration: none; +} + +/* -- body styles ----------------------------------------------------------- */ + +p { + margin: 0.8em 0 0.5em 0; +} + + +a { + color: #4d97c6; + text-decoration: none; +} + +a:hover { + color: #7c858c; +} + +div.body a { + text-decoration: none; +} + +em { + font-style: normal; +} + +/* -- header styles, basically Opscode blue with colored underlines and decreasing border bottom sizes */ + +h1 { + margin: 0.5; + padding: 0.7em 0 0.3em 0; + font-size: 1.75em; + color: #212c35; + border-bottom:solid 4px #f18a20; +} + +h2 { + margin: 1.3em 0 0.2em 0; + font-size: 1.55em; + color: #212c35; + padding: 0.7em 0 0.3em 0; + border-bottom:solid 2px #7c858c; +} + +h3 { + margin: 1em 0 -0.3em 0; + font-size: 1.35em; + color: #212c35; + padding: 0.7em 0 0.3em 0; + border-bottom:solid 1px #7c858c; +} + +h4 { + margin: 1em 0 -0.3em 0; + font-size: 1.15em; + color: #212c35; + padding: 0.7em 0 0.3em 0; + border-bottom:solid 0px #7c858c; +} + +div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a { + color: #ffffff!important; +} + +h1 a.anchor, h2 a.anchor, h3 a.anchor, h4 a.anchor, h5 a.anchor, h6 a.anchor { + display: none; + margin: 0 0 0 0.3em; + padding: 0 0.2em 0 0.2em; + color: #ffffff!important; +} + +h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, +h5:hover a.anchor, h6:hover a.anchor { + display: inline; +} + +h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover, +h5 a.anchor:hover, h6 a.anchor:hover { + color: #ffffff; + background-color: #ffffff; +} + + + + +a.headerlink { + color: #ffffff!important; + font-size: 1em; + margin-left: 6px; + padding: 0 4px 0 4px; + text-decoration: none!important; +} + +a.headerlink:hover { + background-color: #ffffff; + color: #ffffff!important; +} + +cite, code, tt { + font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.95em; + letter-spacing: 0.01em; +} + + + + + +tt { + background-color: #ebecf1; + border-bottom: 1px solid #d8dde3; + color: #212c35; +} + +tt.descname, tt.descclassname, tt.xref { + border: 0; +} + +/* -- has Opscode orange for testing */ + +hr { + border: 1px solid #f18a20; + margin: 2em; +} + +/* -- has Opscode orange for testing */ + +a tt { + border: 0; + color: #f18a20; +} + +/* -- has Opscode orange for testing */ + +a tt:hover { + color: #f18a20; +} + +/* -- has Opscode orange for testing */ + +pre { + font-family: 'Consolas', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.95em; + letter-spacing: 0.015em; + line-height: 120%; + padding: 0.5em; + border: 0.0px solid #d8dde3; + background-color: #ebecf1; +} + +pre a { + color: inherit; + text-decoration: underline; +} + +td.linenos pre { + padding: 0.5em 0; +} + +/* -- has Opscode orange for testing */ + +div.quotebar { + background-color: #f18a20; + max-width: 250px; + float: right; + padding: 2px 7px; + border: 1px solid #f18a20; +} + +/* -- has Opscode orange for testing */ + +div.topic { + background-color: #f18a20; +} + + +/* -- table styles */ + +table.docutils { + border: 0; + border-collapse: separate; + border-spacing:4px; + +} + +table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 0px solid #ffffff; + background-color: #7c858c; + color: #ffffff; +} + +table.docutils td { + padding: 5px 5px 5px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px dashed #7c858c; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + + + + + + + +div.admonition, div.warning { + font-size: 0.9em; + margin: 1em 0 1em 0; + border: 1px solid #6bb1e1; + background-color: #ffffff; + padding: 0; +} + +div.admonition p, div.warning p { + margin: 0.5em 1em 0.5em 1em; + padding: 0; +} + +div.admonition pre, div.warning pre { + margin: 0.4em 1em 0.4em 1em; +} + +div.admonition p.admonition-title, +div.warning p.admonition-title { + margin: 0; + padding: 0.1em 0 0.1em 0.5em; + color: #ffffff; + border-bottom: 1px solid #6bb1e1; + font-weight: bold; + background-color: #6bb1e1; +} + + + + +div.warning { + border: 1px solid #fcb614; +} + +div.warning p.admonition-title { + background-color: #fcb614; + border-bottom-color: #fcb614; +} + +div.admonition ul, div.admonition ol, +div.warning ul, div.warning ol { + margin: 0.1em 0.5em 0.5em 3em; + padding: 0; +} + + + + +div.versioninfo { + margin: 1em 0 0 0; + border: 1px solid #ffffff; + background-color: #ffffff; + padding: 8px; + line-height: 1.3em; + font-size: 0.9em; +} + + + + +.viewcode-back { + font-family: 'Helvetica Neue', 'Helvetica', 'Arial', sans-serif; +} + + + + +div.viewcode-block:target { + background-color: #ffffff; + border-top: 1px solid #ffffff; + border-bottom: 1px solid #ffffff; +} \ No newline at end of file diff --git a/distro/common/html/ctl_chef_client.html b/distro/common/html/ctl_chef_client.html new file mode 100644 index 0000000000..454437bccf --- /dev/null +++ b/distro/common/html/ctl_chef_client.html @@ -0,0 +1,219 @@ + + + + + + + + + chef-client — chef-client Man Pages + + + + + + + + + + + + + +
+Chef +
+ + + + +
+
+ +
+ +
+

chef-client

+

A chef-client is an agent that runs locally on every node that is registered with the server. When a chef-client is run, it will perform all of the steps that are required to bring the node into the expected state, including:

+
    +
  • Registering and authenticating the node with the server
    • +
  • Building the node object
    • +
  • Synchronizing cookbooks
    • +
  • Compiling the resource collection by loading each of the required cookbooks, including recipes, attributes, and all other dependencies
    • +
  • Taking the appropriate and required actions to configure the node
    • +
  • Looking for exceptions and notifications, handling each as required
    • +
+

The chef-client executable can be run as a command-line tool.

+
+

Note

+

A client.rb file is used to specify the configuration details for the chef-client. This file is the default configuration file and is loaded every time the chef-client executable is run. The chef-client executable can be run as a daemon. On UNIX- and Linux-based machines, the configuration file is located at: /etc/chef/client.rb. On Microsoft Windows machines, the configuration file is located at C:\chef\client.rb.

+
+
+

Options

+

This command has the following syntax:

+
chef-client OPTION VALUE OPTION VALUE ...
+
+

This command has the following options:

+
+
-A, --fatal-windows-admin-check
+
Indicates that a chef-client run should fail if the chef-client does not have administrator privileges in Microsoft Windows.
+
--chef-zero-port PORT
+
The port on which chef-zero will listen.
+
-F FORMAT, --format FORMAT
+

The output format: doc (default) or min.

+

Use doc to print the progress of the chef-client run using full strings that display a summary of updates as they occur.

+

Use min to print the progress of the chef-client run using single characters. A summary of updates is printed at the end of the chef-client run. A dot (.) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (.) is printed when the resource is up to date, an S is printed when the resource is skipped by not_if or only_if, and a U is printed when the resource is updated.

+

Other formatting options are available when those formatters are configured in the client.rb file using the add_formatter option.

+
+
--force-formatter
+
Indicates that formatter output will be used instead of logger output.
+
--force-logger
+
Indicates that logger output will be used instead of formatter output.
+
-g GROUP, --group GROUP
+
The name of the group that owns a process. This is required when starting any executable as a daemon.
+
-h, --help
+
Shows help for the command.
+
-i SECONDS, --interval SECONDS
+
The frequency (in seconds) at which the chef-client runs. Default value: 1800.
+
-j PATH, --json-attributes PATH
+
The path to a file that contains JSON data.
+
-k KEY_FILE, --client_key KEY_FILE
+
The location of the file which contains the client key. Default value: /etc/chef/client.pem.
+
-K KEY_FILE, --validation_key KEY_FILE
+
The location of the file which contains the key used when a chef-client is registered with a server. A validation key is signed using the validation_client_name for authentication. Default value: /etc/chef/validation.pem.
+
-l LEVEL, --log_level LEVEL
+
The level of logging that will be stored in a log file.
+
-L LOGLOCATION, --logfile c
+
The location in which log file output files will be saved. If this location is set to something other than STDOUT, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon. Default value: STDOUT.
+
--[no-]color
+
Indicates whether colored output will be used. Default setting: --color.
+
-N NODE_NAME, --node-name NODE_NAME
+
The name of the node.
+
-o RUN_LIST_ITEM, --override-runlist RUN_LIST_ITEM
+
Replace the current run list with the specified items.
+
--once
+
Indicates that the chef-client is run once and that interval and splay options are cancelled.
+
-P PID_FILE, --pid PID_FILE
+
The location in which a process identification number (pid) is saved. An executable, when started as a daemon, will write the pid to the specified file. Default value: /tmp/name-of-executable.pid.
+
-R, --enable-reporting
+
Indicates that data collection reporting is enabled during a chef-client run.
+
-s SECONDS, --splay SECONDS
+
A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time.
+
-S CHEF_SERVER_URL, --server CHEF_SERVER_URL
+
The URL for the server.
+
-u USER, --user USER
+
The user that owns a process. This is required when starting any executable as a daemon.
+
-v, --version
+
The version of the chef-client.
+
-W, --why-run
+
Indicates that the executable will be run in why-run mode, which is a type of chef-client run that does everything except modify the system. Use why-run mode to understand why the chef-client makes the decisions that it makes and to learn more about the current and proposed state of the system.
+
-z, --local-mode
+
Indicates that the chef-client will be run in local mode, which allows all commands that work against the server to also work against the local chef-repo.
+
+
+
+

Run with Elevated Privileges

+

The chef-client may need to be run with elevated privileges in order to get a recipe to converge correctly. On UNIX and UNIX-like operating systems this can be done by running the command as root. On Microsoft Windows this can be done by running the command prompt as an administrator.

+
+

Linux

+

On Linux, the following error sometimes occurs when the permissions used to run the chef-client are incorrect:

+
$ chef-client
+[Tue, 29 Nov 2011 19:46:17 -0800] INFO: *** Chef 10.X.X ***
+[Tue, 29 Nov 2011 19:46:18 -0800] WARN: Failed to read the private key /etc/chef/client.pem: #<Errno::EACCES: Permission denied - /etc/chef/client.pem>
+
+
+

This can be resolved by running the command as root. There are a few ways this can be done:

+
    +

  • Log in as root and then run the chef-client

    +
    • +

  • Use su to become the root user, and then run the chef-client. For example:

    +
    +
    $ su
+
    +
    +
    +
    • +
+

and then:

+
+
$ chef-client
+
+
+
+
    +

  • Use the sudo utility

    +
    +
    $ sudo chef-client
+
    +
    +
    +
    • +

  • Give a user access to read /etc/chef and also the files accessed by the chef-client. This requires super user privileges and, as such, is not a recommended approach

    +
    • +
+
+
+

Windows

+

On Microsoft Windows, running without elevated privileges (when they are necessary) is an issue that fails silently. It will appear that the chef-client completed its run successfully, but the changes will not have been made. When this occurs, do one of the following to run the chef-client as the administrator:

+
    +

  • Log in to the administrator account. (This is not the same as an account in the administrator’s security group.)

    +
    • +

  • Run the chef-client process from the administrator account while being logged into another account. Run the following command:

    +
    +
    $ runas /user:Administrator "cmd /C chef-client"
+
    +
    +

    This will prompt for the administrator account password.

    +
    +
    • +

  • Open a command prompt by right-clicking on the command prompt application, and then selecting Run as administrator. After the command window opens, the chef-client can be run as the administrator

    +
    • +
+
+
+
+

Examples

+

Start a Chef run when the chef-client is running as a daemon

+

A chef-client that is running as a daemon can be woken up and started by sending the process a SIGUSR1. For example, to trigger a chef-client run on a machine running Linux:

+
$ sudo killall -USR1 chef-client
+
+
+

Start a Chef run manually

+
$ ps auxw|grep chef-client
+
+
+

to return something like:

+
root           66066   0.9  0.0  2488880    264 s001  S+   10:26AM   0:03.05
+/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby /usr/bin/chef-client -i 3600 -s 20
+
+
+

and then enter:

+
$ sudo kill -USR1 66066
+
+
+
+
+ + +
+ +
+ + +
+
+ + + + + + \ No newline at end of file diff --git a/distro/common/html/ctl_chef_server.html b/distro/common/html/ctl_chef_server.html new file mode 100644 index 0000000000..8fc86496cd --- /dev/null +++ b/distro/common/html/ctl_chef_server.html @@ -0,0 +1,111 @@ + + + + + + + + + chef-server-ctl — chef-client Man Pages + + + + + + + + + + + + + +
+Chef +
+ + + + +
+
+ +
+ +
+

chef-server-ctl

+

The open source server includes a command-line utility named chef-server-ctl, which is used to start and stop individual services, reconfigure the server, and tail server log files.

+
+

Options

+

This command has the following syntax:

+
chef-server-ctl OPTION
+
+

This command has the following options:

+
+
help
+
Shows help for the command.
+
reconfigure
+
Use to reconfigure the server. This option will read from the /etc/chef-server/chef-server.rb file and apply that configuration to the server. Any time changes are made to the chef-server.rb file, the chef-server-ctl command should be run with this option.
+
restart [SERVICE_NAME]
+
Use to restart all enabled services or to restart a single service.
+
start [SERVICE_NAME]
+
Use to start all enabled services or to start a single service.
+
status [SERVICE_NAME]
+
Use to view the status of all services or to view the status of a single service.
+
stop [SERVICE_NAME]
+
Use to stop all enabled services or to stop a single service.
+
tail [SERVICE_NAME]
+
Use to follow the server logs for all services or for a single service.
+
test --all
+
Use to execute chef-pedant, an integration test suite for the server installation. By default, only a subset of the available test are run. Add the --all flag to run the full test suite.
+
+
+
+

Examples

+

The following examples show how to use chef-server-ctl to manage services.

+

View the status of a service

+
$ ctl-chef-server status name_of_service
+
+
+

For example, to view the status for a service named erchef, enter:

+
$ ctl-chef-server status erchef
+
+
+

Restart a service

+
$ ctl-chef-server restart name_of_service
+
+
+

For example, to restart a service named erchef, enter:

+
$ ctl-chef-server restart erchef
+
+
+

Restart all services

+
$ ctl-chef-server restart
+
+
+
+
+ + +
+ +
+ + +
+
+ + + + + + \ No newline at end of file diff --git a/distro/common/html/ctl_chef_shell.html b/distro/common/html/ctl_chef_shell.html new file mode 100644 index 0000000000..7aa3ef0eac --- /dev/null +++ b/distro/common/html/ctl_chef_shell.html @@ -0,0 +1,120 @@ + + + + + + + + + chef-shell — chef-client Man Pages + + + + + + + + + + + + + +
+Chef +
+ + + + +
+
+ +
+ +
+

chef-shell

+

chef-shell is a recipe debugging tool that allows the use of breakpoints within recipes. chef-shell runs as an Interactive Ruby (IRb) session. chef-shell supports both recipe and attribute file syntax, as well as interactive debugging features.

+
+

Note

+

chef-shell is the new name for Shef as of Chef 11.x. chef-shell is backwards compatible and aside from the name change, has the same set of functionality as with previous releases.

+
+

The chef-shell executable can be run as a command-line tool.

+
+

Modes

+

chef-shell is tool that allows Knife to be run using an Interactive Ruby (IRb) session. chef-shell currently supports recipe and attribute file syntax, as well as interactive debugging features. chef-shell has three run modes:

+ ++++ + + + + + + + + + + + + + + + + +
ModeDescription
StandaloneNo cookbooks are loaded, and the run list is empty. This mode is the default.
Solochef-shell acts as a chef-solo client. It attempts to load the chef-solo configuration file and JSON attributes. If the JSON attributes set a run list, it will be honored. Cookbooks will be loaded in the same way that chef-solo loads them. chef-solo mode is activated with the -s or --solo command line option, and JSON attributes are specified in the same way as for chef-solo, with -j /path/to/chef-solo.json.
Clientchef-shell acts as a chef-client. During startup, it reads the chef-client configuration file and contacts the server to get attributes and cookbooks. The run list will be set in the same way as normal chef-client runs. chef-client mode is activated with the -z or --client options. You can also specify the configuration file with -c CONFIG and the server URL with -S SERVER_URL.
+
+
+

Options

+

This command has the following syntax:

+
chef-shell OPTION VALUE OPTION VALUE ...
+
+

This command has the following options:

+
+
-a, --standalone
+
Indicates that chef-shell will be run in standalone mode.
+
-c CONFIG, --config CONFIG
+
The configuration file to use.
+
-h, --help
+
Shows help for the command.
+
-j PATH, --json-attributes PATH
+
The path to a file that contains JSON data.
+
-l LEVEL, --log-level LEVEL
+
The level of logging that will be stored in a log file.
+
-s, --solo
+
Indicates that chef-shell will be run in chef-solo mode.
+
-S CHEF_SERVER_URL, --server CHEF_SERVER_URL
+
The URL for the server.
+
-v, --version
+
The version of the chef-client.
+
-z, --client
+
Indicates that chef-shell will be run in chef-client mode.
+
+
+
+ + +
+ +
+ + +
+
+ + + + + + \ No newline at end of file diff --git a/distro/common/html/ctl_chef_solo.html b/distro/common/html/ctl_chef_solo.html new file mode 100644 index 0000000000..cc20bfb940 --- /dev/null +++ b/distro/common/html/ctl_chef_solo.html @@ -0,0 +1,144 @@ + + + + + + + + + chef-solo — chef-client Man Pages + + + + + + + + + + + + + +
+Chef +
+ + + + +
+
+ +
+ +
+

chef-solo

+

chef-solo is an open source version of the chef-client that allows using cookbooks with nodes without requiring access to a server. chef-solo runs locally and requires that a cookbook (and any of its dependencies) be on the same physical disk as the node. chef-solo is a limited-functionality version of the chef-client and does not support the following:

+
    +
  • Node data storage
    • +
  • Search indexes
    • +
  • Centralized distribution of cookbooks
    • +
  • A centralized API that interacts with and integrates infrastructure components
    • +
  • Authentication or authorization
    • +
  • Persistent attributes
    • +
+

The chef-solo executable can be run as a command-line tool.

+
+

Options

+

This command has the following syntax:

+
chef-solo OPTION VALUE OPTION VALUE ...
+
+

This command has the following options:

+
+
-c CONFIG, --config CONFIG
+
The configuration file to use.
+
-d, --daemonize
+
Indicates that the executable will be run as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the chef-client::service recipe in the chef-client cookbook: http://community.opscode.com/cookbooks/chef-client. This will install a chef-client service under Microsoft Windows using the Windows Service Wrapper.
+
-E ENVIRONMENT_NAME, --environment ENVIRONMENT_NAME
+
The name of the environment.
+
-f, --[no-]fork
+
Indicates that a chef-client run will be contained in a secondary process with dedicated RAM. When the chef-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use --no-fork to disable running the chef-client in fork node. Default value: --fork.
+
-F FORMAT, --format FORMAT
+

The output format: doc (default) or min.

+

Use doc to print the progress of the chef-client run using full strings that display a summary of updates as they occur.

+

Use min to print the progress of the chef-client run using single characters. A summary of updates is printed at the end of the chef-client run. A dot (.) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (.) is printed when the resource is up to date, an S is printed when the resource is skipped by not_if or only_if, and a U is printed when the resource is updated.

+

Other formatting options are available when those formatters are configured in the client.rb file using the add_formatter option.

+
+
--force-formatter
+
Indicates that formatter output will be used instead of logger output.
+
--force-logger
+
Indicates that logger output will be used instead of formatter output.
+
-g GROUP, --group GROUP
+
The name of the group that owns a process. This is required when starting any executable as a daemon.
+
-h, --help
+
Shows help for the command.
+
-i SECONDS, --interval SECONDS
+
The frequency (in seconds) at which the chef-client runs.
+
-j PATH, --json-attributes PATH
+
The path to a file that contains JSON data. Use this option to override normal attributes set elsewhere.
+
-l LEVEL, --log_level LEVEL
+
The level of logging that will be stored in a log file.
+
-L LOGLOCATION, --logfile c
+
The location in which log file output files will be saved. If this location is set to something other than STDOUT, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon.
+
--[no-]color
+
Indicates whether colored output will be used. Default setting: --color.
+
-N NODE_NAME, --node-name NODE_NAME
+
The name of the node.
+
-o RUN_LIST_ITEM, --override-runlist RUN_LIST_ITEM
+
Replace the current run list with the specified items.
+
-r RECIPE_URL, --recipe-url RECIPE_URL
+
The URL location from which a remote cookbook tar.gz will be downloaded.
+
-s SECONDS, --splay SECONDS
+
A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time.
+
-u USER, --user USER
+
The user that owns a process. This is required when starting any executable as a daemon.
+
-v, --version
+
The version of the chef-client.
+
-W, --why-run
+
Indicates that the executable will be run in why-run mode, which is a type of chef-client run that does everything except modify the system. Use why-run mode to understand why the chef-client makes the decisions that it makes and to learn more about the current and proposed state of the system.
+
+
+
+

Examples

+

Use a URL

+
$ chef-solo -c ~/solo.rb -j ~/node.json -r http://www.example.com/chef-solo.tar.gz
+
+
+

where -r uses the remote_file resource to retrieve the tar.gz archive into the file_cache_path, and then extract it to cookbooks_path.

+

Use a directory

+
$ chef-solo -c ~/solo.rb -j ~/node.json
+
+
+

where the -r URL option is not used. chef-solo will look in the solo.rb file to determine the directory in which cookbooks are located.

+

Use a URL for cookbook and JSON data

+
$ chef-solo -c ~/solo.rb -j http://www.example.com/node.json -r http://www.example.com/chef-solo.tar.gz
+
+
+

where -r corresponds to recipe_url and -j corresponds to json_attribs, both of which are configuration options in solo.rb.

+
+
+ + +
+ +
+ + +
+
+ + + + + + \ No newline at end of file diff --git a/distro/common/html/index.html b/distro/common/html/index.html new file mode 100644 index 0000000000..b26dd0c476 --- /dev/null +++ b/distro/common/html/index.html @@ -0,0 +1,185 @@ + + + + + + + + + chef-client Man Pages — chef-client Man Pages + + + + + + + + + + + + + +
+Chef +
+ + + + +
+
+ +
+ +
+

chef-client Man Pages

+

The following command line interfaces are available in the chef-client:

+ +
+

knife

+

Knife is a command-line tool that provides an interface between a local chef-repo and the server. Knife helps users to manage:

+
    +
  • Nodes
    • +
  • Cookbooks and recipes
    • +
  • Roles
    • +
  • Stores of JSON data (data bags), including encrypted data
    • +
  • Environments
    • +
  • Cloud resources, including provisioning
    • +
  • The installation of the chef-client on management workstations
    • +
  • Searching of indexed data on the server
    • +
+

The following sections describe functionality common to all Knife subcommands:

+ +

Knife includes the following sub-commands:

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Sub-commandDescription
knife bootstrapThe knife bootstrap subcommand is used to run a bootstrap operation that installs the chef-client on the target system. The bootstrap operation must specify the IP address or FQDN of the target system.
knife clientThe knife client subcommand is used to manage an API client list and their associated RSA public key-pairs. This allows authentication requests to be made to the server by any entity that uses the Chef Server API, such as the chef-client and Knife.
knife configureThe knife configure subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes.
knife cookbookThe knife cookbook subcommand is used to interact with cookbooks that are located on the server or the local chef-repo.
knife cookbook siteThe knife cookbook site subcommand is used to interact with cookbooks that are located at https://cookbooks.opscode.com. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: download, search, install, and list.
knife data bagThe knife data bag subcommand is used to manage arbitrary stores of globally available JSON data.
knife deleteThe knife delete subcommand is used to delete an object from a server. This subcommand works similar to knife cookbook delete, knife data bag delete, knife environment delete, knife node delete, and knife role delete, but with a single verb (and a single action).
knife depsThe knife deps subcommand is used to identify dependencies for a node, role, or cookbook.
knife diffThe knife diff subcommand is used to compare the differences between files and directories on the server and in the chef-repo. For example, to compare files on the server prior to an uploading or downloading files using the knife download and knife upload subcommands, or to ensure that certain files in multiple production environments are the same. This subcommand is similar to the git diff command that can be used to diff what is in the chef-repo with what is synced to a git repository.
knife downloadThe knife download subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the server to the current working directory. It can be used to back up data on the server, inspect the state of one or more files, or to extract out-of-process changes users may have made to files on the server, such as if a user made a change that bypassed version source control. This subcommand is often used in conjunction with knife diff, which can be used to see exactly what changes will be downloaded, and then knife upload, which does the opposite of knife download.
knife editThe knife edit subcommand is used to edit objects on the server. This subcommand works similar to knife cookbook edit, knife data bag edit, knife environment edit, knife node edit, and knife role edit, but with a single verb (and a single action).
knife environmentThe knife environment subcommand is used to manage environments within a single organization on the server.
knife execThe knife exec subcommand uses the Knife configuration file to execute Ruby scripts in the context of a fully configured chef-client. This subcommand is most often used to run scripts that will only access server one time (or otherwise very infrequently). Use this subcommand any time that an operation does not warrant full usage of the Knife subcommand library.
knife index rebuildThe knife index rebuild subcommand is used to rebuild the search indexes for the open source server. This operation is destructive and may take some time.
knife listThe knife list subcommand is used to view a list of objects on the server. This subcommand works similar to knife cookbook list, knife data bag list, knife environment list, knife node list, and knife role list, but with a single verb (and a single action).
knife nodeThe knife node subcommand is used to manage the nodes that exist on a server.
knife rawThe knife raw subcommand is used to send a REST request to a specified path using the Chef Server API.
knife recipe listThe knife recipe list subcommand is used to view all of the recipes that are on a server. A regular expression can be used to limit the results to recipes that match a specific pattern. The regular expression must be within quotes and not be surrounded by forward slashes (/).
knife roleThe knife role subcommand is used to manage the roles that are associated with one or more nodes on a server.
knife searchThe knife search subcommand is used run a search query for information that is indexed on a server.
knife showThe knife show subcommand is used to view the details of one (or more) objects on the server. This subcommand works similar to knife cookbook show, knife data bag show, knife environment show, knife node show, and knife role show, but with a single verb (and a single action).
knife sshThe knife ssh subcommand is used to invoke SSH commands (in parallel) on a subset of nodes within an organization, based on the results of a search query.
knife statusThe knife status subcommand is used to display a brief summary of the nodes on a server, including the time of the most recent successful chef-client run.
knife tagThe knife tag subcommand is used to apply tags to nodes on a server.
knife uploadThe knife upload subcommand is used to upload roles, cookbooks, environments, and data bags to the server from the current working directory in the chef-repo. This subcommand is often used in conjunction with knife diff, which can be used to see exactly what changes will be uploaded, and then knife download, which does the opposite of knife upload.
knife userThe knife user subcommand is used to manage the list of users and their associated RSA public key-pairs.
knife xargsThe knife xargs subcommand is used to build and execute command lines against objects on a server using standard input.
+
+
+
+
+ + +
+ +
+ + +
+
+ + + + + + \ No newline at end of file diff --git a/distro/common/html/knife.html b/distro/common/html/knife.html index 19e06baa4a..d2f425438f 100644 --- a/distro/common/html/knife.html +++ b/distro/common/html/knife.html @@ -1,5 +1,4 @@ - @@ -8,9 +7,9 @@ - About Knife — Knife Man Pages + knife — chef-client Man Pages - + - - + +
Chef
-
-

Navigation

- -
-
-
- -
-
+
-
+
-
-

About Knife

+
+

knife

Knife is a command-line tool that provides an interface between a local chef-repo and the server. Knife helps users to manage:

  • Nodes
    • @@ -76,25 +54,11 @@
  • The installation of the chef-client on management workstations
  • Searching of indexed data on the server
- ---- - - - - - - - - - - - - - -
TopicDescription
Working with KnifeKnife runs from a management workstation and sits in-between a server and an organization’s infrastructure.
Common OptionsThere are many options that are available for all Knife sub-commands.
+

The following sections describe functionality common to all Knife subcommands:

+

Knife includes the following sub-commands:

@@ -190,87 +154,18 @@
-
-
-
-
-
-
-
-

Navigation

- -
- -
- Documentation for current man pages for Knife. - -  Send feedback to docs@getchef.com. - This work is licensed under a Creative Commons Attribution 3.0 Unported License. +
+ +
- - - - - - - - diff --git a/distro/common/html/knife_bootstrap.html b/distro/common/html/knife_bootstrap.html index fbed0c2853..121db9cdb0 100644 --- a/distro/common/html/knife_bootstrap.html +++ b/distro/common/html/knife_bootstrap.html @@ -1,5 +1,4 @@ - @@ -8,9 +7,9 @@ - knife bootstrap — Knife Man Pages + knife bootstrap — chef-client Man Pages - + - + +
Chef
-
-

Navigation

- -
-
-
- -

Table Of Contents

- - -
-
+
-
+
@@ -149,32 +112,6 @@
-x USERNAME, --ssh-user USERNAME
The SSH user name.
-
-

knife.rb Settings

-
-

Note

-

See knife.rb for more information about how to add optional settings to the knife.rb file.

-
-

The following knife bootstrap settings can be added to the knife.rb file:

-
-
knife[:bootstrap_proxy]
-
Use to add the --bootstrap-proxy option.
-
knife[:bootstrap_version]
-
Use to add the --bootstrap-version option.
-
knife[:distro]
-
Use to add the --distro option.
-
knife[:run_list]
-
Use to add the --run-list option.
-
knife[:template_file]
-
Use to add the --template-file option.
-
knife[:use_sudo]
-
Use to add the --sudo option.
-
-
-

Note

-

The knife bootstrap subcommand relies on a number of SSH-related settings that are handled by the knife ssh subcommand.

-
-

Custom Templates

@@ -299,78 +236,14 @@ vi ~/.chef/bootstrap/debian5.0-apt.erb
-
-
-
-
-
-

Navigation

- -
- -
- Documentation for current man pages for Knife. - -  Send feedback to docs@getchef.com. - This work is licensed under a Creative Commons Attribution 3.0 Unported License. +
+ +
- - - - - - - - diff --git a/distro/common/html/knife_client.html b/distro/common/html/knife_client.html index 7f73b172eb..ad9df20318 100644 --- a/distro/common/html/knife_client.html +++ b/distro/common/html/knife_client.html @@ -1,5 +1,4 @@ - @@ -8,9 +7,9 @@ - knife client — Knife Man Pages + knife client — chef-client Man Pages - + - + +
Chef
-
-

Navigation

- -
-
-
- -

Table Of Contents

- - -
-
+
-
+
@@ -161,20 +88,6 @@
-a, --admin
Indicates that a client will be created as an admin client. This is required when users of the open source server need to access the Chef Server API as an administrator. This option only works when used with the open source server and will have no effect when used with Enterprise Chef.
-
-

knife.rb Settings

-
-

Note

-

See knife.rb for more information about how to add optional settings to the knife.rb file.

-
-

The following knife client create settings can be added to the knife.rb file:

-
-
knife[:admin]
-
Use to add the --admin option.
-
knife[:file]
-
Use to add the --file option.
-
-

Examples

@@ -208,7 +121,7 @@

Examples

The following examples show how to use this Knife subcommand:

-

xxxxx

+

Delete a client

To delete a client with the name “client_foo”, enter:

$ knife client delete client_foo
@@ -233,7 +146,7 @@

Examples

The following examples show how to use this Knife subcommand:

-

xxxxx

+

Edit a client

To edit a client with the name “exampleorg”, enter:

$ knife client edit exampleorg
@@ -261,7 +174,7 @@

Examples

The following examples show how to use this Knife subcommand:

-

xxxxx

+

View a list of clients

To verify the API client list for the server, enter:

$ knife client list
@@ -300,23 +213,11 @@ server correctly, try getting a list of clients using -f FILE_NAME, --file FILE_NAME
Indicates that the private key will be saved to a specified file name.
-
-

knife.rb Settings

-
-

Note

-

See knife.rb for more information about how to add optional settings to the knife.rb file.

-
-

The following knife client reregister settings can be added to the knife.rb file:

-
-
knife[:file]
-
Use to add the --file option.
-
-
-
-

Examples

+
+

Examples

The following examples show how to use this Knife subcommand:

-

xxxxx

+

Reregister clients

To regenerate the RSA key pair for a client named “testclient” and save it to a file named “rsa_key”, enter:

$ knife client regenerate testclient -f rsa_key
@@ -326,25 +227,25 @@ server correctly, try getting a list of clients using

show

The show argument is used to show the details of an API client.

-
-

Syntax

+
+

Syntax

This argument has the following syntax:

$ knife client show CLIENT_NAME (options)
-
-

Options

+
+

Options

This argument has the following options:

-a ATTR, --attribute ATTR
The attribute (or attributes) to show.
-
-

Examples

+
+

Examples

The following examples show how to use this Knife subcommand:

-

xxxxx

+

Show clients

To view a client named “testclient”, enter:

$ knife client show testclient
@@ -368,78 +269,14 @@ public_key:
-
-
-
-
-
-

Navigation

- -
- -
- Documentation for current man pages for Knife. - -  Send feedback to docs@getchef.com. - This work is licensed under a Creative Commons Attribution 3.0 Unported License. +
+ +
- - - - - - - - diff --git a/distro/common/html/knife_common_options.html b/distro/common/html/knife_common_options.html index 4b6c8f6c33..694e49112b 100644 --- a/distro/common/html/knife_common_options.html +++ b/distro/common/html/knife_common_options.html @@ -1,5 +1,4 @@ - @@ -8,9 +7,9 @@ - Common Options — Knife Man Pages + Common Options — chef-client Man Pages - + - + +
Chef
-
-

Navigation

- -
-
-
- -
-
+
-
+
@@ -102,78 +84,14 @@
-
+
+ +
-
-

Navigation

- -
- -
- Documentation for current man pages for Knife. - -  Send feedback to docs@getchef.com. - This work is licensed under a Creative Commons Attribution 3.0 Unported License. - -
- - - - - - - - - diff --git a/distro/common/html/knife_configure.html b/distro/common/html/knife_configure.html index 4d10066b48..08ea58b4e0 100644 --- a/distro/common/html/knife_configure.html +++ b/distro/common/html/knife_configure.html @@ -1,5 +1,4 @@ - @@ -8,9 +7,9 @@ - knife configure — Knife Man Pages + knife configure — chef-client Man Pages - + - + +
Chef
-
-

Navigation

- -
-
-
- -

Table Of Contents

- - -
-
+
-
+
@@ -107,34 +76,6 @@
--validation-key PATH
The path to the validation key used by the client, typically a file named validation.pem.
-
-

knife.rb Settings

-
-

Note

-

See knife.rb for more information about how to add optional settings to the knife.rb file.

-
-

The following knife configure settings can be added to the knife.rb file:

-
-
knife[:admin_client_name]
-
Use for the name of the admin client that is passed as part of a the command itself.
-
knife[:config_file]
-
Use to add the --config option.
-
knife[:disable_editing]
-
Use to add the --disable-editing option.
-
knife[:file]
-
Use to add the --file option.
-
knife[:initial]
-
Use to add the --initial option.
-
knife[:repository]
-
Use to add the --repository option.
-
knife[:user_home]
-
Use to add the --user option.
-
knife[:user_password]
-
Use to add the --password option.
-
knife[:yes]
-
Use to add the --yes option.
-
-

Examples

@@ -152,78 +93,14 @@
-
+
+ +
-
-

Navigation

- -
-
- Documentation for current man pages for Knife. - -  Send feedback to docs@getchef.com. - This work is licensed under a Creative Commons Attribution 3.0 Unported License. - -
- - - - - - - - - - diff --git a/distro/common/html/knife_cookbook.html b/distro/common/html/knife_cookbook.html index 28afbf0eed..0568be98bb 100644 --- a/distro/common/html/knife_cookbook.html +++ b/distro/common/html/knife_cookbook.html @@ -1,5 +1,4 @@ - @@ -8,9 +7,9 @@ - knife cookbook — Knife Man Pages + knife cookbook — chef-client Man Pages - + - + +
Chef
-
-

Navigation

- -
- -
-
- -

Table Of Contents

- -
-
+
-
+
@@ -189,20 +77,6 @@
-p, --purge
Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.
-
-

knife.rb Settings

-
-

Note

-

See knife.rb for more information about how to add optional settings to the knife.rb file.

-
-

The following knife cookbook bulk delete settings can be added to the knife.rb file:

-
-
knife[:purge]
-
Use to add the --purge option.
-
knife[:yes]
-
Use to add the --yes option.
-
-

Examples

@@ -255,21 +129,9 @@
-r FORMAT, --readme-format FORMAT
The document format of the readme file: md (markdown) and rdoc (Ruby docs).
-
-

knife.rb Settings

-
-

Note

-

See knife.rb for more information about how to add optional settings to the knife.rb file.

-
-

The following knife cookbook create settings can be added to the knife.rb file:

-
-
knife[:readme_format]
-
Use to add the --readme-format option.
-
-
-
-

Examples

+
+

Examples

The following examples show how to use this Knife subcommand:

Create a cookbook

To create a cookbook named “my_cookbook” with copyright, email, license, and readme format options specified, enter:

@@ -287,15 +149,15 @@

delete

The delete argument is used to delete a specified cookbook or cookbook version on the server (and not locally).

-
-

Syntax

+
+

Syntax

This argument has the following syntax:

$ knife cookbook delete COOKBOOK_NAME [COOKBOOK_VERSION] (options)
-
-

Options

+
+

Options

This argument has the following options:

-a, --all
@@ -305,25 +167,9 @@
-p, --purge
Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.
-
-

knife.rb Settings

-
-

Note

-

See knife.rb for more information about how to add optional settings to the knife.rb file.

-
-

The following knife cookbook delete settings can be added to the knife.rb file:

-
-
knife[:all]
-
Use to add the --all option.
-
knife[:print_after]
-
Use to add the --print-after option.
-
knife[:purge]
-
Use to add the --purge option.
-
-
-
-

Examples

+
+

Examples

The following examples show how to use this Knife subcommand:

Delete a cookbook

$ knife cookbook delete cookbook_name version
@@ -339,15 +185,15 @@
 

 
download

 
The download argument is used to download a cookbook from the server to the current working directory.

-

-
Syntax

+

+
Syntax

 
This argument has the following syntax:

 
$ knife cookbook download COOKBOOK_NAME [COOKBOOK_VERSION] (options)
 

 

 

-

-
Options

+

+
Options

 
This argument has the following options:

 

 
-d DOWNLOAD_DIRECTORY, --dir DOWNLOAD_DIRECTORY

@@ -357,25 +203,9 @@
 
-N, --latest

 
Indicates that the most recent version of a cookbook will be downloaded.

 

-

-
knife.rb Settings

-

-
Note

-
See knife.rb for more information about how to add optional settings to the knife.rb file.

-

-
The following knife cookbook download settings can be added to the knife.rb file:

-

-
knife[:download_directory]

-
Use to add the --dir option.

-
knife[:force]

-
Use to add the --force option.

-
knife[:latest]

-
Use to add the --latest option.

-

-

 

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
Download a cookbook

 
To download a cookbook named “smartmon”, enter:

@@ -387,15 +217,15 @@
 

 
list

 
The list argument is used to view a list of cookbooks that are currently available on the server. The list will contain only the most recent version for each cookbook by default.

-

-
Syntax

+

+
Syntax

 
This argument has the following syntax:

 
$ knife cookbook list (options)
 

 

 

-

-
Options

+

+
Options

 
This argument has the following options:

 

 
-a, --all

@@ -403,23 +233,9 @@
 
-w, --with-uri

 
Indicates that the corresponding URIs will be shown.

 

-

-
knife.rb Settings

-

-
Note

-
See knife.rb for more information about how to add optional settings to the knife.rb file.

-

-
The following knife cookbook list settings can be added to the knife.rb file:

-

-
knife[:all]

-
Use to add the --all option.

-
knife[:environment]

-
Use to add the --environment option.

-

-

 

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
View a list of cookbooks

 
To view a list of cookbooks:

@@ -431,15 +247,15 @@
 

 
metadata

 
The metadata argument is used to generate the metadata for one or more cookbooks.

-

-
Syntax

+

+
Syntax

 
This argument has the following syntax:

 
$ knife cookbook metadata (options)
 

 

 

-

-
Options

+

+
Options

 
This argument has the following options:

 

 
-a, --all

@@ -447,21 +263,9 @@
 
-o PATH:PATH, --cookbook-path PATH:PATH

 
The directory in which cookbook are created. This can be a colon-separated path.

 

-

-
knife.rb Settings

-

-
Note

-
See knife.rb for more information about how to add optional settings to the knife.rb file.

-

-
The following knife cookbook metadata settings can be added to the knife.rb file:

-

-
knife[:all]

-
Use to add the --all option.

-

 

-

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
Generate metadata

 
$ knife cookbook metadata -a
@@ -472,19 +276,19 @@
 

 
metadata from file

 
The metadata from file argument is used to load the metadata for a cookbook from a file.

-

-
Syntax

+

+
Syntax

 
This argument has the following syntax:

 
$ knife cookbook metadata from file FILE
 

 

 

-

-
Options

+

+
Options

 
This command does not have any specific options.

 

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
View metadata

 
$ knife cookbook metadta from file /path/to/file
@@ -495,15 +299,15 @@
 

 
show

 
The show argument is used to view information about a cookbook, parts of a cookbook (attributes, definitions, files, libraries, providers, recipes, resources, and templates), or a file that is associated with a cookbook (including attributes such as checksum or specificity).

-

-
Syntax

+

+
Syntax

 
This argument has the following syntax:

 
$ knife cookbook show COOKBOOK_NAME [COOKBOOK_VERSION] [PART...] [FILE_NAME] (options)
 

 

 

-

-
Options

+

+
Options

 
This argument has the following options:

 

 
COOKBOOK_VERSION

@@ -521,25 +325,9 @@
 
-w, --with-uri

 
Indicates that the corresponding URIs will be shown.

 

-

-
knife.rb Settings

-

-
Note

-
See knife.rb for more information about how to add optional settings to the knife.rb file.

 

-
The following knife cookbook show settings can be added to the knife.rb file:

-

-
knife[:fqdn]

-
Use to add the --fqdn option.

-
knife[:platform]

-
Use to add the --platform option.

-
knife[:platform_version]

-
Use to add the --platform-version option.

-

-

-

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
Show cookbook data

 
To get the list of available versions of a cookbook named “getting-started”, enter:

@@ -595,15 +383,15 @@ url:          https://someurlhere.com
 

 
test

 
The test argument is used to test a cookbook for syntax errors. This argument uses Ruby syntax checking to verify every file in a cookbook that ends in .rb and Embedded Ruby (ERB).

-

-
Syntax

+

+
Syntax

 
This argument has the following syntax:

 
$ knife cookbook test COOKBOOK_NAME (options)
 

 

 

-

-
Options

+

+
Options

 
This argument has the following options:

 

 
-a, --all

@@ -611,21 +399,9 @@ url:          https://someurlhere.com
 
-o PATH:PATH, --cookbook-path PATH:PATH

 
The directory in which cookbook are created. This can be a colon-separated path.

 

-

-
knife.rb Settings

-

-
Note

-
See knife.rb for more information about how to add optional settings to the knife.rb file.

-

-
The following knife cookbook test settings can be added to the knife.rb file:

-

-
knife[:all]

-
Use to add the --all option.

-

-

 

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
Test a cookbook

 
$ knife cookbook test cookbook_name
@@ -640,15 +416,15 @@ url:          https://someurlhere.com
 
Note

 
Use a chefignore file to prevent the upload of specific files and file types, such as temporary files or files placed in folders by version control systems. The chefignore file must be located in the root of the cookbook repository and must use rules similar to filename globbing (as defined by the Ruby File.fnmatch syntax).

 

-

-
Syntax

+

+
Syntax

 
This argument has the following syntax:

 
$ knife cookbook upload [COOKBOOK_NAME...] (options)
 

 

 

-

-
Options

+

+
Options

 
This argument has the following options:

 

 
-a, --all

@@ -662,29 +438,9 @@ url:          https://someurlhere.com
 
-o PATH:PATH, --cookbook-path PATH:PATH

 
The directory in which cookbook are created. This can be a colon-separated path.

 

-

-
knife.rb Settings

-

-
Note

-
See knife.rb for more information about how to add optional settings to the knife.rb file.

-

-
The following knife cookbook upload settings can be added to the knife.rb file:

-

-
knife[:all]

-
Use to add the --all option.

-
knife[:depends]

-
Use to add the --include-dependencies option.

-
knife[:environment]

-
Use to add the --environment option.

-
knife[:force]

-
Use to add the --force option.

-
knife[:freeze]

-
Use to add the --freeze option.

-

-

 

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
Upload a cookbook

 
$ knife cookbook upload cookbook_name
@@ -711,78 +467,14 @@ ERROR: Version 0.1.6 of cookbook redis is frozen. Use --force to override.
 
 
           

-        

-      

-      

-    

-    

-      
Navigation

-      
-    

-
 
-    

-      Documentation for current man pages for Knife.
-
-     Send feedback to docs@getchef.com.
-       This work is licensed under a Creative Commons Attribution 3.0 Unported License. 
+      

 
+  
+      

     

 
-
-
-
-
-
 
-
-
-
 
 
   
diff --git a/distro/common/html/knife_cookbook_site.html b/distro/common/html/knife_cookbook_site.html
index 6ffe8ef2fe..4d34dcc998 100644
--- a/distro/common/html/knife_cookbook_site.html
+++ b/distro/common/html/knife_cookbook_site.html
@@ -1,5 +1,4 @@
 
-
 
 
@@ -8,9 +7,9 @@
   
     
     
-    knife cookbook site — Knife Man Pages
+    knife cookbook site — chef-client Man Pages
     
-    
+    
     
     
     
     
     
-     
+
+
   
   
 

 Chef
 

 
-    

-      
Navigation

-      
-    

 
-      

-        

-            
-  
Table Of Contents

-  
-
-        

-      

+  
 
     

       

-        

+
           

             
   

@@ -144,20 +68,6 @@
 
-f, --force

 
Indicates that an existing directory will be overwritten.

 
-

-
knife.rb Settings

-

-
Note

-
See knife.rb for more information about how to add optional settings to the knife.rb file.

-

-
The following knife cookbook site download settings can be added to the knife.rb file:

-

-
knife[:file]

-
Use to add the --file option.

-
knife[:force]

-
Use to add the --force option.

-

-

 

 

 
Examples

@@ -210,27 +120,9 @@ Cookbook saved: /Users/sdanna/opscodesupport/getting-started-0.3.0.tar.gz
 
-o PATH:PATH, --cookbook-path PATH:PATH

 
The directory in which cookbook are created. This can be a colon-separated path.

 
-

-
knife.rb Settings

-

-
Note

-
See knife.rb for more information about how to add optional settings to the knife.rb file.

-

-
The following knife cookbook site install settings can be added to the knife.rb file:

-

-
knife[:cookbook_path]

-
Use to add the --cookbook-path option.

-
knife[:file]

-
Use to add the --file option.

-
knife[:no_deps]

-
Use to add the --skip-dependencies option.

-
knife[:use_current_branch]

-
Use to add the --use-current-branch option.

-

-

 

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
Install a cookbook

 
To install the cookbook “getting-started”, enter:

@@ -273,23 +165,23 @@ Cookbook getting-started version 0.3.0 successfully installed
 

 
list

 
The list argument is used to view a list of cookbooks that are currently available at https://cookbooks.opscode.com.

-

-
Syntax

+

+
Syntax

 
This argument has the following syntax:

 
$ knife cookbook site list
 

 

 

-

-
Options

+

+
Options

 
This argument has the following options:

 

 
-w, --with-uri

 
Indicates that the corresponding URIs will be shown.

 

 

-

-
Examples

+

+
Examples

 
The following examples show how to use this Knife subcommand:

 
View a list of cookbooks

 
To view a list of cookbooks at https://cookbooks.opscode.com server, enter:

@@ -314,19 +206,19 @@ ant                   iis                   redmine