chef 11.12.8 → 11.14.0.alpha.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (193) hide show
  1. checksums.yaml +4 -4
  2. data/Rakefile +4 -2
  3. data/distro/common/html/_sources/index.txt +6 -0
  4. data/distro/common/html/_sources/knife_ssl_check.txt +41 -0
  5. data/distro/common/html/_sources/knife_ssl_fetch.txt +41 -0
  6. data/distro/common/html/_static/basic.css +2 -5
  7. data/distro/common/html/_static/doctools.js +5 -14
  8. data/distro/common/html/_static/jquery.js +2 -154
  9. data/distro/common/html/_static/pygments.css +2 -2
  10. data/distro/common/html/_static/searchtools.js +212 -150
  11. data/distro/common/html/_static/underscore.js +29 -21
  12. data/distro/common/html/_static/websupport.js +1 -1
  13. data/distro/common/html/ctl_chef_client.html +15 -18
  14. data/distro/common/html/ctl_chef_server.html +7 -7
  15. data/distro/common/html/ctl_chef_shell.html +6 -6
  16. data/distro/common/html/ctl_chef_solo.html +7 -8
  17. data/distro/common/html/index.html +34 -24
  18. data/distro/common/html/knife.html +23 -24
  19. data/distro/common/html/knife_bootstrap.html +13 -9
  20. data/distro/common/html/knife_client.html +10 -11
  21. data/distro/common/html/knife_common_options.html +6 -7
  22. data/distro/common/html/knife_configure.html +3 -4
  23. data/distro/common/html/knife_cookbook.html +18 -11
  24. data/distro/common/html/knife_cookbook_site.html +14 -14
  25. data/distro/common/html/knife_data_bag.html +24 -23
  26. data/distro/common/html/knife_delete.html +4 -5
  27. data/distro/common/html/knife_deps.html +4 -5
  28. data/distro/common/html/knife_diff.html +6 -7
  29. data/distro/common/html/knife_download.html +12 -13
  30. data/distro/common/html/knife_edit.html +4 -5
  31. data/distro/common/html/knife_environment.html +8 -9
  32. data/distro/common/html/knife_exec.html +9 -10
  33. data/distro/common/html/knife_index_rebuild.html +4 -5
  34. data/distro/common/html/knife_list.html +8 -9
  35. data/distro/common/html/knife_node.html +34 -33
  36. data/distro/common/html/knife_raw.html +2 -3
  37. data/distro/common/html/knife_recipe_list.html +3 -4
  38. data/distro/common/html/knife_role.html +30 -29
  39. data/distro/common/html/knife_search.html +7 -7
  40. data/distro/common/html/knife_show.html +4 -5
  41. data/distro/common/html/knife_ssh.html +2 -3
  42. data/distro/common/html/knife_ssl_check.html +148 -0
  43. data/distro/common/html/knife_ssl_fetch.html +152 -0
  44. data/distro/common/html/knife_status.html +4 -5
  45. data/distro/common/html/knife_tag.html +2 -3
  46. data/distro/common/html/knife_upload.html +5 -6
  47. data/distro/common/html/knife_user.html +9 -10
  48. data/distro/common/html/knife_using.html +12 -12
  49. data/distro/common/html/knife_xargs.html +11 -12
  50. data/distro/common/html/search.html +1 -2
  51. data/distro/common/html/searchindex.js +1 -1
  52. data/distro/common/man/man1/chef-shell.1 +19 -11
  53. data/distro/common/man/man1/knife-bootstrap.1 +35 -19
  54. data/distro/common/man/man1/knife-client.1 +111 -28
  55. data/distro/common/man/man1/knife-configure.1 +30 -14
  56. data/distro/common/man/man1/knife-cookbook-site.1 +105 -22
  57. data/distro/common/man/man1/knife-cookbook.1 +164 -23
  58. data/distro/common/man/man1/knife-data-bag.1 +157 -33
  59. data/distro/common/man/man1/knife-delete.1 +21 -17
  60. data/distro/common/man/man1/knife-deps.1 +60 -16
  61. data/distro/common/man/man1/knife-diff.1 +37 -17
  62. data/distro/common/man/man1/knife-download.1 +68 -24
  63. data/distro/common/man/man1/knife-edit.1 +19 -15
  64. data/distro/common/man/man1/knife-environment.1 +105 -17
  65. data/distro/common/man/man1/knife-exec.1 +78 -18
  66. data/distro/common/man/man1/knife-index-rebuild.1 +16 -8
  67. data/distro/common/man/man1/knife-list.1 +39 -23
  68. data/distro/common/man/man1/knife-node.1 +170 -22
  69. data/distro/common/man/man1/knife-raw.1 +33 -13
  70. data/distro/common/man/man1/knife-recipe-list.1 +17 -5
  71. data/distro/common/man/man1/knife-role.1 +86 -18
  72. data/distro/common/man/man1/knife-search.1 +80 -16
  73. data/distro/common/man/man1/knife-show.1 +30 -14
  74. data/distro/common/man/man1/knife-ssh.1 +54 -14
  75. data/distro/common/man/man1/knife-ssl-check.1 +207 -0
  76. data/distro/common/man/man1/knife-ssl-fetch.1 +207 -0
  77. data/distro/common/man/man1/knife-status.1 +48 -12
  78. data/distro/common/man/man1/knife-tag.1 +30 -10
  79. data/distro/common/man/man1/knife-upload.1 +72 -20
  80. data/distro/common/man/man1/knife-user.1 +79 -23
  81. data/distro/common/man/man1/knife-xargs.1 +61 -53
  82. data/distro/common/man/man8/chef-client.8 +87 -29
  83. data/distro/common/man/man8/chef-solo.8 +36 -15
  84. data/lib/chef/application.rb +19 -14
  85. data/lib/chef/application/client.rb +5 -0
  86. data/lib/chef/application/solo.rb +5 -0
  87. data/lib/chef/application/windows_service_manager.rb +3 -0
  88. data/lib/chef/chef_fs/chef_fs_data_store.rb +72 -24
  89. data/lib/chef/chef_fs/file_system/chef_repository_file_system_cookbook_dir.rb +20 -4
  90. data/lib/chef/chef_fs/file_system/chef_repository_file_system_cookbooks_dir.rb +20 -1
  91. data/lib/chef/chef_fs/file_system/file_system_entry.rb +10 -2
  92. data/lib/chef/client.rb +2 -3
  93. data/lib/chef/config.rb +34 -8
  94. data/lib/chef/cookbook/cookbook_version_loader.rb +45 -4
  95. data/lib/chef/cookbook_version.rb +38 -30
  96. data/lib/chef/dsl/recipe.rb +4 -1
  97. data/lib/chef/event_dispatch/base.rb +14 -0
  98. data/lib/chef/event_dispatch/events_output_stream.rb +29 -0
  99. data/lib/chef/exceptions.rb +8 -0
  100. data/lib/chef/formatters/base.rb +16 -45
  101. data/lib/chef/formatters/doc.rb +51 -26
  102. data/lib/chef/formatters/indentable_output_stream.rb +165 -0
  103. data/lib/chef/knife/node_environment_set.rb +54 -0
  104. data/lib/chef/knife/user_create.rb +1 -1
  105. data/lib/chef/monkey_patches/pathname.rb +32 -0
  106. data/lib/chef/node.rb +1 -1
  107. data/lib/chef/platform/provider_mapping.rb +345 -338
  108. data/lib/chef/policy_builder/expand_node_object.rb +1 -1
  109. data/lib/chef/policy_builder/policyfile.rb +1 -1
  110. data/lib/chef/provider.rb +1 -0
  111. data/lib/chef/provider/git.rb +1 -1
  112. data/lib/chef/provider/link.rb +2 -2
  113. data/lib/chef/provider/remote_file/content.rb +1 -1
  114. data/lib/chef/provider/remote_file/local_file.rb +8 -2
  115. data/lib/chef/provider/service/arch.rb +0 -1
  116. data/lib/chef/provider/service/debian.rb +0 -2
  117. data/lib/chef/provider/service/freebsd.rb +2 -1
  118. data/lib/chef/provider/service/gentoo.rb +1 -1
  119. data/lib/chef/provider/service/init.rb +0 -1
  120. data/lib/chef/provider/service/insserv.rb +0 -2
  121. data/lib/chef/provider/service/invokercd.rb +0 -2
  122. data/lib/chef/provider/service/macosx.rb +2 -1
  123. data/lib/chef/provider/service/redhat.rb +0 -1
  124. data/lib/chef/provider/service/simple.rb +1 -0
  125. data/lib/chef/provider/service/solaris.rb +1 -0
  126. data/lib/chef/provider/service/systemd.rb +1 -1
  127. data/lib/chef/provider/service/upstart.rb +1 -1
  128. data/lib/chef/provider/user.rb +9 -9
  129. data/lib/chef/provider/user/solaris.rb +2 -0
  130. data/lib/chef/resource.rb +1 -0
  131. data/lib/chef/resource/remote_file.rb +32 -6
  132. data/lib/chef/run_context.rb +22 -0
  133. data/lib/chef/run_lock.rb +43 -4
  134. data/lib/chef/version.rb +2 -2
  135. data/spec/functional/http/simple_spec.rb +84 -0
  136. data/spec/functional/resource/remote_file_spec.rb +107 -43
  137. data/spec/functional/rest_spec.rb +94 -0
  138. data/spec/functional/run_lock_spec.rb +1 -1
  139. data/spec/functional/win32/service_manager_spec.rb +6 -0
  140. data/spec/integration/knife/chef_fs_data_store_spec.rb +2 -0
  141. data/spec/integration/recipes/lwrp_inline_resources_spec.rb +76 -0
  142. data/spec/spec_helper.rb +2 -0
  143. data/spec/support/mock/platform.rb +7 -0
  144. data/spec/support/pedant/pedant_config.rb +121 -0
  145. data/spec/support/pedant/run_pedant.rb +63 -0
  146. data/spec/support/pedant/stickywicket.pem +27 -0
  147. data/spec/support/shared/functional/http.rb +242 -0
  148. data/spec/support/shared/unit/api_error_inspector.rb +2 -2
  149. data/spec/unit/api_client_spec.rb +2 -2
  150. data/spec/unit/application/client_spec.rb +6 -1
  151. data/spec/unit/application/knife_spec.rb +4 -0
  152. data/spec/unit/application/solo_spec.rb +2 -0
  153. data/spec/unit/application_spec.rb +7 -0
  154. data/spec/unit/client_spec.rb +16 -0
  155. data/spec/unit/config_spec.rb +3 -20
  156. data/spec/unit/cookbook_version_spec.rb +224 -122
  157. data/spec/unit/formatters/error_inspectors/compile_error_inspector_spec.rb +2 -2
  158. data/spec/unit/formatters/error_inspectors/cookbook_resolve_error_inspector_spec.rb +2 -2
  159. data/spec/unit/formatters/error_inspectors/cookbook_sync_error_inspector_spec.rb +2 -2
  160. data/spec/unit/formatters/error_inspectors/resource_failure_inspector_spec.rb +2 -2
  161. data/spec/unit/formatters/error_inspectors/run_list_expansion_error_inspector_spec.rb +2 -2
  162. data/spec/unit/handler_spec.rb +0 -1
  163. data/spec/unit/knife/client_bulk_delete_spec.rb +3 -0
  164. data/spec/unit/knife/cookbook_bulk_delete_spec.rb +2 -0
  165. data/spec/unit/knife/cookbook_metadata_spec.rb +2 -2
  166. data/spec/unit/knife/cookbook_site_install_spec.rb +3 -1
  167. data/spec/unit/knife/cookbook_upload_spec.rb +10 -10
  168. data/spec/unit/knife/node_environment_set_spec.rb +80 -0
  169. data/spec/unit/knife/user_create_spec.rb +6 -4
  170. data/spec/unit/knife/user_edit_spec.rb +5 -0
  171. data/spec/unit/knife_spec.rb +3 -0
  172. data/spec/unit/mixin/securable_spec.rb +18 -20
  173. data/spec/unit/node/attribute_spec.rb +15 -2
  174. data/spec/unit/node/immutable_collections_spec.rb +4 -4
  175. data/spec/unit/provider/cron_spec.rb +14 -14
  176. data/spec/unit/provider/git_spec.rb +4 -4
  177. data/spec/unit/provider/group_spec.rb +1 -1
  178. data/spec/unit/provider/ohai_spec.rb +2 -2
  179. data/spec/unit/provider/remote_file/content_spec.rb +58 -35
  180. data/spec/unit/provider/remote_file/local_file_spec.rb +23 -0
  181. data/spec/unit/provider/service/solaris_smf_service_spec.rb +13 -13
  182. data/spec/unit/resource/mount_spec.rb +0 -1
  183. data/spec/unit/resource/remote_file_spec.rb +29 -0
  184. data/spec/unit/resource_spec.rb +1 -1
  185. data/spec/unit/run_context_spec.rb +7 -0
  186. data/spec/unit/run_lock_spec.rb +98 -0
  187. data/spec/unit/version_constraint_spec.rb +1 -1
  188. metadata +164 -151
  189. data/distro/common/html/_static/chef.css +0 -507
  190. data/distro/common/html/_static/chef_logo.png +0 -0
  191. data/lib/chef/checksum/storage.rb +0 -18
  192. data/lib/chef/checksum/storage/filesystem.rb +0 -56
  193. data/spec/unit/checksum/storage/filesystem_spec.rb +0 -70
