chef 11.10.0.alpha.1 → 11.10.0.rc.0
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +57 -36
- data/distro/common/html/chef-client.8.html +4 -4
- data/distro/common/html/chef-expander.8.html +4 -4
- data/distro/common/html/chef-expanderctl.8.html +4 -4
- data/distro/common/html/chef-server-webui.8.html +4 -4
- data/distro/common/html/chef-server.8.html +4 -4
- data/distro/common/html/chef-shell.1.html +4 -4
- data/distro/common/html/chef-solo.8.html +4 -4
- data/distro/common/html/chef-solr.8.html +5 -5
- data/distro/common/html/knife-bootstrap.1.html +4 -4
- data/distro/common/html/knife-client.1.html +4 -4
- data/distro/common/html/knife-configure.1.html +4 -4
- data/distro/common/html/knife-cookbook-site.1.html +4 -4
- data/distro/common/html/knife-cookbook.1.html +4 -4
- data/distro/common/html/knife-data-bag.1.html +4 -4
- data/distro/common/html/knife-environment.1.html +4 -4
- data/distro/common/html/knife-exec.1.html +4 -4
- data/distro/common/html/knife-index.1.html +4 -4
- data/distro/common/html/knife-node.1.html +4 -4
- data/distro/common/html/knife-role.1.html +4 -4
- data/distro/common/html/knife-search.1.html +4 -4
- data/distro/common/html/knife-ssh.1.html +4 -4
- data/distro/common/html/knife-status.1.html +4 -4
- data/distro/common/html/knife-tag.1.html +4 -4
- data/distro/common/html/knife.1.html +4 -4
- data/distro/common/man/man1/knife-bootstrap.1 +58 -64
- data/distro/common/man/man1/knife-client.1 +19 -22
- data/distro/common/man/man1/knife-configure.1 +37 -46
- data/distro/common/man/man1/knife-cookbook-site.1 +14 -17
- data/distro/common/man/man1/knife-cookbook.1 +15 -18
- data/distro/common/man/man1/knife-data-bag.1 +14 -17
- data/distro/common/man/man1/knife-delete.1 +38 -47
- data/distro/common/man/man1/knife-deps.1 +39 -48
- data/distro/common/man/man1/knife-diff.1 +43 -52
- data/distro/common/man/man1/knife-download.1 +47 -53
- data/distro/common/man/man1/knife-edit.1 +32 -41
- data/distro/common/man/man1/knife-environment.1 +14 -17
- data/distro/common/man/man1/knife-exec.1 +52 -61
- data/distro/common/man/man1/knife-index-rebuild.1 +1 -61
- data/distro/common/man/man1/knife-list.1 +47 -59
- data/distro/common/man/man1/knife-node.1 +15 -18
- data/distro/common/man/man1/knife-raw.1 +28 -46
- data/distro/common/man/man1/knife-recipe-list.1 +1 -61
- data/distro/common/man/man1/knife-role.1 +19 -25
- data/distro/common/man/man1/knife-search.1 +53 -62
- data/distro/common/man/man1/knife-show.1 +36 -28
- data/distro/common/man/man1/knife-ssh.1 +55 -61
- data/distro/common/man/man1/knife-status.1 +34 -43
- data/distro/common/man/man1/knife-tag.1 +14 -17
- data/distro/common/man/man1/knife-upload.1 +47 -56
- data/distro/common/man/man1/knife-user.1 +17 -20
- data/distro/common/man/man1/knife-xargs.1 +60 -69
- data/lib/chef/application.rb +3 -1
- data/lib/chef/application/windows_service.rb +0 -1
- data/lib/chef/client.rb +41 -152
- data/lib/chef/config.rb +19 -23
- data/lib/chef/data_bag.rb +1 -1
- data/lib/chef/data_bag_item.rb +1 -1
- data/lib/chef/exceptions.rb +8 -0
- data/lib/chef/formatters/doc.rb +15 -0
- data/lib/chef/formatters/error_inspectors/api_error_formatting.rb +2 -1
- data/lib/chef/http.rb +18 -8
- data/lib/chef/http/authenticator.rb +4 -0
- data/lib/chef/http/cookie_manager.rb +3 -0
- data/lib/chef/http/decompressor.rb +4 -0
- data/lib/chef/http/json_input.rb +4 -0
- data/lib/chef/http/json_output.rb +4 -0
- data/lib/chef/http/validate_content_length.rb +94 -0
- data/lib/chef/knife.rb +0 -1
- data/lib/chef/knife/configure.rb +6 -6
- data/lib/chef/knife/cookbook_create.rb +2 -2
- data/lib/chef/knife/core/subcommand_loader.rb +49 -3
- data/lib/chef/knife/ssh.rb +34 -4
- data/lib/chef/mixin/path_sanity.rb +1 -0
- data/lib/chef/monologger.rb +1 -2
- data/lib/chef/node.rb +7 -0
- data/lib/chef/policy_builder.rb +49 -0
- data/lib/chef/policy_builder/expand_node_object.rb +230 -0
- data/lib/chef/policy_builder/policyfile.rb +338 -0
- data/lib/chef/provider/file.rb +15 -5
- data/lib/chef/provider/group.rb +6 -2
- data/lib/chef/provider/group/windows.rb +12 -2
- data/lib/chef/provider/http_request.rb +3 -2
- data/lib/chef/provider/package.rb +1 -0
- data/lib/chef/provider/package/aix.rb +1 -1
- data/lib/chef/provider/service/debian.rb +7 -2
- data/lib/chef/resource/file.rb +8 -1
- data/lib/chef/resource/package.rb +9 -0
- data/lib/chef/resource/service.rb +0 -1
- data/lib/chef/rest.rb +2 -0
- data/lib/chef/run_context.rb +1 -1
- data/lib/chef/util/file_edit.rb +1 -1
- data/lib/chef/util/windows/net_group.rb +7 -6
- data/lib/chef/version.rb +1 -1
- data/lib/chef/win32/version.rb +31 -18
- data/spec/data/cookbooks/preseed/templates/default/preseed-template-variables.seed +1 -0
- data/spec/functional/resource/file_spec.rb +0 -1
- data/spec/functional/resource/group_spec.rb +96 -16
- data/spec/functional/resource/package_spec.rb +17 -0
- data/spec/functional/resource/user_spec.rb +2 -2
- data/spec/functional/win32/versions_spec.rb +39 -0
- data/spec/integration/client/client_spec.rb +27 -28
- data/spec/spec_helper.rb +2 -0
- data/spec/support/platform_helpers.rb +7 -1
- data/spec/support/shared/functional/file_resource.rb +83 -43
- data/spec/unit/application_spec.rb +7 -5
- data/spec/unit/client_spec.rb +10 -3
- data/spec/unit/config_spec.rb +0 -30
- data/spec/unit/cookbook_spec.rb +1 -0
- data/spec/unit/data_bag_item_spec.rb +8 -0
- data/spec/unit/data_bag_spec.rb +6 -0
- data/spec/unit/http_spec.rb +48 -0
- data/spec/unit/knife/core/subcommand_loader_spec.rb +77 -1
- data/spec/unit/knife/ssh_spec.rb +107 -0
- data/spec/unit/mixin/path_sanity_spec.rb +6 -0
- data/spec/unit/mixin/securable_spec.rb +77 -3
- data/spec/unit/monologger_spec.rb +45 -0
- data/spec/unit/node_spec.rb +16 -0
- data/spec/unit/policy_builder/expand_node_object_spec.rb +320 -0
- data/spec/unit/policy_builder/policyfile_spec.rb +399 -0
- data/spec/unit/policy_builder_spec.rb +26 -0
- data/spec/unit/provider/deploy_spec.rb +3 -0
- data/spec/unit/provider/group/windows_spec.rb +1 -0
- data/spec/unit/provider/http_request_spec.rb +23 -1
- data/spec/unit/provider/service/debian_service_spec.rb +50 -19
- data/spec/unit/recipe_spec.rb +4 -0
- data/spec/unit/resource/package_spec.rb +5 -0
- data/spec/unit/rest_spec.rb +375 -278
- data/spec/unit/run_context_spec.rb +4 -0
- metadata +96 -59
- checksums.yaml +0 -7
@@ -44,14 +44,14 @@ $ knife node [ARGUMENT] (options)
|
|
44
44
|
.fi
|
45
45
|
.SH COMMON OPTIONS
|
46
46
|
.sp
|
47
|
-
The following options
|
47
|
+
The following options may be used with any of the arguments available to the \fBknife node\fP subcommand:
|
48
48
|
.INDENT 0.0
|
49
49
|
.TP
|
50
|
-
.B \fB\-
|
51
|
-
The
|
50
|
+
.B \fB\-\-chef\-zero\-port PORT\fP
|
51
|
+
The port on which chef\-zero will listen.
|
52
52
|
.TP
|
53
|
-
.B \fB\-\-
|
54
|
-
|
53
|
+
.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
|
54
|
+
The configuration file to use.
|
55
55
|
.TP
|
56
56
|
.B \fB\-d\fP, \fB\-\-disable\-editing\fP
|
57
57
|
Indicates that $EDITOR will not be opened; data will be accepted as\-is.
|
@@ -65,9 +65,6 @@ The $EDITOR that is used for all interactive commands.
|
|
65
65
|
.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
|
66
66
|
The name of the environment. When this option is added to a command, the command will run only against the named environment.
|
67
67
|
.TP
|
68
|
-
.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
|
69
|
-
Indicates that the private key will be saved to a specified file name.
|
70
|
-
.TP
|
71
68
|
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
|
72
69
|
The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
|
73
70
|
.TP
|
@@ -77,11 +74,8 @@ Shows help for the command.
|
|
77
74
|
.B \fB\-k KEY\fP, \fB\-\-key KEY\fP
|
78
75
|
The private key that Knife will use to sign requests made by the API client to the server.
|
79
76
|
.TP
|
80
|
-
.B \fB\-\-no\-color\fP
|
81
|
-
Indicates
|
82
|
-
.TP
|
83
|
-
.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP
|
84
|
-
The user password.
|
77
|
+
.B \fB\-\-[no\-]color\fP
|
78
|
+
Indicates whether colored output will be used.
|
85
79
|
.TP
|
86
80
|
.B \fB\-\-print\-after\fP
|
87
81
|
Indicates that data will be shown after a destructive operation.
|
@@ -92,14 +86,17 @@ The URL for the server.
|
|
92
86
|
.B \fB\-u USER\fP, \fB\-\-user USER\fP
|
93
87
|
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.
|
94
88
|
.TP
|
95
|
-
.B \fB\-v\fP, \fB\-\-version\fP
|
96
|
-
The version of the chef\-client.
|
97
|
-
.TP
|
98
89
|
.B \fB\-V\fP, \fB\-\-verbose\fP
|
99
90
|
Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
|
100
91
|
.TP
|
92
|
+
.B \fB\-v\fP, \fB\-\-version\fP
|
93
|
+
The version of the chef\-client.
|
94
|
+
.TP
|
101
95
|
.B \fB\-y\fP, \fB\-\-yes\fP
|
102
96
|
Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
|
97
|
+
.TP
|
98
|
+
.B \fB\-z\fP, \fB\-\-local\-mode\fP
|
99
|
+
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.
|
103
100
|
.UNINDENT
|
104
101
|
.SH BULK DELETE
|
105
102
|
.sp
|
@@ -343,7 +340,7 @@ rs\-123456
|
|
343
340
|
.fi
|
344
341
|
.SH RUN_LIST ADD
|
345
342
|
.sp
|
346
|
-
The \fBrun_list add\fP argument is used to add run list items (roles or recipes) to a node.
|
343
|
+
The \fBrun_list add\fP argument is used to add run list items (roles or recipes) to a node.
|
347
344
|
.sp
|
348
345
|
\fBSyntax\fP
|
349
346
|
.sp
|
@@ -573,6 +570,6 @@ knife node show \-l \-\-format=json <node_name>
|
|
573
570
|
.ft P
|
574
571
|
.fi
|
575
572
|
.SH AUTHOR
|
576
|
-
|
573
|
+
Chef
|
577
574
|
.\" Generated by docutils manpage writer.
|
578
575
|
.
|
@@ -33,16 +33,29 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
33
33
|
.sp
|
34
34
|
The \fBknife raw\fP subcommand is used to send a REST request to a specified path using the Chef Server API.
|
35
35
|
.sp
|
36
|
-
\
|
36
|
+
\fBSyntax\fP
|
37
|
+
.sp
|
38
|
+
This argument has the following syntax:
|
39
|
+
.sp
|
40
|
+
.nf
|
41
|
+
.ft C
|
42
|
+
$ knife raw REQUEST_PATH (options)
|
43
|
+
.ft P
|
44
|
+
.fi
|
37
45
|
.sp
|
38
|
-
|
46
|
+
\fBOptions\fP
|
47
|
+
.sp
|
48
|
+
This subcommand has the following options:
|
39
49
|
.INDENT 0.0
|
40
50
|
.TP
|
41
|
-
.B \fB\-c
|
51
|
+
.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
|
42
52
|
The configuration file to use.
|
43
53
|
.TP
|
44
|
-
.B \fB\-\-
|
45
|
-
|
54
|
+
.B \fB\-\-chef\-zero\-port PORT\fP
|
55
|
+
The port on which chef\-zero will listen.
|
56
|
+
.TP
|
57
|
+
.B \fB\-\-[no\-]color\fP
|
58
|
+
Indicates whether colored output will be used.
|
46
59
|
.TP
|
47
60
|
.B \fB\-d\fP, \fB\-\-disable\-editing\fP
|
48
61
|
Indicates that $EDITOR will not be opened; data will be accepted as\-is.
|
@@ -56,23 +69,23 @@ The $EDITOR that is used for all interactive commands.
|
|
56
69
|
.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
|
57
70
|
The name of the environment. When this option is added to a command, the command will run only against the named environment.
|
58
71
|
.TP
|
59
|
-
.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
|
60
|
-
Indicates that the private key will be saved to a specified file name.
|
61
|
-
.TP
|
62
72
|
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
|
63
73
|
The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
|
64
74
|
.TP
|
65
75
|
.B \fB\-h\fP, \fB\-\-help\fP
|
66
76
|
Shows help for the command.
|
67
77
|
.TP
|
78
|
+
.B \fB\-i FILE\fP, \fB\-\-input FILE\fP
|
79
|
+
The name of a file to be used with the \fBPUT\fP or a \fBPOST\fP request.
|
80
|
+
.TP
|
68
81
|
.B \fB\-k KEY\fP, \fB\-\-key KEY\fP
|
69
82
|
The private key that Knife will use to sign requests made by the API client to the server.
|
70
83
|
.TP
|
71
|
-
.B \fB
|
72
|
-
|
84
|
+
.B \fB\-m METHOD\fP, \fB\-\-method METHOD\fP
|
85
|
+
The request method: \fBDELETE\fP, \fBGET\fP, \fBPOST\fP, or \fBPUT\fP. Default value: \fBGET\fP.
|
73
86
|
.TP
|
74
|
-
.B \fB\-
|
75
|
-
|
87
|
+
.B \fB\-\-[no\-]pretty\fP
|
88
|
+
Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON. Default: \fB\-\-pretty\fP.
|
76
89
|
.TP
|
77
90
|
.B \fB\-\-print\-after\fP
|
78
91
|
Indicates that data will be shown after a destructive operation.
|
@@ -91,40 +104,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
|
|
91
104
|
.TP
|
92
105
|
.B \fB\-y\fP, \fB\-\-yes\fP
|
93
106
|
Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
|
94
|
-
.UNINDENT
|
95
|
-
.sp
|
96
|
-
\fBSyntax\fP
|
97
|
-
.sp
|
98
|
-
This argument has the following syntax:
|
99
|
-
.sp
|
100
|
-
.nf
|
101
|
-
.ft C
|
102
|
-
$ knife raw REQUEST_PATH (options)
|
103
|
-
.ft P
|
104
|
-
.fi
|
105
|
-
.sp
|
106
|
-
\fBOptions\fP
|
107
|
-
.sp
|
108
|
-
This subcommand has the following options:
|
109
|
-
.INDENT 0.0
|
110
|
-
.TP
|
111
|
-
.B \fB\-\-chef\-repo\-path PATH\fP
|
112
|
-
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.
|
113
|
-
.TP
|
114
|
-
.B \fB\-\-concurrency\fP
|
115
|
-
The number of allowed concurrent connections. Default: \fB10\fP.
|
116
|
-
.TP
|
117
|
-
.B \fB\-i FILE\fP, \fB\-\-input FILE\fP
|
118
|
-
The name of a file to be used with the \fBPUT\fP or a \fBPOST\fP request.
|
119
|
-
.TP
|
120
|
-
.B \fB\-\-[no\-]pretty\fP
|
121
|
-
Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON. Default: \fB\-\-pretty\fP.
|
122
|
-
.TP
|
123
|
-
.B \fB\-m METHOD\fP, \fB\-\-method METHOD\fP
|
124
|
-
The request method: \fBDELETE\fP, \fBGET\fP, \fBPOST\fP, or \fBPUT\fP. Default value: \fBGET\fP.
|
125
107
|
.TP
|
126
|
-
.B \fB\-\-
|
127
|
-
|
108
|
+
.B \fB\-z\fP, \fB\-\-local\-mode\fP
|
109
|
+
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.
|
128
110
|
.UNINDENT
|
129
111
|
.sp
|
130
112
|
\fBExamples\fP
|
@@ -165,6 +147,6 @@ to return something similar to:
|
|
165
147
|
.ft P
|
166
148
|
.fi
|
167
149
|
.SH AUTHOR
|
168
|
-
|
150
|
+
Chef
|
169
151
|
.\" Generated by docutils manpage writer.
|
170
152
|
.
|
@@ -33,66 +33,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
33
33
|
.sp
|
34
34
|
The \fBknife recipe list\fP subcommand is used to view all of the recipes that are on a server. A regular expression can be used to limit the results to recipes that match a specific pattern. The regular expression must be within quotes and not be surrounded by forward slashes (/).
|
35
35
|
.sp
|
36
|
-
\fBCommon Options\fP
|
37
|
-
.sp
|
38
|
-
The following options can be run with all Knife sub\-commands and plug\-ins:
|
39
|
-
.INDENT 0.0
|
40
|
-
.TP
|
41
|
-
.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP
|
42
|
-
The configuration file to use.
|
43
|
-
.TP
|
44
|
-
.B \fB\-\-color\fP
|
45
|
-
Indicates that colored output will be used.
|
46
|
-
.TP
|
47
|
-
.B \fB\-d\fP, \fB\-\-disable\-editing\fP
|
48
|
-
Indicates that $EDITOR will not be opened; data will be accepted as\-is.
|
49
|
-
.TP
|
50
|
-
.B \fB\-\-defaults\fP
|
51
|
-
Indicates that Knife will use the default value, instead of asking a user to provide one.
|
52
|
-
.TP
|
53
|
-
.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
|
54
|
-
The $EDITOR that is used for all interactive commands.
|
55
|
-
.TP
|
56
|
-
.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
|
57
|
-
The name of the environment. When this option is added to a command, the command will run only against the named environment.
|
58
|
-
.TP
|
59
|
-
.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
|
60
|
-
Indicates that the private key will be saved to a specified file name.
|
61
|
-
.TP
|
62
|
-
.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.
|
64
|
-
.TP
|
65
|
-
.B \fB\-h\fP, \fB\-\-help\fP
|
66
|
-
Shows help for the command.
|
67
|
-
.TP
|
68
|
-
.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.
|
70
|
-
.TP
|
71
|
-
.B \fB\-\-no\-color\fP
|
72
|
-
Indicates that color will not be used in the output.
|
73
|
-
.TP
|
74
|
-
.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP
|
75
|
-
The user password.
|
76
|
-
.TP
|
77
|
-
.B \fB\-\-print\-after\fP
|
78
|
-
Indicates that data will be shown after a destructive operation.
|
79
|
-
.TP
|
80
|
-
.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
|
81
|
-
The URL for the server.
|
82
|
-
.TP
|
83
|
-
.B \fB\-u USER\fP, \fB\-\-user USER\fP
|
84
|
-
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
|
-
.TP
|
86
|
-
.B \fB\-v\fP, \fB\-\-version\fP
|
87
|
-
The version of the chef\-client.
|
88
|
-
.TP
|
89
|
-
.B \fB\-V\fP, \fB\-\-verbose\fP
|
90
|
-
Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
|
91
|
-
.TP
|
92
|
-
.B \fB\-y\fP, \fB\-\-yes\fP
|
93
|
-
Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
|
94
|
-
.UNINDENT
|
95
|
-
.sp
|
96
36
|
\fBSyntax\fP
|
97
37
|
.sp
|
98
38
|
This argument has the following syntax:
|
@@ -128,6 +68,6 @@ couchdb::org_cleanu
|
|
128
68
|
.ft P
|
129
69
|
.fi
|
130
70
|
.SH AUTHOR
|
131
|
-
|
71
|
+
Chef
|
132
72
|
.\" Generated by docutils manpage writer.
|
133
73
|
.
|
@@ -42,19 +42,16 @@ This subcommand has the following syntax:
|
|
42
42
|
$ knife role [ARGUMENT] (options)
|
43
43
|
.ft P
|
44
44
|
.fi
|
45
|
-
.IP Note
|
46
|
-
Use the \fBknife node\fP subcommand (and the \fBrun_list add node\fP argument) to add a role to a node on the server.
|
47
|
-
.RE
|
48
45
|
.SH COMMON OPTIONS
|
49
46
|
.sp
|
50
|
-
The following options
|
47
|
+
The following options may be used with any of the arguments available to the \fBknife role\fP subcommand:
|
51
48
|
.INDENT 0.0
|
52
49
|
.TP
|
53
|
-
.B \fB\-
|
54
|
-
The
|
50
|
+
.B \fB\-\-chef\-zero\-port PORT\fP
|
51
|
+
The port on which chef\-zero will listen.
|
55
52
|
.TP
|
56
|
-
.B \fB\-\-
|
57
|
-
|
53
|
+
.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
|
54
|
+
The configuration file to use.
|
58
55
|
.TP
|
59
56
|
.B \fB\-d\fP, \fB\-\-disable\-editing\fP
|
60
57
|
Indicates that $EDITOR will not be opened; data will be accepted as\-is.
|
@@ -68,9 +65,6 @@ The $EDITOR that is used for all interactive commands.
|
|
68
65
|
.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
|
69
66
|
The name of the environment. When this option is added to a command, the command will run only against the named environment.
|
70
67
|
.TP
|
71
|
-
.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
|
72
|
-
Indicates that the private key will be saved to a specified file name.
|
73
|
-
.TP
|
74
68
|
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
|
75
69
|
The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
|
76
70
|
.TP
|
@@ -80,11 +74,8 @@ Shows help for the command.
|
|
80
74
|
.B \fB\-k KEY\fP, \fB\-\-key KEY\fP
|
81
75
|
The private key that Knife will use to sign requests made by the API client to the server.
|
82
76
|
.TP
|
83
|
-
.B \fB\-\-no\-color\fP
|
84
|
-
Indicates
|
85
|
-
.TP
|
86
|
-
.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP
|
87
|
-
The user password.
|
77
|
+
.B \fB\-\-[no\-]color\fP
|
78
|
+
Indicates whether colored output will be used.
|
88
79
|
.TP
|
89
80
|
.B \fB\-\-print\-after\fP
|
90
81
|
Indicates that data will be shown after a destructive operation.
|
@@ -95,14 +86,17 @@ The URL for the server.
|
|
95
86
|
.B \fB\-u USER\fP, \fB\-\-user USER\fP
|
96
87
|
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.
|
97
88
|
.TP
|
98
|
-
.B \fB\-v\fP, \fB\-\-version\fP
|
99
|
-
The version of the chef\-client.
|
100
|
-
.TP
|
101
89
|
.B \fB\-V\fP, \fB\-\-verbose\fP
|
102
90
|
Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
|
103
91
|
.TP
|
92
|
+
.B \fB\-v\fP, \fB\-\-version\fP
|
93
|
+
The version of the chef\-client.
|
94
|
+
.TP
|
104
95
|
.B \fB\-y\fP, \fB\-\-yes\fP
|
105
96
|
Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
|
97
|
+
.TP
|
98
|
+
.B \fB\-z\fP, \fB\-\-local\-mode\fP
|
99
|
+
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.
|
106
100
|
.UNINDENT
|
107
101
|
.SH BULK DELETE
|
108
102
|
.sp
|
@@ -133,7 +127,7 @@ $ knife role bulk delete "^[0\-9]{3}$"
|
|
133
127
|
.fi
|
134
128
|
.SH CREATE
|
135
129
|
.sp
|
136
|
-
The \fBcreate\fP argument is used to add a role to the server.
|
130
|
+
The \fBcreate\fP argument is used to add a role to the server. Role data is saved as JSON on the server.
|
137
131
|
.sp
|
138
132
|
\fBSyntax\fP
|
139
133
|
.sp
|
@@ -174,8 +168,8 @@ In the $EDITOR enter the role data in JSON:
|
|
174
168
|
"default_attributes": {
|
175
169
|
},
|
176
170
|
"json_class": "Chef::Role",
|
177
|
-
"run_list": [
|
178
|
-
|
171
|
+
"run_list": [\(aqrecipe[cookbook_name::recipe_name],
|
172
|
+
role[role_name]\(aq
|
179
173
|
],
|
180
174
|
"description": "",
|
181
175
|
"chef_type": "role",
|
@@ -253,8 +247,8 @@ Update the role data in JSON:
|
|
253
247
|
"default_attributes": {
|
254
248
|
},
|
255
249
|
"json_class": "Chef::Role",
|
256
|
-
"run_list": [
|
257
|
-
|
250
|
+
"run_list": [\(aqrecipe[cookbook_name::recipe_name],
|
251
|
+
role[role_name]\(aq
|
258
252
|
],
|
259
253
|
"description": "This is the description for the role1 role.",
|
260
254
|
"chef_type": "role",
|
@@ -369,6 +363,6 @@ $ knife role show devops \-F json
|
|
369
363
|
.sp
|
370
364
|
Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP.
|
371
365
|
.SH AUTHOR
|
372
|
-
|
366
|
+
Chef
|
373
367
|
.\" Generated by docutils manpage writer.
|
374
368
|
.
|
@@ -31,70 +31,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
31
31
|
.\" Man page generated from reStructuredText.
|
32
32
|
.
|
33
33
|
.sp
|
34
|
-
Search indexes allow queries to be made for any type of data that is indexed by the server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full\-text query that can be done from several locations, including from within a recipe, by using the \fBsearch\fP subcommand in Knife, by using the search functionality in the
|
34
|
+
Search indexes allow queries to be made for any type of data that is indexed by the server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full\-text query that can be done from several locations, including from within a recipe, by using the \fBsearch\fP subcommand in Knife, by using the search functionality in the Chef Manager, or by using the \fB/search\fP or \fB/search/INDEX\fP endpoints in the Chef Server API. The search engine is based on Apache Solr and is run from the server.
|
35
35
|
.sp
|
36
36
|
The \fBknife search\fP subcommand is used run a search query for information that is indexed on a server.
|
37
37
|
.sp
|
38
|
-
\fBCommon Options\fP
|
39
|
-
.sp
|
40
|
-
The following options can be run with all Knife sub\-commands and plug\-ins:
|
41
|
-
.INDENT 0.0
|
42
|
-
.TP
|
43
|
-
.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP
|
44
|
-
The configuration file to use.
|
45
|
-
.TP
|
46
|
-
.B \fB\-\-color\fP
|
47
|
-
Indicates that colored output will be used.
|
48
|
-
.TP
|
49
|
-
.B \fB\-d\fP, \fB\-\-disable\-editing\fP
|
50
|
-
Indicates that $EDITOR will not be opened; data will be accepted as\-is.
|
51
|
-
.TP
|
52
|
-
.B \fB\-\-defaults\fP
|
53
|
-
Indicates that Knife will use the default value, instead of asking a user to provide one.
|
54
|
-
.TP
|
55
|
-
.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
|
56
|
-
The $EDITOR that is used for all interactive commands.
|
57
|
-
.TP
|
58
|
-
.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
|
59
|
-
The name of the environment. When this option is added to a command, the command will run only against the named environment.
|
60
|
-
.TP
|
61
|
-
.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
|
62
|
-
Indicates that the private key will be saved to a specified file name.
|
63
|
-
.TP
|
64
|
-
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
|
65
|
-
The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
|
66
|
-
.TP
|
67
|
-
.B \fB\-h\fP, \fB\-\-help\fP
|
68
|
-
Shows help for the command.
|
69
|
-
.TP
|
70
|
-
.B \fB\-k KEY\fP, \fB\-\-key KEY\fP
|
71
|
-
The private key that Knife will use to sign requests made by the API client to the server.
|
72
|
-
.TP
|
73
|
-
.B \fB\-\-no\-color\fP
|
74
|
-
Indicates that color will not be used in the output.
|
75
|
-
.TP
|
76
|
-
.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP
|
77
|
-
The user password.
|
78
|
-
.TP
|
79
|
-
.B \fB\-\-print\-after\fP
|
80
|
-
Indicates that data will be shown after a destructive operation.
|
81
|
-
.TP
|
82
|
-
.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
|
83
|
-
The URL for the server.
|
84
|
-
.TP
|
85
|
-
.B \fB\-u USER\fP, \fB\-\-user USER\fP
|
86
|
-
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.
|
87
|
-
.TP
|
88
|
-
.B \fB\-v\fP, \fB\-\-version\fP
|
89
|
-
The version of the chef\-client.
|
90
|
-
.TP
|
91
|
-
.B \fB\-V\fP, \fB\-\-verbose\fP
|
92
|
-
Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
|
93
|
-
.TP
|
94
|
-
.B \fB\-y\fP, \fB\-\-yes\fP
|
95
|
-
Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
|
96
|
-
.UNINDENT
|
97
|
-
.sp
|
98
38
|
\fBSyntax\fP
|
99
39
|
.sp
|
100
40
|
This argument has the following syntax:
|
@@ -167,12 +107,42 @@ The attribute (or attributes) to show.
|
|
167
107
|
.B \fB\-b ROW\fP, \fB\-\-start ROW\fP
|
168
108
|
The row at which return results will begin.
|
169
109
|
.TP
|
110
|
+
.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
|
111
|
+
The configuration file to use.
|
112
|
+
.TP
|
113
|
+
.B \fB\-\-chef\-zero\-port PORT\fP
|
114
|
+
The port on which chef\-zero will listen.
|
115
|
+
.TP
|
116
|
+
.B \fB\-\-[no\-]color\fP
|
117
|
+
Indicates whether colored output will be used.
|
118
|
+
.TP
|
119
|
+
.B \fB\-d\fP, \fB\-\-disable\-editing\fP
|
120
|
+
Indicates that $EDITOR will not be opened; data will be accepted as\-is.
|
121
|
+
.TP
|
122
|
+
.B \fB\-\-defaults\fP
|
123
|
+
Indicates that Knife will use the default value, instead of asking a user to provide one.
|
124
|
+
.TP
|
125
|
+
.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
|
126
|
+
The $EDITOR that is used for all interactive commands.
|
127
|
+
.TP
|
128
|
+
.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
|
129
|
+
The name of the environment. When this option is added to a command, the command will run only against the named environment.
|
130
|
+
.TP
|
131
|
+
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
|
132
|
+
The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP.
|
133
|
+
.TP
|
134
|
+
.B \fB\-h\fP, \fB\-\-help\fP
|
135
|
+
Shows help for the command.
|
136
|
+
.TP
|
170
137
|
.B \fB\-i\fP, \fB\-\-id\-only\fP
|
171
138
|
Indicates that only matching object IDs will be shown.
|
172
139
|
.TP
|
173
140
|
.B \fBINDEX\fP
|
174
141
|
The name of the index to be queried: \fBclient\fP, \fBenvironment\fP, \fBnode\fP, \fBrole\fP, or \fBDATA_BAG_NAME\fP. Default index: \fBnode\fP.
|
175
142
|
.TP
|
143
|
+
.B \fB\-k KEY\fP, \fB\-\-key KEY\fP
|
144
|
+
The private key that Knife will use to sign requests made by the API client to the server.
|
145
|
+
.TP
|
176
146
|
.B \fB\-l\fP, \fB\-\-long\fP
|
177
147
|
Display long output when searching nodes while using the default summary format.
|
178
148
|
.TP
|
@@ -182,6 +152,9 @@ Display more, but not all, of a node\(aqs data when searching using the default
|
|
182
152
|
.B \fB\-o SORT\fP, \fB\-\-sort SORT\fP
|
183
153
|
The order in which search results will be sorted.
|
184
154
|
.TP
|
155
|
+
.B \fB\-\-print\-after\fP
|
156
|
+
Indicates that data will be shown after a destructive operation.
|
157
|
+
.TP
|
185
158
|
.B \fB\-q SEARCH_QUERY\fP, \fB\-\-query SEARCH_QUERY\fP
|
186
159
|
Use to protect search queries that start with a hyphen (\-). A \fB\-q\fP query may be specified as an argument or an option, but not both.
|
187
160
|
.TP
|
@@ -191,8 +164,26 @@ Indicates that only the run\-list will be shown.
|
|
191
164
|
.B \fB\-R INT\fP, \fB\-\-rows INT\fP
|
192
165
|
The number of rows to be returned.
|
193
166
|
.TP
|
167
|
+
.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
|
168
|
+
The URL for the server.
|
169
|
+
.TP
|
194
170
|
.B \fBSEARCH_QUERY\fP
|
195
171
|
The search query used to identify a a list of items on a server. This option uses the same syntax as the \fBsearch\fP sub\-command.
|
172
|
+
.TP
|
173
|
+
.B \fB\-u USER\fP, \fB\-\-user USER\fP
|
174
|
+
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.
|
175
|
+
.TP
|
176
|
+
.B \fB\-v\fP, \fB\-\-version\fP
|
177
|
+
The version of the chef\-client.
|
178
|
+
.TP
|
179
|
+
.B \fB\-V\fP, \fB\-\-verbose\fP
|
180
|
+
Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
|
181
|
+
.TP
|
182
|
+
.B \fB\-y\fP, \fB\-\-yes\fP
|
183
|
+
Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
|
184
|
+
.TP
|
185
|
+
.B \fB\-z\fP, \fB\-\-local\-mode\fP
|
186
|
+
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.
|
196
187
|
.UNINDENT
|
197
188
|
.sp
|
198
189
|
\fBExamples\fP
|
@@ -299,6 +290,6 @@ $ knife search node "role:web AND NOT name:web03"
|
|
299
290
|
.sp
|
300
291
|
where the query in the previous example will search all servers that have the \fBweb\fP role, but not on the server named \fBweb03\fP.
|
301
292
|
.SH AUTHOR
|
302
|
-
|
293
|
+
Chef
|
303
294
|
.\" Generated by docutils manpage writer.
|
304
295
|
.
|