chef 0.10.4.rc.4 → 0.10.4.rc.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. data/distro/common/html/chef-client.8.html +4 -4
  2. data/distro/common/html/chef-expander.8.html +4 -4
  3. data/distro/common/html/chef-expanderctl.8.html +4 -4
  4. data/distro/common/html/chef-server-webui.8.html +4 -4
  5. data/distro/common/html/chef-server.8.html +4 -4
  6. data/distro/common/html/chef-solo.8.html +4 -4
  7. data/distro/common/html/chef-solr.8.html +4 -4
  8. data/distro/common/html/knife-bootstrap.1.html +4 -4
  9. data/distro/common/html/knife-client.1.html +4 -4
  10. data/distro/common/html/knife-configure.1.html +4 -4
  11. data/distro/common/html/knife-cookbook-site.1.html +6 -6
  12. data/distro/common/html/knife-cookbook.1.html +11 -4
  13. data/distro/common/html/knife-data-bag.1.html +4 -4
  14. data/distro/common/html/knife-environment.1.html +4 -4
  15. data/distro/common/html/knife-exec.1.html +4 -4
  16. data/distro/common/html/knife-index.1.html +4 -4
  17. data/distro/common/html/knife-node.1.html +7 -6
  18. data/distro/common/html/knife-role.1.html +4 -4
  19. data/distro/common/html/knife-search.1.html +177 -24
  20. data/distro/common/html/knife-ssh.1.html +5 -4
  21. data/distro/common/html/knife-status.1.html +4 -4
  22. data/distro/common/html/knife-tag.1.html +4 -4
  23. data/distro/common/html/knife.1.html +4 -4
  24. data/distro/common/html/shef.1.html +4 -4
  25. data/distro/common/man/man1/knife-bootstrap.1 +189 -0
  26. data/distro/common/man/man1/knife-client.1 +99 -0
  27. data/distro/common/man/man1/knife-configure.1 +88 -0
  28. data/distro/common/man/man1/knife-cookbook-site.1 +137 -0
  29. data/distro/common/man/man1/knife-cookbook.1 +340 -0
  30. data/distro/common/man/man1/knife-data-bag.1 +130 -0
  31. data/distro/common/man/man1/knife-environment.1 +178 -0
  32. data/distro/common/man/man1/knife-exec.1 +46 -0
  33. data/distro/common/man/man1/knife-index.1 +29 -0
  34. data/distro/common/man/man1/knife-node.1 +154 -0
  35. data/distro/common/man/man1/knife-role.1 +88 -0
  36. data/distro/common/man/man1/knife-search.1 +270 -0
  37. data/distro/common/man/man1/knife-ssh.1 +78 -0
  38. data/distro/common/man/man1/knife-status.1 +29 -0
  39. data/distro/common/man/man1/knife-tag.1 +43 -0
  40. data/distro/common/man/man1/knife.1 +251 -0
  41. data/distro/common/man/man1/shef.1 +256 -0
  42. data/distro/common/man/man8/chef-client.8 +84 -0
  43. data/distro/common/man/man8/chef-expander.8 +97 -0
  44. data/distro/common/man/man8/chef-expanderctl.8 +62 -0
  45. data/distro/common/man/man8/chef-server-webui.8 +155 -0
  46. data/distro/common/man/man8/chef-server.8 +147 -0
  47. data/distro/common/man/man8/chef-solo.8 +158 -0
  48. data/distro/common/man/man8/chef-solr.8 +114 -0
  49. data/distro/common/markdown/man1/knife-search.mkd +130 -6
  50. data/lib/chef/provider/package/apt.rb +34 -24
  51. data/lib/chef/version.rb +1 -1
  52. metadata +28 -4
