chef 11.18.12 → 12.0.0.alpha.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CONTRIBUTING.md +10 -0
- data/README.md +1 -1
- data/distro/common/html/_sources/index.txt +5 -2
- data/distro/common/html/_sources/knife_serve.txt +19 -0
- data/distro/common/html/_sources/knife_ssl_check.txt +2 -2
- data/distro/common/html/_sources/knife_ssl_fetch.txt +2 -2
- data/distro/common/html/_static/basic.css +1 -1
- data/distro/common/html/_static/doctools.js +1 -1
- data/distro/common/html/_static/searchtools.js +1 -1
- data/distro/common/html/_static/websupport.js +1 -1
- data/distro/common/html/ctl_chef_client.html +19 -9
- data/distro/common/html/ctl_chef_server.html +7 -1
- data/distro/common/html/ctl_chef_shell.html +3 -4
- data/distro/common/html/ctl_chef_solo.html +12 -7
- data/distro/common/html/index.html +19 -12
- data/distro/common/html/knife.html +1 -2
- data/distro/common/html/knife_bootstrap.html +16 -5
- data/distro/common/html/knife_client.html +8 -5
- data/distro/common/html/knife_common_options.html +11 -12
- data/distro/common/html/knife_configure.html +2 -3
- data/distro/common/html/knife_cookbook.html +16 -17
- data/distro/common/html/knife_cookbook_site.html +19 -18
- data/distro/common/html/knife_data_bag.html +6 -7
- data/distro/common/html/knife_delete.html +2 -3
- data/distro/common/html/knife_deps.html +2 -3
- data/distro/common/html/knife_diff.html +3 -4
- data/distro/common/html/knife_download.html +6 -7
- data/distro/common/html/knife_edit.html +0 -1
- data/distro/common/html/knife_environment.html +3 -4
- data/distro/common/html/knife_exec.html +0 -1
- data/distro/common/html/knife_index_rebuild.html +0 -1
- data/distro/common/html/knife_list.html +5 -6
- data/distro/common/html/knife_node.html +13 -6
- data/distro/common/html/knife_raw.html +0 -1
- data/distro/common/html/knife_recipe_list.html +0 -1
- data/distro/common/html/knife_role.html +1 -2
- data/distro/common/html/knife_search.html +2 -3
- data/distro/common/html/knife_serve.html +79 -0
- data/distro/common/html/knife_show.html +1 -2
- data/distro/common/html/knife_ssh.html +2 -3
- data/distro/common/html/knife_ssl_check.html +12 -9
- data/distro/common/html/knife_ssl_fetch.html +9 -10
- data/distro/common/html/knife_status.html +2 -3
- data/distro/common/html/knife_tag.html +0 -1
- data/distro/common/html/knife_upload.html +3 -4
- data/distro/common/html/knife_user.html +2 -3
- data/distro/common/html/knife_using.html +0 -1
- data/distro/common/html/knife_xargs.html +3 -4
- data/distro/common/html/search.html +0 -1
- data/distro/common/html/searchindex.js +1 -1
- data/lib/chef/api_client.rb +1 -1
- data/lib/chef/application.rb +24 -67
- data/lib/chef/application/client.rb +1 -1
- data/lib/chef/application/knife.rb +1 -1
- data/lib/chef/chef_fs/chef_fs_data_store.rb +2 -3
- data/lib/chef/chef_fs/command_line.rb +2 -3
- data/lib/chef/chef_fs/data_handler/group_data_handler.rb +1 -5
- data/lib/chef/chef_fs/file_system/acl_entry.rb +1 -2
- data/lib/chef/chef_fs/file_system/chef_repository_file_system_entry.rb +1 -2
- data/lib/chef/chef_fs/file_system/cookbooks_dir.rb +2 -2
- data/lib/chef/chef_fs/file_system/rest_list_dir.rb +2 -3
- data/lib/chef/chef_fs/file_system/rest_list_entry.rb +4 -5
- data/lib/chef/config.rb +26 -2
- data/lib/chef/config_fetcher.rb +1 -1
- data/lib/chef/cookbook/cookbook_version_loader.rb +4 -4
- data/lib/chef/cookbook/metadata.rb +1 -1
- data/lib/chef/cookbook/synchronizer.rb +50 -8
- data/lib/chef/cookbook_uploader.rb +9 -23
- data/lib/chef/cookbook_version.rb +3 -2
- data/lib/chef/data_bag.rb +1 -1
- data/lib/chef/data_bag_item.rb +1 -1
- data/lib/chef/dsl/recipe.rb +1 -14
- data/lib/chef/encrypted_data_bag_item/decryptor.rb +3 -3
- data/lib/chef/environment.rb +1 -1
- data/lib/chef/exceptions.rb +2 -24
- data/lib/chef/file_content_management/tempfile.rb +8 -1
- data/lib/chef/formatters/base.rb +0 -7
- data/lib/chef/http.rb +12 -19
- data/lib/chef/http/json_input.rb +12 -1
- data/lib/chef/json_compat.rb +45 -64
- data/lib/chef/knife.rb +2 -5
- data/lib/chef/knife/bootstrap.rb +2 -2
- data/lib/chef/knife/bootstrap/archlinux-gems.erb +2 -2
- data/lib/chef/knife/bootstrap/centos5-gems.erb +2 -2
- data/lib/chef/knife/bootstrap/chef-aix.erb +2 -2
- data/lib/chef/knife/bootstrap/chef-full.erb +2 -2
- data/lib/chef/knife/bootstrap/fedora13-gems.erb +2 -2
- data/lib/chef/knife/bootstrap/ubuntu10.04-apt.erb +2 -2
- data/lib/chef/knife/bootstrap/ubuntu10.04-gems.erb +2 -2
- data/lib/chef/knife/bootstrap/ubuntu12.04-gems.erb +2 -2
- data/lib/chef/knife/cookbook_site_download.rb +1 -1
- data/lib/chef/knife/cookbook_site_install.rb +10 -34
- data/lib/chef/knife/cookbook_site_list.rb +1 -1
- data/lib/chef/knife/cookbook_site_search.rb +1 -1
- data/lib/chef/knife/cookbook_site_share.rb +3 -3
- data/lib/chef/knife/cookbook_site_show.rb +3 -3
- data/lib/chef/knife/cookbook_site_unshare.rb +1 -1
- data/lib/chef/knife/cookbook_upload.rb +1 -1
- data/lib/chef/knife/core/subcommand_loader.rb +0 -24
- data/lib/chef/knife/core/ui.rb +8 -7
- data/lib/chef/knife/deps.rb +2 -3
- data/lib/chef/knife/serve.rb +2 -1
- data/lib/chef/local_mode.rb +105 -0
- data/lib/chef/mixin/file_class.rb +1 -4
- data/lib/chef/mixin/shell_out.rb +15 -0
- data/lib/chef/mixin/windows_architecture_helper.rb +0 -16
- data/lib/chef/node.rb +1 -1
- data/lib/chef/platform/query_helpers.rb +1 -5
- data/lib/chef/policy_builder/expand_node_object.rb +3 -0
- data/lib/chef/provider.rb +2 -0
- data/lib/chef/provider/cookbook_file.rb +0 -1
- data/lib/chef/provider/deploy.rb +0 -1
- data/lib/chef/provider/deploy/revision.rb +1 -1
- data/lib/chef/provider/env.rb +10 -25
- data/lib/chef/provider/env/windows.rb +23 -10
- data/lib/chef/provider/execute.rb +0 -3
- data/lib/chef/provider/file.rb +0 -3
- data/lib/chef/provider/git.rb +0 -6
- data/lib/chef/provider/group/dscl.rb +9 -27
- data/lib/chef/provider/group/gpasswd.rb +0 -3
- data/lib/chef/provider/group/groupmod.rb +0 -4
- data/lib/chef/provider/group/suse.rb +0 -3
- data/lib/chef/provider/group/usermod.rb +0 -3
- data/lib/chef/provider/link.rb +22 -5
- data/lib/chef/provider/log.rb +15 -4
- data/lib/chef/provider/mdadm.rb +0 -3
- data/lib/chef/provider/mount/mount.rb +0 -2
- data/lib/chef/provider/mount/solaris.rb +0 -2
- data/lib/chef/provider/package.rb +0 -1
- data/lib/chef/provider/package/apt.rb +0 -3
- data/lib/chef/provider/package/dpkg.rb +0 -1
- data/lib/chef/provider/package/easy_install.rb +0 -4
- data/lib/chef/provider/package/freebsd/base.rb +0 -3
- data/lib/chef/provider/package/freebsd/pkgng.rb +0 -2
- data/lib/chef/provider/package/freebsd/port.rb +0 -2
- data/lib/chef/provider/package/ips.rb +0 -3
- data/lib/chef/provider/package/paludis.rb +0 -5
- data/lib/chef/provider/package/portage.rb +0 -2
- data/lib/chef/provider/package/rpm.rb +2 -4
- data/lib/chef/provider/package/rubygems.rb +0 -4
- data/lib/chef/provider/package/smartos.rb +0 -3
- data/lib/chef/provider/package/windows/msi.rb +0 -2
- data/lib/chef/provider/package/yum.rb +0 -4
- data/lib/chef/provider/package/zypper.rb +0 -3
- data/lib/chef/provider/registry_key.rb +0 -2
- data/lib/chef/provider/remote_directory.rb +0 -1
- data/lib/chef/provider/remote_file.rb +0 -1
- data/lib/chef/provider/remote_file/cache_control_data.rb +1 -3
- data/lib/chef/provider/remote_file/content.rb +0 -1
- data/lib/chef/provider/remote_file/fetcher.rb +0 -2
- data/lib/chef/provider/remote_file/ftp.rb +0 -1
- data/lib/chef/provider/resource_update.rb +0 -3
- data/lib/chef/provider/service/freebsd.rb +0 -3
- data/lib/chef/provider/service/init.rb +0 -3
- data/lib/chef/provider/service/macosx.rb +0 -1
- data/lib/chef/provider/service/redhat.rb +0 -2
- data/lib/chef/provider/service/simple.rb +0 -3
- data/lib/chef/provider/service/solaris.rb +0 -3
- data/lib/chef/provider/service/systemd.rb +15 -14
- data/lib/chef/provider/service/windows.rb +0 -3
- data/lib/chef/provider/subversion.rb +0 -2
- data/lib/chef/provider/template.rb +0 -2
- data/lib/chef/provider/template/content.rb +0 -1
- data/lib/chef/provider/user/dscl.rb +156 -549
- data/lib/chef/provider/user/solaris.rb +0 -1
- data/lib/chef/provider/user/useradd.rb +0 -3
- data/lib/chef/provider/whyrun_safe_ruby_block.rb +1 -1
- data/lib/chef/providers.rb +0 -1
- data/lib/chef/resource.rb +1 -4
- data/lib/chef/resource/freebsd_package.rb +2 -10
- data/lib/chef/resource/lwrp_base.rb +1 -12
- data/lib/chef/resource/user.rb +0 -18
- data/lib/chef/resource_collection.rb +1 -1
- data/lib/chef/resource_reporter.rb +10 -10
- data/lib/chef/resources.rb +0 -1
- data/lib/chef/role.rb +3 -3
- data/lib/chef/run_list.rb +1 -1
- data/lib/chef/tasks/chef_repo.rake +131 -264
- data/lib/chef/user.rb +1 -1
- data/lib/chef/util/path_helper.rb +2 -2
- data/lib/chef/version.rb +9 -1
- data/lib/chef/win32/api/system.rb +0 -9
- data/spec/data/bootstrap/test-hints.erb +1 -1
- data/spec/data/bootstrap/test.erb +1 -1
- data/spec/functional/dsl/reboot_pending_spec.rb +53 -58
- data/spec/functional/knife/cookbook_delete_spec.rb +3 -3
- data/spec/functional/knife/exec_spec.rb +1 -1
- data/spec/functional/mixin/shell_out_spec.rb +48 -0
- data/spec/functional/resource/base.rb +0 -10
- data/spec/functional/resource/group_spec.rb +1 -5
- data/spec/functional/resource/link_spec.rb +8 -0
- data/spec/functional/resource/{user/useradd_spec.rb → user_spec.rb} +1 -1
- data/spec/integration/knife/chef_fs_data_store_spec.rb +3 -3
- data/spec/integration/knife/chef_repo_path_spec.rb +1 -6
- data/spec/integration/knife/chef_repository_file_system_spec.rb +1 -1
- data/spec/integration/knife/chefignore_spec.rb +1 -1
- data/spec/integration/knife/common_options_spec.rb +50 -3
- data/spec/integration/knife/cookbook_api_ipv6_spec.rb +1 -1
- data/spec/integration/knife/delete_spec.rb +1 -1
- data/spec/integration/knife/deps_spec.rb +1 -1
- data/spec/integration/knife/diff_spec.rb +3 -3
- data/spec/integration/knife/download_spec.rb +3 -3
- data/spec/integration/knife/list_spec.rb +1 -1
- data/spec/integration/knife/raw_spec.rb +1 -11
- data/spec/integration/knife/redirection_spec.rb +1 -1
- data/spec/integration/knife/serve_spec.rb +2 -2
- data/spec/integration/knife/show_spec.rb +1 -1
- data/spec/integration/knife/upload_spec.rb +9 -9
- data/spec/spec_helper.rb +0 -9
- data/spec/support/pedant/pedant_config.rb +2 -1
- data/spec/support/pedant/run_pedant.rb +2 -1
- data/spec/support/platform_helpers.rb +5 -24
- data/spec/support/shared/integration/integration_helper.rb +2 -1
- data/spec/support/shared/matchers.rb +17 -0
- data/spec/tiny_server.rb +1 -2
- data/spec/unit/api_client_spec.rb +3 -3
- data/spec/unit/application_spec.rb +9 -32
- data/spec/unit/config_fetcher_spec.rb +1 -1
- data/spec/unit/cookbook/metadata_spec.rb +3 -7
- data/spec/unit/cookbook/synchronizer_spec.rb +441 -226
- data/spec/unit/cookbook_loader_spec.rb +1 -1
- data/spec/unit/cookbook_uploader_spec.rb +160 -0
- data/spec/unit/cookbook_version_spec.rb +0 -4
- data/spec/unit/data_bag_item_spec.rb +1 -5
- data/spec/unit/data_bag_spec.rb +1 -5
- data/spec/unit/deprecation_spec.rb +1 -1
- data/spec/unit/dsl/recipe_spec.rb +12 -0
- data/spec/unit/encrypted_data_bag_item_spec.rb +7 -14
- data/spec/unit/environment_spec.rb +3 -7
- data/spec/unit/exceptions_spec.rb +0 -6
- data/spec/unit/http/json_input_spec.rb +128 -0
- data/spec/unit/json_compat_spec.rb +17 -58
- data/spec/unit/knife/client_create_spec.rb +3 -3
- data/spec/unit/knife/configure_client_spec.rb +6 -5
- data/spec/unit/knife/cookbook_delete_spec.rb +1 -1
- data/spec/unit/knife/cookbook_download_spec.rb +5 -5
- data/spec/unit/knife/cookbook_metadata_from_file_spec.rb +1 -0
- data/spec/unit/knife/cookbook_metadata_spec.rb +1 -1
- data/spec/unit/knife/cookbook_site_download_spec.rb +10 -11
- data/spec/unit/knife/cookbook_site_install_spec.rb +116 -161
- data/spec/unit/knife/cookbook_site_share_spec.rb +8 -8
- data/spec/unit/knife/cookbook_upload_spec.rb +3 -2
- data/spec/unit/knife/core/bootstrap_context_spec.rb +3 -3
- data/spec/unit/knife/core/subcommand_loader_spec.rb +1 -66
- data/spec/unit/knife/data_bag_from_file_spec.rb +2 -1
- data/spec/unit/knife/tag_create_spec.rb +3 -3
- data/spec/unit/knife/tag_delete_spec.rb +3 -3
- data/spec/unit/knife/user_create_spec.rb +1 -1
- data/spec/unit/knife_spec.rb +14 -14
- data/spec/unit/lwrp_spec.rb +1 -21
- data/spec/unit/mixin/shell_out_spec.rb +92 -0
- data/spec/unit/node_spec.rb +0 -4
- data/spec/unit/platform/query_helpers_spec.rb +0 -23
- data/spec/unit/provider/env/windows_spec.rb +34 -70
- data/spec/unit/provider/env_spec.rb +11 -76
- data/spec/unit/provider/group/dscl_spec.rb +1 -38
- data/spec/unit/provider/log_spec.rb +18 -0
- data/spec/unit/provider/package/rpm_spec.rb +0 -12
- data/spec/unit/provider/remote_file/cache_control_data_spec.rb +1 -1
- data/spec/unit/provider/service/systemd_service_spec.rb +44 -27
- data/spec/unit/provider/user/dscl_spec.rb +264 -660
- data/spec/unit/provider/user/useradd_spec.rb +0 -1
- data/spec/unit/provider/whyrun_safe_ruby_block_spec.rb +2 -2
- data/spec/unit/provider_spec.rb +12 -0
- data/spec/unit/recipe_spec.rb +0 -41
- data/spec/unit/resource_collection_spec.rb +1 -5
- data/spec/unit/resource_reporter_spec.rb +3 -51
- data/spec/unit/resource_spec.rb +3 -14
- data/spec/unit/rest_spec.rb +1 -4
- data/spec/unit/role_spec.rb +0 -10
- data/spec/unit/run_list_spec.rb +1 -5
- data/spec/unit/user_spec.rb +1 -5
- metadata +20 -100
- data/lib/chef/mixin/windows_env_helper.rb +0 -56
- data/lib/chef/provider/dsc_script.rb +0 -175
- data/lib/chef/resource/dsc_script.rb +0 -126
- data/lib/chef/streaming_cookbook_uploader.rb +0 -205
- data/lib/chef/util/dsc/configuration_generator.rb +0 -115
- data/lib/chef/util/dsc/lcm_output_parser.rb +0 -133
- data/lib/chef/util/dsc/local_configuration_manager.rb +0 -141
- data/lib/chef/util/dsc/resource_info.rb +0 -26
- data/lib/chef/util/powershell/cmdlet.rb +0 -136
- data/lib/chef/util/powershell/cmdlet_result.rb +0 -46
- data/spec/data/mac_users/10.7-8.plist.xml +0 -559
- data/spec/data/mac_users/10.7-8.shadow.xml +0 -11
- data/spec/data/mac_users/10.7.plist.xml +0 -559
- data/spec/data/mac_users/10.7.shadow.xml +0 -11
- data/spec/data/mac_users/10.8.plist.xml +0 -559
- data/spec/data/mac_users/10.8.shadow.xml +0 -21
- data/spec/data/mac_users/10.9.plist.xml +0 -560
- data/spec/data/mac_users/10.9.shadow.xml +0 -21
- data/spec/functional/provider/whyrun_safe_ruby_block_spec.rb +0 -51
- data/spec/functional/resource/dsc_script_spec.rb +0 -382
- data/spec/functional/resource/env_spec.rb +0 -182
- data/spec/functional/resource/user/dscl_spec.rb +0 -199
- data/spec/functional/util/powershell/cmdlet_spec.rb +0 -113
- data/spec/support/lib/chef/resource/zen_follower.rb +0 -46
- data/spec/support/shared/shared_examples.rb +0 -10
- data/spec/unit/chef_fs/data_handler/group_handler_spec.rb +0 -63
- data/spec/unit/formatters/base_spec.rb +0 -48
- data/spec/unit/provider/dsc_script_spec.rb +0 -174
- data/spec/unit/resource/dsc_script_spec.rb +0 -98
- data/spec/unit/util/dsc/configuration_generator_spec.rb +0 -171
- data/spec/unit/util/dsc/lcm_output_parser_spec.rb +0 -169
- data/spec/unit/util/dsc/local_configuration_manager_spec.rb +0 -139
- data/spec/unit/util/powershell/cmdlet_spec.rb +0 -106
@@ -23,7 +23,6 @@
|
|
23
23
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
24
24
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
25
25
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
26
|
-
<link rel="shortcut icon" href="_static/chef.ico"/>
|
27
26
|
|
28
27
|
|
29
28
|
</head>
|
@@ -64,7 +63,13 @@
|
|
64
63
|
<p>This subcommand has the following options:</p>
|
65
64
|
<dl class="docutils">
|
66
65
|
<dt><tt class="docutils literal"><span class="pre">-A</span></tt>, <tt class="docutils literal"><span class="pre">--forward-agent</span></tt></dt>
|
67
|
-
<dd>
|
66
|
+
<dd>Use to enable SSH agent forwarding.</dd>
|
67
|
+
<dt><tt class="docutils literal"><span class="pre">--bootstrap-curl-options</span> <span class="pre">OPTIONS</span></tt></dt>
|
68
|
+
<dd>Use to specify arbitrary options to be added to the bootstrap command when using cURL. This option may not be used in the same command with <tt class="docutils literal"><span class="pre">--bootstrap-install-command</span></tt>.</dd>
|
69
|
+
<dt><tt class="docutils literal"><span class="pre">--bootstrap-install-command</span> <span class="pre">COMMAND</span></tt></dt>
|
70
|
+
<dd>Use to execute a custom installation command sequence for the chef-client. This option may not be used in the same command with <tt class="docutils literal"><span class="pre">--bootstrap-curl-options</span></tt>, <tt class="docutils literal"><span class="pre">--bootstrap-install-sh</span></tt>, or <tt class="docutils literal"><span class="pre">--bootstrap-wget-options</span></tt>.</dd>
|
71
|
+
<dt><tt class="docutils literal"><span class="pre">--bootstrap-install-sh</span> <span class="pre">URL</span></tt></dt>
|
72
|
+
<dd>Use to fetch and execute an installation script at the specified URL. This option may not be used in the same command with <tt class="docutils literal"><span class="pre">--bootstrap-install-command</span></tt>.</dd>
|
68
73
|
<dt><tt class="docutils literal"><span class="pre">--bootstrap-no-proxy</span> <span class="pre">NO_PROXY_URL_or_IP</span></tt></dt>
|
69
74
|
<dd><p class="first">A URL or IP address that specifies a location that should not be proxied.</p>
|
70
75
|
<div class="last admonition note">
|
@@ -76,6 +81,8 @@
|
|
76
81
|
<dd>The proxy server for the node that is the target of a bootstrap operation.</dd>
|
77
82
|
<dt><tt class="docutils literal"><span class="pre">--bootstrap-version</span> <span class="pre">VERSION</span></tt></dt>
|
78
83
|
<dd>The version of the chef-client to install.</dd>
|
84
|
+
<dt><tt class="docutils literal"><span class="pre">--bootstrap-wget-options</span> <span class="pre">OPTIONS</span></tt></dt>
|
85
|
+
<dd>Use to specify arbitrary options to be added to the bootstrap command when using GNU Wget. This option may not be used in the same command with <tt class="docutils literal"><span class="pre">--bootstrap-install-command</span></tt>.</dd>
|
79
86
|
<dt><tt class="docutils literal"><span class="pre">-d</span> <span class="pre">DISTRO</span></tt>, <tt class="docutils literal"><span class="pre">--distro</span> <span class="pre">DISTRO</span></tt></dt>
|
80
87
|
<dd><p class="first">The template file to be used during a bootstrap operation. The following distributions are supported: <tt class="docutils literal"><span class="pre">chef-full</span></tt> (the default bootstrap), <tt class="docutils literal"><span class="pre">centos5-gems</span></tt>, <tt class="docutils literal"><span class="pre">fedora13-gems</span></tt>, <tt class="docutils literal"><span class="pre">ubuntu10.04-gems</span></tt>, <tt class="docutils literal"><span class="pre">ubuntu10.04-apt</span></tt>, <tt class="docutils literal"><span class="pre">ubuntu12.04-gems</span></tt>, and the name of a custom bootstrap template file. When this option is used, Knife will search for the template file in the following order: the <tt class="docutils literal"><span class="pre">bootstrap/</span></tt> folder in the current working directory, the <tt class="docutils literal"><span class="pre">bootstrap/</span></tt> folder in the chef-repo, the <tt class="docutils literal"><span class="pre">bootstrap/</span></tt> folder in the <tt class="docutils literal"><span class="pre">~/.chef/</span></tt> directory, or a default bootstrap file. Do not use the <tt class="docutils literal"><span class="pre">--template-file</span></tt> option when <tt class="docutils literal"><span class="pre">--distro</span></tt> is specified.</p>
|
81
88
|
<div class="last admonition warning">
|
@@ -83,6 +90,8 @@
|
|
83
90
|
<p class="last">The default bootstrap operation uses the omnibus installer, which means the default template file (<tt class="docutils literal"><span class="pre">chef-full</span></tt>) should work on all supported platforms. It is recommended to use custom bootstrap templates only when the omnibus installer cannot be used. The <tt class="docutils literal"><span class="pre">.erb</span></tt> file extension is added automatically and should not be passed as part of the bootstrap command.</p>
|
84
91
|
</div>
|
85
92
|
</dd>
|
93
|
+
<dt><tt class="docutils literal"><span class="pre">-E</span> <span class="pre">ENVIRONMENT</span></tt>, <tt class="docutils literal"><span class="pre">--environment</span> <span class="pre">ENVIRONMENT</span></tt></dt>
|
94
|
+
<dd>The name of the environment. When this option is added to a command, the command will run only against the named environment.</dd>
|
86
95
|
<dt><tt class="docutils literal"><span class="pre">-G</span> <span class="pre">GATEWAY</span></tt>, <tt class="docutils literal"><span class="pre">--ssh-gateway</span> <span class="pre">GATEWAY</span></tt></dt>
|
87
96
|
<dd>The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation.</dd>
|
88
97
|
<dt><tt class="docutils literal"><span class="pre">--hint</span> <span class="pre">HINT_NAME[=HINT_FILE]</span></tt></dt>
|
@@ -100,7 +109,7 @@
|
|
100
109
|
<dt><tt class="docutils literal"><span class="pre">-P</span> <span class="pre">PASSWORD</span></tt>, <tt class="docutils literal"><span class="pre">--ssh-password</span> <span class="pre">PASSWORD</span></tt></dt>
|
101
110
|
<dd>The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) Knife will prompt for the password.</dd>
|
102
111
|
<dt><tt class="docutils literal"><span class="pre">--prerelease</span></tt></dt>
|
103
|
-
<dd>
|
112
|
+
<dd>Use to install pre-release gems.</dd>
|
104
113
|
<dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">RUN_LIST</span></tt>, <tt class="docutils literal"><span class="pre">--run-list</span> <span class="pre">RUN_LIST</span></tt></dt>
|
105
114
|
<dd>A comma-separated list of roles and/or recipes to be applied.</dd>
|
106
115
|
<dt><tt class="docutils literal"><span class="pre">--secret</span> <span class="pre">SECRET</span></tt></dt>
|
@@ -108,11 +117,13 @@
|
|
108
117
|
<dt><tt class="docutils literal"><span class="pre">--secret-file</span> <span class="pre">FILE</span></tt></dt>
|
109
118
|
<dd>The path to the file that contains the encryption key.</dd>
|
110
119
|
<dt><tt class="docutils literal"><span class="pre">--sudo</span></tt></dt>
|
111
|
-
<dd>
|
120
|
+
<dd>Use to execute a bootstrap operation with sudo.</dd>
|
112
121
|
<dt><tt class="docutils literal"><span class="pre">--template-file</span> <span class="pre">TEMPLATE</span></tt></dt>
|
113
122
|
<dd>The path to a template file that will be used during a bootstrap operation. Do not use the <tt class="docutils literal"><span class="pre">--distro</span></tt> option when <tt class="docutils literal"><span class="pre">--template-file</span></tt> is specified.</dd>
|
114
123
|
<dt><tt class="docutils literal"><span class="pre">--use-sudo-password</span></tt></dt>
|
115
|
-
<dd>
|
124
|
+
<dd>Use to perform a bootstrap operation with sudo; specify the password with the <tt class="docutils literal"><span class="pre">-P</span></tt> (or <tt class="docutils literal"><span class="pre">--ssh-password</span></tt>) option.</dd>
|
125
|
+
<dt><tt class="docutils literal"><span class="pre">-V</span> <span class="pre">-V</span></tt></dt>
|
126
|
+
<dd>Use to run the initial chef-client run at the <tt class="docutils literal"><span class="pre">debug</span></tt> log-level (e.g. <tt class="docutils literal"><span class="pre">chef-client</span> <span class="pre">-l</span> <span class="pre">debug</span></tt>).</dd>
|
116
127
|
<dt><tt class="docutils literal"><span class="pre">-x</span> <span class="pre">USERNAME</span></tt>, <tt class="docutils literal"><span class="pre">--ssh-user</span> <span class="pre">USERNAME</span></tt></dt>
|
117
128
|
<dd>The SSH user name.</dd>
|
118
129
|
</dl>
|
@@ -23,7 +23,6 @@
|
|
23
23
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
24
24
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
25
25
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
26
|
-
<link rel="shortcut icon" href="_static/chef.ico"/>
|
27
26
|
|
28
27
|
|
29
28
|
</head>
|
@@ -49,7 +48,7 @@
|
|
49
48
|
</div>
|
50
49
|
<div class="section" id="bulk-delete">
|
51
50
|
<h2>bulk delete<a class="headerlink" href="#bulk-delete" title="Permalink to this headline">¶</a></h2>
|
52
|
-
<p>The <tt class="docutils literal"><span class="pre">bulk</span> <span class="pre">delete</span></tt> argument is used to delete any API client that matches a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (
|
51
|
+
<p>The <tt class="docutils literal"><span class="pre">bulk</span> <span class="pre">delete</span></tt> argument is used to delete any API client that matches a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (<tt class="docutils literal"><span class="pre">/</span></tt>).</p>
|
53
52
|
<div class="section" id="syntax">
|
54
53
|
<h3>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h3>
|
55
54
|
<p>This argument has the following syntax:</p>
|
@@ -85,14 +84,18 @@
|
|
85
84
|
<p>This argument has the following options:</p>
|
86
85
|
<dl class="docutils">
|
87
86
|
<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--admin</span></tt></dt>
|
88
|
-
<dd>
|
87
|
+
<dd>Use to create a client as an admin client. This is required for any user to access Open Source Chef as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef.</dd>
|
88
|
+
<dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FILE</span></tt>, <tt class="docutils literal"><span class="pre">--file</span> <span class="pre">FILE</span></tt></dt>
|
89
|
+
<dd>Use to save a private key to the specified file name.</dd>
|
90
|
+
<dt><tt class="docutils literal"><span class="pre">--validator</span></tt></dt>
|
91
|
+
<dd>Use to create the client as the chef-validator. Default value: <tt class="docutils literal"><span class="pre">true</span></tt>.</dd>
|
89
92
|
</dl>
|
90
93
|
</div>
|
91
94
|
<div class="section" id="id3">
|
92
95
|
<h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
93
96
|
<p>The following examples show how to use this Knife subcommand:</p>
|
94
97
|
<p><strong>Create an admin client</strong></p>
|
95
|
-
<p>To create a Chef
|
98
|
+
<p>To create a chef-client that can access the Chef Server API as an administrator—sometimes referred to as an “API chef-client”—with the name “exampleorg” and save its private key to a file, enter:</p>
|
96
99
|
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife client create exampleorg -a -f <span class="s2">"/etc/chef/client.pem"</span>
|
97
100
|
</pre></div>
|
98
101
|
</div>
|
@@ -167,7 +170,7 @@
|
|
167
170
|
<p>This argument has the following options:</p>
|
168
171
|
<dl class="docutils">
|
169
172
|
<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
|
170
|
-
<dd>
|
173
|
+
<dd>Use to show the corresponding URIs.</dd>
|
171
174
|
</dl>
|
172
175
|
</div>
|
173
176
|
<div class="section" id="id12">
|
@@ -23,7 +23,6 @@
|
|
23
23
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
24
24
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
25
25
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
26
|
-
<link rel="shortcut icon" href="_static/chef.ico"/>
|
27
26
|
|
28
27
|
|
29
28
|
</head>
|
@@ -44,18 +43,18 @@
|
|
44
43
|
<h1>Common Options<a class="headerlink" href="#common-options" title="Permalink to this headline">¶</a></h1>
|
45
44
|
<p>The following options can be run with all Knife sub-commands and plug-ins:</p>
|
46
45
|
<dl class="docutils">
|
47
|
-
<dt><tt class="docutils literal"><span class="pre">--chef-zero-port</span> <span class="pre">PORT</span></tt></dt>
|
48
|
-
<dd>The port on which chef-zero will listen.</dd>
|
49
46
|
<dt><tt class="docutils literal"><span class="pre">-c</span> <span class="pre">CONFIG_FILE</span></tt>, <tt class="docutils literal"><span class="pre">--config</span> <span class="pre">CONFIG_FILE</span></tt></dt>
|
50
47
|
<dd>The configuration file to use. For example, when Knife is run from a node that is configured to be managed by the Chef server, this option is used to allow Knife to use the same credentials as the chef-client when communicating with the Chef server.</dd>
|
48
|
+
<dt><tt class="docutils literal"><span class="pre">--chef-zero-port</span> <span class="pre">PORT</span></tt></dt>
|
49
|
+
<dd>The port on which chef-zero will listen.</dd>
|
51
50
|
<dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--disable-editing</span></tt></dt>
|
52
|
-
<dd>
|
51
|
+
<dd>Use to prevent the $EDITOR from being opened and to accept data as-is.</dd>
|
53
52
|
<dt><tt class="docutils literal"><span class="pre">--defaults</span></tt></dt>
|
54
|
-
<dd>
|
53
|
+
<dd>Use to have Knife use the default value instead of asking a user to provide one.</dd>
|
55
54
|
<dt><tt class="docutils literal"><span class="pre">-e</span> <span class="pre">EDITOR</span></tt>, <tt class="docutils literal"><span class="pre">--editor</span> <span class="pre">EDITOR</span></tt></dt>
|
56
55
|
<dd>The $EDITOR that is used for all interactive commands.</dd>
|
57
56
|
<dt><tt class="docutils literal"><span class="pre">-E</span> <span class="pre">ENVIRONMENT</span></tt>, <tt class="docutils literal"><span class="pre">--environment</span> <span class="pre">ENVIRONMENT</span></tt></dt>
|
58
|
-
<dd>The name of the environment. When this option is added to a command, the command will run only against the named environment.</dd>
|
57
|
+
<dd>The name of the environment. When this option is added to a command, the command will run only against the named environment. This option is ignored during search queries made using the <strong>knife search</strong> subcommand.</dd>
|
59
58
|
<dt><tt class="docutils literal"><span class="pre">-F</span> <span class="pre">FORMAT</span></tt>, <tt class="docutils literal"><span class="pre">--format</span> <span class="pre">FORMAT</span></tt></dt>
|
60
59
|
<dd>The output format: <tt class="docutils literal"><span class="pre">summary</span></tt> (default), <tt class="docutils literal"><span class="pre">text</span></tt>, <tt class="docutils literal"><span class="pre">json</span></tt>, <tt class="docutils literal"><span class="pre">yaml</span></tt>, and <tt class="docutils literal"><span class="pre">pp</span></tt>.</dd>
|
61
60
|
<dt><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--help</span></tt></dt>
|
@@ -63,21 +62,21 @@
|
|
63
62
|
<dt><tt class="docutils literal"><span class="pre">-k</span> <span class="pre">KEY</span></tt>, <tt class="docutils literal"><span class="pre">--key</span> <span class="pre">KEY</span></tt></dt>
|
64
63
|
<dd>The private key that Knife will use to sign requests made by the API client to the Chef server.</dd>
|
65
64
|
<dt><tt class="docutils literal"><span class="pre">--[no-]color</span></tt></dt>
|
66
|
-
<dd>
|
65
|
+
<dd>Use to view colored output.</dd>
|
67
66
|
<dt><tt class="docutils literal"><span class="pre">--print-after</span></tt></dt>
|
68
|
-
<dd>
|
67
|
+
<dd>Use to show data after a destructive operation.</dd>
|
69
68
|
<dt><tt class="docutils literal"><span class="pre">-s</span> <span class="pre">URL</span></tt>, <tt class="docutils literal"><span class="pre">--server-url</span> <span class="pre">URL</span></tt></dt>
|
70
69
|
<dd>The URL for the Chef server.</dd>
|
71
70
|
<dt><tt class="docutils literal"><span class="pre">-u</span> <span class="pre">USER</span></tt>, <tt class="docutils literal"><span class="pre">--user</span> <span class="pre">USER</span></tt></dt>
|
72
71
|
<dd>The user name used by Knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key.</dd>
|
73
|
-
<dt><tt class="docutils literal"><span class="pre">-V</span></tt>, <tt class="docutils literal"><span class="pre">--verbose</span></tt></dt>
|
74
|
-
<dd>Set for more verbose outputs. Use <tt class="docutils literal"><span class="pre">-VV</span></tt> for maximum verbosity.</dd>
|
75
72
|
<dt><tt class="docutils literal"><span class="pre">-v</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt></dt>
|
76
73
|
<dd>The version of the chef-client.</dd>
|
74
|
+
<dt><tt class="docutils literal"><span class="pre">-V</span></tt>, <tt class="docutils literal"><span class="pre">--verbose</span></tt></dt>
|
75
|
+
<dd>Set for more verbose outputs. Use <tt class="docutils literal"><span class="pre">-VV</span></tt> for maximum verbosity.</dd>
|
77
76
|
<dt><tt class="docutils literal"><span class="pre">-y</span></tt>, <tt class="docutils literal"><span class="pre">--yes</span></tt></dt>
|
78
|
-
<dd>
|
77
|
+
<dd>Use to respond to all confirmation prompts with “Yes”. Knife will not ask for confirmation.</dd>
|
79
78
|
<dt><tt class="docutils literal"><span class="pre">-z</span></tt>, <tt class="docutils literal"><span class="pre">--local-mode</span></tt></dt>
|
80
|
-
<dd>
|
79
|
+
<dd>Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo.</dd>
|
81
80
|
</dl>
|
82
81
|
</div>
|
83
82
|
|
@@ -23,7 +23,6 @@
|
|
23
23
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
24
24
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
25
25
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
26
|
-
<link rel="shortcut icon" href="_static/chef.ico"/>
|
27
26
|
|
28
27
|
|
29
28
|
</head>
|
@@ -71,9 +70,9 @@
|
|
71
70
|
<dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">REPO</span></tt>, <tt class="docutils literal"><span class="pre">--repository</span> <span class="pre">REPO</span></tt></dt>
|
72
71
|
<dd>The path to the chef-repo.</dd>
|
73
72
|
<dt><tt class="docutils literal"><span class="pre">--validation-client-name</span> <span class="pre">NAME</span></tt></dt>
|
74
|
-
<dd>The name of the validation client, typically a client named chef-validator
|
73
|
+
<dd>The name of the validation client, typically a client named chef-validator.</dd>
|
75
74
|
<dt><tt class="docutils literal"><span class="pre">--validation-key</span> <span class="pre">PATH</span></tt></dt>
|
76
|
-
<dd>The path to the validation key used by the client, typically a file named
|
75
|
+
<dd>The path to the validation key used by the client, typically a file named chef-validator.pem.</dd>
|
77
76
|
</dl>
|
78
77
|
</div>
|
79
78
|
<div class="section" id="examples">
|
@@ -23,7 +23,6 @@
|
|
23
23
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
24
24
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
25
25
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
26
|
-
<link rel="shortcut icon" href="_static/chef.ico"/>
|
27
26
|
|
28
27
|
|
29
28
|
</head>
|
@@ -74,7 +73,7 @@
|
|
74
73
|
<p>This argument has the following options:</p>
|
75
74
|
<dl class="docutils">
|
76
75
|
<dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt>
|
77
|
-
<dd>
|
76
|
+
<dd>Use to entirely remove a cookbook (or cookbook version) from the Chef server. This action should be used carefully because only one copy of any single file is stored on the Chef server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.</dd>
|
78
77
|
</dl>
|
79
78
|
</div>
|
80
79
|
<div class="section" id="examples">
|
@@ -160,11 +159,11 @@
|
|
160
159
|
<p>This argument has the following options:</p>
|
161
160
|
<dl class="docutils">
|
162
161
|
<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
|
163
|
-
<dd>
|
162
|
+
<dd>Use to delete all cookbooks (and cookbook versions).</dd>
|
164
163
|
<dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
|
165
164
|
<dd>The version of a cookbook to be deleted. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, Knife will prompt for a version.</dd>
|
166
165
|
<dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt>
|
167
|
-
<dd>
|
166
|
+
<dd>Use to entirely remove a cookbook (or cookbook version) from the Chef server. This action should be used carefully because only one copy of any single file is stored on the Chef server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.</dd>
|
168
167
|
</dl>
|
169
168
|
</div>
|
170
169
|
<div class="section" id="id6">
|
@@ -198,9 +197,9 @@
|
|
198
197
|
<dt><tt class="docutils literal"><span class="pre">-d</span> <span class="pre">DOWNLOAD_DIRECTORY</span></tt>, <tt class="docutils literal"><span class="pre">--dir</span> <span class="pre">DOWNLOAD_DIRECTORY</span></tt></dt>
|
199
198
|
<dd>The directory into which a cookbook will be downloaded.</dd>
|
200
199
|
<dt><tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">--force</span></tt></dt>
|
201
|
-
<dd>
|
200
|
+
<dd>Use to overwrite an existing directory.</dd>
|
202
201
|
<dt><tt class="docutils literal"><span class="pre">-N</span></tt>, <tt class="docutils literal"><span class="pre">--latest</span></tt></dt>
|
203
|
-
<dd>
|
202
|
+
<dd>Use to download the most recent version of a cookbook.</dd>
|
204
203
|
</dl>
|
205
204
|
</div>
|
206
205
|
<div class="section" id="id9">
|
@@ -228,9 +227,9 @@
|
|
228
227
|
<p>This argument has the following options:</p>
|
229
228
|
<dl class="docutils">
|
230
229
|
<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
|
231
|
-
<dd>
|
230
|
+
<dd>Use to return all available versions for every cookbook.</dd>
|
232
231
|
<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
|
233
|
-
<dd>
|
232
|
+
<dd>Use to show the corresponding URIs.</dd>
|
234
233
|
</dl>
|
235
234
|
</div>
|
236
235
|
<div class="section" id="id12">
|
@@ -258,7 +257,7 @@
|
|
258
257
|
<p>This argument has the following options:</p>
|
259
258
|
<dl class="docutils">
|
260
259
|
<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
|
261
|
-
<dd>
|
260
|
+
<dd>Use to generate metadata for all cookbooks.</dd>
|
262
261
|
<dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
|
263
262
|
<dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
|
264
263
|
</dl>
|
@@ -290,7 +289,7 @@
|
|
290
289
|
<h3>Examples<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
|
291
290
|
<p>The following examples show how to use this Knife subcommand:</p>
|
292
291
|
<p><strong>View metadata</strong></p>
|
293
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook
|
292
|
+
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata from file /path/to/file
|
294
293
|
</pre></div>
|
295
294
|
</div>
|
296
295
|
</div>
|
@@ -322,7 +321,7 @@
|
|
322
321
|
<dt><tt class="docutils literal"><span class="pre">-V</span> <span class="pre">PLATFORM_VERSION</span></tt>, <tt class="docutils literal"><span class="pre">--platform-version</span> <span class="pre">PLATFORM_VERSION</span></tt></dt>
|
323
322
|
<dd>The version of the platform.</dd>
|
324
323
|
<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
|
325
|
-
<dd>
|
324
|
+
<dd>Use to show the corresponding URIs.</dd>
|
326
325
|
</dl>
|
327
326
|
</div>
|
328
327
|
<div class="section" id="id21">
|
@@ -381,7 +380,7 @@ url: https://someurlhere.com
|
|
381
380
|
</div>
|
382
381
|
<div class="section" id="test">
|
383
382
|
<h2>test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2>
|
384
|
-
<p>The <tt class="docutils literal"><span class="pre">test</span></tt> 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).</p>
|
383
|
+
<p>The <tt class="docutils literal"><span class="pre">test</span></tt> 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). This argument will respect .chefignore files when determining which cookbooks to test for syntax errors.</p>
|
385
384
|
<div class="section" id="id22">
|
386
385
|
<h3>Syntax<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
|
387
386
|
<p>This argument has the following syntax:</p>
|
@@ -394,7 +393,7 @@ url: https://someurlhere.com
|
|
394
393
|
<p>This argument has the following options:</p>
|
395
394
|
<dl class="docutils">
|
396
395
|
<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
|
397
|
-
<dd>
|
396
|
+
<dd>Use to test all cookbooks.</dd>
|
398
397
|
<dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
|
399
398
|
<dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
|
400
399
|
</dl>
|
@@ -431,17 +430,17 @@ url: https://someurlhere.com
|
|
431
430
|
<p>This argument has the following options:</p>
|
432
431
|
<dl class="docutils">
|
433
432
|
<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
|
434
|
-
<dd>
|
433
|
+
<dd>Use to upload all cookbooks.</dd>
|
435
434
|
<dt><tt class="docutils literal"><span class="pre">--concurrency</span></tt></dt>
|
436
435
|
<dd>The number of allowed concurrent connections. Default: <tt class="docutils literal"><span class="pre">10</span></tt>.</dd>
|
437
436
|
<dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--include-dependencies</span></tt></dt>
|
438
|
-
<dd>
|
437
|
+
<dd>Use to ensure that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded.</dd>
|
439
438
|
<dt><tt class="docutils literal"><span class="pre">-E</span> <span class="pre">ENVIRONMENT</span></tt>, <tt class="docutils literal"><span class="pre">--environment</span> <span class="pre">ENVIRONMENT</span></tt></dt>
|
440
439
|
<dd>Use to set the environment version dependency to the cookbook version being uploaded.</dd>
|
441
440
|
<dt><tt class="docutils literal"><span class="pre">--force</span></tt></dt>
|
442
|
-
<dd>
|
441
|
+
<dd>Use to update a cookbook even if the <tt class="docutils literal"><span class="pre">--freeze</span></tt> flag has been set.</dd>
|
443
442
|
<dt><tt class="docutils literal"><span class="pre">--freeze</span></tt></dt>
|
444
|
-
<dd>
|
443
|
+
<dd>Use to require changes to a cookbook be included as a new version. Only the <tt class="docutils literal"><span class="pre">--force</span></tt> option can override this setting.</dd>
|
445
444
|
<dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
|
446
445
|
<dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
|
447
446
|
</dl>
|
@@ -23,7 +23,6 @@
|
|
23
23
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
24
24
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
25
25
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
26
|
-
<link rel="shortcut icon" href="_static/chef.ico"/>
|
27
26
|
|
28
27
|
|
29
28
|
</head>
|
@@ -42,8 +41,8 @@
|
|
42
41
|
|
43
42
|
<div class="section" id="knife-cookbook-site">
|
44
43
|
<h1>knife cookbook site<a class="headerlink" href="#knife-cookbook-site" title="Permalink to this headline">¶</a></h1>
|
45
|
-
<p>The Cookbooks Site API is used to provide access to the cookbooks community hosted at <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
46
|
-
<p>The <strong>knife cookbook site</strong> subcommand is used to interact with cookbooks that are located at <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
44
|
+
<p>The Cookbooks Site API is used to provide access to the cookbooks community hosted at <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a>. All of the cookbooks in the community are accessible through a RESTful API located at <a class="reference external" href="https://cookbooks.opscode.com/api/v1/cookbooks">https://cookbooks.opscode.com/api/v1/cookbooks</a> by using any of the supported endpoints. In most cases, using Knife and the <strong>knife cookbook site</strong> sub-command (and any of its arguments) is the recommended method of interacting with these cookbooks, but in some cases, using the Cookbooks Site API directly may make sense.</p>
|
45
|
+
<p>The <strong>knife cookbook site</strong> subcommand is used to interact with cookbooks that are located at <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a>. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: <tt class="docutils literal"><span class="pre">download</span></tt>, <tt class="docutils literal"><span class="pre">search</span></tt>, <tt class="docutils literal"><span class="pre">install</span></tt>, and <tt class="docutils literal"><span class="pre">list</span></tt>.</p>
|
47
46
|
<div class="admonition note">
|
48
47
|
<p class="first admonition-title">Note</p>
|
49
48
|
<p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) Knife subcommands and plugins.</p>
|
@@ -63,9 +62,11 @@
|
|
63
62
|
<p>This argument has the following options:</p>
|
64
63
|
<dl class="docutils">
|
65
64
|
<dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
|
66
|
-
<dd>The version of a cookbook to be downloaded. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified,
|
67
|
-
<dt><tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">--
|
68
|
-
<dd>
|
65
|
+
<dd>The version of a cookbook to be downloaded. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, the most recent version of the cookbook will be downloaded.</dd>
|
66
|
+
<dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FILE</span></tt>, <tt class="docutils literal"><span class="pre">--file</span> <span class="pre">FILE</span></tt></dt>
|
67
|
+
<dd>The file to which a cookbook download is written.</dd>
|
68
|
+
<dt><tt class="docutils literal"><span class="pre">--force</span></tt></dt>
|
69
|
+
<dd>Use to overwrite an existing directory.</dd>
|
69
70
|
</dl>
|
70
71
|
</div>
|
71
72
|
<div class="section" id="examples">
|
@@ -86,12 +87,12 @@ Cookbook saved: /Users/sdanna/opscodesupport/getting-started-0.3.0.tar.gz
|
|
86
87
|
</div>
|
87
88
|
<div class="section" id="install">
|
88
89
|
<h2>install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
|
89
|
-
<p>The <tt class="docutils literal"><span class="pre">install</span></tt> argument is used to install a cookbook that has been downloaded from the community site to a local git repository . This action uses the git version control system in conjunction with the <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
90
|
+
<p>The <tt class="docutils literal"><span class="pre">install</span></tt> argument is used to install a cookbook that has been downloaded from the community site to a local git repository . This action uses the git version control system in conjunction with the <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a> site to install community-contributed cookbooks to the local chef-repo. Using this argument does the following:</p>
|
90
91
|
<blockquote>
|
91
92
|
<div><ol class="arabic simple">
|
92
93
|
<li>A new “pristine copy” branch is created in git for tracking the upstream.</li>
|
93
94
|
<li>All existing versions of a cookbook are removed from the branch.</li>
|
94
|
-
<li>The cookbook is downloaded from <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
95
|
+
<li>The cookbook is downloaded from <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a> in the tar.gz format.</li>
|
95
96
|
<li>The downloaded cookbook is untarred and its contents are committed to git and a tag is created.</li>
|
96
97
|
<li>The “pristine copy” branch is merged into the master branch.</li>
|
97
98
|
</ol>
|
@@ -109,13 +110,13 @@ Cookbook saved: /Users/sdanna/opscodesupport/getting-started-0.3.0.tar.gz
|
|
109
110
|
<p>This argument has the following options:</p>
|
110
111
|
<dl class="docutils">
|
111
112
|
<dt><tt class="docutils literal"><span class="pre">-b</span></tt>, <tt class="docutils literal"><span class="pre">--use-current-branch</span></tt></dt>
|
112
|
-
<dd>
|
113
|
+
<dd>Use to ensure that the current branch is used.</dd>
|
113
114
|
<dt><tt class="docutils literal"><span class="pre">-B</span> <span class="pre">BRANCH</span></tt>, <tt class="docutils literal"><span class="pre">--branch</span> <span class="pre">BRANCH</span></tt></dt>
|
114
115
|
<dd>The name of the default branch. This will default to the master branch.</dd>
|
115
116
|
<dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
|
116
117
|
<dd>The version of the cookbook to be installed. If a version is not specified, the most recent version of the cookbook will be installed.</dd>
|
117
118
|
<dt><tt class="docutils literal"><span class="pre">-D</span></tt>, <tt class="docutils literal"><span class="pre">--skip-dependencies</span></tt></dt>
|
118
|
-
<dd>
|
119
|
+
<dd>Use to ensure that all cookbooks to which the installed cookbook has a dependency will not be installed.</dd>
|
119
120
|
<dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
|
120
121
|
<dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
|
121
122
|
</dl>
|
@@ -163,7 +164,7 @@ Cookbook getting-started version 0.3.0 successfully installed
|
|
163
164
|
</div>
|
164
165
|
<div class="section" id="list">
|
165
166
|
<h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2>
|
166
|
-
<p>The <tt class="docutils literal"><span class="pre">list</span></tt> argument is used to view a list of cookbooks that are currently available at <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
167
|
+
<p>The <tt class="docutils literal"><span class="pre">list</span></tt> argument is used to view a list of cookbooks that are currently available at <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a>.</p>
|
167
168
|
<div class="section" id="id4">
|
168
169
|
<h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
|
169
170
|
<p>This argument has the following syntax:</p>
|
@@ -176,14 +177,14 @@ Cookbook getting-started version 0.3.0 successfully installed
|
|
176
177
|
<p>This argument has the following options:</p>
|
177
178
|
<dl class="docutils">
|
178
179
|
<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
|
179
|
-
<dd>
|
180
|
+
<dd>Use to show the corresponding URIs.</dd>
|
180
181
|
</dl>
|
181
182
|
</div>
|
182
183
|
<div class="section" id="id6">
|
183
184
|
<h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
|
184
185
|
<p>The following examples show how to use this Knife subcommand:</p>
|
185
186
|
<p><strong>View a list of cookbooks</strong></p>
|
186
|
-
<p>To view a list of cookbooks at <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
187
|
+
<p>To view a list of cookbooks at <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a> server, enter:</p>
|
187
188
|
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook site list
|
188
189
|
</pre></div>
|
189
190
|
</div>
|
@@ -205,7 +206,7 @@ ant iis redmine
|
|
205
206
|
</div>
|
206
207
|
<div class="section" id="search">
|
207
208
|
<h2>search<a class="headerlink" href="#search" title="Permalink to this headline">¶</a></h2>
|
208
|
-
<p>The <tt class="docutils literal"><span class="pre">search</span></tt> argument is used to search for a cookbook at <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
209
|
+
<p>The <tt class="docutils literal"><span class="pre">search</span></tt> argument is used to search for a cookbook at <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a>. A search query is used to return a list of cookbooks at <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a> and uses the same syntax as the <strong>knife search</strong> sub-command.</p>
|
209
210
|
<div class="section" id="id7">
|
210
211
|
<h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
211
212
|
<p>This argument has the following syntax:</p>
|
@@ -248,7 +249,7 @@ kickstart:
|
|
248
249
|
</div>
|
249
250
|
<div class="section" id="share">
|
250
251
|
<h2>share<a class="headerlink" href="#share" title="Permalink to this headline">¶</a></h2>
|
251
|
-
<p>The <tt class="docutils literal"><span class="pre">share</span></tt> argument is used to add a cookbook to <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
252
|
+
<p>The <tt class="docutils literal"><span class="pre">share</span></tt> argument is used to add a cookbook to <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a>. This action will require a user account and a certificate for <a class="reference external" href="http://community.opscode.com">http://community.opscode.com</a>. By default, Knife will use the user name and API key that is identified in the configuration file used during the upload; otherwise these values must be specified on the command line or in an alternate configuration file. If a cookbook already exists on <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a>, then only an owner or maintainer of that cookbook can make updates.</p>
|
252
253
|
<div class="section" id="id10">
|
253
254
|
<h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
|
254
255
|
<p>This argument has the following syntax:</p>
|
@@ -261,7 +262,7 @@ kickstart:
|
|
261
262
|
<p>This argument has the following options:</p>
|
262
263
|
<dl class="docutils">
|
263
264
|
<dt><tt class="docutils literal"><span class="pre">CATEGORY</span></tt></dt>
|
264
|
-
<dd>The cookbook category: <tt class="docutils literal"><span class="pre"
|
265
|
+
<dd>The cookbook category: <tt class="docutils literal"><span class="pre">"Databases"</span></tt>, <tt class="docutils literal"><span class="pre">"Web</span> <span class="pre">Servers"</span></tt>, <tt class="docutils literal"><span class="pre">"Process</span> <span class="pre">Management"</span></tt>, <tt class="docutils literal"><span class="pre">"Monitoring</span> <span class="pre">&</span> <span class="pre">Trending"</span></tt>, <tt class="docutils literal"><span class="pre">"Programming</span> <span class="pre">Languages"</span></tt>, <tt class="docutils literal"><span class="pre">"Package</span> <span class="pre">Management"</span></tt>, <tt class="docutils literal"><span class="pre">"Applications"</span></tt>, <tt class="docutils literal"><span class="pre">"Networking"</span></tt>, <tt class="docutils literal"><span class="pre">"Operations</span> <span class="pre">Systems</span> <span class="pre">&</span> <span class="pre">Virtualization"</span></tt>, <tt class="docutils literal"><span class="pre">"Utilities"</span></tt>, or <tt class="docutils literal"><span class="pre">"Other"</span></tt>.</dd>
|
265
266
|
<dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
|
266
267
|
<dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
|
267
268
|
</dl>
|
@@ -278,7 +279,7 @@ kickstart:
|
|
278
279
|
</div>
|
279
280
|
<div class="section" id="show">
|
280
281
|
<h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2>
|
281
|
-
<p>The <tt class="docutils literal"><span class="pre">show</span></tt> argument is used to view information about a cookbook on <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
282
|
+
<p>The <tt class="docutils literal"><span class="pre">show</span></tt> argument is used to view information about a cookbook on <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a>.</p>
|
282
283
|
<div class="section" id="id13">
|
283
284
|
<h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
|
284
285
|
<p>This argument has the following syntax:</p>
|
@@ -332,7 +333,7 @@ versions:
|
|
332
333
|
</div>
|
333
334
|
<div class="section" id="unshare">
|
334
335
|
<h2>unshare<a class="headerlink" href="#unshare" title="Permalink to this headline">¶</a></h2>
|
335
|
-
<p>The <tt class="docutils literal"><span class="pre">unshare</span></tt> argument is used to stop the sharing of a cookbook at <a class="reference external" href="http://community.opscode.com/">http://community.opscode.com
|
336
|
+
<p>The <tt class="docutils literal"><span class="pre">unshare</span></tt> argument is used to stop the sharing of a cookbook at <a class="reference external" href="http://community.opscode.com/cookbooks">http://community.opscode.com/cookbooks</a>. Only the maintainer of a cookbook may perform this action.</p>
|
336
337
|
<div class="section" id="id16">
|
337
338
|
<h3>Syntax<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
|
338
339
|
<p>This argument has the following syntax:</p>
|
@@ -23,7 +23,6 @@
|
|
23
23
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
24
24
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
25
25
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
26
|
-
<link rel="shortcut icon" href="_static/chef.ico"/>
|
27
26
|
|
28
27
|
|
29
28
|
</head>
|
@@ -181,12 +180,12 @@
|
|
181
180
|
</div>
|
182
181
|
<div class="section" id="from-file">
|
183
182
|
<h2>from file<a class="headerlink" href="#from-file" title="Permalink to this headline">¶</a></h2>
|
184
|
-
<p>The <tt class="docutils literal"><span class="pre">from</span> <span class="pre">file</span></tt> argument is used to
|
183
|
+
<p>The <tt class="docutils literal"><span class="pre">from</span> <span class="pre">file</span></tt> argument is used to:</p>
|
185
184
|
<ul class="simple">
|
186
|
-
<li>
|
187
|
-
<li>
|
185
|
+
<li>Add a data bag item to a data bag</li>
|
186
|
+
<li>Update the contents of an existing data bag item</li>
|
188
187
|
</ul>
|
189
|
-
<p>
|
188
|
+
<p>The data bag itself must already exist on the Chef server and must be specified as part of the command. The contents of the data bag item are specified using a JSON file. This JSON file may be located at a relative or absolute path; its location must be specified as part of the command. The JSON file that defines the contents of the data bag item must at least contain the name of the data bag item—<tt class="docutils literal"><span class="pre">"id":</span> <span class="pre">"name"</span></tt>.</p>
|
190
189
|
<div class="admonition warning">
|
191
190
|
<p class="first admonition-title">Warning</p>
|
192
191
|
<p class="last">A chef-client must be version 11.6 (or higher) when using the <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">data</span> <span class="pre">bag</span> <span class="pre">from</span> <span class="pre">file</span></tt> argument with the Enterprise Chef or Open Source Chef version 11 servers.</p>
|
@@ -203,7 +202,7 @@
|
|
203
202
|
<p>This argument has the following options:</p>
|
204
203
|
<dl class="docutils">
|
205
204
|
<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
|
206
|
-
<dd>
|
205
|
+
<dd>Use to upload all data bags found at the specified path.</dd>
|
207
206
|
<dt><tt class="docutils literal"><span class="pre">--secret</span> <span class="pre">SECRET</span></tt></dt>
|
208
207
|
<dd>The encryption key that is used for values contained within a data bag item.</dd>
|
209
208
|
<dt><tt class="docutils literal"><span class="pre">--secret-file</span> <span class="pre">FILE</span></tt></dt>
|
@@ -244,7 +243,7 @@
|
|
244
243
|
<p>This argument has the following options:</p>
|
245
244
|
<dl class="docutils">
|
246
245
|
<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
|
247
|
-
<dd>
|
246
|
+
<dd>Use to show the corresponding URIs.</dd>
|
248
247
|
</dl>
|
249
248
|
</div>
|
250
249
|
<div class="section" id="id12">
|