@@ -1,4 +1,6 @@
1
- .TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.10.0" "" "knife cookbook site"
1
+ .\" Man page generated from reStructuredText.
2
+ .
3
+ .TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.12.0" "" "knife cookbook site"
2
4
  .SH NAME
3
5
  knife-cookbook-site \- The man page for the knife cookbook site subcommand.
4
6
  .
@@ -28,12 +30,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
28
30
  .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
31
  .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30
32
  ..
31
- .\" Man page generated from reStructuredText.
32
- .
33
33
  .sp
34
- The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%https://cookbooks.opscode.com\fP. All of the cookbooks in the community are accessible through a REST API located at \fI\%https://cookbooks.opscode.com/api/v1/\fP by using any of the supported endpoints. In most cases, using Knife and the \fBknife cookbook site\fP sub\-command (and any of its arguments) is the recommended method of interacting with these cookbooks, but in some cases, using the REST API directly may make sense.
34
+ The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%http://community.opscode.com/\fP\&. All of the cookbooks in the community are accessible through a REST API located at \fI\%https://cookbooks.opscode.com/api/v1/cookbooks\fP by using any of the supported endpoints. In most cases, using Knife and the \fBknife cookbook site\fP sub\-command (and any of its arguments) is the recommended method of interacting with these cookbooks, but in some cases, using the REST API directly may make sense.
35
35
  .sp
36
- The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%https://cookbooks.opscode.com\fP. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: \fBdownload\fP, \fBsearch\fP, \fBinstall\fP, and \fBlist\fP.
36
+ The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%http://community.opscode.com/\fP\&. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: \fBdownload\fP, \fBsearch\fP, \fBinstall\fP, and \fBlist\fP\&.
37
37
  .SH COMMON OPTIONS
38
38
  .sp
39
39
  The following options may be used with any of the arguments available to the \fBknife cookbook site\fP subcommand:
@@ -58,13 +58,13 @@ The $EDITOR that is used for all interactive commands.
58
58
  The name of the environment. When this option is added to a command, the command will run only against the named environment.
59
59
  .TP
60
60
  .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
61
- The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
61
+ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
62
62
  .TP
63
63
  .B \fB\-h\fP, \fB\-\-help\fP
64
64
  Shows help for the command.
65
65
  .TP
66
66
  .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
67
- The private key that Knife will use to sign requests made by the API client to the server.
67
+ The private key that Knife will use to sign requests made by the API client to the Chef server\&.
68
68
  .TP
69
69
  .B \fB\-\-[no\-]color\fP
70
70
  Indicates whether colored output will be used.
@@ -73,22 +73,22 @@ Indicates whether colored output will be used.
73
73
  Indicates that data will be shown after a destructive operation.
74
74
  .TP
75
75
  .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
76
- The URL for the server.
76
+ The URL for the Chef server\&.
77
77
  .TP
78
78
  .B \fB\-u USER\fP, \fB\-\-user USER\fP
79
- The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key.
79
+ 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.
80
80
  .TP
81
81
  .B \fB\-V\fP, \fB\-\-verbose\fP
82
82
  Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
83
83
  .TP
84
84
  .B \fB\-v\fP, \fB\-\-version\fP
85
- The version of the chef\-client.
85
+ The version of the chef\-client\&.
86
86
  .TP
87
87
  .B \fB\-y\fP, \fB\-\-yes\fP
88
88
  Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
89
89
  .TP
90
90
  .B \fB\-z\fP, \fB\-\-local\-mode\fP
91
- Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo.
91
+ Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&.
92
92
  .UNINDENT
93
93
  .SH DOWNLOAD
94
94
  .sp
@@ -97,12 +97,16 @@ The \fBdownload\fP argument is used to download a cookbook from the community we
97
97
  \fBSyntax\fP
98
98
  .sp
99
99
  This argument has the following syntax:
100
+ .INDENT 0.0
101
+ .INDENT 3.5
100
102
  .sp
101
103
  .nf
102
104
  .ft C
103
105
  $ knife cookbook site download COOKBOOK_NAME [COOKBOOK_VERSION] (options)
104
106
  .ft P
105
107
  .fi
108
+ .UNINDENT
109
+ .UNINDENT
106
110
  .sp
107
111
  \fBOptions\fP
108
112
  .sp
@@ -112,21 +116,30 @@ This argument has the following options:
112
116
  .B \fBCOOKBOOK_VERSION\fP
113
117
  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, Knife will prompt for a version.
114
118
  .TP
115
- .B \fB\-f\fP, \fB\-\-force\fP
119
+ .B \fB\-f FILE\fP, \fB\-\-file FILE\fP
120
+ The file to which a cookbook download is written.
121
+ .TP
122
+ .B \fB\-\-force\fP
116
123
  Indicates that an existing directory will be overwritten.
117
124
  .UNINDENT
118
125
  .sp
119
126
  \fBExamples\fP
120
127
  .sp
121
128
  To download the cookbook "getting\-started", enter:
129
+ .INDENT 0.0
130
+ .INDENT 3.5
122
131
  .sp
123
132
  .nf
124
133
  .ft C
125
134
  $ knife cookbook site download getting\-started
126
135
  .ft P
127
136
  .fi
137
+ .UNINDENT
138
+ .UNINDENT
128
139
  .sp
129
140
  to return something like:
141
+ .INDENT 0.0
142
+ .INDENT 3.5
130
143
  .sp
131
144
  .nf
132
145
  .ft C
@@ -135,9 +148,11 @@ Downloading getting\-started from the cookbooks site at version 0.3.0 to
135
148
  Cookbook saved: /Users/sdanna/opscodesupport/getting\-started\-0.3.0.tar.gz
136
149
  .ft P
137
150
  .fi
151
+ .UNINDENT
152
+ .UNINDENT
138
153
  .SH INSTALL
139
154
  .sp
140
- The \fBinstall\fP 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 \fI\%https://cookbooks.opscode.com\fP site to install community\-contributed cookbooks to the local chef\-repo. Using this argument does the following:
155
+ The \fBinstall\fP 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 \fI\%http://community.opscode.com/\fP site to install community\-contributed cookbooks to the local chef\-repo\&. Using this argument does the following:
141
156
  .INDENT 0.0
142
157
  .INDENT 3.5
143
158
  .INDENT 0.0
@@ -146,7 +161,7 @@ A new "pristine copy" branch is created in git for tracking the upstream.
146
161
  .IP 2. 3
147
162
  All existing versions of a cookbook are removed from the branch.
148
163
  .IP 3. 3
149
- The cookbook is downloaded from \fI\%https://cookbooks.opscode.com\fP in the tar.gz format.
164
+ The cookbook is downloaded from \fI\%http://community.opscode.com/\fP in the tar.gz format.
150
165
  .IP 4. 3
151
166
  The downloaded cookbook is untarred and its contents are committed to git and a tag is created.
152
167
  .IP 5. 3
@@ -160,12 +175,16 @@ This process allows the upstream cookbook in the master branch to be modified wh
160
175
  \fBSyntax\fP
161
176
  .sp
162
177
  This argument has the following syntax:
178
+ .INDENT 0.0
179
+ .INDENT 3.5
163
180
  .sp
164
181
  .nf
165
182
  .ft C
166
183
  $ knife cookbook site install COOKBOOK_NAME [COOKBOOK_VERSION] (options)
167
184
  .ft P
168
185
  .fi
186
+ .UNINDENT
187
+ .UNINDENT
169
188
  .sp
170
189
  \fBOptions\fP
171
190
  .sp
@@ -191,14 +210,20 @@ The directory in which cookbook are created. This can be a colon\-separated path
191
210
  \fBExamples\fP
192
211
  .sp
193
212
  To install the cookbook "getting\-started", enter:
213
+ .INDENT 0.0
214
+ .INDENT 3.5
194
215
  .sp
195
216
  .nf
196
217
  .ft C
