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-CLIENT" "1" "Chef 11.10.0" "" "knife client"
1
+ .\" Man page generated from reStructuredText.
2
+ .
3
+ .TH "KNIFE-CLIENT" "1" "Chef 11.12.0" "" "knife client"
2
4
  .SH NAME
3
5
  knife-client \- The man page for the knife client subcommand.
4
6
  .
@@ -28,14 +30,16 @@ 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
- When a node runs the chef\-client for the first time, it generally does not yet have an API client identity, and so it cannot make authenticated requests to the server. This is where the validation client\-\-\-known as the chef\-validator\-\-\-comes in. When the chef\-client runs, it checks if it has a client key. If the client key does not exist, it then attempts to borrow the identity of the chef\-validator to register itself with the server. In order to register with the server, the private key for the chef\-validator needs to be copied to the host and placed in \fB/etc/chef/validation.pem\fP.
34
+ Every request made by the chef\-client to the Chef server must be an authenticated request using the Chef Server API and a private key. When the chef\-client makes a request to the Chef server, the chef\-client authenticates each request using a private key located in \fB/etc/chef/client.pem\fP\&.
35
+ .sp
36
+ However, during the first chef\-client run, this private key does not exist. Instead, the chef\-client will attempt to use the private key assigned to the chef\-validator, located in \fB/etc/chef/validation.pem\fP\&. (If, for any reason, the chef\-validator is unable to make an authenticated request to the Chef server, the initial chef\-client run will fail.)
35
37
  .sp
36
- Once the chef\-client has registered itself with the server, it no longer uses the validation client for anything. It is recommended that you delete the private key for the chef\-validator from the host after the host has registered or use the \fBdelete_validation\fP recipe that can be found in the \fBchef\-client\fP cookbook (\fI\%https://github.com/opscode-cookbooks/chef-client\fP).
38
+ During the initial chef\-client run, the chef\-client will register with the Chef server using the private key assigned to the chef\-validator, after which the chef\-client will obtain a \fBclient.pem\fP private key for all future authentication requests to the Chef server\&.
37
39
  .sp
38
- The \fBknife client\fP subcommand is used to manage an API client list and their associated RSA public key\-pairs. This allows authentication requests to be made to the server by any entity that uses the Chef Server API, such as the chef\-client and Knife.
40
+ After the initial chef\-client run has completed successfully, the chef\-validator is no longer required and may be deleted from the node. Use the \fBdelete_validation\fP recipe found in the \fBchef\-client\fP cookbook (\fI\%https://github.com/opscode\-cookbooks/chef\-client\fP) to remove the chef\-validator\&.
41
+ .sp
42
+ The \fBknife client\fP subcommand is used to manage an API client list and their associated RSA public key\-pairs. This allows authentication requests to be made to the Chef server by any entity that uses the Chef Server API, such as the chef\-client and Knife\&.
39
43
  .SH COMMON OPTIONS
40
44
  .sp
41
45
  The following options may be used with any of the arguments available to the \fBknife client\fP subcommand:
@@ -60,13 +64,13 @@ The $EDITOR that is used for all interactive commands.
60
64
  The name of the environment. When this option is added to a command, the command will run only against the named environment.
61
65
  .TP
62
66
  .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
63
- The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
67
+ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
64
68
  .TP
65
69
  .B \fB\-h\fP, \fB\-\-help\fP
66
70
  Shows help for the command.
67
71
  .TP
68
72
  .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
69
- The private key that Knife will use to sign requests made by the API client to the server.
73
+ The private key that Knife will use to sign requests made by the API client to the Chef server\&.
70
74
  .TP
71
75
  .B \fB\-\-[no\-]color\fP
72
76
  Indicates whether colored output will be used.
@@ -75,46 +79,50 @@ Indicates whether colored output will be used.
75
79
  Indicates that data will be shown after a destructive operation.
76
80
  .TP
77
81
  .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
78
- The URL for the server.
82
+ The URL for the Chef server\&.
79
83
  .TP
80
84
  .B \fB\-u USER\fP, \fB\-\-user USER\fP
81
- 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.
85
+ 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.
82
86
  .TP
83
87
  .B \fB\-V\fP, \fB\-\-verbose\fP
84
88
  Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
85
89
  .TP
86
90
  .B \fB\-v\fP, \fB\-\-version\fP
87
- The version of the chef\-client.
91
+ The version of the chef\-client\&.
88
92
  .TP
89
93
  .B \fB\-y\fP, \fB\-\-yes\fP
90
94
  Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
91
95
  .TP
92
96
  .B \fB\-z\fP, \fB\-\-local\-mode\fP
93
- 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.
97
+ 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\&.
94
98
  .UNINDENT
95
99
  .SH BULK DELETE
96
100
  .sp
97
- The \fBbulk delete\fP argument is used to delete any API client that matches a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/).
101
+ The \fBbulk delete\fP argument is used to delete any API client that matches a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (\fB/\fP).
98
102
  .sp
99
103
  \fBSyntax\fP
100
104
  .sp
101
105
  This argument has the following syntax:
106
+ .INDENT 0.0
107
+ .INDENT 3.5
102
108
  .sp
103
109
  .nf
104
110
  .ft C
105
111
  $ knife client bulk delete REGEX
106
112
  .ft P
107
113
  .fi
114
+ .UNINDENT
115
+ .UNINDENT
108
116
  .sp
109
117
  \fBOptions\fP
110
118
  .sp
111
119
  This command does not have any specific options.
112
120
  .SH CREATE
113
121
  .sp
114
- The \fBcreate\fP argument is used to create a new API client. This process will generate an RSA key pair for the named API client. 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.
122
+ The \fBcreate\fP argument is used to create a new API client\&. This process will generate an RSA key pair for the named API client\&. 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.
115
123
  .INDENT 0.0
116
124
  .IP \(bu 2
117
- For the chef\-client, the private key should be copied to the system as \fB/etc/chef/client.pem\fP.
125
+ For the chef\-client, the private key should be copied to the system as \fB/etc/chef/client.pem\fP\&.
118
126
  .IP \(bu 2
119
127
  For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file.
120
128
  .UNINDENT
@@ -122,12 +130,16 @@ For Knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP
122
130
  \fBSyntax\fP
123
131
  .sp
124
132
  This argument has the following syntax:
133
+ .INDENT 0.0
134
+ .INDENT 3.5
125
135
  .sp
126
136
  .nf
127
137
  .ft C
128
138
  $ knife client create CLIENT_NAME (options)
129
139
  .ft P
130
140
  .fi
141
+ .UNINDENT
142
+ .UNINDENT
131
143
  .sp
132
144
  \fBOptions\fP
133
145
  .sp
@@ -135,39 +147,54 @@ This argument has the following options:
135
147
  .INDENT 0.0
136
148
  .TP
137
149
  .B \fB\-a\fP, \fB\-\-admin\fP
138
- 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.
150
+ 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\&.
151
+ .TP
152
+ .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
153
+ Use to save a private key to the specified file name.
139
154
  .UNINDENT
140
155
  .sp
141
156
  \fBExamples\fP
142
157
  .sp
143
158
  To create a Chef Admin client with the name "exampleorg" and save its private key to a file, enter:
159
+ .INDENT 0.0
160
+ .INDENT 3.5
144
161
  .sp
145
162
  .nf
146
163
  .ft C
147
164
  $ knife client create exampleorg \-a \-f "/etc/chef/client.pem"
148
165
  .ft P
149
166
  .fi
167
+ .UNINDENT
168
+ .UNINDENT
150
169
  .sp
151
170
  When running the \fBcreate\fP argument on Enterprise Chef, be sure to omit the \fB\-a\fP option:
171
+ .INDENT 0.0
172
+ .INDENT 3.5
152
173
  .sp
153
174
  .nf
154
175
  .ft C
155
176
  $ knife client create exampleorg \-f "/etc/chef/client.pem"
156
177
  .ft P
157
178
  .fi
179
+ .UNINDENT
180
+ .UNINDENT
158
181
  .SH DELETE
159
182
  .sp
160
- The \fBdelete\fP argument is used to delete a registered API client.
183
+ The \fBdelete\fP argument is used to delete a registered API client\&.
161
184
  .sp
162
185
  \fBSyntax\fP
163
186
  .sp
164
187
  This argument has the following syntax:
188
+ .INDENT 0.0
189
+ .INDENT 3.5
165
190
  .sp
166
191
  .nf
167
192
  .ft C
168
193
  $ knife client delete CLIENT_NAME
169
194
  .ft P
170
195
  .fi
196
+ .UNINDENT
197
+ .UNINDENT
171
198
  .sp
172
199
  \fBOptions\fP
173
200
  .sp
@@ -176,27 +203,35 @@ This command does not have any specific options.
176
203
  \fBExamples\fP
177
204
  .sp
178
205
  To delete a client with the name "client_foo", enter:
206
+ .INDENT 0.0
207
+ .INDENT 3.5
179
208
  .sp
180
209
  .nf
181
210
  .ft C
182
211
  $ knife client delete client_foo
183
212
  .ft P
184
213
  .fi
214
+ .UNINDENT
215
+ .UNINDENT
185
216
  .sp
186
217
  Type \fBY\fP to confirm a deletion.
187
218
  .SH EDIT
188
219
  .sp
189
- The \fBedit\fP argument is used to edit the details of a registered API client. When this argument is run, Knife will open $EDITOR to enable editing of the \fBadmin\fP attribute. (None of the other attributes should be changed using this argument.) When finished, Knife will update the server with those changes.
220
+ The \fBedit\fP argument is used to edit the details of a registered API client\&. When this argument is run, Knife will open $EDITOR to enable editing of the \fBadmin\fP attribute. (None of the other attributes should be changed using this argument.) When finished, Knife will update the Chef server with those changes.
190
221
  .sp
191
222
  \fBSyntax\fP
192
223
  .sp
193
224
  This argument has the following syntax:
225
+ .INDENT 0.0
226
+ .INDENT 3.5
194
227
  .sp
195
228
  .nf
196
229
  .ft C
197
230
  $ knife client edit CLIENT_NAME
198
231
  .ft P
199
232
  .fi
233
+ .UNINDENT
234
+ .UNINDENT
200
235
  .sp
201
236
  \fBOptions\fP
202
237
  .sp
@@ -205,25 +240,33 @@ This command does not have any specific options.
205
240
  \fBExamples\fP
206
241
  .sp
207
242
  To edit a client with the name "exampleorg", enter:
243
+ .INDENT 0.0
244
+ .INDENT 3.5
208
245
  .sp
209
246
  .nf
210
247
  .ft C
211
248
  $ knife client edit exampleorg
212
249
  .ft P
213
250
  .fi
251
+ .UNINDENT
252
+ .UNINDENT
214
253
  .SH LIST
215
254
  .sp
216
- The \fBlist\fP argument is used to view a list of registered API client.
255
+ The \fBlist\fP argument is used to view a list of registered API client\&.
217
256
  .sp
218
257
  \fBSyntax\fP
219
258
  .sp
220
259
  This argument has the following syntax:
260
+ .INDENT 0.0
261
+ .INDENT 3.5
221
262
  .sp
222
263
  .nf
223
264
  .ft C
224
265
  $ knife client list (options)
225
266
  .ft P
226
267
  .fi
268
+ .UNINDENT
269
+ .UNINDENT
227
270
  .sp
228
271
  \fBOptions\fP
229
272
  .sp
@@ -236,15 +279,21 @@ Indicates that the corresponding URIs will be shown.
236
279
  .sp
237
280
  \fBExamples\fP
238
281
  .sp
239
- To verify the API client list for the server, enter:
282
+ To verify the API client list for the Chef server, enter:
283
+ .INDENT 0.0
284
+ .INDENT 3.5
240
285
  .sp
241
286
  .nf
242
287
  .ft C
243
288
  $ knife client list
244
289
  .ft P
245
290
  .fi
291
+ .UNINDENT
292
+ .UNINDENT
246
293
  .sp
247
294
  to return something similar to:
295
+ .INDENT 0.0
296
+ .INDENT 3.5
248
297
  .sp
249
298
  .nf
250
299
  .ft C
@@ -253,31 +302,45 @@ i\-12345678
253
302
  rs\-123456
254
303
  .ft P
255
304
  .fi
305
+ .UNINDENT
306
+ .UNINDENT
256
307
  .sp
257
308
  To verify that an API client can authenticate to the
258
- server correctly, try getting a list of clients using \fB\-u\fP and \fB\-k\fP options to specify its name and private key:
309
+ Chef server correctly, try getting a list of clients using \fB\-u\fP and \fB\-k\fP options to specify its name and private key:
310
+ .INDENT 0.0
311
+ .INDENT 3.5
259
312
  .sp
260
313
  .nf
261
314
  .ft C
262
315
  $ knife client list \-u ORGNAME \-k .chef/ORGNAME.pem
263
316
  .ft P
264
317
  .fi
318
+ .UNINDENT
319
+ .UNINDENT
265
320
  .SH REREGISTER
266
321
  .sp
267
- The \fBreregister\fP argument is used to regenerate an RSA key pair for an API client. 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.
268
- .IP Note
269
- Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the server.
270
- .RE
322
+ The \fBreregister\fP argument is used to regenerate an RSA key pair for an API client\&. 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.
323
+ .sp
324
+ \fBNOTE:\fP
325
+ .INDENT 0.0
326
+ .INDENT 3.5
327
+ Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the Chef server\&.
328
+ .UNINDENT
329
+ .UNINDENT
271
330
  .sp
272
331
  \fBSyntax\fP
273
332
  .sp
274
333
  This argument has the following syntax:
334
+ .INDENT 0.0
335
+ .INDENT 3.5
275
336
  .sp
276
337
  .nf
277
338
  .ft C
278
339
  $ knife client reregister CLIENT_NAME (options)
279
340
  .ft P
280
341
  .fi
342
+ .UNINDENT
343
+ .UNINDENT
281
344
  .sp
282
345
  \fBOptions\fP
283
346
  .sp
@@ -285,31 +348,39 @@ This argument has the following options:
285
348
  .INDENT 0.0
286
349
  .TP
287
350
  .B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
288
- Indicates that the private key will be saved to a specified file name.
351
+ Use to save a private key to the specified file name.
289
352
  .UNINDENT
290
353
  .sp
291
354
  \fBExamples\fP
292
355
  .sp
293
356
  To regenerate the RSA key pair for a client named "testclient" and save it to a file named "rsa_key", enter:
357
+ .INDENT 0.0
358
+ .INDENT 3.5
294
359
  .sp
295
360
  .nf
296
361
  .ft C
297
362
  $ knife client regenerate testclient \-f rsa_key
298
363
  .ft P
299
364
  .fi
365
+ .UNINDENT
366
+ .UNINDENT
300
367
  .SH SHOW
301
368
  .sp
302
- The \fBshow\fP argument is used to show the details of an API client.
369
+ The \fBshow\fP argument is used to show the details of an API client\&.
303
370
  .sp
304
371
  \fBSyntax\fP
305
372
  .sp
306
373
  This argument has the following syntax:
374
+ .INDENT 0.0
375
+ .INDENT 3.5
307
376
  .sp
308
377
  .nf
309
378
  .ft C
310
379
  $ knife client show CLIENT_NAME (options)
311
380
  .ft P
312
381
  .fi
382
+ .UNINDENT
383
+ .UNINDENT
313
384
  .sp
314
385
  \fBOptions\fP
315
386
  .sp
@@ -323,14 +394,20 @@ The attribute (or attributes) to show.
323
394
  \fBExamples\fP
324
395
  .sp
325
396
  To view a client named "testclient", enter:
397
+ .INDENT 0.0
398
+ .INDENT 3.5
326
399
  .sp
327
400
  .nf
328
401
  .ft C
329
402
  $ knife client show testclient
330
403
  .ft P
331
404
  .fi
405
+ .UNINDENT
406
+ .UNINDENT
332
407
  .sp
333
408
  to return something like:
409
+ .INDENT 0.0
410
+ .INDENT 3.5
334
411
  .sp
335
412
  .nf
336
413
  .ft C
@@ -341,16 +418,22 @@ name: testclient
341
418
  public_key:
342
419
  .ft P
343
420
  .fi
421
+ .UNINDENT
422
+ .UNINDENT
344
423
  .sp
345
424
  To view information in JSON format, use the \fB\-F\fP common option as part of the command like this:
425
+ .INDENT 0.0
426
+ .INDENT 3.5
346
427
  .sp
347
428
  .nf
348
429
  .ft C
349
430
  $ knife role show devops \-F json
350
431
  .ft P
351
432
  .fi
433
+ .UNINDENT
434
+ .UNINDENT
352
435
  .sp
353
- Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP.
436
+ Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&.
354
437
  .SH AUTHOR
355
438
  Chef
356
439
  .\" Generated by docutils manpage writer.
@@ -1,4 +1,6 @@
1
- .TH "KNIFE-CONFIGURE" "1" "Chef 11.10.0" "" "knife configure"
1
+ .\" Man page generated from reStructuredText.
2
+ .
3
+ .TH "KNIFE-CONFIGURE" "1" "Chef 11.12.0" "" "knife configure"
2
4
  .SH NAME
3
5
  knife-configure \- The man page for the knife configure subcommand.
4
6
  .
@@ -28,28 +30,34 @@ 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 configure\fP subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes.
35
35
  .sp
36
36
  \fBSyntax\fP
37
37
  .sp
38
- This argument has the following syntax when creating a knife.rb file:
38
+ This subcommand has the following syntax when creating a knife.rb file:
39
+ .INDENT 0.0
40
+ .INDENT 3.5
39
41
  .sp
40
42
  .nf
41
43
  .ft C
42
44
  $ knife configure (options)
43
45
  .ft P
44
46
  .fi
47
+ .UNINDENT
48
+ .UNINDENT
45
49
  .sp
46
50
  and the following syntax when creating a client.rb file:
51
+ .INDENT 0.0
52
+ .INDENT 3.5
47
53
  .sp
48
54
  .nf
49
55
  .ft C
50
56
  $ knife configure client DIRECTORY
51
57
  .ft P
52
58
  .fi
59
+ .UNINDENT
60
+ .UNINDENT
53
61
  .sp
54
62
  \fBOptions\fP
55
63
  .sp
@@ -57,7 +65,7 @@ This subcommand has the following options:
57
65
  .INDENT 0.0
58
66
  .TP
59
67
  .B \fB\-\-admin\-client\-key PATH\fP
60
- The path to the private key used by the client, typically a file named \fBadmin.pem\fP.
68
+ The path to the private key used by the client, typically a file named \fBadmin.pem\fP\&.
61
69
  .TP
62
70
  .B \fB\-\-admin\-client\-name NAME\fP
63
71
  The name of the client, typically the name of the admin client.
@@ -84,31 +92,31 @@ The $EDITOR that is used for all interactive commands.
84
92
  The name of the environment. When this option is added to a command, the command will run only against the named environment.
85
93
  .TP
86
94
  .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
87
- The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
95
+ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
88
96
  .TP
89
97
  .B \fB\-h\fP, \fB\-\-help\fP
90
98
  Shows help for the command.
91
99
  .TP
92
100
  .B \fB\-i\fP, \fB\-\-initial\fP
93
- Use to create a API client, typically an administrator client on a freshly\-installed server.
101
+ Use to create a API client, typically an administrator client on a freshly\-installed Chef server\&.
94
102
  .TP
95
103
  .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
96
- The private key that Knife will use to sign requests made by the API client to the server.
104
+ The private key that Knife will use to sign requests made by the API client to the Chef server\&.
97
105
  .TP
98
106
  .B \fB\-\-print\-after\fP
99
107
  Indicates that data will be shown after a destructive operation.
100
108
  .TP
101
109
  .B \fB\-r REPO\fP, \fB\-\-repository REPO\fP
102
- The path to the chef\-repo.
110
+ The path to the chef\-repo\&.
103
111
  .TP
104
112
  .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
105
- The URL for the server.
113
+ The URL for the Chef server\&.
106
114
  .TP
107
115
  .B \fB\-u USER\fP, \fB\-\-user USER\fP
108
- 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.
116
+ 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.
109
117
  .TP
110
118
  .B \fB\-v\fP, \fB\-\-version\fP
111
- The version of the chef\-client.
119
+ The version of the chef\-client\&.
112
120
  .TP
113
121
  .B \fB\-V\fP, \fB\-\-verbose\fP
114
122
  Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
@@ -117,28 +125,36 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
117
125
  The name of the validation client.
118
126
  .TP
119
127
  .B \fB\-\-validation\-key PATH\fP
120
- The path to the validation key used by the client, typically a file named \fBvalidation.pem\fP.
128
+ The path to the validation key used by the client, typically a file named \fBvalidation.pem\fP\&.
121
129
  .TP
122
130
  .B \fB\-y\fP, \fB\-\-yes\fP
123
131
  Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
124
132
  .TP
125
133
  .B \fB\-z\fP, \fB\-\-local\-mode\fP
126
- 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.
134
+ 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\&.
127
135
  .UNINDENT
128
136
  .sp
129
137
  \fBExamples\fP
138
+ .INDENT 0.0
139
+ .INDENT 3.5
130
140
  .sp
131
141
  .nf
132
142
  .ft C
133
143
  $ knife configure
134
144
  .ft P
135
145
  .fi
146
+ .UNINDENT
147
+ .UNINDENT
148
+ .INDENT 0.0
149
+ .INDENT 3.5
136
150
  .sp
137
151
  .nf
138
152
  .ft C
139
153
  $ knife configure client \(aq/directory\(aq
140
154
  .ft P
141
155
  .fi
156
+ .UNINDENT
157
+ .UNINDENT
142
158
  .SH AUTHOR
143
159
  Chef
144
160
  .\" Generated by docutils manpage writer.