chef 13.11.3-universal-mingw32 → 13.12.3-universal-mingw32
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +4 -3
- data/README.md +35 -40
- data/Rakefile +18 -22
- data/chef-universal-mingw32.gemspec +1 -1
- data/chef.gemspec +3 -3
- data/lib/chef/client.rb +1 -1
- data/lib/chef/mixin/params_validate.rb +3 -1
- data/lib/chef/provider/script.rb +2 -2
- data/lib/chef/version.rb +1 -1
- data/spec/functional/http/simple_spec.rb +12 -6
- data/spec/functional/resource/remote_file_spec.rb +19 -15
- data/spec/support/platform_helpers.rb +2 -1
- data/tasks/announce.rb +1 -1
- data/tasks/dependencies.rb +5 -39
- data/tasks/maintainers.rb +10 -10
- data/tasks/rspec.rb +2 -2
- data/tasks/templates/prerelease.md.erb +11 -2
- data/tasks/templates/release.md.erb +9 -1
- metadata +6 -247
- data/CONTRIBUTING.md +0 -151
- data/VERSION +0 -1
- data/acceptance/.gitignore +0 -3
- data/acceptance/.shared/kitchen_acceptance/.kitchen.digitalocean.yml +0 -33
- data/acceptance/.shared/kitchen_acceptance/.kitchen.ec2.yml +0 -283
- data/acceptance/.shared/kitchen_acceptance/.kitchen.vagrant.yml +0 -59
- data/acceptance/.shared/kitchen_acceptance/libraries/kitchen.rb +0 -68
- data/acceptance/.shared/kitchen_acceptance/metadata.rb +0 -1
- data/acceptance/Gemfile +0 -19
- data/acceptance/Gemfile.lock +0 -266
- data/acceptance/README.md +0 -137
- data/acceptance/basics/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/basics/.acceptance/acceptance-cookbook/metadata.rb +0 -3
- data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
- data/acceptance/basics/.kitchen.yml +0 -4
- data/acceptance/basics/test/integration/chef-current-install/serverspec/chef_client_spec.rb +0 -19
- data/acceptance/basics/test/integration/chef-current-install/serverspec/spec_helper.rb +0 -6
- data/acceptance/basics/test/integration/helpers/serverspec/Gemfile +0 -8
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/metadata.rb +0 -3
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -2
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -2
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -2
- data/acceptance/data-collector/.acceptance/data-collector-test/.gitignore +0 -16
- data/acceptance/data-collector/.acceptance/data-collector-test/Berksfile +0 -3
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/api.rb +0 -101
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/apigemfile +0 -3
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-both-mode.rb +0 -4
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-client-mode.rb +0 -4
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-no-endpoint.rb +0 -2
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-solo-mode.rb +0 -4
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/config.ru +0 -2
- data/acceptance/data-collector/.acceptance/data-collector-test/metadata.rb +0 -7
- data/acceptance/data-collector/.acceptance/data-collector-test/recipes/default.rb +0 -44
- data/acceptance/data-collector/.kitchen.yml +0 -9
- data/acceptance/data-collector/Berksfile +0 -3
- data/acceptance/data-collector/test/integration/default/serverspec/default_spec.rb +0 -208
- data/acceptance/data-collector/test/integration/helpers/serverspec/Gemfile +0 -8
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/metadata.rb +0 -1
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -61
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/libraries/cookbook_kitchen.rb +0 -43
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/libraries/top_cookbooks.rb +0 -41
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/metadata.rb +0 -3
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
- data/acceptance/top-cookbooks/.gitignore +0 -1
- data/acceptance/top-cookbooks/.kitchen.chocolatey.yml +0 -6
- data/acceptance/top-cookbooks/.kitchen.iis.yml +0 -4
- data/acceptance/top-cookbooks/.kitchen.learn-the-basics-rhel.yml +0 -7
- data/acceptance/top-cookbooks/.kitchen.learn-the-basics-ubuntu.yml +0 -7
- data/acceptance/top-cookbooks/.kitchen.learn-the-basics-windows.yml +0 -7
- data/acceptance/top-cookbooks/.kitchen.powershell.yml +0 -4
- data/acceptance/top-cookbooks/.kitchen.sql_server.yml +0 -5
- data/acceptance/top-cookbooks/.kitchen.winbox.yml +0 -8
- data/acceptance/top-cookbooks/.kitchen.windows.yml +0 -38
- data/acceptance/trivial/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/trivial/.acceptance/acceptance-cookbook/metadata.rb +0 -2
- data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
- data/acceptance/trivial/.kitchen.yml +0 -7
- data/acceptance/trivial/test/integration/chef-current-install/inspec/chef_client_spec.rb +0 -5
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/metadata.rb +0 -2
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
- data/acceptance/windows-service/.kitchen.yml +0 -7
- data/acceptance/windows-service/test/integration/chef-windows-service/inspec/chef_windows_service_spec.rb +0 -58
- data/distro/common/html/_sources/ctl_chef_client.txt +0 -36
- data/distro/common/html/_sources/ctl_chef_server.txt +0 -341
- data/distro/common/html/_sources/ctl_chef_shell.txt +0 -15
- data/distro/common/html/_sources/ctl_chef_solo.txt +0 -25
- data/distro/common/html/_sources/index.txt +0 -135
- data/distro/common/html/_sources/knife.txt +0 -74
- data/distro/common/html/_sources/knife_bootstrap.txt +0 -56
- data/distro/common/html/_sources/knife_client.txt +0 -151
- data/distro/common/html/_sources/knife_common_options.txt +0 -6
- data/distro/common/html/_sources/knife_configure.txt +0 -29
- data/distro/common/html/_sources/knife_cookbook.txt +0 -236
- data/distro/common/html/_sources/knife_cookbook_site.txt +0 -157
- data/distro/common/html/_sources/knife_data_bag.txt +0 -160
- data/distro/common/html/_sources/knife_delete.txt +0 -26
- data/distro/common/html/_sources/knife_deps.txt +0 -61
- data/distro/common/html/_sources/knife_diff.txt +0 -34
- data/distro/common/html/_sources/knife_download.txt +0 -44
- data/distro/common/html/_sources/knife_edit.txt +0 -26
- data/distro/common/html/_sources/knife_environment.txt +0 -158
- data/distro/common/html/_sources/knife_exec.txt +0 -47
- data/distro/common/html/_sources/knife_index_rebuild.txt +0 -21
- data/distro/common/html/_sources/knife_list.txt +0 -33
- data/distro/common/html/_sources/knife_node.txt +0 -250
- data/distro/common/html/_sources/knife_raw.txt +0 -35
- data/distro/common/html/_sources/knife_recipe_list.txt +0 -23
- data/distro/common/html/_sources/knife_role.txt +0 -157
- data/distro/common/html/_sources/knife_search.txt +0 -53
- data/distro/common/html/_sources/knife_serve.txt +0 -19
- data/distro/common/html/_sources/knife_show.txt +0 -27
- data/distro/common/html/_sources/knife_ssh.txt +0 -43
- data/distro/common/html/_sources/knife_ssl_check.txt +0 -41
- data/distro/common/html/_sources/knife_ssl_fetch.txt +0 -41
- data/distro/common/html/_sources/knife_status.txt +0 -37
- data/distro/common/html/_sources/knife_tag.txt +0 -69
- data/distro/common/html/_sources/knife_upload.txt +0 -49
- data/distro/common/html/_sources/knife_user.txt +0 -127
- data/distro/common/html/_sources/knife_using.txt +0 -43
- data/distro/common/html/_sources/knife_xargs.txt +0 -30
- data/distro/common/html/_static/ajax-loader.gif +0 -0
- data/distro/common/html/_static/basic.css +0 -537
- data/distro/common/html/_static/chef.ico +0 -0
- data/distro/common/html/_static/chef_html_logo.png +0 -0
- data/distro/common/html/_static/comment-bright.png +0 -0
- data/distro/common/html/_static/comment-close.png +0 -0
- data/distro/common/html/_static/comment.png +0 -0
- data/distro/common/html/_static/contents.png +0 -0
- data/distro/common/html/_static/doctools.js +0 -238
- data/distro/common/html/_static/down-pressed.png +0 -0
- data/distro/common/html/_static/down.png +0 -0
- data/distro/common/html/_static/file.png +0 -0
- data/distro/common/html/_static/guide.css +0 -505
- data/distro/common/html/_static/jquery.js +0 -2
- data/distro/common/html/_static/minus.png +0 -0
- data/distro/common/html/_static/navigation.png +0 -0
- data/distro/common/html/_static/plus.png +0 -0
- data/distro/common/html/_static/pygments.css +0 -62
- data/distro/common/html/_static/searchtools.js +0 -622
- data/distro/common/html/_static/underscore.js +0 -31
- data/distro/common/html/_static/up-pressed.png +0 -0
- data/distro/common/html/_static/up.png +0 -0
- data/distro/common/html/_static/websupport.js +0 -808
- data/distro/common/html/ctl_chef_client.html +0 -270
- data/distro/common/html/ctl_chef_server.html +0 -728
- data/distro/common/html/ctl_chef_shell.html +0 -163
- data/distro/common/html/ctl_chef_solo.html +0 -194
- data/distro/common/html/index.html +0 -202
- data/distro/common/html/knife.html +0 -170
- data/distro/common/html/knife_bootstrap.html +0 -285
- data/distro/common/html/knife_client.html +0 -285
- data/distro/common/html/knife_common_options.html +0 -96
- data/distro/common/html/knife_configure.html +0 -105
- data/distro/common/html/knife_cookbook.html +0 -487
- data/distro/common/html/knife_cookbook_site.html +0 -375
- data/distro/common/html/knife_data_bag.html +0 -374
- data/distro/common/html/knife_delete.html +0 -93
- data/distro/common/html/knife_deps.html +0 -143
- data/distro/common/html/knife_diff.html +0 -123
- data/distro/common/html/knife_download.html +0 -145
- data/distro/common/html/knife_edit.html +0 -89
- data/distro/common/html/knife_environment.html +0 -322
- data/distro/common/html/knife_exec.html +0 -220
- data/distro/common/html/knife_index_rebuild.html +0 -83
- data/distro/common/html/knife_list.html +0 -114
- data/distro/common/html/knife_node.html +0 -458
- data/distro/common/html/knife_raw.html +0 -110
- data/distro/common/html/knife_recipe_list.html +0 -91
- data/distro/common/html/knife_role.html +0 -295
- data/distro/common/html/knife_search.html +0 -203
- data/distro/common/html/knife_serve.html +0 -79
- data/distro/common/html/knife_show.html +0 -104
- data/distro/common/html/knife_ssh.html +0 -177
- data/distro/common/html/knife_ssl_check.html +0 -151
- data/distro/common/html/knife_ssl_fetch.html +0 -151
- data/distro/common/html/knife_status.html +0 -144
- data/distro/common/html/knife_tag.html +0 -138
- data/distro/common/html/knife_upload.html +0 -153
- data/distro/common/html/knife_user.html +0 -242
- data/distro/common/html/knife_using.html +0 -210
- data/distro/common/html/knife_xargs.html +0 -122
- data/distro/common/html/objects.inv +0 -0
- data/distro/common/html/search.html +0 -82
- data/distro/common/html/searchindex.js +0 -1
- data/distro/common/man/man1/README.md +0 -58
- data/distro/common/man/man1/chef-shell.1 +0 -194
- data/distro/common/man/man1/knife-bootstrap.1 +0 -215
- data/distro/common/man/man1/knife-client.1 +0 -443
- data/distro/common/man/man1/knife-configure.1 +0 -161
- data/distro/common/man/man1/knife-cookbook-site.1 +0 -552
- data/distro/common/man/man1/knife-cookbook.1 +0 -770
- data/distro/common/man/man1/knife-data-bag.1 +0 -617
- data/distro/common/man/man1/knife-delete.1 +0 -127
- data/distro/common/man/man1/knife-deps.1 +0 -246
- data/distro/common/man/man1/knife-diff.1 +0 -226
- data/distro/common/man/man1/knife-download.1 +0 -258
- data/distro/common/man/man1/knife-edit.1 +0 -121
- data/distro/common/man/man1/knife-environment.1 +0 -496
- data/distro/common/man/man1/knife-exec.1 +0 -362
- data/distro/common/man/man1/knife-index-rebuild.1 +0 -63
- data/distro/common/man/man1/knife-list.1 +0 -174
- data/distro/common/man/man1/knife-node.1 +0 -716
- data/distro/common/man/man1/knife-raw.1 +0 -172
- data/distro/common/man/man1/knife-recipe-list.1 +0 -85
- data/distro/common/man/man1/knife-role.1 +0 -426
- data/distro/common/man/man1/knife-search.1 +0 -359
- data/distro/common/man/man1/knife-serve.1 +0 -109
- data/distro/common/man/man1/knife-show.1 +0 -160
- data/distro/common/man/man1/knife-ssh.1 +0 -284
- data/distro/common/man/man1/knife-ssl-check.1 +0 -207
- data/distro/common/man/man1/knife-ssl-fetch.1 +0 -207
- data/distro/common/man/man1/knife-status.1 +0 -234
- data/distro/common/man/man1/knife-tag.1 +0 -189
- data/distro/common/man/man1/knife-upload.1 +0 -280
- data/distro/common/man/man1/knife-user.1 +0 -356
- data/distro/common/man/man1/knife-xargs.1 +0 -189
- data/distro/common/man/man1/knife.1 +0 -332
- data/distro/common/man/man8/chef-apply.8 +0 -86
- data/distro/common/man/man8/chef-client.8 +0 -398
- data/distro/common/man/man8/chef-solo.8 +0 -260
- data/distro/common/markdown/README +0 -3
- data/distro/common/markdown/man1/chef-shell.mkd +0 -195
- data/distro/common/markdown/man1/knife-bootstrap.mkd +0 -141
- data/distro/common/markdown/man1/knife-client.mkd +0 -103
- data/distro/common/markdown/man1/knife-configure.mkd +0 -71
- data/distro/common/markdown/man1/knife-cookbook-site.mkd +0 -123
- data/distro/common/markdown/man1/knife-cookbook.mkd +0 -263
- data/distro/common/markdown/man1/knife-data-bag.mkd +0 -121
- data/distro/common/markdown/man1/knife-environment.mkd +0 -151
- data/distro/common/markdown/man1/knife-exec.mkd +0 -42
- data/distro/common/markdown/man1/knife-index.mkd +0 -30
- data/distro/common/markdown/man1/knife-node.mkd +0 -130
- data/distro/common/markdown/man1/knife-role.mkd +0 -85
- data/distro/common/markdown/man1/knife-search.mkd +0 -180
- data/distro/common/markdown/man1/knife-ssh.mkd +0 -69
- data/distro/common/markdown/man1/knife-status.mkd +0 -36
- data/distro/common/markdown/man1/knife-tag.mkd +0 -39
- data/distro/common/markdown/man1/knife.mkd +0 -213
- data/distro/common/markdown/man8/chef-client.mkd +0 -75
- data/distro/common/markdown/man8/chef-expander.mkd +0 -81
- data/distro/common/markdown/man8/chef-expanderctl.mkd +0 -57
- data/distro/common/markdown/man8/chef-server-webui.mkd +0 -121
- data/distro/common/markdown/man8/chef-server.mkd +0 -120
- data/distro/common/markdown/man8/chef-solo.mkd +0 -107
- data/distro/common/markdown/man8/chef-solr.mkd +0 -89
- data/tasks/cbgb.rb +0 -84
@@ -1,141 +0,0 @@
|
|
1
|
-
knife-bootstrap(1) -- Install Chef Client on a remote host
|
2
|
-
========================================
|
3
|
-
|
4
|
-
## SYNOPSIS
|
5
|
-
|
6
|
-
__knife__ __bootstrap__ _(options)_
|
7
|
-
|
8
|
-
* `-i`, `--identity-file IDENTITY_FILE`:
|
9
|
-
The SSH identity file used for authentication
|
10
|
-
* `-N`, `--node-name NAME`:
|
11
|
-
The Chef node name for your new node
|
12
|
-
* `-P`, `--ssh-password PASSWORD`:
|
13
|
-
The ssh password
|
14
|
-
* `-x`, `--ssh-user USERNAME`:
|
15
|
-
The ssh username
|
16
|
-
* `-p`, `--ssh-port PORT`:
|
17
|
-
The ssh port
|
18
|
-
* `--bootstrap-version VERSION`:
|
19
|
-
The version of Chef to install
|
20
|
-
* `--bootstrap-proxy PROXY_URL`:
|
21
|
-
`The proxy server for the node being bootstrapped`
|
22
|
-
* `--prerelease`:
|
23
|
-
Install pre-release Chef gems
|
24
|
-
* `-r`, `--run-list RUN_LIST`:
|
25
|
-
Comma separated list of roles/recipes to apply
|
26
|
-
* `--template-file TEMPLATE`:
|
27
|
-
Full path to location of template to use
|
28
|
-
* `--sudo`:
|
29
|
-
Execute the bootstrap via sudo
|
30
|
-
* `-d`, `--distro DISTRO`:
|
31
|
-
Bootstrap a distro using a template
|
32
|
-
* `--[no-]host-key-verify`:
|
33
|
-
Enable host key verification, which is the default behavior.
|
34
|
-
* `--hint HINT_NAME[=HINT_FILE]`:
|
35
|
-
Provide the name of a hint (with option JSON file) to set for use by
|
36
|
-
Ohai plugins.
|
37
|
-
|
38
|
-
## DESCRIPTION
|
39
|
-
|
40
|
-
Performs a Chef Bootstrap on the target node. The goal of the bootstrap
|
41
|
-
is to get Chef installed on the target system so it can run Chef Client
|
42
|
-
with a Chef Server. The main assumption is a baseline OS installation
|
43
|
-
exists. This sub-command is used internally by some cloud computing
|
44
|
-
plugins.
|
45
|
-
|
46
|
-
The bootstrap sub-command supports supplying a template to perform the
|
47
|
-
bootstrap steps. If the distro is not specified (via `-d` or `--distro`
|
48
|
-
option), an Ubuntu 10.04 host bootstrapped with RubyGems is assumed. The
|
49
|
-
__DISTRO__ value corresponds to the base filename of the template, in
|
50
|
-
other words `DISTRO`.erb. A template file can be specified with the
|
51
|
-
`--template-file` option in which case the __DISTRO__ is not used. The
|
52
|
-
sub-command looks in the following locations for the template to use:
|
53
|
-
|
54
|
-
* `bootstrap` directory in the installed Chef Knife library.
|
55
|
-
* `bootstrap` directory in the `$PWD/.chef`.
|
56
|
-
* `bootstrap` directory in the users `$HOME/.chef`.
|
57
|
-
|
58
|
-
The default bootstrap templates are scripts that get copied to the
|
59
|
-
target node (FQDN). The following distros are supported:
|
60
|
-
|
61
|
-
* centos5-gems
|
62
|
-
* fedora13-gems
|
63
|
-
* ubuntu10.04-gems
|
64
|
-
* ubuntu10.04-apt
|
65
|
-
|
66
|
-
The gems installations will use RubyGems 1.3.6 and Chef installed as a
|
67
|
-
gem. The apt installation will use the Opscode APT repository.
|
68
|
-
|
69
|
-
In addition to handling the software installation, these bootstrap
|
70
|
-
templates do the following:
|
71
|
-
|
72
|
-
- Write the validation.pem per the local knife configuration.
|
73
|
-
- Write a default config file for Chef (`/etc/chef/client.rb`) using values from the `knife.rb`.
|
74
|
-
- Create a JSON attributes file containing the specified run list and run Chef.
|
75
|
-
|
76
|
-
In the case of the RubyGems, the `client.rb` will be written from
|
77
|
-
scratch with a minimal set of values; see __EXAMPLES__. In the case of
|
78
|
-
APT Package installation, `client.rb` will have the
|
79
|
-
`validation_client_name` appended if it is not set to `chef-validator`
|
80
|
-
(default config value), and the `node_name` will be added if
|
81
|
-
`chef_node_name` option is specified.
|
82
|
-
|
83
|
-
When this is complete, the bootstrapped node will have:
|
84
|
-
|
85
|
-
- Latest Chef version installed from RubyGems or APT Packages from Opscode. This may be a later version than the local system.
|
86
|
-
- Be validated with the configured Chef Server.
|
87
|
-
- Have run Chef with its default run list if one is specified.
|
88
|
-
|
89
|
-
Additional custom bootstrap templates can be created and stored in
|
90
|
-
`.chef/bootstrap/DISTRO.erb`, replacing __DISTRO__ with the value passed
|
91
|
-
with the `-d` or `--distro` option. See __EXAMPLES__ for more
|
92
|
-
information.
|
93
|
-
|
94
|
-
## EXAMPLES
|
95
|
-
Setting up a custom bootstrap is fairly straightforward. Create a
|
96
|
-
`.chef/bootstrap` directory in your Chef Repository or in
|
97
|
-
`$HOME/.chef/bootstrap`. Then create the ERB template file.
|
98
|
-
|
99
|
-
mkdir ~/.chef/bootstrap
|
100
|
-
vi ~/.chef/bootstrap/debian5.0-apt.erb
|
101
|
-
|
102
|
-
For example, to create a new bootstrap template that should be used when
|
103
|
-
setting up a new Debian node. Edit the template to run the commands, set
|
104
|
-
up the validation certificate and the client configuration file, and
|
105
|
-
finally to run chef-client on completion. The bootstrap template can be
|
106
|
-
called with:
|
107
|
-
|
108
|
-
knife bootstrap mynode.example.com --template-file ~/.chef/bootstrap/debian5.0-apt.erb
|
109
|
-
|
110
|
-
Or,
|
111
|
-
|
112
|
-
knife bootstrap mynode.example.com --distro debian5.0-apt
|
113
|
-
|
114
|
-
The `--distro` parameter will automatically look in the
|
115
|
-
`~/.chef/bootstrap` directory for a file named `debian5.0-apt.erb`.
|
116
|
-
|
117
|
-
Templates provided by the Chef installation are located in
|
118
|
-
`BASEDIR/lib/chef/knife/bootstrap/*.erb`, where _BASEDIR_ is the
|
119
|
-
location where the package or Gem installed the Chef client libraries.
|
120
|
-
|
121
|
-
## BUGS
|
122
|
-
`knife bootstrap` is not capable of bootstrapping multiple hosts in
|
123
|
-
parallel.
|
124
|
-
|
125
|
-
The bootstrap script is passed as an argument to sh(1) on the remote
|
126
|
-
system, so sensitive information contained in the script will be visible
|
127
|
-
to other users via the process list using tools such as ps(1).
|
128
|
-
|
129
|
-
## SEE ALSO
|
130
|
-
__knife-ssh__(1)
|
131
|
-
|
132
|
-
## AUTHOR
|
133
|
-
Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
|
134
|
-
|
135
|
-
## DOCUMENTATION
|
136
|
-
This manual page was written by Joshua Timberman <joshua@opscode.com>.
|
137
|
-
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
|
138
|
-
|
139
|
-
|
140
|
-
## CHEF
|
141
|
-
Knife is distributed with Chef. <http://docs.chef.io>
|
@@ -1,103 +0,0 @@
|
|
1
|
-
knife-client(1) -- Manage Chef API Clients
|
2
|
-
========================================
|
3
|
-
|
4
|
-
## SYNOPSIS
|
5
|
-
|
6
|
-
__knife__ __client__ _sub-command_ _(options)_
|
7
|
-
|
8
|
-
## SUB-COMMANDS
|
9
|
-
Client subcommands follow a basic create, read, update, delete (CRUD)
|
10
|
-
pattern. The Following subcommands are available:
|
11
|
-
|
12
|
-
## BULK DELETE
|
13
|
-
__knife client bulk delete__ _regex_ _(options)_
|
14
|
-
|
15
|
-
Delete clients where the client name matches the regular expression
|
16
|
-
_regex_ on the Chef Server. The regular expression should be given as a
|
17
|
-
quoted string, and not surrounded by forward slashes.
|
18
|
-
|
19
|
-
## CREATE
|
20
|
-
__knife client create__ _client name_ _(options)_
|
21
|
-
|
22
|
-
* `-a`, `--admin `:
|
23
|
-
Create the client as an admin
|
24
|
-
* `-f`, `--file FILE`:
|
25
|
-
Write the key to a file
|
26
|
-
|
27
|
-
Create a new client. This generates an RSA keypair. The private key will
|
28
|
-
be displayed on _STDOUT_ or written to the named file. The public half
|
29
|
-
will be stored on the Server. For _chef-client_ systems, the private key
|
30
|
-
should be copied to the system as `/etc/chef/client.pem`.
|
31
|
-
|
32
|
-
Admin clients should be created for users that will use _knife_ to
|
33
|
-
access the API as an administrator. The private key will generally be
|
34
|
-
copied to `~/.chef/client\_name.pem` and referenced in the `knife.rb`
|
35
|
-
configuration file.
|
36
|
-
|
37
|
-
## DELETE
|
38
|
-
__knife client delete__ _client name_ _(options)_
|
39
|
-
|
40
|
-
Deletes a registered client.
|
41
|
-
|
42
|
-
## EDIT
|
43
|
-
__client edit__ _client name_ _(options)_
|
44
|
-
|
45
|
-
Edit a registered client.
|
46
|
-
|
47
|
-
## LIST
|
48
|
-
__client list__ _(options)_
|
49
|
-
|
50
|
-
* `-w`, `--with-uri`:
|
51
|
-
Show corresponding URIs
|
52
|
-
|
53
|
-
List all registered clients.
|
54
|
-
|
55
|
-
## REREGISTER
|
56
|
-
__client reregister__ _client name_ _(options)_
|
57
|
-
|
58
|
-
* `-f`, `--file FILE`:
|
59
|
-
Write the key to a file
|
60
|
-
|
61
|
-
Regenerate the RSA keypair for a client. The public half will be stored
|
62
|
-
on the server and the private key displayed on _STDOUT_ or written to
|
63
|
-
the named file. This operation will invalidate the previous keypair used
|
64
|
-
by the client, preventing it from authenticating with the Chef Server.
|
65
|
-
Use care when reregistering the validator client.
|
66
|
-
|
67
|
-
## SHOW
|
68
|
-
__client show__ _client name_ _(options)_
|
69
|
-
|
70
|
-
* `-a`, `--attribute ATTR`:
|
71
|
-
Show only one attribute
|
72
|
-
|
73
|
-
Show a client. Output format is determined by the --format option.
|
74
|
-
|
75
|
-
## DESCRIPTION
|
76
|
-
Clients are identities used for communication with the Chef Server API,
|
77
|
-
roughly equivalent to user accounts on the Chef Server, except that
|
78
|
-
clients only communicate with the Chef Server API and are authenticated
|
79
|
-
via request signatures.
|
80
|
-
|
81
|
-
In the typical case, there will be one client object on the server for
|
82
|
-
each node, and the corresponding client and node will have identical
|
83
|
-
names.
|
84
|
-
|
85
|
-
In the Chef authorization model, there is one special client, the
|
86
|
-
"validator", which is authorized to create new non-administrative
|
87
|
-
clients but has minimal privileges otherwise. This identity is used as a
|
88
|
-
sort of "guest account" to create a client identity when initially
|
89
|
-
setting up a host for management with Chef.
|
90
|
-
|
91
|
-
## SEE ALSO
|
92
|
-
__knife-node__(1)
|
93
|
-
|
94
|
-
## AUTHOR
|
95
|
-
Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
|
96
|
-
|
97
|
-
## DOCUMENTATION
|
98
|
-
This manual page was written by Joshua Timberman <joshua@opscode.com>.
|
99
|
-
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
|
100
|
-
|
101
|
-
## CHEF
|
102
|
-
Knife is distributed with Chef. <http://docs.chef.io>
|
103
|
-
|
@@ -1,71 +0,0 @@
|
|
1
|
-
knife-configure(1) -- Generate configuration files for knife or Chef Client
|
2
|
-
========================================
|
3
|
-
|
4
|
-
## SYNOPSIS
|
5
|
-
|
6
|
-
__knife__ __configure__ [client] _(options)_
|
7
|
-
|
8
|
-
## DESCRIPTION
|
9
|
-
Generates a knife.rb configuration file interactively. When given the
|
10
|
-
--initial option, also creates a new administrative user.
|
11
|
-
|
12
|
-
## CONFIGURE SUBCOMMANDS ##
|
13
|
-
|
14
|
-
__knife configure__ _(options)_
|
15
|
-
|
16
|
-
* `-i`, `--initial`:
|
17
|
-
Create an initial API Client
|
18
|
-
* `-r`, `--repository REPO`:
|
19
|
-
The path to your chef-repo
|
20
|
-
|
21
|
-
Create a configuration file for knife. This will prompt for values to
|
22
|
-
enter into the file. Default values are listed in square brackets if no
|
23
|
-
other entry is typed. See __knife__(1) for a description of
|
24
|
-
configuration options.
|
25
|
-
|
26
|
-
__knife configure client__ _directory_
|
27
|
-
|
28
|
-
Read the _knife.rb_ config file and generate a config file suitable for
|
29
|
-
use in _/etc/chef/client.rb_ and copy the validation certificate into
|
30
|
-
the specified _directory_.
|
31
|
-
|
32
|
-
## EXAMPLES
|
33
|
-
* On a freshly installed Chef Server, use _knife configure -i_ to
|
34
|
-
create an administrator and knife configuration file. Leave the
|
35
|
-
field blank to accept the default value. On most systems, the
|
36
|
-
default values are acceptable (except for the chef server URL,
|
37
|
-
there you must add your organization name)
|
38
|
-
|
39
|
-
user@host$ knife configure -i
|
40
|
-
Please enter the chef server URL: [http://localhost/organizations/myorg]
|
41
|
-
Please enter a clientname for the new client: [username]
|
42
|
-
Please enter the existing admin clientname: [chef-webui]
|
43
|
-
Please enter the location of the existing admin client's private key: [/etc/chef/webui.pem]
|
44
|
-
Please enter the validation clientname: [chef-validator]
|
45
|
-
Please enter the location of the validation key: [/etc/chef/validation.pem]
|
46
|
-
Please enter the path to a chef repository (or leave blank):
|
47
|
-
Creating initial API user...
|
48
|
-
Created (or updated) client[username]
|
49
|
-
Configuration file written to /home/username/.chef/knife.rb
|
50
|
-
|
51
|
-
This creates a new administrator client named _username_, writes
|
52
|
-
a configuration file to _/home/username/.chef/knife.rb_, and the
|
53
|
-
private key to _/home/username/.chef/username.pem_. The
|
54
|
-
configuration file and private key may be copied to another system
|
55
|
-
to facilitate administration of the Chef Server from a remote
|
56
|
-
system. Depending on the value given for the Chef Server URL, you
|
57
|
-
may need to modify that setting after copying to a remote host.
|
58
|
-
|
59
|
-
## SEE ALSO
|
60
|
-
__knife__(1) __knife-client__(1)
|
61
|
-
|
62
|
-
## AUTHOR
|
63
|
-
Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
|
64
|
-
|
65
|
-
## DOCUMENTATION
|
66
|
-
This manual page was written by Joshua Timberman <joshua@opscode.com>.
|
67
|
-
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
|
68
|
-
|
69
|
-
## CHEF
|
70
|
-
Knife is distributed with Chef. <http://docs.chef.io>
|
71
|
-
|
@@ -1,123 +0,0 @@
|
|
1
|
-
knife-cookbook-site(1) -- Install and update open source cookbooks
|
2
|
-
========================================
|
3
|
-
|
4
|
-
## SYNOPSIS
|
5
|
-
|
6
|
-
__knife__ __cookbook site__ _sub-command_ _(options)_
|
7
|
-
|
8
|
-
## COOKBOOK SITE SUB-COMMANDS
|
9
|
-
`knife cookbook site` provides the following subcommands:
|
10
|
-
|
11
|
-
## INSTALL
|
12
|
-
__cookbook site install COOKBOOK [VERSION]__ _(options)_
|
13
|
-
|
14
|
-
* `-D`, `--skip-dependencies `:
|
15
|
-
Skip automatic installation of dependencies.
|
16
|
-
* `-o`, `--cookbook-path PATH`:
|
17
|
-
Install cookbooks to PATH
|
18
|
-
* `-B`, `--branch BRANCH`:
|
19
|
-
Default branch to work with [defaults to master]
|
20
|
-
|
21
|
-
Uses git(1) version control in conjunction with the cookbook site to
|
22
|
-
install community contributed cookbooks to your local cookbook
|
23
|
-
repository. Running `knife cookbook site install` does the following:
|
24
|
-
|
25
|
-
1. A new "pristine copy" branch is created in git for tracking the
|
26
|
-
upstream;
|
27
|
-
2. All existing cookbooks are removed from the branch;
|
28
|
-
3. The cookbook is downloaded from the cookbook site in tarball form;
|
29
|
-
4. The downloaded cookbook is untarred, and its contents committed via git;
|
30
|
-
5. The pristine copy branch is merged into the master branch.
|
31
|
-
|
32
|
-
By installing cookbook with this process, you can locally modify the
|
33
|
-
upstream cookbook in your master branch and let git maintain your
|
34
|
-
changes as a separate patch. When an updated upstream version becomes
|
35
|
-
available, you will be able to merge the upstream changes while
|
36
|
-
maintaining your local modifications.
|
37
|
-
|
38
|
-
Unless _--skip-dependencies_ is specified, the process is applied recursively to all the
|
39
|
-
cookbooks _COOKBOOK_ depends on (via metadata _dependencies_).
|
40
|
-
|
41
|
-
## DOWNLOAD
|
42
|
-
__knife cookbook site download COOKBOOK [VERSION]__ _(options)_
|
43
|
-
|
44
|
-
* `-f`, `--file FILE`:
|
45
|
-
The filename to write to
|
46
|
-
* `--force`:
|
47
|
-
Force download deprecated cookbook
|
48
|
-
|
49
|
-
Downloads a specific cookbook from the Community site, optionally
|
50
|
-
specifying a certain version.
|
51
|
-
|
52
|
-
## LIST
|
53
|
-
__knife cookbook site list__ _(options)_
|
54
|
-
|
55
|
-
* `-w`, `--with-uri`:
|
56
|
-
Show corresponding URIs
|
57
|
-
|
58
|
-
Lists available cookbooks from the Community site.
|
59
|
-
|
60
|
-
## SEARCH
|
61
|
-
__knife cookbook site search QUERY__ _(options)_
|
62
|
-
|
63
|
-
Searches for available cookbooks matching the specified query.
|
64
|
-
|
65
|
-
## SHARE
|
66
|
-
__knife cookbook site share COOKBOOK CATEGORY__ _(options)_
|
67
|
-
|
68
|
-
* `-k`, `--key KEY`:
|
69
|
-
API Client Key
|
70
|
-
* `-u`, `--user USER`:
|
71
|
-
API Client Username
|
72
|
-
* `-o`, `--cookbook-path PATH:PATH`:
|
73
|
-
A colon-separated path to look for cookbooks in
|
74
|
-
|
75
|
-
Uploads the specified cookbook using the given category to the Opscode
|
76
|
-
cookbooks site. Requires a login user and certificate for the Opscode
|
77
|
-
Cookbooks site. By default, knife will use the username and API key
|
78
|
-
you've configured in your configuration file; otherwise you must
|
79
|
-
explicitly set these values on the command line or use an alternate
|
80
|
-
configuration file.
|
81
|
-
|
82
|
-
## UNSHARE
|
83
|
-
__knife cookbook site unshare COOKBOOK__
|
84
|
-
|
85
|
-
Stops sharing the specified cookbook on the Opscode cookbooks site.
|
86
|
-
|
87
|
-
## SHOW
|
88
|
-
__knife cookbook site show COOKBOOK [VERSION]__ _(options)_
|
89
|
-
|
90
|
-
Shows information from the site about a particular cookbook.
|
91
|
-
|
92
|
-
## DESCRIPTION
|
93
|
-
The cookbook site, <http://community.opscode.com/>, is a cookbook
|
94
|
-
distribution service operated by Opscode. This service provides users
|
95
|
-
with a central location to publish cookbooks for sharing with other
|
96
|
-
community members.
|
97
|
-
|
98
|
-
`knife cookbook site` commands provide an interface to the cookbook
|
99
|
-
site's HTTP API. For commands that read data from the API, no account is
|
100
|
-
required. In order to upload cookbooks using the `knife cookbook site
|
101
|
-
share` command, you must create an account on the cookbook site and
|
102
|
-
configure your credentials via command line option or in your knife
|
103
|
-
configuration file.
|
104
|
-
|
105
|
-
## EXAMPLES
|
106
|
-
Uploading cookbooks to the Opscode cookbooks site:
|
107
|
-
|
108
|
-
knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME
|
109
|
-
|
110
|
-
## SEE ALSO
|
111
|
-
__knife-cookbook(1)__
|
112
|
-
<http://community.opscode.com/cookbooks>
|
113
|
-
|
114
|
-
## AUTHOR
|
115
|
-
Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
|
116
|
-
|
117
|
-
## DOCUMENTATION
|
118
|
-
This manual page was written by Joshua Timberman <joshua@opscode.com>.
|
119
|
-
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
|
120
|
-
|
121
|
-
## CHEF
|
122
|
-
Knife is distributed with Chef. <http://docs.chef.io>
|
123
|
-
|
@@ -1,263 +0,0 @@
|
|
1
|
-
knife-cookbook(1) -- upload and manage chef cookbooks
|
2
|
-
========================================
|
3
|
-
|
4
|
-
## SYNOPSIS
|
5
|
-
|
6
|
-
__knife__ __cookbook__ _sub-command_ _(options)_
|
7
|
-
|
8
|
-
## SUB-COMMANDS
|
9
|
-
`knife cookbook` supports the following sub commands:
|
10
|
-
|
11
|
-
## LIST
|
12
|
-
__knife cookbook list__ _(options)_
|
13
|
-
|
14
|
-
* `-a`, `--all`:
|
15
|
-
show all versions of a cookbook instead of just the most recent
|
16
|
-
* `-w`, `--with-uri`:
|
17
|
-
show corresponding uris
|
18
|
-
|
19
|
-
Lists the cookbooks available on the Chef server.
|
20
|
-
|
21
|
-
## SHOW
|
22
|
-
__knife cookbook show cookbook [version] [part] [filename]__ _(options)_
|
23
|
-
|
24
|
-
* `-f`, `--fqdn fqdn `:
|
25
|
-
the fqdn of the host to see the file for
|
26
|
-
* `-p`, `--platform platform `:
|
27
|
-
the platform to see the file for
|
28
|
-
* `-v`, `--platform-version version`:
|
29
|
-
the platform version to see the file for
|
30
|
-
* `-w`, `--with-uri`:
|
31
|
-
Show corresponding URIs
|
32
|
-
|
33
|
-
show a particular part of a _cookbook_ for the specified _version_. _part_ can be one of:
|
34
|
-
|
35
|
-
* _attributes_
|
36
|
-
* _definitions_
|
37
|
-
* _files_
|
38
|
-
* _libraries_
|
39
|
-
* _providers_
|
40
|
-
* _recipes_
|
41
|
-
* _resources_
|
42
|
-
* _templates_
|
43
|
-
|
44
|
-
## UPLOAD
|
45
|
-
__knife cookbook upload [cookbooks...]__ _(options)_
|
46
|
-
|
47
|
-
* `-a`, `--all`:
|
48
|
-
upload all cookbooks, rather than just a single cookbook
|
49
|
-
* `-o`, `--cookbook-path path:path`:
|
50
|
-
a colon-separated path to look for cookbooks in
|
51
|
-
* `-d`, `--upload-dependencies`:
|
52
|
-
Uploads additional cookbooks that this cookbook lists in as
|
53
|
-
dependencies in its metadata.
|
54
|
-
* `-E`, `--environment ENVIRONMENT`:
|
55
|
-
An _ENVIRONMENT_ to apply the uploaded cookbooks to. Specifying this
|
56
|
-
option will cause knife to edit the _ENVIRONMENT_ to place a strict
|
57
|
-
version constraint on the cookbook version(s) uploaded.
|
58
|
-
* `--freeze`:
|
59
|
-
Sets the frozen flag on the uploaded cookbook(s) Any future attempt
|
60
|
-
to modify the cookbook without changing the version number will
|
61
|
-
return an error unless --force is specified.
|
62
|
-
* `--force`:
|
63
|
-
Overrides the frozen flag on a cookbook, allowing you to overwrite a
|
64
|
-
cookbook version that has previously been uploaded with the --freeze
|
65
|
-
option.
|
66
|
-
|
67
|
-
Uploads one or more cookbooks from your local cookbook repository(ies)
|
68
|
-
to the Chef Server. Only files that don't yet exist on the server will
|
69
|
-
be uploaded.
|
70
|
-
|
71
|
-
As the command parses the name args as 1..n cookbook names:
|
72
|
-
`knife cookbook upload COOKBOOK COOKBOOK ...`
|
73
|
-
works for one to many cookbooks.
|
74
|
-
|
75
|
-
## DOWNLOAD
|
76
|
-
__knife cookbook download cookbook [version]__ _(options)_
|
77
|
-
|
78
|
-
* `-d`, `--dir download_directory`:
|
79
|
-
the directory to download the cookbook into
|
80
|
-
* `-f`, `--force`:
|
81
|
-
overwrite an existing directory with the download
|
82
|
-
* `-n`, `--latest`:
|
83
|
-
download the latest version of the cookbook
|
84
|
-
|
85
|
-
download a cookbook from the chef server. if no version is specified and
|
86
|
-
only one version exists on the server, that version will be downloaded.
|
87
|
-
if no version is specified and multiple versions are available on the
|
88
|
-
server, you will be prompted for a version to download.
|
89
|
-
|
90
|
-
## DELETE
|
91
|
-
__knife cookbook delete cookbook [version]__ _(options)_
|
92
|
-
|
93
|
-
* `-a`, `--all`:
|
94
|
-
delete all versions
|
95
|
-
* `-p`, `--purge`:
|
96
|
-
purge files from backing store. this will disable any cookbook that contains any of the same files as the cookbook being purged.
|
97
|
-
|
98
|
-
delete the specified _version_ of the named _cookbook_. if no version is
|
99
|
-
specified, and only one version exists on the server, that version will
|
100
|
-
be deleted. if multiple versions are available on the server, you will
|
101
|
-
be prompted for a version to delete.
|
102
|
-
|
103
|
-
## BULK DELETE
|
104
|
-
__knife cookbook bulk delete regex__ _(options)_
|
105
|
-
|
106
|
-
* `-p`, `--purge`:
|
107
|
-
purge files from backing store. this will disable any cookbook that
|
108
|
-
contains any of the same files as the cookbook being purged.
|
109
|
-
|
110
|
-
delete cookbooks on the chef server based on a regular expression. the
|
111
|
-
regular expression (_regex_) should be in quotes, not in //'s.
|
112
|
-
|
113
|
-
## COOKBOOK CREATE
|
114
|
-
__knife cookbook create cookbook__ _(options)_
|
115
|
-
|
116
|
-
* `-o`, `--cookbook-path path`:
|
117
|
-
the directory where the cookbook will be created
|
118
|
-
* `-r`, `--readme-format format`:
|
119
|
-
format of the readme file md, mkd, txt, rdoc
|
120
|
-
* `-C`, `--copyright copyright`:
|
121
|
-
name of copyright holder
|
122
|
-
* `-i`, `--license license`:
|
123
|
-
license for cookbook, apachev2 or none
|
124
|
-
* `-m`, `--email email`:
|
125
|
-
email address of cookbook maintainer
|
126
|
-
|
127
|
-
this is a helper command that creates a new cookbook directory in the
|
128
|
-
`cookbook_path`. the following directories and files are created for the
|
129
|
-
named cookbook.
|
130
|
-
|
131
|
-
* cookbook/attributes
|
132
|
-
* cookbook/definitions
|
133
|
-
* cookbook/files/default
|
134
|
-
* cookbook/libraries
|
135
|
-
* cookbook/metadata.rb
|
136
|
-
* cookbook/providers
|
137
|
-
* cookbook/readme.md
|
138
|
-
* cookbook/recipes/default.rb
|
139
|
-
* cookbook/resources
|
140
|
-
* cookbook/templates/default
|
141
|
-
|
142
|
-
supported readme formats are 'md' (default), 'mkd', 'txt', 'rdoc'. the
|
143
|
-
readme file will be written with the specified extension and a set of
|
144
|
-
helpful starting headers.
|
145
|
-
|
146
|
-
specify `-C` or `--copyright` with the name of the copyright holder as
|
147
|
-
your name or your company/organization name in a quoted string. if this
|
148
|
-
value is not specified an all-caps string `your_company_name` is used
|
149
|
-
which can be easily changed with find/replace.
|
150
|
-
|
151
|
-
specify `-i` or `--license` with the license that the cookbook is
|
152
|
-
distributed under for sharing with other people or posting to the
|
153
|
-
opscode cookbooks site. be aware of the licenses of files you put inside
|
154
|
-
the cookbook and follow any restrictions they describe. when using
|
155
|
-
`none` (default) or `apachev2`, comment header text and metadata file
|
156
|
-
are pre-filled. the `none` license will be treated as
|
157
|
-
non-redistributable.
|
158
|
-
|
159
|
-
specify `-m` or `--email` with the email address of the cookbook's
|
160
|
-
maintainer. if this value is not specified, an all-caps string
|
161
|
-
`your_email` is used which can easily be changed with find/replace.
|
162
|
-
|
163
|
-
the cookbook copyright, license, email and readme_format settings can be filled in the
|
164
|
-
`knife.rb`, for example with default values:
|
165
|
-
|
166
|
-
cookbook_copyright "your_company_name"
|
167
|
-
cookbook_license "none"
|
168
|
-
cookbook_email "your_email"
|
169
|
-
readme_format "md"
|
170
|
-
|
171
|
-
|
172
|
-
## METADATA
|
173
|
-
__knife cookbook metadata cookbook__ _(options)_
|
174
|
-
|
175
|
-
* `-a`, `--all`:
|
176
|
-
generate metadata for all cookbooks, rather than just a single cookbook
|
177
|
-
* `-o`, `--cookbook-path path:path`:
|
178
|
-
a colon-separated path to look for cookbooks in
|
179
|
-
|
180
|
-
generate cookbook metadata for the named _cookbook_. the _path_ used here specifies where the cookbooks directory is located and corresponds to the `cookbook_path` configuration option.
|
181
|
-
|
182
|
-
## METADATA FROM FILE
|
183
|
-
__knife cookbook metadata from file__ _(options)_
|
184
|
-
|
185
|
-
load the cookbook metadata from a specified file.
|
186
|
-
|
187
|
-
## TEST
|
188
|
-
__knife cookbook test [cookbooks...]__ _(options)_
|
189
|
-
|
190
|
-
* `-a`, `--all`:
|
191
|
-
test all cookbooks, rather than just a single cookbook
|
192
|
-
* `-o`, `--cookbook-path path:path`:
|
193
|
-
a colon-separated path to look for cookbooks in
|
194
|
-
|
195
|
-
test the specified cookbooks for syntax errors. this uses the built-in
|
196
|
-
ruby syntax checking option for files in the cookbook ending in `.rb`,
|
197
|
-
and the erb syntax check for files ending in `.erb` (templates).
|
198
|
-
|
199
|
-
## RECIPE LIST
|
200
|
-
__knife recipe list [PATTERN]__
|
201
|
-
|
202
|
-
List available recipes from the server. Specify _PATTERN_ as a regular
|
203
|
-
expression to limit the results.
|
204
|
-
|
205
|
-
## DESCRIPTION
|
206
|
-
Cookbooks are the fundamental unit of distribution in Chef. They
|
207
|
-
encapsulate all recipes of resources and assets used to configure a
|
208
|
-
particular aspect of the infrastructure. The following sub-commands can
|
209
|
-
be used to manipulate the cookbooks stored on the Chef Server.
|
210
|
-
|
211
|
-
On disk, cookbooks are directories with a defined structure. The
|
212
|
-
following directories may appear within a cookbook:
|
213
|
-
|
214
|
-
* COOKBOOK/attributes/:
|
215
|
-
Ruby files that define default parameters to be used in recipes
|
216
|
-
* COOKBOOK/definitions/:
|
217
|
-
Ruby files that contain _resource definitions_
|
218
|
-
* COOKBOOK/files/SPECIFICITY:
|
219
|
-
Files of arbitrary type. These files may be downloaded by
|
220
|
-
chef-client(8) when configuring a host.
|
221
|
-
* COOKBOOK/libraries/:
|
222
|
-
Ruby files that contain library code needed for recipes
|
223
|
-
* COOKBOOK/providers/:
|
224
|
-
Ruby files that contain Lightweight Provider definitions
|
225
|
-
* COOKBOOK/recipes/:
|
226
|
-
Ruby files that use Chef's recipe DSL to describe the desired
|
227
|
-
configuration of a system
|
228
|
-
* COOKBOOK/resources/:
|
229
|
-
Ruby files that contain Lightweight Resource definitions
|
230
|
-
* COOKBOOK/templates/SPECIFICITY:
|
231
|
-
ERuby (ERb) template files. These are referenced by _recipes_ and
|
232
|
-
evaluated to dynamically generate configuration files.
|
233
|
-
|
234
|
-
__SPECIFICITY__ is a feature of _files_ and _templates_ that allow you
|
235
|
-
to specify alternate files to be used on a specific OS platform or host.
|
236
|
-
The default specificity setting is _default_, that is files in
|
237
|
-
`COOKBOOK/files/default` will be used when a more specific copy is not
|
238
|
-
available. Further documentation for this feature is available on the
|
239
|
-
Chef wiki: <https://docs.chef.io/resource_cookbook_file.html#file-specificity>
|
240
|
-
|
241
|
-
Cookbooks also contain a metadata file that defines various properties
|
242
|
-
of the cookbook. The most important of these are the _version_ and the
|
243
|
-
_dependencies_. The _version_ is used in combination with environments
|
244
|
-
to select which copy of a given cookbook is distributed to a node. The
|
245
|
-
_dependencies_ are used by the server to determine which additional
|
246
|
-
cookbooks must be distributed to a given host when it requires a
|
247
|
-
cookbook.
|
248
|
-
|
249
|
-
## SEE ALSO
|
250
|
-
__knife-environment(1)__ __knife-cookbook-site(1)__
|
251
|
-
<http://docs.chef.io/cookbooks.html>
|
252
|
-
<http://docs.chef.io/cookbook_repo.html>
|
253
|
-
|
254
|
-
## AUTHOR
|
255
|
-
Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
|
256
|
-
|
257
|
-
## DOCUMENTATION
|
258
|
-
This manual page was written by Joshua Timberman <joshua@opscode.com>.
|
259
|
-
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
|
260
|
-
|
261
|
-
|
262
|
-
## CHEF
|
263
|
-
Knife is distributed with Chef. <http://docs.chef.io>
|