197
218
  $ knife cookbook site install getting\-started
198
219
  .ft P
199
220
  .fi
221
+ .UNINDENT
222
+ .UNINDENT
200
223
  .sp
201
224
  to return something like:
225
+ .INDENT 0.0
226
+ .INDENT 3.5
202
227
  .sp
203
228
  .nf
204
229
  .ft C
@@ -232,19 +257,25 @@ Fast\-forward
232
257
  Cookbook getting\-started version 0.3.0 successfully installed
233
258
  .ft P
234
259
  .fi
260
+ .UNINDENT
261
+ .UNINDENT
235
262
  .SH LIST
236
263
  .sp
237
- The \fBlist\fP argument is used to view a list of cookbooks that are currently available at \fI\%https://cookbooks.opscode.com\fP.
264
+ The \fBlist\fP argument is used to view a list of cookbooks that are currently available at \fI\%http://community.opscode.com/\fP\&.
238
265
  .sp
239
266
  \fBSyntax\fP
240
267
  .sp
241
268
  This argument has the following syntax:
269
+ .INDENT 0.0
270
+ .INDENT 3.5
242
271
  .sp
243
272
  .nf
244
273
  .ft C
245
274
  $ knife cookbook site list
246
275
  .ft P
247
276
  .fi
277
+ .UNINDENT
278
+ .UNINDENT
248
279
  .sp
249
280
  \fBOptions\fP
250
281
  .sp
@@ -257,15 +288,21 @@ Indicates that the corresponding URIs will be shown.
257
288
  .sp
258
289
  \fBExamples\fP
259
290
  .sp
260
- To view a list of cookbooks at \fI\%https://cookbooks.opscode.com\fP server, enter:
291
+ To view a list of cookbooks at \fI\%http://community.opscode.com/\fP server, enter:
292
+ .INDENT 0.0
293
+ .INDENT 3.5
261
294
  .sp
262
295
  .nf
263
296
  .ft C
264
297
  $ knife cookbook site list
265
298
  .ft P
266
299
  .fi
300
+ .UNINDENT
301
+ .UNINDENT
267
302
  .sp
268
303
  to return:
304
+ .INDENT 0.0
305
+ .INDENT 3.5
269
306
  .sp
270
307
  .nf
271
308
  .ft C
@@ -282,19 +319,25 @@ ant iis redmine
282
319
  [...truncated...]
283
320
  .ft P
284
321
  .fi
322
+ .UNINDENT
323
+ .UNINDENT
285
324
  .SH SEARCH
286
325
  .sp
287
- The \fBsearch\fP argument is used to search for a cookbook at \fI\%https://cookbooks.opscode.com\fP. A search query is used to return a list of cookbooks at \fI\%https://cookbooks.opscode.com\fP and uses the same syntax as the \fBknife search\fP sub\-command.
326
+ The \fBsearch\fP argument is used to search for a cookbook at \fI\%http://community.opscode.com/\fP\&. A search query is used to return a list of cookbooks at \fI\%http://community.opscode.com/\fP and uses the same syntax as the \fBknife search\fP sub\-command.
288
327
  .sp
289
328
  \fBSyntax\fP
290
329
  .sp
291
330
  This argument has the following syntax:
331
+ .INDENT 0.0
332
+ .INDENT 3.5
292
333
  .sp
293
334
  .nf
294
335
  .ft C
295
336
  $ knife cookbook site search SEARCH_QUERY (options)
296
337
  .ft P
297
338
  .fi
339
+ .UNINDENT
340
+ .UNINDENT
298
341
  .sp
299
342
  \fBOptions\fP
300
343
  .sp
@@ -303,14 +346,20 @@ This command does not have any specific options.
303
346
  \fBExamples\fP
304
347
  .sp
305
348
  To search for all of the cookbooks that can be used with Apache, enter:
349
+ .INDENT 0.0
350
+ .INDENT 3.5
306
351
  .sp
307
352
  .nf
308
353
  .ft C
309
354
  $ knife cookbook site search apache*
310
355
  .ft P
311
356
  .fi
357
+ .UNINDENT
358
+ .UNINDENT
312
359
  .sp
313
360
  to return something like:
361
+ .INDENT 0.0
362
+ .INDENT 3.5
314
363
  .sp
315
364
  .nf
316
365
  .ft C
@@ -332,19 +381,25 @@ kickstart:
332
381
  [...truncated...]
333
382
  .ft P
334
383
  .fi
384
+ .UNINDENT
385
+ .UNINDENT
335
386
  .SH SHARE
336
387
  .sp
337
- The \fBshare\fP argument is used to add a cookbook to \fI\%https://cookbooks.opscode.com\fP. This action will require a user account and a certificate for \fI\%http://community.opscode.com\fP. 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 \fI\%https://cookbooks.opscode.com\fP, then only an owner or maintainer of that cookbook can make updates.
388
+ The \fBshare\fP argument is used to add a cookbook to \fI\%http://community.opscode.com/\fP\&. This action will require a user account and a certificate for \fI\%http://community.opscode.com\fP\&. 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 \fI\%http://community.opscode.com/\fP, then only an owner or maintainer of that cookbook can make updates.
338
389
  .sp
339
390
  \fBSyntax\fP
340
391
  .sp
341
392
  This argument has the following syntax:
393
+ .INDENT 0.0
394
+ .INDENT 3.5
342
395
  .sp
343
396
  .nf
344
397
  .ft C
345
398
  $ knife cookbook site share COOKBOOK_NAME CATEGORY (options)
346
399
  .ft P
347
400
  .fi
401
+ .UNINDENT
402
+ .UNINDENT
348
403
  .sp
349
404
  \fBOptions\fP
350
405
  .sp
@@ -352,7 +407,7 @@ This argument has the following options:
352
407
  .INDENT 0.0
353
408
  .TP
354
409
  .B \fBCATEGORY\fP
355
- The cookbook category: \fBDatabases\fP, \fBWeb Servers\fP, \fBProcess Management\fP, \fBMonitoring and Trending\fP, \fBProgramming Languages\fP, \fBPackage Management\fP, \fBApplications\fP, \fBNetworking\fP, \fBOperations Systems and Virtualization\fP, \fBUtilities\fP, or \fBOther\fP.
410
+ The cookbook category: \fBDatabases\fP, \fBWeb Servers\fP, \fBProcess Management\fP, \fBMonitoring and Trending\fP, \fBProgramming Languages\fP, \fBPackage Management\fP, \fBApplications\fP, \fBNetworking\fP, \fBOperations Systems and Virtualization\fP, \fBUtilities\fP, or \fBOther\fP\&.
356
411
  .TP
357
412
  .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP
358
413
  The directory in which cookbook are created. This can be a colon\-separated path.
@@ -361,25 +416,33 @@ The directory in which cookbook are created. This can be a colon\-separated path
361
416
  \fBExamples\fP
362
417
  .sp
363
418
  To share a cookbook named "apache2":
419
+ .INDENT 0.0
420
+ .INDENT 3.5
364
421
  .sp
365
422
  .nf
366
423
  .ft C
367
424
  $ knife cookbook site share "apache2" "Web Servers"
368
425
  .ft P
369
426
  .fi
427
+ .UNINDENT
428
+ .UNINDENT
370
429
  .SH SHOW
371
430
  .sp
372
- The \fBshow\fP argument is used to view information about a cookbook on \fI\%https://cookbooks.opscode.com\fP.
431
+ The \fBshow\fP argument is used to view information about a cookbook on \fI\%http://community.opscode.com/\fP\&.
373
432
  .sp
374
433
  \fBSyntax\fP
375
434
  .sp
376
435
  This argument has the following syntax:
436
+ .INDENT 0.0
437
+ .INDENT 3.5
377
438
  .sp
378
439
  .nf
379
440
  .ft C
380
441
  $ knife cookbook site show COOKBOOK_NAME [COOKBOOK_VERSION]
381
442
  .ft P
382
443
  .fi
444
+ .UNINDENT
445
+ .UNINDENT
383
446
  .sp
384
447
  \fBOptions\fP
385
448
  .sp
@@ -393,14 +456,20 @@ The version of a cookbook to be shown. If a cookbook has only one version, this
393
456
  \fBExamples\fP
394
457
  .sp
395
458
  To show the details for a cookbook named "haproxy":
459
+ .INDENT 0.0
460
+ .INDENT 3.5
396
461
  .sp
397
462
  .nf
398
463
  .ft C
399
464
  $ knife cookbook site show haproxy
400
465
  .ft P
401
466
  .fi
467
+ .UNINDENT
468
+ .UNINDENT
402
469
  .sp
403
470
  to return something like:
471
+ .INDENT 0.0
472
+ .INDENT 3.5
404
473
  .sp
405
474
  .nf
406
475
  .ft C
@@ -423,29 +492,39 @@ versions:
423
492
  http://cookbooks.opscode.com/api/v1/cookbooks/haproxy/versions/0_7_0
424
493
  .ft P
425
494
  .fi
495
+ .UNINDENT
496
+ .UNINDENT
426
497
  .sp
427
498
  To view information in JSON format, use the \fB\-F\fP common option as part of the command like this:
499
+ .INDENT 0.0
500
+ .INDENT 3.5
428
501
  .sp
429
502
  .nf
430
503
  .ft C
431
504
  $ knife role show devops \-F json
432
505
  .ft P
433
506
  .fi
507
+ .UNINDENT
508
+ .UNINDENT
434
509
  .sp
435
- Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP.
510
+ Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&.
436
511
  .SH UNSHARE
437
512
  .sp
438
- The \fBunshare\fP argument is used to stop the sharing of a cookbook at \fI\%https://cookbooks.opscode.com\fP. Only the maintainer of a cookbook may perform this action.
513
+ The \fBunshare\fP argument is used to stop the sharing of a cookbook at \fI\%http://community.opscode.com/\fP\&. Only the maintainer of a cookbook may perform this action.
439
514
  .sp
440
515
  \fBSyntax\fP
441
516
  .sp
442
517
  This argument has the following syntax:
518
+ .INDENT 0.0
519
+ .INDENT 3.5
443
520
  .sp
444
521
  .nf
445
522
  .ft C
446
523
  $ knife cookbook site unshare COOKBOOK_NAME
447
524
  .ft P
448
525
  .fi
526
+ .UNINDENT
527
+ .UNINDENT
449
528
  .sp
450
529
  \fBOptions\fP
451
530
  .sp
@@ -454,12 +533,16 @@ This command does not have any specific options.
454
533
  \fBExamples\fP
455
534
  .sp
456
535
  To unshare a cookbook named "getting\-started", enter:
536
+ .INDENT 0.0
537
+ .INDENT 3.5
457
538
  .sp
458
539
  .nf
459
540
  .ft C
460
541
  $ knife cookbook site unshare getting\-started
461
542
  .ft P
462
543
  .fi
544
+ .UNINDENT
545
+ .UNINDENT
463
546
  .SH AUTHOR
464
547
  Chef
465
548
  .\" Generated by docutils manpage writer.
@@ -1,4 +1,6 @@
1
- .TH "KNIFE-COOKBOOK" "1" "Chef 11.10.0" "" "knife cookbook"
1
+ .\" Man page generated from reStructuredText.
2
+ .
3
+ .TH "KNIFE-COOKBOOK" "1" "Chef 11.12.0" "" "knife cookbook"
2
4
  .SH NAME
3
5
  knife-cookbook \- The man page for the knife cookbook subcommand.
4
6
  .
@@ -28,8 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
28
30
  .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
31
  .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30
32
  ..
31
- .\" Man page generated from reStructuredText.
32
- .
33
33
  .sp
34
34
  A cookbook is the fundamental unit of configuration and policy distribution. Each cookbook defines a scenario, such as everything needed to install and configure MySQL, and then it contains all of the components that are required to support that scenario, including:
35
35
  .INDENT 0.0
@@ -53,7 +53,7 @@ Versions
53
53
  Metadata about recipes (including dependencies), version constraints, supported platforms, and so on
54
54
  .UNINDENT
55
55
  .sp
56
- The \fBknife cookbook\fP subcommand is used to interact with cookbooks that are located on the server or the local chef\-repo.
56
+ The \fBknife cookbook\fP subcommand is used to interact with cookbooks that are located on the Chef server or the local chef\-repo\&.
57
57
  .SH COMMON OPTIONS
58
58
  .sp
59
59
  The following options may be used with any of the arguments available to the \fBknife cookbook\fP subcommand:
@@ -78,13 +78,13 @@ The $EDITOR that is used for all interactive commands.
78
78
  The name of the environment. When this option is added to a command, the command will run only against the named environment.
79
79
  .TP
80
80
  .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
81
- The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
81
+ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
82
82
  .TP
83
83
  .B \fB\-h\fP, \fB\-\-help\fP
84
84
  Shows help for the command.
85
85
  .TP
86
86
  .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
87
- The private key that Knife will use to sign requests made by the API client to the server.
87
+ The private key that Knife will use to sign requests made by the API client to the Chef server\&.
88
88
  .TP
89
89
  .B \fB\-\-[no\-]color\fP
90
90
  Indicates whether colored output will be used.
@@ -93,22 +93,22 @@ Indicates whether colored output will be used.
93
93
  Indicates that data will be shown after a destructive operation.
94
94
  .TP
95
95
  .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
96
- The URL for the server.
96
+ The URL for the Chef server\&.
97
97
  .TP
98
98
  .B \fB\-u USER\fP, \fB\-\-user USER\fP
99
- The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key.
99
+ 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.
100
100
  .TP
101
101
  .B \fB\-V\fP, \fB\-\-verbose\fP
102
102
  Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
103
103
  .TP
104
104
  .B \fB\-v\fP, \fB\-\-version\fP
105
- The version of the chef\-client.
105
+ The version of the chef\-client\&.
106
106
  .TP
107
107
  .B \fB\-y\fP, \fB\-\-yes\fP
108
108
  Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
109
109
  .TP
110
110
  .B \fB\-z\fP, \fB\-\-local\-mode\fP
111
- Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo.
111
+ Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&.
112
112
  .UNINDENT
113
113
  .SH BULK DELETE
114
114
  .sp