@@ -0,0 +1,99 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "KNIFE\-CLIENT" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
5
+ .
6
+ .SH "NAME"
7
+ \fBknife\-client\fR \- Manage Chef API Clients
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBknife\fR \fBclient\fR \fIsub\-command\fR \fI(options)\fR
11
+ .
12
+ .SH "SUB\-COMMANDS"
13
+ Client subcommands follow a basic create, read, update, delete (CRUD) pattern\. The Following subcommands are available:
14
+ .
15
+ .SH "BULK DELETE"
16
+ \fBknife client bulk delete\fR \fIregex\fR \fI(options)\fR
17
+ .
18
+ .P
19
+ Delete clients where the client name matches the regular expression \fIregex\fR on the Chef Server\. The regular expression should be given as a quoted string, and not surrounded by forward slashes\.
20
+ .
21
+ .SH "CREATE"
22
+ \fBknife client create\fR \fIclient name\fR \fI(options)\fR
23
+ .
24
+ .TP
25
+ \fB\-a\fR, \fB\-\-admin\fR
26
+ Create the client as an admin
27
+ .
28
+ .TP
29
+ \fB\-f\fR, \fB\-\-file FILE\fR
30
+ Write the key to a file
31
+ .
32
+ .P
33
+ Create a new client\. This generates an RSA keypair\. The private key will be displayed on \fISTDOUT\fR or written to the named file\. The public half will be stored on the Server\. For \fIchef\-client\fR systems, the private key should be copied to the system as \fB/etc/chef/client\.pem\fR\.
34
+ .
35
+ .P
36
+ Admin clients should be created for users that will use \fIknife\fR to access the API as an administrator\. The private key will generally be copied to \fB~/\.chef/client\e_name\.pem\fR and referenced in the \fBknife\.rb\fR configuration file\.
37
+ .
38
+ .SH "DELETE"
39
+ \fBknife client delete\fR \fIclient name\fR \fI(options)\fR
40
+ .
41
+ .P
42
+ Deletes a registered client\.
43
+ .
44
+ .SH "EDIT"
45
+ \fBclient edit\fR \fIclient name\fR \fI(options)\fR
46
+ .
47
+ .P
48
+ Edit a registered client\.
49
+ .
50
+ .SH "LIST"
51
+ \fBclient list\fR \fI(options)\fR
52
+ .
53
+ .TP
54
+ \fB\-w\fR, \fB\-\-with\-uri\fR
55
+ Show corresponding URIs
56
+ .
57
+ .P
58
+ List all registered clients\.
59
+ .
60
+ .SH "REREGISTER"
61
+ \fBclient reregister\fR \fIclient name\fR \fI(options)\fR
62
+ .
63
+ .TP
64
+ \fB\-f\fR, \fB\-\-file FILE\fR
65
+ Write the key to a file
66
+ .
67
+ .P
68
+ Regenerate the RSA keypair for a client\. The public half will be stored on the server and the private key displayed on \fISTDOUT\fR or written to the named file\. This operation will invalidate the previous keypair used by the client, preventing it from authenticating with the Chef Server\. Use care when reregistering the validator client\.
69
+ .
70
+ .SH "SHOW"
71
+ \fBclient show\fR \fIclient name\fR \fI(options)\fR
72
+ .
73
+ .TP
74
+ \fB\-a\fR, \fB\-\-attribute ATTR\fR
75
+ Show only one attribute
76
+ .
77
+ .P
78
+ Show a client\. Output format is determined by the \-\-format option\.
79
+ .
80
+ .SH "DESCRIPTION"
81
+ Clients are identities used for communication with the Chef Server API, roughly equivalent to user accounts on the Chef Server, except that clients only communicate with the Chef Server API and are authenticated via request signatures\.
82
+ .
83
+ .P
84
+ In the typical case, there will be one client object on the server for each node, and the corresponding client and node will have identical names\.
85
+ .
86
+ .P
87
+ In the Chef authorization model, there is one special client, the "validator", which is authorized to create new non\-administrative clients but has minimal privileges otherwise\. This identity is used as a sort of "guest account" to create a client identity when initially setting up a host for management with Chef\.
88
+ .
89
+ .SH "SEE ALSO"
90
+ \fBknife\-node\fR(1)
91
+ .
92
+ .SH "AUTHOR"
93
+ Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
94
+ .
95
+ .SH "DOCUMENTATION"
96
+ This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
97
+ .
98
+ .SH "CHEF"
99
+ Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR
@@ -0,0 +1,88 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "KNIFE\-CONFIGURE" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
5
+ .
6
+ .SH "NAME"
7
+ \fBknife\-configure\fR \- Generate configuration files for knife or Chef Client
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBknife\fR \fBconfigure\fR [client] \fI(options)\fR
11
+ .
12
+ .SH "DESCRIPTION"
13
+ Generates a knife\.rb configuration file interactively\. When given the \-\-initial option, also creates a new administrative user\.
14
+ .
15
+ .SH "CONFIGURE SUBCOMMANDS"
16
+ \fBknife configure\fR \fI(options)\fR
17
+ .
18
+ .TP
19
+ \fB\-i\fR, \fB\-\-initial\fR
20
+ Create an initial API Client
21
+ .
22
+ .TP
23
+ \fB\-r\fR, \fB\-\-repository REPO\fR
24
+ The path to your chef\-repo
25
+ .
26
+ .P
27
+ Create a configuration file for knife\. This will prompt for values to enter into the file\. Default values are listed in square brackets if no other entry is typed\. See \fBknife\fR(1) for a description of configuration options\.
28
+ .
29
+ .P
30
+ \fBknife configure client\fR \fIdirectory\fR
31
+ .
32
+ .P
33
+ Read the \fIknife\.rb\fR config file and generate a config file suitable for use in \fI/etc/chef/client\.rb\fR and copy the validation certificate into the specified \fIdirectory\fR\.
34
+ .
35
+ .SH "EXAMPLES"
36
+ .
37
+ .IP "\(bu" 4
38
+ On a freshly installed Chef Server, use \fIknife configure \-i\fR to create an administrator and knife configuration file\. Leave the field blank to accept the default value\. On most systems, the default values are acceptable\.
39
+ .
40
+ .IP
41
+ user@host$ knife configure \-i
42
+ .
43
+ .br
44
+ Please enter the chef server URL: [http://localhost:4000]
45
+ .
46
+ .br
47
+ Please enter a clientname for the new client: [username]
48
+ .
49
+ .br
50
+ Please enter the existing admin clientname: [chef\-webui]
51
+ .
52
+ .br
53
+ Please enter the location of the existing admin client\'s private key: [/etc/chef/webui\.pem]
54
+ .
55
+ .br
56
+ Please enter the validation clientname: [chef\-validator]
57
+ .
58
+ .br
59
+ Please enter the location of the validation key: [/etc/chef/validation\.pem]
60
+ .
61
+ .br
62
+ Please enter the path to a chef repository (or leave blank):
63
+ .
64
+ .br
65
+ Creating initial API user\.\.\.
66
+ .
67
+ .br
68
+ Created (or updated) client[username]
69
+ .
70
+ .br
71
+ Configuration file written to /home/username/\.chef/knife\.rb
72
+ .
73
+ .IP
74
+ This creates a new administrator client named \fIusername\fR, writes a configuration file to \fI/home/username/\.chef/knife\.rb\fR, and the private key to \fI/home/username/\.chef/username\.pem\fR\. The configuration file and private key may be copied to another system to facilitate administration of the Chef Server from a remote system\. Depending on the value given for the Chef Server URL, you may need to modify that setting after copying to a remote host\.
75
+ .
76
+ .IP "" 0
77
+ .
78
+ .SH "SEE ALSO"
79
+ \fBknife\fR(1) \fBknife\-client\fR(1)
80
+ .
81
+ .SH "AUTHOR"
82
+ Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
83
+ .
84
+ .SH "DOCUMENTATION"
85
+ This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
86
+ .
87
+ .SH "CHEF"
88
+ Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR
@@ -0,0 +1,137 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "KNIFE\-COOKBOOK\-SITE" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
5
+ .
6
+ .SH "NAME"
7
+ \fBknife\-cookbook\-site\fR \- Install and update open source cookbooks
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBknife\fR \fBcookbook site\fR \fIsub\-command\fR \fI(options)\fR
11
+ .
12
+ .SH "COOKBOOK SITE SUB\-COMMANDS"
13
+ \fBknife cookbook site\fR provides the following subcommands:
14
+ .
15
+ .SH "INSTALL"
16
+ \fBcookbook site install COOKBOOK [VERSION]\fR \fI(options)\fR
17
+ .
18
+ .TP
19
+ \fB\-D\fR, \fB\-\-no\-dependencies\fR
20
+ Do not install dependencies automatically
21
+ .
22
+ .P
23
+ Uses git(1) version control in conjunction with the cookbook site to install community contributed cookbooks to your local cookbook repository\. Running \fBknife cookbook site install\fR does the following:
24
+ .
25
+ .IP "1." 4
26
+ A new "pristine copy" branch is created in git for tracking the upstream;
27
+ .
28
+ .IP "2." 4
29
+ All existing cookbooks are removed from the branch;
30
+ .
31
+ .IP "3." 4
32
+ The cookbook is downloaded from the cookbook site in tarball form;
33
+ .
34
+ .IP "4." 4
35
+ The downloaded cookbook is untarred, and its contents commited via git;
36
+ .
37
+ .IP "5." 4
38
+ The pristine copy branch is merged into the master branch\.
39
+ .
40
+ .IP "" 0
41
+ .
42
+ .P
43
+ By installing cookbook with this process, you can locally modify the upstream cookbook in your master branch ant let git maintain your changes as a separate patch\. When an updated upstream version becomes available, you will be able to merge the upstream changes while maintaining your local modifications\.
44
+ .
45
+ .P
46
+ Unless \fI\-D\fR is specified, the process is applied recursively to all the cookbooks \fICOOKBOOK\fR depends on (via metadata \fIdependencies\fR)\.
47
+ .
48
+ .SH "DOWNLOAD"
49
+ \fBknife cookbook site download COOKBOOK [VERSION]\fR \fI(options)\fR
50
+ .
51
+ .TP
52
+ \fB\-f\fR, \fB\-\-file FILE\fR
53
+ The filename to write to
54
+ .
55
+ .TP
56
+ \fB\-\-force\fR
57
+ Force download deprecated cookbook
58
+ .
59
+ .P
60
+ Downloads a specific cookbook from the Community site, optionally specifying a certain version\.
61
+ .
62
+ .SH "LIST"
63
+ \fBknife cookbook site list\fR \fI(options)\fR
64
+ .
65
+ .TP
66
+ \fB\-w\fR, \fB\-\-with\-uri\fR
67
+ Show corresponding URIs
68
+ .
69
+ .P
70
+ Lists available cookbooks from the Community site\.
71
+ .
72
+ .SH "SEARCH"
73
+ \fBknife cookbook site search QUERY\fR \fI(options)\fR
74
+ .
75
+ .P
76
+ Searches for available cookbooks matching the specified query\.
77
+ .
78
+ .SH "SHARE"
79
+ \fBknife cookbook site share COOKBOOK CATEGORY\fR \fI(options)\fR
80
+ .
81
+ .TP
82
+ \fB\-k\fR, \fB\-\-key KEY\fR
83
+ API Client Key
84
+ .
85
+ .TP
86
+ \fB\-u\fR, \fB\-\-user USER\fR
87
+ API Client Username
88
+ .
89
+ .TP
90
+ \fB\-o\fR, \fB\-\-cookbook\-path PATH:PATH\fR
91
+ A colon\-separated path to look for cookbooks in
92
+ .
93
+ .P
94
+ Uploads the specified cookbook using the given category to the Opscode cookbooks site\. Requires a login user and certificate for the Opscode Cookbooks site\. By default, knife will use the username and API key you\'ve configured in your configuration file; otherwise you must explicitly set these values on the command line or use an alternate configuration file\.
95
+ .
96
+ .SH "UNSHARE"
97
+ \fBknife cookbook site unshare COOKBOOK\fR
98
+ .
99
+ .P
100
+ Stops sharing the specified cookbook on the Opscode cookbooks site\.
101
+ .
102
+ .SH "SHOW"
103
+ \fBknife cookbook site show COOKBOOK [VERSION]\fR \fI(options)\fR
104
+ .
105
+ .P
106
+ Shows information from the site about a particular cookbook\.
107
+ .
108
+ .SH "DESCRIPTION"
109
+ The cookbook site, \fIhttp://community\.opscode\.com/\fR, is a cookbook distribution service operated by Opscode\. This service provides users with a central location to publish cookbooks for sharing with other community members\.
110
+ .
111
+ .P
112
+ \fBknife cookbook site\fR commands provide an interface to the cookbook site\'s HTTP API\. For commands that read data from the API, no account is required\. In order to upload cookbooks using the \fBknife cookbook site share\fR command, you must create an account on the cookbook site and configure your credentials via command line option or in your knife configuration file\.
113
+ .
114
+ .SH "EXAMPLES"
115
+ Uploading cookbooks to the Opscode cookbooks site:
116
+ .
117
+ .IP "" 4
118
+ .
119
+ .nf
120
+
121
+ knife cookbook site share example Other \-k ~/\.chef/USERNAME\.pem \-u USERNAME
122
+ .
123
+ .fi
124
+ .
125
+ .IP "" 0
126
+ .
127
+ .SH "SEE ALSO"
128
+ \fBknife\-cookbook(1)\fR \fIhttp://community\.opscode\.com/cookbooks\fR
129
+ .
130
+ .SH "AUTHOR"
131
+ Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
132
+ .
133
+ .SH "DOCUMENTATION"
134
+ This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
135
+ .
136
+ .SH "CHEF"
137
+ Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR
@@ -0,0 +1,340 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "KNIFE\-COOKBOOK" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
5
+ .
6
+ .SH "NAME"
7
+ \fBknife\-cookbook\fR \- upload and manage chef cookbooks
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBknife\fR \fBcookbook\fR \fIsub\-command\fR \fI(options)\fR
11
+ .
12
+ .SH "SUB\-COMMANDS"
13
+ \fBknife cookbook\fR supports the following sub commands:
14
+ .
15
+ .SH "LIST"
16
+ \fBknife cookbook list\fR \fI(options)\fR
17
+ .
18
+ .TP
19
+ \fB\-a\fR, \fB\-\-all\fR
20
+ show all versions of a cookbook instead of just the most recent
21
+ .
22
+ .TP
23
+ \fB\-w\fR, \fB\-\-with\-uri\fR
24
+ show corresponding uris
25
+ .
26
+ .P
27
+ Lists the cookbooks available on the Chef server\.
28
+ .
29
+ .SH "SHOW"
30
+ \fBknife cookbook show cookbook [version] [part] [filename]\fR \fI(options)\fR
31
+ .
32
+ .TP
33
+ \fB\-f\fR, \fB\-\-fqdn fqdn\fR
34
+ the fqdn of the host to see the file for
35
+ .
36
+ .TP
37
+ \fB\-p\fR, \fB\-\-platform platform\fR
38
+ the platform to see the file for
39
+ .
40
+ .TP
41
+ \fB\-v\fR, \fB\-\-platform\-version version\fR
42
+ the platform version to see the file for
43
+ .
44
+ .P
45
+ show a particular part of a \fIcookbook\fR for the specified \fIversion\fR\. \fIpart\fR can be one of:
46
+ .
47
+ .IP "\(bu" 4
48
+ \fIattributes\fR
49
+ .
50
+ .IP "\(bu" 4
51
+ \fIdefinitions\fR
52
+ .
53
+ .IP "\(bu" 4
54
+ \fIfiles\fR
55
+ .
56
+ .IP "\(bu" 4
57
+ \fIlibraries\fR
58
+ .
59
+ .IP "\(bu" 4
60
+ \fIproviders\fR
61
+ .
62
+ .IP "\(bu" 4
63
+ \fIrecipes\fR
64
+ .
65
+ .IP "\(bu" 4
66
+ \fIresources\fR
67
+ .
68
+ .IP "\(bu" 4
69
+ \fItemplates\fR
70
+ .
71
+ .IP "" 0
72
+ .
73
+ .SH "UPLOAD"
74
+ \fBknife cookbook upload [cookbooks\.\.\.]\fR \fI(options)\fR
75
+ .
76
+ .TP
77
+ \fB\-a\fR, \fB\-\-all\fR
78
+ upload all cookbooks, rather than just a single cookbook
79
+ .
80
+ .TP
81
+ \fB\-o\fR, \fB\-\-cookbook\-path path:path\fR
82
+ a colon\-separated path to look for cookbooks in
83
+ .
84
+ .TP
85
+ \fB\-d\fR, \fB\-\-upload\-dependencies\fR
86
+ Uploads additional cookbooks that this cookbook lists in as dependencies in its metadata\.
87
+ .
88
+ .TP
89
+ \fB\-E\fR, \fB\-\-environment ENVIRONMENT\fR
90
+ An \fIENVIRONMENT\fR to apply the uploaded cookbooks to\. Specifying this option will cause knife to edit the \fIENVIRONMENT\fR to place a strict version constraint on the cookbook version(s) uploaded\.
91
+ .
92
+ .TP
93
+ \fB\-\-freeze\fR
94
+ Sets the frozen flag on the uploaded cookbook(s) Any future attempt to modify the cookbook without changing the version number will return an error unless \-\-force is specified\.
95
+ .
96
+ .TP
97
+ \fB\-\-force\fR
98
+ Overrides the frozen flag on a cookbook, allowing you to overwrite a cookbook version that has previously been uploaded with the \-\-freeze option\.
99
+ .
100
+ .P
101
+ Uploads one or more cookbooks from your local cookbook repository(ies) to the Chef Server\. Only files that don\'t yet exist on the server will be uploaded\.
102
+ .
103
+ .P
104
+ As the command parses the name args as 1\.\.n cookbook names:
105
+ .
106
+ .IP "" 4
107
+ .
108
+ .nf
109
+
110
+ `knife cookbook upload COOKBOOK COOKBOOK \.\.\.`
111
+ .
112
+ .fi
113
+ .
114
+ .IP "" 0
115
+ .
116
+ .P
117
+ works for one to many cookbooks\.
118
+ .
119
+ .SH "DOWNLOAD"
120
+ \fBknife cookbook download cookbook [version]\fR \fI(options)\fR
121
+ .
122
+ .TP
123
+ \fB\-d\fR, \fB\-\-dir download_directory\fR
124
+ the directory to download the cookbook into
125
+ .
126
+ .TP
127
+ \fB\-f\fR, \fB\-\-force\fR
128
+ overwrite an existing directory with the download
129
+ .
130
+ .TP
131
+ \fB\-n\fR, \fB\-\-latest\fR
132
+ download the latest version of the cookbook
133
+ .
134
+ .P
135
+ download a cookbook from the chef server\. if no version is specified and only one version exists on the server, that version will be downloaded\. if no version is specified and multiple versions are available on the server, you will be prompted for a version to download\.
136
+ .
137
+ .SH "DELETE"
138
+ \fBknife cookbook delete cookbook [version]\fR \fI(options)\fR
139
+ .
140
+ .TP
141
+ \fB\-a\fR, \fB\-\-all\fR
142
+ delete all versions
143
+ .
144
+ .TP
145
+ \fB\-p\fR, \fB\-\-purge\fR
146
+ purge files from backing store\. this will disable any cookbook that contains any of the same files as the cookbook being purged\.
147
+ .
148
+ .P
149
+ delete the specified \fIversion\fR of the named \fIcookbook\fR\. if no version is specified, and only one version exists on the server, that version will be deleted\. if multiple versions are available on the server, you will be prompted for a version to delete\.
150
+ .
151
+ .SH "BULK DELETE"
152
+ \fBknife cookbook bulk delete regex\fR \fI(options)\fR
153
+ .
154
+ .TP
155
+ \fB\-p\fR, \fB\-\-purge\fR
156
+ purge files from backing store\. this will disable any cookbook that contains any of the same files as the cookbook being purged\.
157
+ .
158
+ .P
159
+ delete cookbooks on the chef server based on a regular expression\. the regular expression (\fIregex\fR) should be in quotes, not in //\'s\.
160
+ .
161
+ .SH "COOKBOOK CREATE"
162
+ \fBknife cookbook create cookbook\fR \fI(options)\fR
163
+ .
164
+ .TP
165
+ \fB\-o\fR, \fB\-\-cookbook\-path path\fR
166
+ the directory where the cookbook will be created
167
+ .
168
+ .TP
169
+ \fB\-r\fR, \fB\-\-readme\-format format\fR
170
+ format of the readme file
171
+ .
172
+ .TP
173
+ \fB\-c\fR, \fB\-\-copyright copyright\fR
174
+ name of copyright holder
175
+ .
176
+ .TP
177
+ \fB\-i\fR, \fB\-\-license license\fR
178
+ license for cookbook, apachev2 or none
179
+ .
180
+ .TP
181
+ \fB\-e\fR, \fB\-\-email email\fR
182
+ email address of cookbook maintainer
183
+ .
184
+ .P
185
+ this is a helper command that creates a new cookbook directory in the \fBcookbook_path\fR\. the following directories and files are created for the named cookbook\.
186
+ .
187
+ .IP "\(bu" 4
188
+ cookbook/attributes
189
+ .
190
+ .IP "\(bu" 4
191
+ cookbook/definitions
192
+ .
193
+ .IP "\(bu" 4
194
+ cookbook/files/default
195
+ .
196
+ .IP "\(bu" 4
197
+ cookbook/libraries
198
+ .
199
+ .IP "\(bu" 4
200
+ cookbook/metadata\.rb
201
+ .
202
+ .IP "\(bu" 4
203
+ cookbook/providers
204
+ .
205
+ .IP "\(bu" 4
206
+ cookbook/readme\.rdoc
207
+ .
208
+ .IP "\(bu" 4
209
+ cookbook/recipes/default\.rb
210
+ .
211
+ .IP "\(bu" 4
212
+ cookbook/resources
213
+ .
214
+ .IP "\(bu" 4
215
+ cookbook/templates/default
216
+ .
217
+ .IP "" 0
218
+ .
219
+ .P
220
+ supported readme formats are \'rdoc\' (default), \'md\', \'mkd\', \'txt\'\. the readme file will be written with the specified extension and a set of helpful starting headers\.
221
+ .
222
+ .P
223
+ specify \fB\-c\fR or \fB\-\-copyright\fR with the name of the copyright holder as your name or your company/organization name in a quoted string\. if this value is not specified an all\-caps string \fByour_company_name\fR is used which can be easily changed with find/replace\.
224
+ .
225
+ .P
226
+ specify \fB\-i\fR or \fB\-\-license\fR with the license that the cookbook is distributed under for sharing with other people or posting to the opscode cookbooks site\. be aware of the licenses of files you put inside the cookbook and follow any restrictions they describe\. when using \fBnone\fR (default) or \fBapachev2\fR, comment header text and metadata file are pre\-filled\. the \fBnone\fR license will be treated as non\-redistributable\.
227
+ .
228
+ .P
229
+ specify \fB\-e\fR or \fB\-\-email\fR with the email address of the cookbook\'s maintainer\. if this value is not specified, an all\-caps string \fByour_email\fR is used which can easily be changed with find/replace\.
230
+ .
231
+ .P
232
+ the cookbook copyright, license and email settings can be filled in the \fBknife\.rb\fR, for example with default values:
233
+ .
234
+ .IP "" 4
235
+ .
236
+ .nf
237
+
238
+ cookbook_copyright "your_company_name"
239
+ cookbook_license "none"
240
+ cookbook_email "your_email"
241
+ .
242
+ .fi
243
+ .
244
+ .IP "" 0
245
+ .
246
+ .SH "METADATA"
247
+ \fBknife cookbook metadata cookbook\fR \fI(options)\fR
248
+ .
249
+ .TP
250
+ \fB\-a\fR, \fB\-\-all\fR
251
+ generate metadata for all cookbooks, rather than just a single cookbook
252
+ .
253
+ .TP
254
+ \fB\-o\fR, \fB\-\-cookbook\-path path:path\fR
255
+ a colon\-separated path to look for cookbooks in
256
+ .
257
+ .P
258
+ generate cookbook metadata for the named \fIcookbook\fR\. the \fIpath\fR used here specifies where the cookbooks directory is located and corresponds to the \fBcookbook_path\fR configuration option\.
259
+ .
260
+ .SH "METADATA FROM FILE"
261
+ \fBknife cookbook metadata from file\fR \fI(options)\fR
262
+ .
263
+ .P
264
+ load the cookbook metadata from a specified file\.
265
+ .
266
+ .SH "TEST"
267
+ \fBknife cookbook test [cookbooks\.\.\.]\fR \fI(options)\fR
268
+ .
269
+ .TP
270
+ \fB\-a\fR, \fB\-\-all\fR
271
+ test all cookbooks, rather than just a single cookbook
272
+ .
273
+ .TP
274
+ \fB\-o\fR, \fB\-\-cookbook\-path path:path\fR
275
+ a colon\-separated path to look for cookbooks in
276
+ .
277
+ .P
278
+ test the specified cookbooks for syntax errors\. this uses the built\-in ruby syntax checking option for files in the cookbook ending in \fB\.rb\fR, and the erb syntax check for files ending in \fB\.erb\fR (templates)\.
279
+ .
280
+ .SH "RECIPE LIST"
281
+ \fBknife recipe list [PATTERN]\fR
282
+ .
283
+ .P
284
+ List available recipes from the server\. Specify \fIPATTERN\fR as a regular expression to limit the results\.
285
+ .
286
+ .SH "DESCRIPTION"
287
+ Cookbooks are the fundamental unit of distribution in Chef\. They encapsulate all recipes of resources and assets used to configure a particular aspect of the infrastructure\. The following sub\-commands can be used to manipulate the cookbooks stored on the Chef Server\.
288
+ .
289
+ .P
290
+ On disk, cookbooks are directories with a defined structure\. The following directories may appear within a cookbook:
291
+ .
292
+ .TP
293
+ COOKBOOK/attributes/
294
+ Ruby files that define default parameters to be used in recipes
295
+ .
296
+ .TP
297
+ COOKBOOK/definitions/
298
+ Ruby files that contain \fIresource definitions\fR
299
+ .
300
+ .TP
301
+ COOKBOOK/files/SPECIFICITY
302
+ Files of arbitrary type\. These files may be downloaded by chef\-client(8) when configuring a host\.
303
+ .
304
+ .TP
305
+ COOKBOOK/libraries/
306
+ Ruby files that contain library code needed for recipes
307
+ .
308
+ .TP
309
+ COOKBOOK/providers/
310
+ Ruby files that contain Lightweight Provider definitions
311
+ .
312
+ .TP
313
+ COOKBOOK/recipes/
314
+ Ruby files that use Chef\'s recipe DSL to describe the desired configuration of a system
315
+ .
316
+ .TP
317
+ COOKBOOK/resources/
318
+ Ruby files that contain Lightweight Resource definitions
319
+ .
320
+ .TP
321
+ COOKBOOK/templates/SPECIFICITY
322
+ ERuby (ERb) template files\. These are referenced by \fIrecipes\fR and evaluated to dynamically generate configuration files\.
323
+ .
324
+ .P
325
+ \fBSPECIFICITY\fR is a feature of \fIfiles\fR and \fItemplates\fR that allow you to specify alternate files to be used on a specific OS platform or host\. The default specificity setting is \fIdefault\fR, that is files in \fBCOOKBOOK/files/default\fR will be used when a more specific copy is not available\. Further documentation for this feature is available on the Chef wiki: \fIhttp://wiki\.opscode\.com/display/chef/File+Distribution#FileDistribution\-FileSpecificity\fR
326
+ .
327
+ .P
328
+ Cookbooks also contain a metadata file that defines various properties of the cookbook\. The most important of these are the \fIversion\fR and the \fIdependencies\fR\. The \fIversion\fR is used in combination with environments to select which copy of a given cookbook is distributed to a node\. The \fIdependencies\fR are used by the server to determine which additional cookbooks must be distributed to a given host when it requires a cookbook\.
329
+ .
330
+ .SH "SEE ALSO"
331
+ \fBknife\-environment(1)\fR \fBknife\-cookbook\-site(1)\fR \fIhttp://wiki\.opscode\.com/display/chef/Cookbooks\fR \fIhttp://wiki\.opscode\.com/display/chef/Metadata\fR
332
+ .
333
+ .SH "AUTHOR"
334
+ Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
335
+ .
336
+ .SH "DOCUMENTATION"
337
+ This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
338
+ .
339
+ .SH "CHEF"
340
+ Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR