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-TAG" "1" "Chef 11.10.0" "" "knife tag"
1
+ .\" Man page generated from reStructuredText.
2
+ .
3
+ .TH "KNIFE-TAG" "1" "Chef 11.12.0" "" "knife tag"
2
4
  .SH NAME
3
5
  knife-tag \- The man page for the knife tag 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
34
  A tag is a custom description that is applied to a node. A tag, once applied, can be helpful when managing nodes using Knife or when building recipes by providing alternate methods of grouping similar types of information.
35
35
  .sp
36
- The \fBknife tag\fP subcommand is used to apply tags to nodes on a server.
36
+ The \fBknife tag\fP subcommand is used to apply tags to nodes on a Chef server\&.
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 tag\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 CREATE
94
94
  .sp
@@ -97,12 +97,16 @@ The \fBcreate\fP argument is used to add one or more tags to a node.
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 tag create NODE_NAME [TAG...]
104
106
  .ft P
105
107
  .fi
108
+ .UNINDENT
109
+ .UNINDENT
106
110
  .sp
107
111
  \fBOptions\fP
108
112
  .sp
@@ -111,12 +115,16 @@ This command does not have any specific options.
111
115
  \fBExamples\fP
112
116
  .sp
113
117
  To create tags named "seattle", "portland", and "vancouver", enter:
118
+ .INDENT 0.0
119
+ .INDENT 3.5
114
120
  .sp
115
121
  .nf
116
122
  .ft C
117
123
  $ knife tag create node seattle portland vancouver
118
124
  .ft P
119
125
  .fi
126
+ .UNINDENT
127
+ .UNINDENT
120
128
  .SH DELETE
121
129
  .sp
122
130
  The \fBdelete\fP argument is used to delete one or more tags from a node.
@@ -124,12 +132,16 @@ The \fBdelete\fP argument is used to delete one or more tags from a node.
124
132
  \fBSyntax\fP
125
133
  .sp
126
134
  This argument has the following syntax:
135
+ .INDENT 0.0
136
+ .INDENT 3.5
127
137
  .sp
128
138
  .nf
129
139
  .ft C
130
140
  $ knife tag delete NODE_NAME [TAG...]
131
141
  .ft P
132
142
  .fi
143
+ .UNINDENT
144
+ .UNINDENT
133
145
  .sp
134
146
  \fBOptions\fP
135
147
  .sp
@@ -138,12 +150,16 @@ This command does not have any specific options.
138
150
  \fBExamples\fP
139
151
  .sp
140
152
  To delete tags named "denver" and "phoenix", enter:
153
+ .INDENT 0.0
154
+ .INDENT 3.5
141
155
  .sp
142
156
  .nf
143
157
  .ft C
144
158
  $ knife tag delete node denver phoenix
145
159
  .ft P
146
160
  .fi
161
+ .UNINDENT
162
+ .UNINDENT
147
163
  .sp
148
164
  Type \fBY\fP to confirm a deletion.
149
165
  .SH LIST
@@ -153,12 +169,16 @@ The \fBlist\fP argument is used to list all of the tags that have been applied t
153
169
  \fBSyntax\fP
154
170
  .sp
155
171
  This argument has the following syntax:
172
+ .INDENT 0.0
173
+ .INDENT 3.5
156
174
  .sp
157
175
  .nf
158
176
  .ft C
159
177
  $ knife tag list [NODE_NAME...]
160
178
  .ft P
161
179
  .fi
180
+ .UNINDENT
181
+ .UNINDENT
162
182
  .sp
163
183
  \fBOptions\fP
164
184
  .sp
@@ -1,4 +1,6 @@
1
- .TH "KNIFE-UPLOAD" "1" "Chef 11.10.0" "" "knife upload"
1
+ .\" Man page generated from reStructuredText.
2
+ .
3
+ .TH "KNIFE-UPLOAD" "1" "Chef 11.12.0" "" "knife upload"
2
4
  .SH NAME