@@ -117,12 +117,16 @@ The \fBbulk delete\fP argument is used to delete cookbook files that match a pat
117
117
  \fBSyntax\fP
118
118
  .sp
119
119
  This argument has the following syntax:
120
+ .INDENT 0.0
121
+ .INDENT 3.5
120
122
  .sp
121
123
  .nf
122
124
  .ft C
123
125
  $ knife cookbook bulk delete REGEX (options)
124
126
  .ft P
125
127
  .fi
128
+ .UNINDENT
129
+ .UNINDENT
126
130
  .sp
127
131
  \fBOptions\fP
128
132
  .sp
@@ -130,18 +134,22 @@ This argument has the following options:
130
134
  .INDENT 0.0
131
135
  .TP
132
136
  .B \fB\-p\fP, \fB\-\-purge\fP
133
- Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.
137
+ Indicates that a cookbook (or cookbook version) will be removed entirely 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.
134
138
  .UNINDENT
135
139
  .sp
136
140
  \fBExamples\fP
137
141
  .sp
138
142
  Use a regular expression to define the pattern used to bulk delete cookbooks:
143
+ .INDENT 0.0
144
+ .INDENT 3.5
139
145
  .sp
140
146
  .nf
141
147
  .ft C
142
148
  $ knife cookbook bulk delete "^[0\-9]{3}$" \-p
143
149
  .ft P
144
150
  .fi
151
+ .UNINDENT
152
+ .UNINDENT
145
153
  .SH CREATE
146
154
  .sp
147
155
  The \fBcreate\fP argument is used to create a new cookbook directory on the local machine, including the following directories and files:
@@ -174,17 +182,21 @@ cookbook/templates/default
174
182
  .UNINDENT
175
183
  .UNINDENT
176
184
  .sp
177
- After the cookbook is created, it can be uploaded to the server using the \fBknife upload\fP argument.
185
+ After the cookbook is created, it can be uploaded to the Chef server using the \fBknife upload\fP argument.
178
186
  .sp
179
187
  \fBSyntax\fP
180
188
  .sp
181
189
  This argument has the following syntax:
190
+ .INDENT 0.0
191
+ .INDENT 3.5
182
192
  .sp
183
193
  .nf
184
194
  .ft C
185
195
  $ knife cookbook create COOKBOOK_NAME (options)
186
196
  .ft P
187
197
  .fi
198
+ .UNINDENT
199
+ .UNINDENT
188
200
  .sp
189
201
  \fBOptions\fP
190
202
  .sp
@@ -210,14 +222,20 @@ The document format of the readme file: \fBmd\fP (markdown) and \fBrdoc\fP (Ruby
210
222
  \fBExamples\fP
211
223
  .sp
212
224
  To create a cookbook named "my_cookbook" with copyright, email, license, and readme format options specified, enter:
225
+ .INDENT 0.0
226
+ .INDENT 3.5
213
227
  .sp
214
228
  .nf
215
229
  .ft C
216
230
  $ knife cookbook create my_cookbook \-C "My Name" \-m "my@email.com" \-I apachev2 \-r md
217
231
  .ft P
218
232
  .fi
233
+ .UNINDENT
234
+ .UNINDENT
219
235
  .sp
220
236
  to return something like:
237
+ .INDENT 0.0
238
+ .INDENT 3.5
221
239
  .sp
222
240
  .nf
223
241
  .ft C
@@ -226,19 +244,25 @@ to return something like:
226
244
  ** Creating metadata for cookbook: my_cookbook
227
245
  .ft P
228
246
  .fi
247
+ .UNINDENT
248
+ .UNINDENT
229
249
  .SH DELETE
230
250
  .sp
231
- The \fBdelete\fP argument is used to delete a specified cookbook or cookbook version on the server (and not locally).
251
+ The \fBdelete\fP argument is used to delete a specified cookbook or cookbook version on the Chef server (and not locally).
232
252
  .sp
233
253
  \fBSyntax\fP
234
254
  .sp
235
255
  This argument has the following syntax:
256
+ .INDENT 0.0
257
+ .INDENT 3.5
236
258
  .sp
237
259
  .nf
238
260
  .ft C
239
261
  $ knife cookbook delete COOKBOOK_NAME [COOKBOOK_VERSION] (options)
240
262
  .ft P
241
263
  .fi
264
+ .UNINDENT
265
+ .UNINDENT
242
266
  .sp
243
267
  \fBOptions\fP
244
268
  .sp
@@ -252,39 +276,51 @@ Indicates that a cookbook and every version of that cookbook will be deleted.
252
276
  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.
253
277
  .TP
254
278
  .B \fB\-p\fP, \fB\-\-purge\fP
255
- Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.
279
+ Indicates that a cookbook (or cookbook version) will be removed entirely 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.
256
280
  .UNINDENT
257
281
  .sp
258
282
  \fBExamples\fP
283
+ .INDENT 0.0
284
+ .INDENT 3.5
259
285
  .sp
260
286
  .nf
261
287
  .ft C
262
288
  $ knife cookbook delete cookbook_name version
263
289
  .ft P
264
290
  .fi
291
+ .UNINDENT
292
+ .UNINDENT
265
293
  .sp
266
294
  For example:
295
+ .INDENT 0.0
296
+ .INDENT 3.5
267
297
  .sp
268
298
  .nf
269
299
  .ft C
270
300
  $ knife cookbook delete smartmon 0.8
271
301
  .ft P
272
302
  .fi
303
+ .UNINDENT
304
+ .UNINDENT
273
305
  .sp
274
306
  Type \fBY\fP to confirm a deletion.
275
307
  .SH DOWNLOAD
276
308
  .sp
277
- The \fBdownload\fP argument is used to download a cookbook from the server to the current working directory.
309
+ The \fBdownload\fP argument is used to download a cookbook from the Chef server to the current working directory.
278
310
  .sp
279
311
  \fBSyntax\fP
280
312
  .sp
281
313
  This argument has the following syntax:
314
+ .INDENT 0.0
315
+ .INDENT 3.5
282
316
  .sp
283
317
  .nf
284
318
  .ft C
285
319
  $ knife cookbook download COOKBOOK_NAME [COOKBOOK_VERSION] (options)
286
320
  .ft P
287
321
  .fi
322
+ .UNINDENT
323
+ .UNINDENT
288
324
  .sp
289
325
  \fBOptions\fP
290
326
  .sp
@@ -304,25 +340,33 @@ Indicates that the most recent version of a cookbook will be downloaded.
304
340
  \fBExamples\fP
305
341
  .sp
306
342
  To download a cookbook named "smartmon", enter:
343
+ .INDENT 0.0
344
+ .INDENT 3.5
307
345
  .sp
308
346
  .nf
309
347
  .ft C
310
348
  $ knife cookbook download smartmon
311
349
  .ft P
312
350
  .fi
351
+ .UNINDENT
352
+ .UNINDENT
313
353
  .SH LIST
314
354
  .sp
315
- The \fBlist\fP argument is used to view a list of cookbooks that are currently available on the server. The list will contain only the most recent version for each cookbook by default.
355
+ The \fBlist\fP argument is used to view a list of cookbooks that are currently available on the Chef server\&. The list will contain only the most recent version for each cookbook by default.
316
356
  .sp
317
357
  \fBSyntax\fP
318
358
  .sp
319
359
  This argument has the following syntax:
360
+ .INDENT 0.0
361
+ .INDENT 3.5
320
362
  .sp
321
363
  .nf
322
364
  .ft C
323
365
  $ knife cookbook list (options)
324
366
  .ft P
325
367
  .fi
368
+ .UNINDENT
369
+ .UNINDENT
326
370
  .sp
327
371
  \fBOptions\fP
328
372
  .sp
@@ -339,12 +383,16 @@ Indicates that the corresponding URIs will be shown.
339
383
  \fBExamples\fP
340
384
  .sp
341
385
  To view a list of cookbooks:
386
+ .INDENT 0.0
387
+ .INDENT 3.5
342
388
  .sp
343
389
  .nf
344
390
  .ft C
345
391
  $ knife cookbook list
346
392
  .ft P
347
393
  .fi
394
+ .UNINDENT
395
+ .UNINDENT
348
396
  .SH METADATA
349
397
  .sp
350
398
  The \fBmetadata\fP argument is used to generate the metadata for one or more cookbooks.
@@ -352,12 +400,16 @@ The \fBmetadata\fP argument is used to generate the metadata for one or more coo
352
400
  \fBSyntax\fP
353
401
  .sp
354
402
  This argument has the following syntax:
403
+ .INDENT 0.0
404
+ .INDENT 3.5
355
405
  .sp
356
406
  .nf
357
407
  .ft C
358
408
  $ knife cookbook metadata (options)
359
409
  .ft P
360
410
  .fi
411
+ .UNINDENT
412
+ .UNINDENT
361
413
  .sp
362
414
  \fBOptions\fP
363
415
  .sp
@@ -372,12 +424,16 @@ The directory in which cookbook are created. This can be a colon\-separated path
372
424
  .UNINDENT
373
425
  .sp
374
426
  \fBExamples\fP
427
+ .INDENT 0.0
428
+ .INDENT 3.5
375
429
  .sp
376
430
  .nf
377
431
  .ft C
378
432
  $ knife cookbook metadata \-a
379
433
  .ft P
380
434
  .fi
435
+ .UNINDENT
436
+ .UNINDENT
381
437
  .SH METADATA FROM FILE
382
438
  .sp
383
439
  The \fBmetadata from file\fP argument is used to load the metadata for a cookbook from a file.
@@ -385,24 +441,32 @@ The \fBmetadata from file\fP argument is used to load the metadata for a cookboo
385
441
  \fBSyntax\fP
386
442
  .sp
387
443
  This argument has the following syntax:
444
+ .INDENT 0.0
445
+ .INDENT 3.5
388
446
  .sp
389
447
  .nf
390
448
  .ft C
391
449
  $ knife cookbook metadata from file FILE
392
450
  .ft P
393
451
  .fi
452
+ .UNINDENT
453
+ .UNINDENT
394
454
  .sp
395
455
  \fBOptions\fP
396
456
  .sp
397
457
  This command does not have any specific options.
398
458
  .sp
399
459
  \fBExamples\fP
460
+ .INDENT 0.0
461
+ .INDENT 3.5
400
462
  .sp
401
463
  .nf
402
464
  .ft C
403
465
  $ knife cookbook metadta from file /path/to/file
404
466
  .ft P
405
467
  .fi
468
+ .UNINDENT
469
+ .UNINDENT
406
470
  .SH SHOW
407
471
  .sp
408
472
  The \fBshow\fP argument is used to view information about a cookbook, parts of a cookbook (attributes, definitions, files, libraries, providers, recipes, resources, and templates), or a file that is associated with a cookbook (including attributes such as checksum or specificity).
@@ -410,12 +474,16 @@ The \fBshow\fP argument is used to view information about a cookbook, parts of a
410
474
  \fBSyntax\fP
411
475
  .sp
412
476
  This argument has the following syntax:
477
+ .INDENT 0.0
478
+ .INDENT 3.5
413
479
  .sp
414
480
  .nf
415
481
  .ft C
416
482
  $ knife cookbook show COOKBOOK_NAME [COOKBOOK_VERSION] [PART...] [FILE_NAME] (options)
417
483
  .ft P
418
484
  .fi
485
+ .UNINDENT
486
+ .UNINDENT
419
487
  .sp
420
488
  \fBOptions\fP
421
489
  .sp
@@ -435,7 +503,7 @@ The name of a file that is associated with a cookbook.
435
503
  The platform for which a cookbook is designed.
436
504
  .TP
437
505
  .B \fBPART\fP
438
- The part of the cookbook to show: \fBattributes\fP, \fBdefinitions\fP, \fBfiles\fP, \fBlibraries\fP, \fBproviders\fP, \fBrecipes\fP, \fBresources\fP, or \fBtemplates\fP. More than one part can be specified.
506
+ The part of the cookbook to show: \fBattributes\fP, \fBdefinitions\fP, \fBfiles\fP, \fBlibraries\fP, \fBproviders\fP, \fBrecipes\fP, \fBresources\fP, or \fBtemplates\fP\&. More than one part can be specified.
439
507
  .TP
440
508
  .B \fB\-V PLATFORM_VERSION\fP, \fB\-\-platform\-version PLATFORM_VERSION\fP
441
509
  The version of the platform.
@@ -447,30 +515,44 @@ Indicates that the corresponding URIs will be shown.
447
515
  \fBExamples\fP
448
516
  .sp
449
517
  To get the list of available versions of a cookbook named "getting\-started", enter:
518
+ .INDENT 0.0
519
+ .INDENT 3.5
450
520
  .sp
451
521
  .nf
452
522
  .ft C
453
523
  $ knife cookbook show getting\-started
454
524
  .ft P
455
525
  .fi
526
+ .UNINDENT
527
+ .UNINDENT
456
528
  .sp
457
529
  to return something like:
530
+ .INDENT 0.0
531
+ .INDENT 3.5
458
532
  .sp
459
533
  .nf
460
534
  .ft C
461
535
  getting\-started 0.3.0 0.2.0
462
536
  .ft P
463
537
  .fi
538
+ .UNINDENT
539
+ .UNINDENT
464
540
  .sp
465
541
  To show a list of data about a cookbook using the name of the cookbook and the version, enter:
542
+ .INDENT 0.0
543
+ .INDENT 3.5
466
544
  .sp
467
545
  .nf
468
546
  .ft C
469
547
  $ knife cookbook show getting\-started 0.3.0
470
548
  .ft P
471
549
  .fi
550
+ .UNINDENT
551
+ .UNINDENT
472
552
  .sp
473
553
  to return something like:
554
+ .INDENT 0.0
555
+ .INDENT 3.5
474
556
  .sp
475
557
  .nf
476
558
  .ft C
@@ -489,16 +571,24 @@ json_class: Chef::CookbookVersion
489
571
  libraries: []
490
572
  .ft P
491
573
  .fi
574
+ .UNINDENT
575
+ .UNINDENT
492
576
  .sp
493
577
  To only view data about "templates", enter:
578
+ .INDENT 0.0
579
+ .INDENT 3.5
494
580
  .sp
495
581
  .nf
496
582
  .ft C
497
583
  $ knife cookbook show getting\-started 0.3.0 templates
498
584
  .ft P
499
585
  .fi
586
+ .UNINDENT
587
+ .UNINDENT
500
588
  .sp
501
589
  to return something like:
590
+ .INDENT 0.0
591
+ .INDENT 3.5
502
592
  .sp
503
593
  .nf
504
594
  .ft C
@@ -509,29 +599,39 @@ specificity: default
509
599
  url: https://someurlhere.com
510
600
  .ft P
511
601
  .fi
602
+ .UNINDENT
603
+ .UNINDENT
512
604
  .sp
513
605
  To view information in JSON format, use the \fB\-F\fP common option as part of the command like this:
606
+ .INDENT 0.0
607
+ .INDENT 3.5
514
608
  .sp
515
609
  .nf
516
610
  .ft C
517
611
  $ knife role show devops \-F json
518
612
  .ft P
519
613
  .fi
614
+ .UNINDENT
615
+ .UNINDENT
520
616
  .sp
521
- Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP.
617
+ Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&.
522
618
  .SH TEST
523
619
  .sp
524
- The \fBtest\fP 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).
620
+ The \fBtest\fP 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)\&.
525
621
  .sp