3
5
  knife-upload \- The man page for the knife upload subcommand.
4
6
  .
@@ -28,20 +30,22 @@ 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 \fBknife upload\fP subcommand is used to upload roles, cookbooks, environments, and data bags to the server from the current working directory in the chef\-repo. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be uploaded, and then \fBknife download\fP, which does the opposite of \fBknife upload\fP.
34
+ The \fBknife upload\fP subcommand is used to upload roles, cookbooks, environments, and data bags to the Chef server from the current working directory in the chef\-repo\&. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be uploaded, and then \fBknife download\fP, which does the opposite of \fBknife upload\fP\&.
35
35
  .sp
36
36
  \fBSyntax\fP
37
37
  .sp
38
- This argument has the following syntax:
38
+ This subcommand has the following syntax:
39
+ .INDENT 0.0
40
+ .INDENT 3.5
39
41
  .sp
40
42
  .nf
41
43
  .ft C
42
44
  $ knife upload [PATTERN...] (options)
43
45
  .ft P
44
46
  .fi
47
+ .UNINDENT
48
+ .UNINDENT
45
49
  .sp
46
50
  \fBOptions\fP
47
51
  .sp
@@ -52,7 +56,7 @@ This subcommand has the following options:
52
56
  The configuration file to use.
53
57
  .TP
54
58
  .B \fB\-\-chef\-repo\-path PATH\fP
55
- The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb.
59
+ The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb.
56
60
  .TP
57
61
  .B \fB\-\-chef\-zero\-port PORT\fP
58
62
  The port on which chef\-zero will listen.
@@ -61,7 +65,7 @@ The port on which chef\-zero will listen.
61
65
  Indicates whether colored output will be used.
62
66
  .TP
63
67
  .B \fB\-\-concurrency\fP
64
- The number of allowed concurrent connections. Default: \fB10\fP.
68
+ The number of allowed concurrent connections. Default: \fB10\fP\&.
65
69
  .TP
66
70
  .B \fB\-d\fP, \fB\-\-disable\-editing\fP
67
71
  Indicates that $EDITOR will not be opened; data will be accepted as\-is.
@@ -70,7 +74,7 @@ Indicates that $EDITOR will not be opened; data will be accepted as\-is.
70
74
  Indicates that Knife will use the default value, instead of asking a user to provide one.
71
75
  .TP
72
76
  .B \fB\-\-[no\-]diff\fP
73
- Indicates that only new and modified files will be uploaded. Set to \fBfalse\fP to upload all files. Default: \fBtrue\fP.
77
+ Indicates that only new and modified files will be uploaded. Set to \fBfalse\fP to upload all files. Default: \fBtrue\fP\&.
74
78
  .TP
75
79
  .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
76
80
  The $EDITOR that is used for all interactive commands.
@@ -79,43 +83,43 @@ The $EDITOR that is used for all interactive commands.
79
83
  The name of the environment. When this option is added to a command, the command will run only against the named environment.
80
84
  .TP
81
85
  .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
82
- The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
86
+ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
83
87
  .TP
84
88
  .B \fB\-\-[no\-]force\fP
85
- Use \fB\-\-force\fP to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no \fBPOST\fP or \fBPUT\fP is performed unless an actual change would be made). Default: \fB\-\-no\-force\fP.
89
+ Use \fB\-\-force\fP to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no \fBPOST\fP or \fBPUT\fP is performed unless an actual change would be made). Default: \fB\-\-no\-force\fP\&.
86
90
  .TP
87
91
  .B \fB\-\-[no\-]freeze\fP
88
- Indicates that a cookbook cannot be modified; any changes to this cookbook must be included as a new version. Only the \fB\-\-force\fP option can override this setting. Default: \fBfalse\fP.
92
+ Indicates that a cookbook cannot be modified; any changes to this cookbook must be included as a new version. Only the \fB\-\-force\fP option can override this setting. Default: \fBfalse\fP\&.
89
93
  .TP
90
94
  .B \fB\-h\fP, \fB\-\-help\fP
91
95
  Shows help for the command.
92
96
  .TP
93
97
  .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
94
- The private key that Knife will use to sign requests made by the API client to the server.
98
+ The private key that Knife will use to sign requests made by the API client to the Chef server\&.
95
99
  .TP
96
100
  .B \fB\-n\fP, \fB\-\-dry\-run\fP
97
- Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP.
101
+ Indicates that no action is taken and that results are only printed out. Default: \fBfalse\fP\&.
98
102
  .TP
99
103
  .B \fB\-\-print\-after\fP
100
104
  Indicates that data will be shown after a destructive operation.
101
105
  .TP
102
106
  .B \fB\-\-[no\-]purge\fP
103
- Use \fB\-\-purge\fP to delete roles, cookbooks, etc. from the server if their corresponding files do not exist in the chef\-repo. By default, such objects are left alone and NOT purged. Default: \fB\-\-no\-purge\fP.
107
+ Use \fB\-\-purge\fP to delete roles, cookbooks, etc. from the Chef server if their corresponding files do not exist in the chef\-repo\&. By default, such objects are left alone and NOT purged. Default: \fB\-\-no\-purge\fP\&.
104
108
  .TP
105
109
  .B \fB\-\-[no\-]recurse\fP
106
- Use \fB\-\-no\-recurse\fP to disable uploading a directory recursively. Default: \fB\-\-recurse\fP.
110
+ Use \fB\-\-no\-recurse\fP to disable uploading a directory recursively. Default: \fB\-\-recurse\fP\&.
107
111
  .TP
108
112
  .B \fB\-\-repo\-mode MODE\fP
109
- The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP.
113
+ The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&.
110
114
  .TP
111
115
  .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
112
- The URL for the server.
116
+ The URL for the Chef server\&.
113
117
  .TP
114
118
  .B \fB\-u USER\fP, \fB\-\-user USER\fP
115
- 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.
119
+ 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.
116
120
  .TP
117
121
  .B \fB\-v\fP, \fB\-\-version\fP
118
- The version of the chef\-client.
122
+ The version of the chef\-client\&.
119
123
  .TP
120
124
  .B \fB\-V\fP, \fB\-\-verbose\fP
121
125
  Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
@@ -124,104 +128,152 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
124
128
  Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
125
129
  .TP
126
130
  .B \fB\-z\fP, \fB\-\-local\-mode\fP
127
- 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.
131
+ 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\&.
128
132
  .UNINDENT
129
133
  .sp
130
134
  \fBExamples\fP
131
135
  .sp
132
136
  Browse to the top level of the chef\-repo and enter:
137
+ .INDENT 0.0
138
+ .INDENT 3.5
133
139
  .sp
134
140
  .nf
135
141
  .ft C
136
142
  $ knife upload
137
143
  .ft P
138
144
  .fi
145
+ .UNINDENT
146
+ .UNINDENT
139
147
  .sp
140
148
  or from anywhere in the chef\-repo, enter:
149
+ .INDENT 0.0
150
+ .INDENT 3.5
141
151
  .sp
142
152
  .nf
143
153
  .ft C
144
154
  $ knife upload /
145
155
  .ft P
146
156
  .fi
157
+ .UNINDENT
158
+ .UNINDENT
147
159
  .sp
148
160
  Browse to the top level of the chef\-repo and enter:
161
+ .INDENT 0.0
162
+ .INDENT 3.5
149
163
  .sp
150
164
  .nf
151
165
  .ft C
152
166
  $ knife upload cookbooks
153
167
  .ft P
154
168
  .fi
169
+ .UNINDENT
170
+ .UNINDENT
155
171
  .sp
156
172
  or from anywhere in the chef\-repo, enter:
173
+ .INDENT 0.0
174
+ .INDENT 3.5
157
175
  .sp
158
176
  .nf
159
177
  .ft C
160
178
  $ knife upload /cookbooks
161
179
  .ft P
162
180
  .fi
181
+ .UNINDENT
182
+ .UNINDENT
163
183
  .sp
164
184
  Browse to the top level of the chef\-repo and enter:
185
+ .INDENT 0.0
186
+ .INDENT 3.5
165
187
  .sp
166
188
  .nf
167
189
  .ft C
168
190
  $ knife upload environments
169
191
  .ft P
170
192
  .fi
193
+ .UNINDENT
194
+ .UNINDENT
171
195
  .sp
172
196
  or from anywhere in the chef\-repo, enter:
197
+ .INDENT 0.0
198
+ .INDENT 3.5
173
199
  .sp
174
200
  .nf
175
201
  .ft C
176
202
  $ knife upload /environments
177
203
  .ft P
178
204
  .fi
205
+ .UNINDENT
206
+ .UNINDENT
179
207
  .sp
180
208
  Browse to the top level of the chef\-repo and enter:
209
+ .INDENT 0.0
210
+ .INDENT 3.5
181
211
  .sp
182
212
  .nf
183
213
  .ft C
184
214
  $ knife upload environments/production.json
185
215
  .ft P
186
216
  .fi
217
+ .UNINDENT
218
+ .UNINDENT
187
219
  .sp
188
220
  or from the \fBenvironments/\fP directory, enter:
221
+ .INDENT 0.0
222
+ .INDENT 3.5
189
223
  .sp
190
224
  .nf
191
225
  .ft C
192
226
  $ knife upload production.json
193
227
  .ft P
194
228
  .fi
229
+ .UNINDENT
230
+ .UNINDENT
195
231
  .sp
196
232
  Browse to the top level of the chef\-repo and enter:
233
+ .INDENT 0.0
234
+ .INDENT 3.5
197
235
  .sp
198
236
  .nf
199
237
  .ft C
200
238
  $ knife upload roles
201
239
  .ft P
202
240
  .fi
241
+ .UNINDENT
242
+ .UNINDENT
203
243
  .sp
204
244
  or from anywhere in the chef\-repo, enter:
245
+ .INDENT 0.0
246
+ .INDENT 3.5
205
247
  .sp
206
248
  .nf
207
249
  .ft C
208
250
  $ knife upload /roles
209
251
  .ft P
210
252
  .fi
253
+ .UNINDENT
254
+ .UNINDENT
211
255
  .sp
212
256
  Browse to the top level of the chef\-repo and enter:
257
+ .INDENT 0.0
258
+ .INDENT 3.5
213
259
  .sp
214
260
  .nf
215
261
  .ft C
216
262
  $ knife upload cookbooks/apache\e* roles/webserver.json
217
263
  .ft P
218
264
  .fi
265
+ .UNINDENT
266
+ .UNINDENT
267
+ .INDENT 0.0
268
+ .INDENT 3.5
219
269
  .sp
220
270
  .nf
221
271
  .ft C
222
272
  $ knife upload \(gaknife deps nodes/*.json\(ga
223
273
  .ft P
224
274
  .fi
275
+ .UNINDENT
276
+ .UNINDENT
225
277
  .SH AUTHOR
226
278
  Chef
227
279
  .\" Generated by docutils manpage writer.
@@ -1,4 +1,6 @@
1
- .TH "KNIFE-USER" "1" "Chef 11.10.0" "" "knife user"
1
+ .\" Man page generated from reStructuredText.
2
+ .
3
+ .TH "KNIFE-USER" "1" "Chef 11.12.0" "" "knife user"
2
4
  .SH NAME
3
5
  knife-user \- The man page for the knife user subcommand.
4
6
  .
@@ -28,13 +30,15 @@ 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
  The \fBknife user\fP subcommand is used to manage the list of users and their associated RSA public key\-pairs.
35
- .IP Note
36
- This subcommand ONLY works when run against the open source server version 10.x. This subcommand will NOT run against open source server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef.
37
- .RE
35
+ .sp
36
+ \fBNOTE:\fP
37
+ .INDENT 0.0
38
+ .INDENT 3.5
39
+ This subcommand ONLY works when run against the open source Chef server version 10.x. This subcommand will NOT run against open source Chef server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef\&.
40
+ .UNINDENT
41
+ .UNINDENT
38
42
  .SH COMMON OPTIONS
39
43
  .sp
40
44
  The following options may be used with any of the arguments available to the \fBknife user\fP subcommand:
@@ -59,13 +63,13 @@ The $EDITOR that is used for all interactive commands.
59
63
  The name of the environment. When this option is added to a command, the command will run only against the named environment.
60
64
  .TP
61
65
  .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
62
- The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
66
+ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
63
67
  .TP
64
68
  .B \fB\-h\fP, \fB\-\-help\fP
65
69
  Shows help for the command.
66
70
  .TP
67
71
  .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
68
- The private key that Knife will use to sign requests made by the API client to the server.
72
+ The private key that Knife will use to sign requests made by the API client to the Chef server\&.
69
73
  .TP
70
74
  .B \fB\-\-[no\-]color\fP
71
75
  Indicates whether colored output will be used.
@@ -74,29 +78,29 @@ Indicates whether colored output will be used.
74
78
  Indicates that data will be shown after a destructive operation.
75
79
  .TP
76
80
  .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
77
- The URL for the server.
81
+ The URL for the Chef server\&.
78
82
  .TP
79
83
  .B \fB\-u USER\fP, \fB\-\-user USER\fP
80
- 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.
84
+ 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.
81
85
  .TP
82
86
  .B \fB\-V\fP, \fB\-\-verbose\fP
83
87
  Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
84
88
  .TP
85
89
  .B \fB\-v\fP, \fB\-\-version\fP
86
- The version of the chef\-client.
90
+ The version of the chef\-client\&.
87
91
  .TP
88
92
  .B \fB\-y\fP, \fB\-\-yes\fP
89
93
  Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
90
94
  .TP
91
95
  .B \fB\-z\fP, \fB\-\-local\-mode\fP
92
- 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.
96
+ 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\&.
93
97
  .UNINDENT
94
98
  .SH CREATE
95
99
  .sp
96
- The \fBcreate\fP argument is used to create a user. This process will generate an RSA key pair for the named user. The public key will be stored on the server and the private key will be displayed on \fBSTDOUT\fP or written to a named file.
100
+ The \fBcreate\fP argument is used to create a user. This process will generate an RSA key pair for the named user. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file.
97
101
  .INDENT 0.0
98
102
  .IP \(bu 2
99
- For the user, the private key should be copied to the system as \fB/etc/chef/client.pem\fP.
103
+ For the user, the private key should be copied to the system as \fB/etc/chef/client.pem\fP\&.
100
104
  .IP \(bu 2
101
105
  For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file.
102
106
  .UNINDENT
@@ -104,12 +108,16 @@ For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP
104
108
  \fBSyntax\fP
105
109
  .sp
106
110
  This argument has the following syntax:
111
+ .INDENT 0.0
112
+ .INDENT 3.5
107
113
  .sp
108
114
  .nf
109
115
  .ft C
110
116
  $ knife user create USER_NAME (options)
111
117
  .ft P
112
118
  .fi
119
+ .UNINDENT
120
+ .UNINDENT
113
121
  .sp
114
122
  \fBOptions\fP
115
123
  .sp
@@ -117,10 +125,10 @@ This argument has the following options:
117
125
  .INDENT 0.0
118
126
  .TP
119
127
  .B \fB\-a\fP, \fB\-\-admin\fP
120
- Indicates that a client will be created as an admin client. This is required when users of the open source server need to access the Chef Server API as an administrator. This option only works when used with the open source server and will have no effect when used with Enterprise Chef.
128
+ Indicates that a client will be created as an admin client. This is required when users of the open source Chef server need to access the Chef Server API as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&.
121
129
  .TP
122
130
  .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
123
- Indicates that the private key will be saved to a specified file name.
131
+ Use to save a private key to the specified file name.
124
132
  .TP
125
133
  .B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP
126
134
  The user password.
@@ -130,12 +138,16 @@ All users are assigned a public key. Use to write the public key to a file.
130
138
  .UNINDENT
131
139
  .sp
132
140
  \fBExamples\fP
141
+ .INDENT 0.0
142
+ .INDENT 3.5
133
143
  .sp
134
144
  .nf
135
145
  .ft C
136
146
  $ knife user create "Radio Birdman" \-f /keys/user_name
137
147
  .ft P
138
148
  .fi
149
+ .UNINDENT
150
+ .UNINDENT
139
151
  .SH DELETE
140
152
  .sp
141
153
  The \fBdelete\fP argument is used to delete a registered user.
@@ -143,37 +155,49 @@ The \fBdelete\fP argument is used to delete a registered user.
143
155
  \fBSyntax\fP
144
156
  .sp
145
157
  This argument has the following syntax:
158
+ .INDENT 0.0
159
+ .INDENT 3.5
146
160
  .sp
147
161
  .nf
148
162
  .ft C
149
163
  $ knife user delete USER_NAME
150
164
  .ft P
151
165
  .fi
166
+ .UNINDENT
167
+ .UNINDENT
152
168
  .sp
153
169
  \fBOptions\fP
154
170
  .sp
155
171
  This command does not have any specific options.
156
172
  .sp
157
173
  \fBExamples\fP
174
+ .INDENT 0.0
175
+ .INDENT 3.5
158
176
  .sp
159
177
  .nf
160
178
  .ft C
161
179
  $ knife user delete "Steve Danno"
162
180
  .ft P
163
181
  .fi
182
+ .UNINDENT
183
+ .UNINDENT
164
184
  .SH EDIT
165
185
  .sp
166
- The \fBedit\fP argument is used to edit the details of a user. When this argument is run, Knife will open $EDITOR. When finished, Knife will update the server with those changes.
186
+ The \fBedit\fP argument is used to edit the details of a user. When this argument is run, Knife will open $EDITOR\&. When finished, Knife will update the Chef server with those changes.
167
187
  .sp
168
188
  \fBSyntax\fP
169
189
  .sp
170
190
  This argument has the following syntax:
191
+ .INDENT 0.0
192
+ .INDENT 3.5
171
193
  .sp
172
194
  .nf
173
195
  .ft C
174
196
  $ knife user edit USER_NAME
175
197
  .ft P
176
198
  .fi
199
+ .UNINDENT
200
+ .UNINDENT
177
201
  .sp
178
202
  \fBOptions\fP
179
203
  .sp
@@ -189,12 +213,16 @@ The \fBlist\fP argument is used to view a list of registered users.
189
213
  \fBSyntax\fP
190
214
  .sp
191
215
  This argument has the following syntax:
216
+ .INDENT 0.0
217
+ .INDENT 3.5
192
218
  .sp
193
219
  .nf
194
220
  .ft C
195
221
  $ knife user list (options)
196
222
  .ft P
197
223
  .fi
224
+ .UNINDENT
225
+ .UNINDENT
198
226
  .sp
199
227
  \fBOptions\fP
200
228
  .sp
@@ -210,20 +238,28 @@ Indicates that the corresponding URIs will be shown.
210
238
  None.
211
239
  .SH REREGISTER
212
240
  .sp
213
- The \fBreregister\fP argument is used to regenerate an RSA key pair for a user. The public key will be stored on the server and the private key will be displayed on \fBSTDOUT\fP or written to a named file.
214
- .IP Note
215
- Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the server.
216
- .RE
241
+ The \fBreregister\fP argument is used to regenerate an RSA key pair for a user. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file.
242
+ .sp
243
+ \fBNOTE:\fP
244
+ .INDENT 0.0
245
+ .INDENT 3.5
246
+ Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the Chef server\&.
247
+ .UNINDENT
248
+ .UNINDENT
217
249
  .sp
218
250
  \fBSyntax\fP
219
251
  .sp
220
252
  This argument has the following syntax:
253
+ .INDENT 0.0
254
+ .INDENT 3.5
221
255
  .sp
222
256
  .nf
223
257
  .ft C
224
258
  $ knife user reregister USER_NAME (options)
225
259
  .ft P
226
260
  .fi
261
+ .UNINDENT
262
+ .UNINDENT
227
263
  .sp
228
264
  \fBOptions\fP
229
265
  .sp
@@ -231,16 +267,20 @@ This argument has the following options:
231
267
  .INDENT 0.0
232
268
  .TP
233
269
  .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
234
- Indicates that the private key will be saved to a specified file name.
270
+ Use to save a private key to the specified file name.
235
271
  .UNINDENT
236
272
  .sp
237
273
  \fBExamples\fP
274
+ .INDENT 0.0
275
+ .INDENT 3.5
238
276
  .sp
239
277
  .nf
240
278
  .ft C
241
279
  $ knife user reregister "Robert Younger"
242
280
  .ft P
243
281
  .fi
282
+ .UNINDENT
283
+ .UNINDENT
244
284
  .SH SHOW
245
285
  .sp
246
286
  The \fBshow\fP argument is used to show the details of a user.
@@ -248,12 +288,16 @@ The \fBshow\fP argument is used to show the details of a user.
248
288
  \fBSyntax\fP
249
289
  .sp
250
290
  This argument has the following syntax:
291
+ .INDENT 0.0
292
+ .INDENT 3.5
251
293
  .sp
252
294
  .nf
253
295
  .ft C
254
296
  $ knife user show USER_NAME (options)
255
297
  .ft P
256
298
  .fi
299
+ .UNINDENT
300
+ .UNINDENT
257
301
  .sp
258
302
  \fBOptions\fP
259
303
  .sp
@@ -267,14 +311,20 @@ The attribute (or attributes) to show.
267
311
  \fBExamples\fP
268
312
  .sp
269
313
  To view a user named "Dennis Teck", enter:
314
+ .INDENT 0.0
315
+ .INDENT 3.5
270
316
  .sp
271
317
  .nf
272
318
  .ft C
273
319
  $ knife user show "Dennis Teck"
274
320
  .ft P
275
321
  .fi
322
+ .UNINDENT
323
+ .UNINDENT
276
324
  .sp
277
325
  to return something like:
326
+ .INDENT 0.0
327
+ .INDENT 3.5
278
328
  .sp
279
329
  .nf
280
330
  .ft C
@@ -284,16 +334,22 @@ name: Dennis Teck
284
334
  public_key:
285
335
  .ft P
286
336
  .fi
337
+ .UNINDENT
338
+ .UNINDENT
287
339
  .sp
288
340
  To view information in JSON format, use the \fB\-F\fP common option as part of the command like this:
341
+ .INDENT 0.0
342
+ .INDENT 3.5
289
343
  .sp
290
344
  .nf
291
345
  .ft C
292
346
  $ knife user show "Dennis Teck" \-F json
293
347
  .ft P
294
348
  .fi
349
+ .UNINDENT
350
+ .UNINDENT
295
351
  .sp
296
- (Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP, e.g. \fB\-F yaml\fP for YAML.)
352
+ (Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP, e.g. \fB\-F yaml\fP for YAML\&.)
297
353
  .SH AUTHOR
298
354
  Chef
299
355
  .\" Generated by docutils manpage writer.