526
622
  \fBSyntax\fP
527
623
  .sp
528
624
  This argument has the following syntax:
625
+ .INDENT 0.0
626
+ .INDENT 3.5
529
627
  .sp
530
628
  .nf
531
629
  .ft C
532
630
  $ knife cookbook test COOKBOOK_NAME (options)
533
631
  .ft P
534
632
  .fi
633
+ .UNINDENT
634
+ .UNINDENT
535
635
  .sp
536
636
  \fBOptions\fP
537
637
  .sp
@@ -546,28 +646,47 @@ The directory in which cookbook are created. This can be a colon\-separated path
546
646
  .UNINDENT
547
647
  .sp
548
648
  \fBExamples\fP
649
+ .INDENT 0.0
650
+ .INDENT 3.5
549
651
  .sp
550
652
  .nf
551
653
  .ft C
552
654
  $ knife cookbook test cookbook_name
553
655
  .ft P
554
656
  .fi
657
+ .UNINDENT
658
+ .UNINDENT
555
659
  .SH UPLOAD
556
660
  .sp
557
- The \fBupload\fP argument is used to upload one or more cookbooks (and any files that are associated with those cookbooks) from a local repository to the server. Only files that do not already exist on the server will be uploaded.
558
- .IP Note
559
- Use a chefignore file to prevent the upload of specific files and file types, such as temporary files or files placed in folders by version control systems. The chefignore file must be located in the root of the cookbook repository and must use rules similar to filename globbing (as defined by the Ruby \fBFile.fnmatch\fP syntax).
560
- .RE
661
+ The \fBupload\fP argument is used to upload one or more cookbooks (and any files that are associated with those cookbooks) from a local repository to the Chef server\&. Only files that do not already exist on the Chef server will be uploaded.
662
+ .sp
663
+ \fBNOTE:\fP
664
+ .INDENT 0.0
665
+ .INDENT 3.5
666
+ Use a \&.chefignore file to prevent the upload of specific files and file types, such as temporary files or files placed in folders by version control systems. The \&.chefignore file must be located in the root of the cookbook repository and must use rules similar to filename globbing (as defined by the Ruby \fBFile.fnmatch\fP syntax).
667
+ .UNINDENT
668
+ .UNINDENT
669
+ .sp
670
+ \fBNOTE:\fP
671
+ .INDENT 0.0
672
+ .INDENT 3.5
673
+ Empty directories are not uploaded to the Chef server\&. To upload an empty directory, create a "dot" file\-\-\-e.g. \fB\&.keep\fP\-\-\-in that directory to ensure that the directory itself is not empty.
674
+ .UNINDENT
675
+ .UNINDENT
561
676
  .sp
562
677
  \fBSyntax\fP
563
678
  .sp
564
679
  This argument has the following syntax:
680
+ .INDENT 0.0
681
+ .INDENT 3.5
565
682
  .sp
566
683
  .nf
567
684
  .ft C
568
685
  $ knife cookbook upload [COOKBOOK_NAME...] (options)
569
686
  .ft P
570
687
  .fi
688
+ .UNINDENT
689
+ .UNINDENT
571
690
  .sp
572
691
  \fBOptions\fP
573
692
  .sp
@@ -577,9 +696,15 @@ This argument has the following options:
577
696
  .B \fB\-a\fP, \fB\-\-all\fP
578
697
  Indicates that all cookbooks will be uploaded.
579
698
  .TP
699
+ .B \fB\-\-concurrency\fP
700
+ The number of allowed concurrent connections. Default: \fB10\fP\&.
701
+ .TP
580
702
  .B \fB\-d\fP, \fB\-\-include\-dependencies\fP
581
703
  Indicates that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded.
582
704
  .TP
705
+ .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
706
+ Use to set the environment version dependency to the cookbook version being uploaded.
707
+ .TP
583
708
  .B \fB\-\-force\fP
584
709
  Indicates that a cookbook should be updated even if the \fB\-\-freeze\fP flag has been set.
585
710
  .TP
@@ -591,22 +716,32 @@ The directory in which cookbook are created. This can be a colon\-separated path
591
716
  .UNINDENT
592
717
  .sp
593
718
  \fBExamples\fP
719
+ .INDENT 0.0
720
+ .INDENT 3.5
594
721
  .sp
595
722
  .nf
596
723
  .ft C
597
724
  $ knife cookbook upload cookbook_name
598
725
  .ft P
599
726
  .fi
727
+ .UNINDENT
728
+ .UNINDENT
600
729
  .sp
601
730
  To upload a cookbook, and then prevent other users from being able to make changes to it, enter:
731
+ .INDENT 0.0
732
+ .INDENT 3.5
602
733
  .sp
603
734
  .nf
604
735
  .ft C
605
736
  $ knife cookbook upload redis \-\-freeze
606
737
  .ft P
607
738
  .fi
739
+ .UNINDENT
740
+ .UNINDENT
608
741
  .sp
609
742
  to return something like:
743
+ .INDENT 0.0
744
+ .INDENT 3.5
610
745
  .sp
611
746
  .nf
612
747
  .ft C
@@ -614,8 +749,12 @@ Uploading redis...
614
749
  Upload completed
615
750
  .ft P
616
751
  .fi
752
+ .UNINDENT
753
+ .UNINDENT
617
754
  .sp
618
755
  If a cookbook is frozen and the \fB\-\-force\fP option is not specified, Knife will return an error message similar to the following:
756
+ .INDENT 0.0
757
+ .INDENT 3.5
619
758
  .sp
620
759
  .nf
621
760
  .ft C
@@ -623,6 +762,8 @@ Uploading redis...
623
762
  ERROR: Version 0.1.6 of cookbook redis is frozen. Use \-\-force to override.
624
763
  .ft P
625
764
  .fi
765
+ .UNINDENT
766
+ .UNINDENT
626
767
  .SH AUTHOR
627
768
  Chef
628
769
  .\" Generated by docutils manpage writer.