From 36c2c011348d8779449e315934f80b189fcc1845 Mon Sep 17 00:00:00 2001 From: Jay Mundrawala Date: Tue, 21 Oct 2014 13:32:56 -0700 Subject: Only include chef-service-manager on windows --- chef-x86-mingw32.gemspec | 2 ++ chef.gemspec | 5 +---- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/chef-x86-mingw32.gemspec b/chef-x86-mingw32.gemspec index 6d69c4e7e6..08b7a8e0c0 100644 --- a/chef-x86-mingw32.gemspec +++ b/chef-x86-mingw32.gemspec @@ -15,4 +15,6 @@ gemspec.add_dependency "win32-service", "0.8.2" gemspec.add_dependency "win32-mmap", "0.4.0" gemspec.add_dependency "wmi-lite", "~> 1.0" +gemspec.executables += %w( chef-service-manager chef-windows-service ) + gemspec diff --git a/chef.gemspec b/chef.gemspec index 427657f678..e7b6aa35ff 100644 --- a/chef.gemspec +++ b/chef.gemspec @@ -46,10 +46,7 @@ Gem::Specification.new do |s| %w(rspec-core rspec-expectations rspec-mocks).each { |gem| s.add_development_dependency gem, "~> 2.14.0" } s.bindir = "bin" - # chef-service-manager is a windows only executable. - # However gemspec doesn't give us a way to have this executable only - # on windows. So we're including this in all platforms. - s.executables = %w( chef-client chef-solo knife chef-shell shef chef-apply chef-service-manager chef-windows-service ) + s.executables = %w( chef-client chef-solo knife chef-shell shef chef-apply ) s.require_path = 'lib' s.files = %w(Rakefile LICENSE README.md CONTRIBUTING.md) + Dir.glob("{distro,lib,tasks,spec}/**/*", File::FNM_DOTMATCH).reject {|f| File.directory?(f) } -- cgit v1.2.1 From b13b6756bb7596da91f23f96adbdf06c1538ec82 Mon Sep 17 00:00:00 2001 From: jamescott Date: Mon, 3 Nov 2014 14:59:19 -0800 Subject: update man pages for chef-client 12 --- distro/common/man/man1/chef-shell.1 | 73 ++++++++++++++- distro/common/man/man1/knife-bootstrap.1 | 134 ++++++++++++++------------- distro/common/man/man1/knife-client.1 | 2 +- distro/common/man/man1/knife-configure.1 | 2 +- distro/common/man/man1/knife-cookbook-site.1 | 5 +- distro/common/man/man1/knife-cookbook.1 | 2 +- distro/common/man/man1/knife-data-bag.1 | 10 +- distro/common/man/man1/knife-delete.1 | 2 +- distro/common/man/man1/knife-deps.1 | 2 +- distro/common/man/man1/knife-diff.1 | 2 +- distro/common/man/man1/knife-download.1 | 2 +- distro/common/man/man1/knife-edit.1 | 2 +- distro/common/man/man1/knife-environment.1 | 2 +- distro/common/man/man1/knife-exec.1 | 2 +- distro/common/man/man1/knife-index-rebuild.1 | 2 +- distro/common/man/man1/knife-list.1 | 2 +- distro/common/man/man1/knife-node.1 | 6 +- distro/common/man/man1/knife-raw.1 | 4 +- distro/common/man/man1/knife-recipe-list.1 | 2 +- distro/common/man/man1/knife-role.1 | 4 +- distro/common/man/man1/knife-search.1 | 8 +- distro/common/man/man1/knife-serve.1 | 2 +- distro/common/man/man1/knife-show.1 | 2 +- distro/common/man/man1/knife-ssh.1 | 2 +- distro/common/man/man1/knife-ssl-check.1 | 2 +- distro/common/man/man1/knife-ssl-fetch.1 | 2 +- distro/common/man/man1/knife-status.1 | 2 +- distro/common/man/man1/knife-tag.1 | 2 +- distro/common/man/man1/knife-upload.1 | 2 +- distro/common/man/man1/knife-user.1 | 2 +- distro/common/man/man1/knife-xargs.1 | 2 +- distro/common/man/man1/knife.1 | 2 +- distro/common/man/man8/chef-client.8 | 81 +++++++++++++++- distro/common/man/man8/chef-solo.8 | 85 +++++++++++++++-- 34 files changed, 342 insertions(+), 116 deletions(-) diff --git a/distro/common/man/man1/chef-shell.1 b/distro/common/man/man1/chef-shell.1 index 97aa50bbd0..df004c5b0f 100644 --- a/distro/common/man/man1/chef-shell.1 +++ b/distro/common/man/man1/chef-shell.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "CHEF-SHELL" "1" "Chef 11.16" "" "chef-shell" +.TH "CHEF-SHELL" "1" "Chef 12.0" "" "chef-shell" .SH NAME chef-shell \- The man page for the chef-shell command line tool. . @@ -101,6 +101,77 @@ Shows help for the command. .TP .B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP The path to a file that contains JSON data. +.sp +Use this option to define a \fBrun_list\fP object. For example, a JSON file similar to: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +"run_list": [ + "recipe[base]", + "recipe[foo]", + "recipe[bar]", + "role[webserver]" +], +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +may be used by running \fBchef\-client \-j path/to/file.json\fP\&. +.sp +In certain situations this option may be used to update \fBnormal\fP attributes. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Any other attribute type that is contained in this JSON file will be treated as a \fBnormal\fP attribute. For example, attempting to update \fBoverride\fP attributes using the \fB\-j\fP option: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ + "name": "dev\-99", + "description": "Install some stuff", + "override_attributes": { + "apptastic": { + "enable_apptastic": "false", + "apptastic_tier_name": "dev\-99.bomb.com" + } + } +} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +will result in a node object similar to: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ + "name": "maybe\-dev\-99", + "normal": { + "name": "dev\-99", + "description": "Install some stuff", + "override_attributes": { + "apptastic": { + "enable_apptastic": "false", + "apptastic_tier_name": "dev\-99.bomb.com" + } + } + } +} +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT .TP .B \fB\-l LEVEL\fP, \fB\-\-log\-level LEVEL\fP The level of logging that will be stored in a log file. diff --git a/distro/common/man/man1/knife-bootstrap.1 b/distro/common/man/man1/knife-bootstrap.1 index 1068daa224..a4a699872f 100644 --- a/distro/common/man/man1/knife-bootstrap.1 +++ b/distro/common/man/man1/knife-bootstrap.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-BOOTSTRAP" "1" "Chef 11.16" "" "knife bootstrap" +.TH "KNIFE-BOOTSTRAP" "1" "Chef 12.0" "" "knife bootstrap" .SH NAME knife-bootstrap \- The man page for the knife bootstrap subcommand. . @@ -57,61 +57,78 @@ This subcommand has the following options: .B \fB\-A\fP, \fB\-\-forward\-agent\fP Use to enable SSH agent forwarding. .TP -.B \fB\-\-bootstrap\-no\-proxy NO_PROXY_URL_or_IP\fP -A URL or IP address that specifies a location that should not be proxied. Note: This option is used internally by Chef to help verify bootstrap operations during testing and should never be used during an actual bootstrap operation. -.TP -.B \fB\-\-bootstrap\-proxy PROXY_URL\fP -The proxy server for the node that is the target of a bootstrap operation. -.TP -.B \fB\-\-bootstrap\-version VERSION\fP -The version of the chef\-client to install. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. +.B \fB\-\-bootstrap\-curl\-options OPTIONS\fP +Use to specify arbitrary options to be added to the bootstrap command when using cURL\&. This option may not be used in the same command with \fB\-\-bootstrap\-install\-command\fP\&. .TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. +.B \fB\-\-bootstrap\-install\-command COMMAND\fP +Use to execute a custom installation command sequence for the chef\-client\&. This option may not be used in the same command with \fB\-\-bootstrap\-curl\-options\fP, \fB\-\-bootstrap\-install\-sh\fP, or \fB\-\-bootstrap\-wget\-options\fP\&. .TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. +.B \fB\-\-bootstrap\-install\-sh URL\fP +Use to fetch and execute an installation script at the specified URL. This option may not be used in the same command with \fB\-\-bootstrap\-install\-command\fP\&. .TP -.B \fB\-d DISTRO\fP, \fB\-\-distro DISTRO\fP +.B \fB\-\-bootstrap\-no\-proxy NO_PROXY_URL_or_IP\fP +A URL or IP address that specifies a location that should not be proxied. .sp -\fBWARNING:\fP +\fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The default bootstrap operation uses the omnibus installer, which means the default template file (\fBchef\-full\fP) should work on all supported platforms. It is recommended to use custom bootstrap templates only when the omnibus installer cannot be used. The \fB\&.erb\fP file extension is added automatically and should not be passed as part of the bootstrap command. +This option is used internally by Chef to help verify bootstrap operations during testing and should never be used during an actual bootstrap operation. .UNINDENT .UNINDENT -.sp -The template file to be used during a bootstrap operation. The following distributions are supported: \fBchef\-full\fP (the default bootstrap), \fBcentos5\-gems\fP, \fBfedora13\-gems\fP, \fBubuntu10.04\-gems\fP, \fBubuntu10.04\-apt\fP, \fBubuntu12.04\-gems\fP, and the name of a custom bootstrap template file. When this option is used, knife will search for the template file in the following order: the \fBbootstrap/\fP folder in the current working directory, the \fBbootstrap/\fP folder in the chef\-repo, the \fBbootstrap/\fP folder in the \fB~/.chef/\fP directory, or a default bootstrap file. Do not use the \fB\-\-template\-file\fP option when \fB\-\-distro\fP is specified. .TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. +.B \fB\-\-bootstrap\-proxy PROXY_URL\fP +The proxy server for the node that is the target of a bootstrap operation. .TP -.B \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. +.B \fB\-\-bootstrap\-version VERSION\fP +The version of the chef\-client to install. .TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. +.B \fB\-\-bootstrap\-wget\-options OPTIONS\fP +Use to specify arbitrary options to be added to the bootstrap command when using GNU Wget\&. This option may not be used in the same command with \fB\-\-bootstrap\-install\-command\fP\&. .TP .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP The name of the environment. When this option is added to a command, the command will run only against the named environment. .TP -.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP -The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&. -.TP .B \fB\-G GATEWAY\fP, \fB\-\-ssh\-gateway GATEWAY\fP The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation. .TP -.B \fB\-h\fP, \fB\-\-help\fP -Shows help for the command. -.TP .B \fB\-\-hint HINT_NAME[=HINT_FILE]\fP -An Ohai hint to be set on the target of the bootstrap. The hint is contained in a file and is formatted as JSON: \fB{"attribute":"value","attribute":"value"...}\fP\&. \fBHINT_NAME\fP is the name of the hint and \fBHINT_FILE\fP is the name of the hint file located at \fB/etc/chef/ohai/hints/HINT_FILE.json\fP\&. Use multiple \fB\-\-hint\fP options in the command to specify multiple hints. -.TP -.B \fB\-\-[no\-]host\-key\-verify\fP -Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. +Use to specify an Ohai hint to be set on the target node. +.sp +Ohai hints are used to tell Ohai something about the system that it is running on that it would not be able to discover itself. An Ohai hint exists if a JSON file exists in the hint directory with the same name as the hint. For example, calling \fBhint?(\(aqantartica\(aq)\fP in an Ohai plugin would return an empty hash if the file \fBantartica.json\fP existed in the hints directory, and return nil if the file does not exist. +.sp +If the hint file contains JSON content, it will be returned as a hash from the call to \fBhint?\fP\&. +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ + "snow": true, + "penguins": "many" +} +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +arctic_hint = hint?(\(aqantartica\(aq) +if arctic_hint[\(aqsnow\(aq] + "There are #{arctic_hint[\(aqpenguins\(aq]} penguins here." +else + "There is no snow here, and penguins like snow." +end +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +The default directory in which hint files are located is \fB/etc/chef/ohai/hints/\fP\&. Use the \fBOhai::Config[:hints_path]\fP setting in the client.rb file to customize this location. +.sp +\fBHINT_FILE\fP is the name of the JSON file. \fBHINT_NAME\fP is the name of a hint in a JSON file. Use multiple \fB\-\-hint\fP options to specify multiple hints. .TP .B \fB\-i IDENTITY_FILE\fP, \fB\-\-identity\-file IDENTITY_FILE\fP The SSH identity file used for authentication. Key\-based authentication is recommended. @@ -119,12 +136,24 @@ The SSH identity file used for authentication. Key\-based authentication is reco .B \fB\-j JSON_ATTRIBS\fP, \fB\-\-json\-attributes JSON_ATTRIBS\fP A JSON string that is added to the first run of a chef\-client\&. .TP -.B \fB\-k KEY\fP, \fB\-\-key KEY\fP -The private key that knife will use to sign requests made by the API client to the Chef server\&. -.TP .B \fB\-N NAME\fP, \fB\-\-node\-name NAME\fP The name of the node. .TP +.B \fB\-\-[no\-]host\-key\-verify\fP +Use \fB\-\-no\-host\-key\-verify\fP to disable host key verification. Default setting: \fB\-\-host\-key\-verify\fP\&. +.TP +.B \fB\-\-[no\-]node\-verify\-api\-cert\fP +Use \fBverify_api_cert\fP to only do SSL validation of the Chef server connection; may be needed if the chef\-client needs to talk to other services that have broken SSL certificates. If this option is not specified, the setting for \fBverify_api_cert\fP in the configuration file is applied. +.TP +.B \fB\-\-node\-ssl\-verify\-mode PEER_OR_NONE\fP +The verify mode for HTTPS requests. +.sp +Use \fB:verify_none\fP to do no validation of SSL certificates. +.sp +Use \fB:verify_peer\fP to do validation of all SSL certificates, including the Chef server connections, S3 connections, and any HTTPS \fBremote_file\fP resource URLs used in the chef\-client run. This is the recommended setting. +.sp +If this option is not specified, the setting for \fBssl_verify_mode\fP in the configuration file is applied. +.TP .B \fB\-p PORT\fP, \fB\-\-ssh\-port PORT\fP The SSH port. .TP @@ -134,15 +163,9 @@ The SSH password. This can be used to pass the password directly on the command .B \fB\-\-prerelease\fP Use to install pre\-release gems. .TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP .B \fB\-r RUN_LIST\fP, \fB\-\-run\-list RUN_LIST\fP A comma\-separated list of roles and/or recipes to be applied. .TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.TP .B \fB\-\-secret SECRET\fP The encryption key that is used for values contained within a data bag item. .TP @@ -152,32 +175,17 @@ The path to the file that contains the encryption key. .B \fB\-\-sudo\fP Use to execute a bootstrap operation with sudo\&. .TP -.B \fB\-\-template\-file TEMPLATE\fP -The path to a template file that will be used during a bootstrap operation. Do not use the \fB\-\-distro\fP option when \fB\-\-template\-file\fP is specified. -.TP -.B \fB\-u USER\fP, \fB\-\-user USER\fP -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. +.B \fB\-t TEMPLATE\fP, \fB\-\-bootstrap\-template TEMPLATE\fP +Use to specify the bootstrap template to use. This may specify the name of a bootstrap template\-\-\-\fBchef\-full\fP, for example\-\-\-or it may specify the full path to an Embedded Ruby (ERB) template that defines a custom bootstrap. Default value: \fBchef\-full\fP, which installs the chef\-client using the omnibus installer on all supported platforms. .TP .B \fB\-\-use\-sudo\-password\fP Use to perform a bootstrap operation with sudo; specify the password with the \fB\-P\fP (or \fB\-\-ssh\-password\fP) option. .TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP .B \fB\-V \-V\fP Use to run the initial chef\-client run at the \fBdebug\fP log\-level (e.g. \fBchef\-client \-l debug\fP). .TP .B \fB\-x USERNAME\fP, \fB\-\-ssh\-user USERNAME\fP The SSH user name. -.TP -.B \fB\-y\fP, \fB\-\-yes\fP -Use to respond to all confirmation prompts with "Yes". knife will not ask for confirmation. -.TP -.B \fB\-z\fP, \fB\-\-local\-mode\fP -Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .sp \fBExamples\fP diff --git a/distro/common/man/man1/knife-client.1 b/distro/common/man/man1/knife-client.1 index 9606b93687..9dbd174c71 100644 --- a/distro/common/man/man1/knife-client.1 +++ b/distro/common/man/man1/knife-client.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-CLIENT" "1" "Chef 11.16" "" "knife client" +.TH "KNIFE-CLIENT" "1" "Chef 12.0" "" "knife client" .SH NAME knife-client \- The man page for the knife client subcommand. . diff --git a/distro/common/man/man1/knife-configure.1 b/distro/common/man/man1/knife-configure.1 index 55ddb910ac..91eb69f1c6 100644 --- a/distro/common/man/man1/knife-configure.1 +++ b/distro/common/man/man1/knife-configure.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-CONFIGURE" "1" "Chef 11.16" "" "knife configure" +.TH "KNIFE-CONFIGURE" "1" "Chef 12.0" "" "knife configure" .SH NAME knife-configure \- The man page for the knife configure subcommand. . diff --git a/distro/common/man/man1/knife-cookbook-site.1 b/distro/common/man/man1/knife-cookbook-site.1 index add01304d9..a90a5305f0 100644 --- a/distro/common/man/man1/knife-cookbook-site.1 +++ b/distro/common/man/man1/knife-cookbook-site.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.16" "" "knife cookbook site" +.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 12.0" "" "knife cookbook site" .SH NAME knife-cookbook-site \- The man page for the knife cookbook site subcommand. . @@ -409,6 +409,9 @@ This argument has the following options: .B \fBCATEGORY\fP The cookbook category: \fB"Databases"\fP, \fB"Web Servers"\fP, \fB"Process Management"\fP, \fB"Monitoring & Trending"\fP, \fB"Programming Languages"\fP, \fB"Package Management"\fP, \fB"Applications"\fP, \fB"Networking"\fP, \fB"Operating Systems & Virtualization"\fP, \fB"Utilities"\fP, or \fB"Other"\fP\&. .TP +.B \fB\-n\fP, \fB\-\-dry\-run\fP +Use to take no action and only print out results. Default: \fBfalse\fP\&. +.TP .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP The directory in which cookbooks are created. This can be a colon\-separated path. .UNINDENT diff --git a/distro/common/man/man1/knife-cookbook.1 b/distro/common/man/man1/knife-cookbook.1 index b42338c905..ce74c9dd8c 100644 --- a/distro/common/man/man1/knife-cookbook.1 +++ b/distro/common/man/man1/knife-cookbook.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-COOKBOOK" "1" "Chef 11.16" "" "knife cookbook" +.TH "KNIFE-COOKBOOK" "1" "Chef 12.0" "" "knife cookbook" .SH NAME knife-cookbook \- The man page for the knife cookbook subcommand. . diff --git a/distro/common/man/man1/knife-data-bag.1 b/distro/common/man/man1/knife-data-bag.1 index 556f56a054..a4d45ce60e 100644 --- a/distro/common/man/man1/knife-data-bag.1 +++ b/distro/common/man/man1/knife-data-bag.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DATA-BAG" "1" "Chef 11.16" "" "knife data bag" +.TH "KNIFE-DATA-BAG" "1" "Chef 12.0" "" "knife data bag" .SH NAME knife-data-bag \- The man page for the knife data bag subcommand. . @@ -119,7 +119,7 @@ This argument has the following options: The name of a specific item within a data bag. .TP .B \fB\-\-secret SECRET\fP -The encryption key that is used for values contained within a data bag item. +The encryption key that is used for values contained within a data bag item. If \fBsecret\fP is not specified, the chef\-client will look for a secret at the path specified by the \fBencrypted_data_bag_secret\fP setting in the client.rb file. .TP .B \fB\-\-secret\-file FILE\fP The path to the file that contains the encryption key. @@ -236,7 +236,7 @@ This argument has the following options: The name of a specific item within a data bag. .TP .B \fB\-\-secret SECRET\fP -The encryption key that is used for values contained within a data bag item. +The encryption key that is used for values contained within a data bag item. If \fBsecret\fP is not specified, the chef\-client will look for a secret at the path specified by the \fBencrypted_data_bag_secret\fP setting in the client.rb file. .TP .B \fB\-\-secret\-file FILE\fP The path to the file that contains the encryption key. @@ -372,7 +372,7 @@ This argument has the following options: Use to upload all data bags found at the specified path. .TP .B \fB\-\-secret SECRET\fP -The encryption key that is used for values contained within a data bag item. +The encryption key that is used for values contained within a data bag item. If \fBsecret\fP is not specified, the chef\-client will look for a secret at the path specified by the \fBencrypted_data_bag_secret\fP setting in the client.rb file. .TP .B \fB\-\-secret\-file FILE\fP The path to the file that contains the encryption key. @@ -475,7 +475,7 @@ This argument has the following options: The name of a specific item within a data bag. .TP .B \fB\-\-secret SECRET\fP -The encryption key that is used for values contained within a data bag item. +The encryption key that is used for values contained within a data bag item. If \fBsecret\fP is not specified, the chef\-client will look for a secret at the path specified by the \fBencrypted_data_bag_secret\fP setting in the client.rb file. .TP .B \fB\-\-secret\-file FILE\fP The path to the file that contains the encryption key. diff --git a/distro/common/man/man1/knife-delete.1 b/distro/common/man/man1/knife-delete.1 index 1b31849596..fcbf52a65a 100644 --- a/distro/common/man/man1/knife-delete.1 +++ b/distro/common/man/man1/knife-delete.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DELETE" "1" "Chef 11.16" "" "knife delete" +.TH "KNIFE-DELETE" "1" "Chef 12.0" "" "knife delete" .SH NAME knife-delete \- The man page for the knife delete subcommand. . diff --git a/distro/common/man/man1/knife-deps.1 b/distro/common/man/man1/knife-deps.1 index 581ea6f0e9..afa384c1a9 100644 --- a/distro/common/man/man1/knife-deps.1 +++ b/distro/common/man/man1/knife-deps.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DEPS" "1" "Chef 11.16" "" "knife deps" +.TH "KNIFE-DEPS" "1" "Chef 12.0" "" "knife deps" .SH NAME knife-deps \- The man page for the knife deps subcommand. . diff --git a/distro/common/man/man1/knife-diff.1 b/distro/common/man/man1/knife-diff.1 index 97938ef13c..8bf19ef609 100644 --- a/distro/common/man/man1/knife-diff.1 +++ b/distro/common/man/man1/knife-diff.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DIFF" "1" "Chef 11.16" "" "knife diff" +.TH "KNIFE-DIFF" "1" "Chef 12.0" "" "knife diff" .SH NAME knife-diff \- The man page for the knife diff subcommand. . diff --git a/distro/common/man/man1/knife-download.1 b/distro/common/man/man1/knife-download.1 index 3b60df12e2..ab232fe613 100644 --- a/distro/common/man/man1/knife-download.1 +++ b/distro/common/man/man1/knife-download.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-DOWNLOAD" "1" "Chef 11.16" "" "knife download" +.TH "KNIFE-DOWNLOAD" "1" "Chef 12.0" "" "knife download" .SH NAME knife-download \- The man page for the knife download subcommand. . diff --git a/distro/common/man/man1/knife-edit.1 b/distro/common/man/man1/knife-edit.1 index 344431b082..bc159e6444 100644 --- a/distro/common/man/man1/knife-edit.1 +++ b/distro/common/man/man1/knife-edit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-EDIT" "1" "Chef 11.16" "" "knife edit" +.TH "KNIFE-EDIT" "1" "Chef 12.0" "" "knife edit" .SH NAME knife-edit \- The man page for the knife edit subcommand. . diff --git a/distro/common/man/man1/knife-environment.1 b/distro/common/man/man1/knife-environment.1 index d7aedf35c5..d583abe7fa 100644 --- a/distro/common/man/man1/knife-environment.1 +++ b/distro/common/man/man1/knife-environment.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-ENVIRONMENT" "1" "Chef 11.16" "" "knife environment" +.TH "KNIFE-ENVIRONMENT" "1" "Chef 12.0" "" "knife environment" .SH NAME knife-environment \- The man page for the knife environment subcommand. . diff --git a/distro/common/man/man1/knife-exec.1 b/distro/common/man/man1/knife-exec.1 index 7f46263108..b63491185f 100644 --- a/distro/common/man/man1/knife-exec.1 +++ b/distro/common/man/man1/knife-exec.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-EXEC" "1" "Chef 11.16" "" "knife exec" +.TH "KNIFE-EXEC" "1" "Chef 12.0" "" "knife exec" .SH NAME knife-exec \- The man page for the knife exec subcommand. . diff --git a/distro/common/man/man1/knife-index-rebuild.1 b/distro/common/man/man1/knife-index-rebuild.1 index d327c4b2e6..3fe2c52f8c 100644 --- a/distro/common/man/man1/knife-index-rebuild.1 +++ b/distro/common/man/man1/knife-index-rebuild.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-INDEX-REBUILD" "1" "Chef 11.16" "" "knife index rebuild" +.TH "KNIFE-INDEX-REBUILD" "1" "Chef 12.0" "" "knife index rebuild" .SH NAME knife-index-rebuild \- The man page for the knife index rebuild subcommand. . diff --git a/distro/common/man/man1/knife-list.1 b/distro/common/man/man1/knife-list.1 index 546eacf009..c9349fa822 100644 --- a/distro/common/man/man1/knife-list.1 +++ b/distro/common/man/man1/knife-list.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-LIST" "1" "Chef 11.16" "" "knife list" +.TH "KNIFE-LIST" "1" "Chef 12.0" "" "knife list" .SH NAME knife-list \- The man page for the knife list subcommand. . diff --git a/distro/common/man/man1/knife-node.1 b/distro/common/man/man1/knife-node.1 index fb1adffe9d..af7eab9317 100644 --- a/distro/common/man/man1/knife-node.1 +++ b/distro/common/man/man1/knife-node.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-NODE" "1" "Chef 11.16" "" "knife node" +.TH "KNIFE-NODE" "1" "Chef 12.0" "" "knife node" .SH NAME knife-node \- The man page for the knife node subcommand. . @@ -557,10 +557,10 @@ This argument has the following options: The attribute (or attributes) to show. .TP .B \fB\-l\fP, \fB\-\-long\fP -Display long output when searching nodes while using the default summary format. +Use to display all attributes in the output and to show the output as JSON\&. .TP .B \fB\-m\fP, \fB\-\-medium\fP -Display more, but not all, of a node\(aqs data when searching using the default summary format. +Use to display normal attributes in the output and to show the output as JSON\&. .TP .B \fB\-r\fP, \fB\-\-run\-list\fP Use to show only the run\-list. diff --git a/distro/common/man/man1/knife-raw.1 b/distro/common/man/man1/knife-raw.1 index 53cb7abf34..a484db25bb 100644 --- a/distro/common/man/man1/knife-raw.1 +++ b/distro/common/man/man1/knife-raw.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-RAW" "1" "Chef 11.16" "" "knife raw" +.TH "KNIFE-RAW" "1" "Chef 12.0" "" "knife raw" .SH NAME knife-raw \- The man page for the knife raw subcommand. . @@ -31,7 +31,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .sp -The \fBknife raw\fP subcommand is used to send a REST request to a specified path using the Chef server API\&. +The \fBknife raw\fP subcommand is used to send a REST request to an endpoint in the Chef server API\&. .sp \fBSyntax\fP .sp diff --git a/distro/common/man/man1/knife-recipe-list.1 b/distro/common/man/man1/knife-recipe-list.1 index cba87be064..3bd5a4c3aa 100644 --- a/distro/common/man/man1/knife-recipe-list.1 +++ b/distro/common/man/man1/knife-recipe-list.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-RECIPE-LIST" "1" "Chef 11.16" "" "knife recipe list" +.TH "KNIFE-RECIPE-LIST" "1" "Chef 12.0" "" "knife recipe list" .SH NAME knife-recipe-list \- The man page for the knife recipe list subcommand. . diff --git a/distro/common/man/man1/knife-role.1 b/distro/common/man/man1/knife-role.1 index 5275489dd8..d5b5616d31 100644 --- a/distro/common/man/man1/knife-role.1 +++ b/distro/common/man/man1/knife-role.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-ROLE" "1" "Chef 11.16" "" "knife role" +.TH "KNIFE-ROLE" "1" "Chef 12.0" "" "knife role" .SH NAME knife-role \- The man page for the knife role subcommand. . @@ -31,7 +31,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .sp -A role is a way to define certain patterns and processes that exist across nodes in an organization as belonging to a single job function. Each role consists of zero (or more) attributes and a run list. Each node can have zero (or more) roles assigned to it. When a role is run against a node, the configuration details of that node are compared against the attributes of the role, and then the contents of that role\(aqs run list are applied to the node\(aqs configuration details. When a chef\-client runs, it merges its own attributes and run lists with those contained within each assigned role. +A role is a way to define certain patterns and processes that exist across nodes in an organization as belonging to a single job function. Each role consists of zero (or more) attributes and a run\-list. Each node can have zero (or more) roles assigned to it. When a role is run against a node, the configuration details of that node are compared against the attributes of the role, and then the contents of that role\(aqs run\-list are applied to the node\(aqs configuration details. When a chef\-client runs, it merges its own attributes and run\-lists with those contained within each assigned role. .sp The \fBknife role\fP subcommand is used to manage the roles that are associated with one or more nodes on a Chef server\&. .SH COMMON OPTIONS diff --git a/distro/common/man/man1/knife-search.1 b/distro/common/man/man1/knife-search.1 index 5955a12529..3b81898530 100644 --- a/distro/common/man/man1/knife-search.1 +++ b/distro/common/man/man1/knife-search.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SEARCH" "1" "Chef 11.16" "" "knife search" +.TH "KNIFE-SEARCH" "1" "Chef 12.0" "" "knife search" .SH NAME knife-search \- The man page for the knife search subcommand. . @@ -31,7 +31,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .sp -Search indexes allow queries to be made for any type of data that is indexed by the Chef 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, 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 Chef server\&. +Search indexes allow queries to be made for any type of data that is indexed by the Chef 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, the \fBsearch\fP method in the Recipe DSL, and 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 Chef server\&. .sp The \fBknife search\fP subcommand is used run a search query for information that is indexed on a Chef server\&. .sp @@ -168,10 +168,10 @@ The name of the index to be queried: \fBclient\fP, \fBenvironment\fP, \fBnode\fP The private key that knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-l\fP, \fB\-\-long\fP -Display long output when searching nodes while using the default summary format. +Use to display all attributes in the output and to show the output as JSON\&. .TP .B \fB\-m\fP, \fB\-\-medium\fP -Display more, but not all, of a node\(aqs data when searching using the default summary format. +Use to display normal attributes in the output and to show the output as JSON\&. .TP .B \fB\-o SORT\fP, \fB\-\-sort SORT\fP The order in which search results will be sorted. diff --git a/distro/common/man/man1/knife-serve.1 b/distro/common/man/man1/knife-serve.1 index e56c8dbe9f..8760559f32 100644 --- a/distro/common/man/man1/knife-serve.1 +++ b/distro/common/man/man1/knife-serve.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SERVE" "1" "Chef 11.16" "" "knife serve" +.TH "KNIFE-SERVE" "1" "Chef 12.0" "" "knife serve" .SH NAME knife-serve \- The man page for the knife serve subcommand. . diff --git a/distro/common/man/man1/knife-show.1 b/distro/common/man/man1/knife-show.1 index 2ee107d37b..94f295afb7 100644 --- a/distro/common/man/man1/knife-show.1 +++ b/distro/common/man/man1/knife-show.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SHOW" "1" "Chef 11.16" "" "knife show" +.TH "KNIFE-SHOW" "1" "Chef 12.0" "" "knife show" .SH NAME knife-show \- The man page for the knife show subcommand. . diff --git a/distro/common/man/man1/knife-ssh.1 b/distro/common/man/man1/knife-ssh.1 index 50a4babae3..78555b7293 100644 --- a/distro/common/man/man1/knife-ssh.1 +++ b/distro/common/man/man1/knife-ssh.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SSH" "1" "Chef 11.16" "" "knife ssh" +.TH "KNIFE-SSH" "1" "Chef 12.0" "" "knife ssh" .SH NAME knife-ssh \- The man page for the knife ssh subcommand. . diff --git a/distro/common/man/man1/knife-ssl-check.1 b/distro/common/man/man1/knife-ssl-check.1 index c90f7be05c..23b945468d 100644 --- a/distro/common/man/man1/knife-ssl-check.1 +++ b/distro/common/man/man1/knife-ssl-check.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SSL-CHECK" "1" "Chef 11.16" "" "knife ssl check" +.TH "KNIFE-SSL-CHECK" "1" "Chef 12.0" "" "knife ssl check" .SH NAME knife-ssl-check \- The man page for the knife ssl check subcommand. . diff --git a/distro/common/man/man1/knife-ssl-fetch.1 b/distro/common/man/man1/knife-ssl-fetch.1 index c6f0af2472..88b0ad1ebf 100644 --- a/distro/common/man/man1/knife-ssl-fetch.1 +++ b/distro/common/man/man1/knife-ssl-fetch.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-SSL-FETCH" "1" "Chef 11.16" "" "knife ssl fetch" +.TH "KNIFE-SSL-FETCH" "1" "Chef 12.0" "" "knife ssl fetch" .SH NAME knife-ssl-fetch \- The man page for the knife ssl fetch subcommand. . diff --git a/distro/common/man/man1/knife-status.1 b/distro/common/man/man1/knife-status.1 index 52929d5d8c..038cf3a0f0 100644 --- a/distro/common/man/man1/knife-status.1 +++ b/distro/common/man/man1/knife-status.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-STATUS" "1" "Chef 11.16" "" "knife status" +.TH "KNIFE-STATUS" "1" "Chef 12.0" "" "knife status" .SH NAME knife-status \- The man page for the knife status subcommand. . diff --git a/distro/common/man/man1/knife-tag.1 b/distro/common/man/man1/knife-tag.1 index d794f1953a..3149f520f1 100644 --- a/distro/common/man/man1/knife-tag.1 +++ b/distro/common/man/man1/knife-tag.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-TAG" "1" "Chef 11.16" "" "knife tag" +.TH "KNIFE-TAG" "1" "Chef 12.0" "" "knife tag" .SH NAME knife-tag \- The man page for the knife tag subcommand. . diff --git a/distro/common/man/man1/knife-upload.1 b/distro/common/man/man1/knife-upload.1 index 82bb3e464e..dfc20e0270 100644 --- a/distro/common/man/man1/knife-upload.1 +++ b/distro/common/man/man1/knife-upload.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-UPLOAD" "1" "Chef 11.16" "" "knife upload" +.TH "KNIFE-UPLOAD" "1" "Chef 12.0" "" "knife upload" .SH NAME knife-upload \- The man page for the knife upload subcommand. . diff --git a/distro/common/man/man1/knife-user.1 b/distro/common/man/man1/knife-user.1 index 88dd5dae7d..cdd15b9d14 100644 --- a/distro/common/man/man1/knife-user.1 +++ b/distro/common/man/man1/knife-user.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-USER" "1" "Chef 11.16" "" "knife user" +.TH "KNIFE-USER" "1" "Chef 12.0" "" "knife user" .SH NAME knife-user \- The man page for the knife user subcommand. . diff --git a/distro/common/man/man1/knife-xargs.1 b/distro/common/man/man1/knife-xargs.1 index ff78b2d068..1fcc3d9f4a 100644 --- a/distro/common/man/man1/knife-xargs.1 +++ b/distro/common/man/man1/knife-xargs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE-XARGS" "1" "Chef 11.16" "" "knife xargs" +.TH "KNIFE-XARGS" "1" "Chef 12.0" "" "knife xargs" .SH NAME knife-xargs \- The man page for the knife xargs subcommand. . diff --git a/distro/common/man/man1/knife.1 b/distro/common/man/man1/knife.1 index f0bc35ba37..9259da8477 100644 --- a/distro/common/man/man1/knife.1 +++ b/distro/common/man/man1/knife.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "KNIFE" "1" "Chef 11.16" "" "knife" +.TH "KNIFE" "1" "Chef 12.0" "" "knife" .SH NAME knife \- The man page for the knife command line tool. . diff --git a/distro/common/man/man8/chef-client.8 b/distro/common/man/man8/chef-client.8 index 6a8de44e27..4c8a1f7b8f 100644 --- a/distro/common/man/man8/chef-client.8 +++ b/distro/common/man/man8/chef-client.8 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "CHEF-CLIENT" "8" "Chef 11.16" "" "chef-client" +.TH "CHEF-CLIENT" "8" "Chef 12.0" "" "chef-client" .SH NAME chef-client \- The man page for the chef-client command line tool. . @@ -86,7 +86,7 @@ This command has the following options: Use to cause a chef\-client run to fail when the chef\-client does not have administrator privileges in Microsoft Windows\&. .TP .B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. +The port on which chef\-zero will listen. If a port is not specified\-\-\-individually, as range of ports, or from the \fBchef_zero.port\fP setting in the client.rb file\-\-\-the chef\-client will scan for ports between 8889\-9999 and will pick the first port that is available. .TP .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP The output format: \fBdoc\fP (default) or \fBmin\fP\&. @@ -110,10 +110,81 @@ The name of the group that owns a process. This is required when starting any ex Shows help for the command. .TP .B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP -The frequency (in seconds) at which the chef\-client runs. Default value: \fB1800\fP\&. +The frequency (in seconds) at which the chef\-client runs. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run. Default value: \fB1800\fP\&. .TP .B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP The path to a file that contains JSON data. +.sp +Use this option to define a \fBrun_list\fP object. For example, a JSON file similar to: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +"run_list": [ + "recipe[base]", + "recipe[foo]", + "recipe[bar]", + "role[webserver]" +], +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +may be used by running \fBchef\-client \-j path/to/file.json\fP\&. +.sp +In certain situations this option may be used to update \fBnormal\fP attributes. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Any other attribute type that is contained in this JSON file will be treated as a \fBnormal\fP attribute. For example, attempting to update \fBoverride\fP attributes using the \fB\-j\fP option: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ + "name": "dev\-99", + "description": "Install some stuff", + "override_attributes": { + "apptastic": { + "enable_apptastic": "false", + "apptastic_tier_name": "dev\-99.bomb.com" + } + } +} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +will result in a node object similar to: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ + "name": "maybe\-dev\-99", + "normal": { + "name": "dev\-99", + "description": "Install some stuff", + "override_attributes": { + "apptastic": { + "enable_apptastic": "false", + "apptastic_tier_name": "dev\-99.bomb.com" + } + } + } +} +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT .TP .B \fB\-k KEY_FILE\fP, \fB\-\-client_key KEY_FILE\fP The location of the file which contains the client key. Default value: \fB/etc/chef/client.pem\fP\&. @@ -134,7 +205,7 @@ Use to view colored output. Default setting: \fB\-\-color\fP\&. The name of the node. .TP .B \fB\-o RUN_LIST_ITEM\fP, \fB\-\-override\-runlist RUN_LIST_ITEM\fP -Replace the current run list with the specified items. +Replace the current run list with the specified items. This option will not clear the list of cookbooks (and related files) that is cached on the node. .TP .B \fB\-\-once\fP Use to run the chef\-client only once and to cancel \fBinterval\fP and \fBsplay\fP options. @@ -155,7 +226,7 @@ The path to a recipe. For example, if a recipe file is in the current directory, The amount of time (in seconds) to wait for a chef\-client run to finish. Default value: not set (indefinite). Set to \fB0\fP to cause a second chef\-client to exit immediately. .TP .B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP -A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. +A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run. .TP .B \fB\-S CHEF_SERVER_URL\fP, \fB\-\-server CHEF_SERVER_URL\fP The URL for the Chef server\&. diff --git a/distro/common/man/man8/chef-solo.8 b/distro/common/man/man8/chef-solo.8 index 73a49a79cf..d4bbc7507f 100644 --- a/distro/common/man/man8/chef-solo.8 +++ b/distro/common/man/man8/chef-solo.8 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "CHEF-SOLO" "8" "Chef 11.16" "" "chef-solo" +.TH "CHEF-SOLO" "8" "Chef 12.0" "" "chef-solo" .SH NAME chef-solo \- The man page for the chef-solo command line tool. . @@ -77,13 +77,15 @@ This command has the following options: The configuration file to use. .TP .B \fB\-d\fP, \fB\-\-daemonize\fP -Use to run the executable as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef\-client\fP\&. This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper\&. +Use to run the executable as a daemon. This option may not be used in the same command with the \fB\-\-[no\-]fork\fP option. +.sp +This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef\-client\fP\&. This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper\&. .TP .B \fB\-E ENVIRONMENT_NAME\fP, \fB\-\-environment ENVIRONMENT_NAME\fP The name of the environment. .TP .B \fB\-f\fP, \fB\-\-[no\-]fork\fP -Use to contain the chef\-client run in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP\&. +Use to contain the chef\-client run in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP\&. This option may not be used in the same command with the \fB\-\-daemonize\fP and \fB\-\-interval\fP options. .TP .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP The output format: \fBdoc\fP (default) or \fBmin\fP\&. @@ -107,10 +109,81 @@ The name of the group that owns a process. This is required when starting any ex Shows help for the command. .TP .B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP -The frequency (in seconds) at which the chef\-client runs. +The frequency (in seconds) at which the chef\-client runs. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run. This option may not be used in the same command with the \fB\-\-[no\-]fork\fP option. .TP .B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP -The path to a file that contains JSON data. Use this option to override \fBnormal\fP attributes set elsewhere. +The path to a file that contains JSON data. +.sp +Use this option to define a \fBrun_list\fP object. For example, a JSON file similar to: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +"run_list": [ + "recipe[base]", + "recipe[foo]", + "recipe[bar]", + "role[webserver]" +], +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +may be used by running \fBchef\-client \-j path/to/file.json\fP\&. +.sp +In certain situations this option may be used to update \fBnormal\fP attributes. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Any other attribute type that is contained in this JSON file will be treated as a \fBnormal\fP attribute. For example, attempting to update \fBoverride\fP attributes using the \fB\-j\fP option: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ + "name": "dev\-99", + "description": "Install some stuff", + "override_attributes": { + "apptastic": { + "enable_apptastic": "false", + "apptastic_tier_name": "dev\-99.bomb.com" + } + } +} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +will result in a node object similar to: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ + "name": "maybe\-dev\-99", + "normal": { + "name": "dev\-99", + "description": "Install some stuff", + "override_attributes": { + "apptastic": { + "enable_apptastic": "false", + "apptastic_tier_name": "dev\-99.bomb.com" + } + } + } +} +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT .TP .B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP The level of logging that will be stored in a log file. @@ -134,7 +207,7 @@ The URL location from which a remote cookbook tar.gz will be downloaded. The amount of time (in seconds) to wait for a chef\-client run to finish. Default value: not set (indefinite). Set to \fB0\fP to cause a second chef\-client to exit immediately. .TP .B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP -A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. +A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run. .TP .B \fB\-u USER\fP, \fB\-\-user USER\fP The user that owns a process. This is required when starting any executable as a daemon. -- cgit v1.2.1 From ff9147776117f6a5592449384ab6f6ff6605e9be Mon Sep 17 00:00:00 2001 From: jamescott Date: Mon, 3 Nov 2014 14:59:44 -0800 Subject: update html pages for chef-client 12 --- distro/common/html/_sources/ctl_chef_client.txt | 2 +- distro/common/html/_sources/ctl_chef_server.txt | 88 +++++++++------ distro/common/html/_sources/ctl_chef_solo.txt | 2 +- distro/common/html/_sources/knife_bootstrap.txt | 2 +- .../common/html/_sources/knife_cookbook_site.txt | 2 +- distro/common/html/_sources/knife_data_bag.txt | 8 +- distro/common/html/_sources/knife_status.txt | 2 +- distro/common/html/ctl_chef_client.html | 62 ++++++++-- distro/common/html/ctl_chef_server.html | 125 ++++++++++++++------- distro/common/html/ctl_chef_shell.html | 46 +++++++- distro/common/html/ctl_chef_solo.html | 56 ++++++++- distro/common/html/index.html | 4 +- distro/common/html/knife.html | 2 +- distro/common/html/knife_bootstrap.html | 40 +++++-- distro/common/html/knife_cookbook_site.html | 2 + distro/common/html/knife_data_bag.html | 8 +- distro/common/html/knife_node.html | 4 +- distro/common/html/knife_raw.html | 2 +- distro/common/html/knife_role.html | 2 +- distro/common/html/knife_search.html | 6 +- distro/common/html/knife_status.html | 4 + distro/common/html/searchindex.js | 2 +- 22 files changed, 348 insertions(+), 123 deletions(-) diff --git a/distro/common/html/_sources/ctl_chef_client.txt b/distro/common/html/_sources/ctl_chef_client.txt index 99b0037154..f0af14e090 100644 --- a/distro/common/html/_sources/ctl_chef_client.txt +++ b/distro/common/html/_sources/ctl_chef_client.txt @@ -10,7 +10,7 @@ chef-client Options ===================================================== -.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_11-8_options.rst +.. include:: ../../release_chef_12-0/includes_ctl_chef_client_options.rst Run with Elevated Privileges ===================================================== diff --git a/distro/common/html/_sources/ctl_chef_server.txt b/distro/common/html/_sources/ctl_chef_server.txt index bc55662531..a7f6ce81e7 100644 --- a/distro/common/html/_sources/ctl_chef_server.txt +++ b/distro/common/html/_sources/ctl_chef_server.txt @@ -1,5 +1,5 @@ ===================================================== -chef-server-ctl +|chef server ctl| (executable) ===================================================== .. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server.rst @@ -28,31 +28,25 @@ install ===================================================== .. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_install.rst -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_install_table.rst - -master-recover -===================================================== -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_master_recover.rst - -org-associate -===================================================== -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_associate.rst - **Syntax** -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_associate_syntax.rst +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_install_syntax.rst -**Examples** - -.. code-block:: bash - - $ chef-server-ctl org-associate prod john_smith +**Options** +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_install_options.rst -.. code-block:: bash +Use Downloads +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_install_features_download.rst - $ chef-server-ctl org-associate preprod testmaster +Use Local Packages +----------------------------------------------------- +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_install_features_manual.rst +master-recover +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_master_recover.rst org-create ===================================================== @@ -82,7 +76,6 @@ org-create $ chef-server-ctl org-create dev Development -f /tmp/id-dev.key - org-delete ===================================================== .. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_delete.rst @@ -102,46 +95,71 @@ org-delete $ chef-server-ctl org-delete pedant-testing-org +org-list +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list_syntax.rst -org-disassociate +**Options** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list_options.rst + +org-show +===================================================== +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_show.rst + +**Syntax** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_show_syntax.rst + +org-user-add ===================================================== -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_disassociate.rst +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_user_add.rst **Syntax** -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_disassociate_syntax.rst +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_user_add_syntax.rst + +**Options** + +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_user_add_options.rst **Examples** .. code-block:: bash - $ chef-server-ctl org-disassociate prod john_smith + $ chef-server-ctl org-user-add prod john_smith + +.. code-block:: bash + $ chef-server-ctl org-user-add preprod testmaster .. code-block:: bash - $ chef-server-ctl org-disassociate prod testmaster + $ chef-server-ctl org-user-add dev grantmc --admin -org-list +org-user-remove ===================================================== -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list.rst +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_user_remove.rst **Syntax** -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list_syntax.rst +.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_user_remove_syntax.rst -**Options** +**Examples** -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_list_options.rst +.. code-block:: bash -org-show -===================================================== -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_show.rst + $ chef-server-ctl org-user-remove prod john_smith -**Syntax** +.. code-block:: bash + + $ chef-server-ctl org-user-remove prod testmaster -.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_org_show_syntax.rst password ===================================================== diff --git a/distro/common/html/_sources/ctl_chef_solo.txt b/distro/common/html/_sources/ctl_chef_solo.txt index a80c8bad3c..99f7b919de 100644 --- a/distro/common/html/_sources/ctl_chef_solo.txt +++ b/distro/common/html/_sources/ctl_chef_solo.txt @@ -8,7 +8,7 @@ chef-solo Options ===================================================== -.. include:: ../../includes_ctl_chef_solo/includes_ctl_chef_solo_options.rst +.. include:: ../../release_chef_12-0/includes_ctl_chef_solo_options.rst Examples ===================================================== diff --git a/distro/common/html/_sources/knife_bootstrap.txt b/distro/common/html/_sources/knife_bootstrap.txt index ee275b58f5..29af753b23 100644 --- a/distro/common/html/_sources/knife_bootstrap.txt +++ b/distro/common/html/_sources/knife_bootstrap.txt @@ -16,7 +16,7 @@ Options ===================================================== .. note:: Review the list of :doc:`common options ` available to this (and all) |knife| subcommands and plugins. -.. include:: ../../includes_knife/includes_knife_bootstrap_options.rst +.. include:: ../../release_chef_12-0/includes_knife_bootstrap_options.rst Custom Templates ===================================================== diff --git a/distro/common/html/_sources/knife_cookbook_site.txt b/distro/common/html/_sources/knife_cookbook_site.txt index 92fadaa819..d1b03f2fa0 100644 --- a/distro/common/html/_sources/knife_cookbook_site.txt +++ b/distro/common/html/_sources/knife_cookbook_site.txt @@ -98,7 +98,7 @@ Syntax Options ----------------------------------------------------- -.. include:: ../../includes_knife/includes_knife_site_cookbook_share_options.rst +.. include:: ../../release_chef_12-0/includes_knife_site_cookbook_share_options.rst Examples ----------------------------------------------------- diff --git a/distro/common/html/_sources/knife_data_bag.txt b/distro/common/html/_sources/knife_data_bag.txt index 32888e6f8b..369baab2b7 100644 --- a/distro/common/html/_sources/knife_data_bag.txt +++ b/distro/common/html/_sources/knife_data_bag.txt @@ -20,7 +20,7 @@ Syntax Options ----------------------------------------------------- -.. include:: ../../includes_knife/includes_knife_data_bag_create_options.rst +.. include:: ../../release_chef_12-0/includes_knife_data_bag_create_options.rst Examples ----------------------------------------------------- @@ -64,7 +64,7 @@ Syntax Options ----------------------------------------------------- -.. include:: ../../includes_knife/includes_knife_data_bag_edit_options.rst +.. include:: ../../release_chef_12-0/includes_knife_data_bag_edit_options.rst Examples ----------------------------------------------------- @@ -88,7 +88,7 @@ Syntax Options ----------------------------------------------------- -.. include:: ../../includes_knife/includes_knife_data_bag_from_file_options.rst +.. include:: ../../release_chef_12-0/includes_knife_data_bag_from_file_options.rst Examples ----------------------------------------------------- @@ -133,7 +133,7 @@ Syntax Options ----------------------------------------------------- -.. include:: ../../includes_knife/includes_knife_data_bag_show_options.rst +.. include:: ../../release_chef_12-0/includes_knife_data_bag_show_options.rst Examples ----------------------------------------------------- diff --git a/distro/common/html/_sources/knife_status.txt b/distro/common/html/_sources/knife_status.txt index 194b985f67..7f00826b96 100644 --- a/distro/common/html/_sources/knife_status.txt +++ b/distro/common/html/_sources/knife_status.txt @@ -12,7 +12,7 @@ Options ===================================================== .. note:: Review the list of :doc:`common options ` available to this (and all) |knife| subcommands and plugins. -.. include:: ../../includes_knife/includes_knife_status_options.rst +.. include:: ../../release_chef_12-0/includes_knife_status_options.rst Examples ===================================================== diff --git a/distro/common/html/ctl_chef_client.html b/distro/common/html/ctl_chef_client.html index 7bb43d6878..dbdca11487 100644 --- a/distro/common/html/ctl_chef_client.html +++ b/distro/common/html/ctl_chef_client.html @@ -71,10 +71,8 @@
-A, --fatal-windows-admin-check
Use to cause a chef-client run to fail when the chef-client does not have administrator privileges in Microsoft Windows.
-
-c CONFIG, --config CONFIG
-
The configuration file to use.
--chef-zero-port PORT
-
The port on which chef-zero will listen.
+
The port on which chef-zero will listen. If a port is not specified—individually, as range of ports, or from the chef_zero.port setting in the client.rb file—the chef-client will scan for ports between 8889-9999 and will pick the first port that is available.
-F FORMAT, --format FORMAT

The output format: doc (default) or min.

Use doc to print the progress of the chef-client run using full strings that display a summary of updates as they occur.

@@ -90,9 +88,53 @@
-h, --help
Shows help for the command.
-i SECONDS, --interval SECONDS
-
The frequency (in seconds) at which the chef-client runs. Default value: 1800.
+
The frequency (in seconds) at which the chef-client runs. When the chef-client is run at intervals, --splay and --interval values are applied before the chef-client run. Default value: 1800.
-j PATH, --json-attributes PATH
-
The path to a file that contains JSON data.
+

The path to a file that contains JSON data.

+

Use this option to define a run_list object. For example, a JSON file similar to:

+
"run_list": [
+  "recipe[base]",
+  "recipe[foo]",
+  "recipe[bar]",
+  "role[webserver]"
+],
+
+
+

may be used by running chef-client -j path/to/file.json.

+

In certain situations this option may be used to update normal attributes.

+
+

Warning

+

Any other attribute type that is contained in this JSON file will be treated as a normal attribute. For example, attempting to update override attributes using the -j option:

+
{
+  "name": "dev-99",
+  "description": "Install some stuff",
+  "override_attributes": {
+    "apptastic": {
+      "enable_apptastic": "false",
+      "apptastic_tier_name": "dev-99.bomb.com"
+    }
+  }
+}
+
+
+

will result in a node object similar to:

+
{
+  "name": "maybe-dev-99",
+  "normal": {
+  "name": "dev-99",
+    "description": "Install some stuff",
+    "override_attributes": {
+      "apptastic": {
+        "enable_apptastic": "false",
+        "apptastic_tier_name": "dev-99.bomb.com"
+      }
+    }
+  }
+}
+
+
+
+
-k KEY_FILE, --client_key KEY_FILE
The location of the file which contains the client key. Default value: /etc/chef/client.pem.
-K KEY_FILE, --validation_key KEY_FILE
@@ -106,15 +148,21 @@
-N NODE_NAME, --node-name NODE_NAME
The name of the node.
-o RUN_LIST_ITEM, --override-runlist RUN_LIST_ITEM
-
Replace the current run list with the specified items.
+
Replace the current run list with the specified items. This option will not clear the list of cookbooks (and related files) that is cached on the node.
--once
Use to run the chef-client only once and to cancel interval and splay options.
-P PID_FILE, --pid PID_FILE
The location in which a process identification number (pid) is saved. An executable, when started as a daemon, will write the pid to the specified file. Default value: /tmp/name-of-executable.pid.
+
-r RUN_LIST_ITEM, --runlist RUN_LIST_ITEM
+
Use to permanently replace the current run-list with the specified run-list items.
-R, --enable-reporting
Use to enable Chef reporting, which performs data collection during a chef-client run.
+
RECIPE_FILE
+
The path to a recipe. For example, if a recipe file is in the current directory, use recipe_file.rb. This is typically used with the --local-mode option.
+
--run-lock-timeout SECONDS
+
The amount of time (in seconds) to wait for a chef-client run to finish. Default value: not set (indefinite). Set to 0 to cause a second chef-client to exit immediately.
-s SECONDS, --splay SECONDS
-
A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time.
+
A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef-client is run at intervals, --splay and --interval values are applied before the chef-client run.
-S CHEF_SERVER_URL, --server CHEF_SERVER_URL
The URL for the Chef server.
-u USER, --user USER
diff --git a/distro/common/html/ctl_chef_server.html b/distro/common/html/ctl_chef_server.html index 8c68c21cd0..c5bc97af08 100644 --- a/distro/common/html/ctl_chef_server.html +++ b/distro/common/html/ctl_chef_server.html @@ -6,7 +6,7 @@ - chef-server-ctl — chef-client Man Pages + chef-server-ctl (executable) — chef-client Man Pages @@ -39,8 +39,8 @@
-
-

chef-server-ctl

+
+

chef-server-ctl (executable)

The Chef server includes a command-line utility named chef-server-ctl. This command-line tool is used to start and stop individual services, reconfigure the Chef server, run chef-pedant, and then tail Chef server log files.

backup-recover

@@ -132,11 +132,21 @@

install

The install subcommand is used to install premium features of the Chef server: Chef management console, Chef analytics, chef-client run reporting, high availability configurations, Chef push jobs, and Chef server replication.

+

Syntax

This subcommand has the following syntax:

-
$ chef-server-ctl install name_of_premium_feature
+
$ chef-server-ctl install name_of_premium_feature (options)
 

 

 
where name_of_premium_feature represents the command line value associated with the premium feature:

+
Options

+
This subcommand has the following options:

+

+
--path PATH

+
Use to specify the location of a package. This option is not required when packages are downloaded from https://packagecloud.io/.

+

+

+
Use Downloads

+
The install subcommand downloads packages from https://packagecloud.io/ by default. For systems that are not behind a firewall (and have connectivity to https://packagecloud.io/), these packages can be installed as described below.

 @@ -150,12 +160,16 @@
 
@@ -166,8 +180,12 @@
 
$ chef-server-ctl install opscode-push-jobs-server
 

 

+
then:

+
$ opscode-push-jobs-server-ctl reconfigure
+

+
and then:

-
$ opscode-push-jobs-server-ctl reconfigure
+
$ chef-server-ctl reconfigure
 

 

 
@@ -190,12 +208,16 @@
 

@@ -203,27 +225,23 @@
 

 
 

 
Chef Manage
 
Use Chef management console to manage data bags, attributes, run-lists, roles, environments, and cookbooks from a web user interface.

-
Run:

+
(Front end machines only.) Run:

 
$ chef-server-ctl install opscode-manage
 

 

+
then:

+
$ opscode-manage-ctl reconfigure
+

+

 
and then:

-
$ opscode-manage-ctl reconfigure
+
$ chef-server-ctl reconfigure
 

 

 

 

 
Reporting
 
Use Chef reporting to keep track of what happens during every chef-client runs across all of the infrastructure being managed by Chef. Run Chef reporting with Chef management console to view reports from a web user interface.

-
Run:

+
(Front end machines only.) Run:

 
$ chef-server-ctl install opscode-reporting
 

 

+
then:

+
$ opscode-reporting-ctl reconfigure
+

+

 
and then:

-
$ opscode-reporting-ctl reconfigure
+
$ chef-server-ctl reconfigure
 

 

 

 

 

-

-
master-recover

-
The master-recover subcommand is used to force the Chef server to attempt to become the master server. This command is typically run in tandem with the backup-recover subcommand on the back-end peer, unless the back-end peer is no longer available.

-
This subcommand has the following syntax:

-
$ chef-server-ctl master-recover
+

+
Use Local Packages

+
The install subcommand downloads packages from https://packagecloud.io/ by default. For systems that are behind a firewall (and do not have connectivity to https://packagecloud.io/), these packages can be installed manually. First download the package that is appropriate for the platform and save it to a local path. Then run the install command using the --path option to specify the location for the package:

+
$ chef-server-ctl install NAME_OF_PACKAGE --path /path/to/package
 

 

-

-

-
org-associate

-
The org-associate subcommand is used to associate a user to an organization.

-
Syntax

-
This subcommand has the following syntax:

-
$ chef-server-ctl org-associate ORG_NAME USER_NAME
+
For example:

+
$ chef-server-ctl install opscode-manage-1.6.2-1.el6.x86_64 --path /home/vagrant
 

 

-
Examples

-
$ chef-server-ctl org-associate prod john_smith
-

 

-
$ chef-server-ctl org-associate preprod testmaster
+

+

+
master-recover

+
The master-recover subcommand is used to force the Chef server to attempt to become the master server. This command is typically run in tandem with the backup-recover subcommand on the back-end peer, unless the back-end peer is no longer available.

+
This subcommand has the following syntax:

+
$ chef-server-ctl master-recover
 

 

 

@@ -270,22 +288,6 @@
 

 

 

-

-
org-disassociate

-
The org-disassociate subcommand is used to disassociate a user from an organization.

-
Syntax

-
This subcommand has the following syntax:

-
$ chef-server-ctl org-disassociate ORG_NAME USER_NAME
-

-

-
Examples

-
$ chef-server-ctl org-disassociate prod john_smith
-

-

-
$ chef-server-ctl org-disassociate prod testmaster
-

-

-

 

 
org-list

 
The org-list subcommand is used to list all of the organizations currently present on the Chef server.

@@ -312,6 +314,47 @@
 

 

 

+

+
org-user-add

+
The org-user-add subcommand is used to add a user to an organization.

+
Syntax

+
This subcommand has the following syntax:

+
$ chef-server-ctl org-user-add ORG_NAME USER_NAME (options)
+

+

+
Options

+
This subcommand has the following options:

+

+
--admin

+
Use to add the user to the admins group.

+

+
Examples

+
$ chef-server-ctl org-user-add prod john_smith
+

+

+
$ chef-server-ctl org-user-add preprod testmaster
+

+

+
$ chef-server-ctl org-user-add dev grantmc --admin
+

+

+

+

+
org-user-remove

+
The org-user-remove subcommand is used to remove a user from an organization.

+
Syntax

+
This subcommand has the following syntax:

+
$ chef-server-ctl org-user-remove ORG_NAME USER_NAME
+

+

+
Examples

+
$ chef-server-ctl org-user-remove prod john_smith
+

+

+
$ chef-server-ctl org-user-remove prod testmaster
+

+

+

 

 
password

 

diff --git a/distro/common/html/ctl_chef_shell.html b/distro/common/html/ctl_chef_shell.html
index b3ae1742f8..e655ec9146 100644
--- a/distro/common/html/ctl_chef_shell.html
+++ b/distro/common/html/ctl_chef_shell.html
@@ -88,7 +88,51 @@
 
-h, --help

 
Shows help for the command.

 
-j PATH, --json-attributes PATH

-
The path to a file that contains JSON data.

+
The path to a file that contains JSON data.

+
Use this option to define a run_list object. For example, a JSON file similar to:

+
"run_list": [
+  "recipe[base]",
+  "recipe[foo]",
+  "recipe[bar]",
+  "role[webserver]"
+],
+

+

+
may be used by running chef-client -j path/to/file.json.

+
In certain situations this option may be used to update normal attributes.

+

+
Warning

+
Any other attribute type that is contained in this JSON file will be treated as a normal attribute. For example, attempting to update override attributes using the -j option:

+
{
+  "name": "dev-99",
+  "description": "Install some stuff",
+  "override_attributes": {
+    "apptastic": {
+      "enable_apptastic": "false",
+      "apptastic_tier_name": "dev-99.bomb.com"
+    }
+  }
+}
+

+

+
will result in a node object similar to:

+
{
+  "name": "maybe-dev-99",
+  "normal": {
+  "name": "dev-99",
+    "description": "Install some stuff",
+    "override_attributes": {
+      "apptastic": {
+        "enable_apptastic": "false",
+        "apptastic_tier_name": "dev-99.bomb.com"
+      }
+    }
+  }
+}
+

+

+

+

 
-l LEVEL, --log-level LEVEL

 
The level of logging that will be stored in a log file.

 
-s, --solo

diff --git a/distro/common/html/ctl_chef_solo.html b/distro/common/html/ctl_chef_solo.html
index f32136e7c4..2382fed80a 100644
--- a/distro/common/html/ctl_chef_solo.html
+++ b/distro/common/html/ctl_chef_solo.html
@@ -66,11 +66,13 @@
 
-c CONFIG, --config CONFIG

 
The configuration file to use.

 
-d, --daemonize

-
Use to run the executable as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the chef-client::service recipe in the chef-client cookbook: http://community.opscode.com/cookbooks/chef-client. This will install a chef-client service under Microsoft Windows using the Windows Service Wrapper.

+
Use to run the executable as a daemon.  This option may not be used in the same command with the --[no-]fork option.

+
This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the chef-client::service recipe in the chef-client cookbook: http://community.opscode.com/cookbooks/chef-client. This will install a chef-client service under Microsoft Windows using the Windows Service Wrapper.

+

 
-E ENVIRONMENT_NAME, --environment ENVIRONMENT_NAME

 
The name of the environment.

 
-f, --[no-]fork

-
Use to contain the chef-client run in a secondary process with dedicated RAM. When the chef-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use --no-fork to disable running the chef-client in fork node. Default value: --fork.

+
Use to contain the chef-client run in a secondary process with dedicated RAM. When the chef-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use --no-fork to disable running the chef-client in fork node. Default value: --fork. This option may not be used in the same command with the --daemonize and --interval options.

 
-F FORMAT, --format FORMAT

 
The output format: doc (default) or min.

 
Use doc to print the progress of the chef-client run using full strings that display a summary of updates as they occur.

@@ -86,9 +88,53 @@
 
-h, --help

 
Shows help for the command.

 
-i SECONDS, --interval SECONDS

-
The frequency (in seconds) at which the chef-client runs.

+
The frequency (in seconds) at which the chef-client runs. When the chef-client is run at intervals, --splay and --interval values are applied before the chef-client run. This option may not be used in the same command with the --[no-]fork option.

 
-j PATH, --json-attributes PATH

-
The path to a file that contains JSON data. Use this option to override normal attributes set elsewhere.

+
The path to a file that contains JSON data.

+
Use this option to define a run_list object. For example, a JSON file similar to:

+
"run_list": [
+  "recipe[base]",
+  "recipe[foo]",
+  "recipe[bar]",
+  "role[webserver]"
+],
+

+

+
may be used by running chef-client -j path/to/file.json.

+
In certain situations this option may be used to update normal attributes.

+

+
Warning

+
Any other attribute type that is contained in this JSON file will be treated as a normal attribute. For example, attempting to update override attributes using the -j option:

+
{
+  "name": "dev-99",
+  "description": "Install some stuff",
+  "override_attributes": {
+    "apptastic": {
+      "enable_apptastic": "false",
+      "apptastic_tier_name": "dev-99.bomb.com"
+    }
+  }
+}
+

+

+
will result in a node object similar to:

+
{
+  "name": "maybe-dev-99",
+  "normal": {
+  "name": "dev-99",
+    "description": "Install some stuff",
+    "override_attributes": {
+      "apptastic": {
+        "enable_apptastic": "false",
+        "apptastic_tier_name": "dev-99.bomb.com"
+      }
+    }
+  }
+}
+

+

+

+

 
-l LEVEL, --log_level LEVEL

 
The level of logging that will be stored in a log file.

 
-L LOGLOCATION, --logfile c

@@ -104,7 +150,7 @@
 
--run-lock-timeout SECONDS

 
The amount of time (in seconds) to wait for a chef-client run to finish. Default value: not set (indefinite). Set to 0 to cause a second chef-client to exit immediately.

 
-s SECONDS, --splay SECONDS

-
A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time.

+
A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef-client is run at intervals, --splay and --interval values are applied before the chef-client run.

 
-u USER, --user USER

 
The user that owns a process. This is required when starting any executable as a daemon.

 
-v, --version

diff --git a/distro/common/html/index.html b/distro/common/html/index.html
index 370c34f5f5..2742b07e03 100644
--- a/distro/common/html/index.html
+++ b/distro/common/html/index.html
@@ -44,7 +44,7 @@
 
The following command line interfaces are available in the chef-client:

 
    
 
  • chef-client
    • 
-
  • chef-server-ctl
    • 
+
  • chef-server-ctl (executable)
    • 
 
  • chef-shell
    • 
 
  • chef-solo
    • 
 
  • knife
    • 
@@ -128,7 +128,7 @@
 The knife node subcommand is used to manage the nodes that exist on a Chef server.
 
 knife raw
-The knife raw subcommand is used to send a REST request to a specified path using the Chef server API.
+The knife raw subcommand is used to send a REST request to an endpoint in the Chef server API.
 
 knife recipe list
 The knife recipe list subcommand is used to view all of the recipes that are on a Chef 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 (/).
diff --git a/distro/common/html/knife.html b/distro/common/html/knife.html
index 140edc125b..5a081702fc 100644
--- a/distro/common/html/knife.html
+++ b/distro/common/html/knife.html
@@ -118,7 +118,7 @@
 The knife node subcommand is used to manage the nodes that exist on a Chef server.
 
 knife raw
-The knife raw subcommand is used to send a REST request to a specified path using the Chef server API.
+The knife raw subcommand is used to send a REST request to an endpoint in the Chef server API.
 
 knife recipe list
 The knife recipe list subcommand is used to view all of the recipes that are on a Chef 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 (/).
diff --git a/distro/common/html/knife_bootstrap.html b/distro/common/html/knife_bootstrap.html
index ea1a1cf153..5e3d70404f 100644
--- a/distro/common/html/knife_bootstrap.html
+++ b/distro/common/html/knife_bootstrap.html
@@ -83,19 +83,31 @@
 
    The version of the chef-client to install.
    
 
    --bootstrap-wget-options OPTIONS
    
 
    Use to specify arbitrary options to be added to the bootstrap command when using GNU Wget. This option may not be used in the same command with --bootstrap-install-command.
    
-
    -d DISTRO, --distro DISTRO
    
-
    The template file to be used during a bootstrap operation. The following distributions are supported: chef-full (the default bootstrap), centos5-gems, fedora13-gems, ubuntu10.04-gems, ubuntu10.04-apt, ubuntu12.04-gems, and the name of a custom bootstrap template file. When this option is used, knife will search for the template file in the following order: the bootstrap/ folder in the current working directory, the bootstrap/ folder in the chef-repo, the bootstrap/ folder in the ~/.chef/ directory, or a default bootstrap file. Do not use the --template-file option when --distro is specified.
    
-
    
-
    Warning
    
-
    The default bootstrap operation uses the omnibus installer, which means the default template file (chef-full) should work on all supported platforms. It is recommended to use custom bootstrap templates only when the omnibus installer cannot be used. The .erb file extension is added automatically and should not be passed as part of the bootstrap command.
    
-
    
-
    
 
    -E ENVIRONMENT, --environment ENVIRONMENT
    
 
    The name of the environment. When this option is added to a command, the command will run only against the named environment.
    
 
    -G GATEWAY, --ssh-gateway GATEWAY
    
 
    The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation.
    
 
    --hint HINT_NAME[=HINT_FILE]
    
-
    An Ohai hint to be set on the target of the bootstrap. The hint is contained in a file and is formatted as JSON: {"attribute":"value","attribute":"value"...}. HINT_NAME is the name of the hint and HINT_FILE is the name of the hint file located at /etc/chef/ohai/hints/HINT_FILE.json. Use multiple --hint options in the command to specify multiple hints.
    
+
    Use to specify an Ohai hint to be set on the target node.
    
+
    Ohai hints are used to tell Ohai something about the system that it is running on that it would not be able to discover itself. An Ohai hint exists if a JSON file exists in the hint directory with the same name as the hint. For example, calling hint?('antartica') in an Ohai plugin would return an empty hash if the file antartica.json existed in the hints directory, and return nil if the file does not exist.
    
+
    If the hint file contains JSON content, it will be returned as a hash from the call to hint?.
    
+
    {
+  "snow": true,
+  "penguins": "many"
+}
+
    
+
    
+
    arctic_hint = hint?('antartica')
+if arctic_hint['snow']
+  "There are #{arctic_hint['penguins']} penguins here."
+else
+  "There is no snow here, and penguins like snow."
+end
+
    
+
    
+
    The default directory in which hint files are located is /etc/chef/ohai/hints/. Use the Ohai::Config[:hints_path] setting in the client.rb file to customize this location.
    
+
    HINT_FILE is the name of the JSON file. HINT_NAME is the name of a hint in a JSON file. Use multiple --hint options to specify multiple hints.
    
+
    
 
    -i IDENTITY_FILE, --identity-file IDENTITY_FILE
    
 
    The SSH identity file used for authentication. Key-based authentication is recommended.
    
 
    -j JSON_ATTRIBS, --json-attributes JSON_ATTRIBS
    
@@ -104,6 +116,14 @@
 
    The name of the node.
    
 
    --[no-]host-key-verify
    
 
    Use --no-host-key-verify to disable host key verification. Default setting: --host-key-verify.
    
+
    --[no-]node-verify-api-cert
    
+
    Use verify_api_cert to only do SSL validation of the Chef server connection; may be needed if the chef-client needs to talk to other services that have broken SSL certificates. If this option is not specified, the setting for verify_api_cert in the configuration file is applied.
    
+
    --node-ssl-verify-mode PEER_OR_NONE
    
+
    The verify mode for HTTPS requests.
    
+
    Use :verify_none to do no validation of SSL certificates.
    
+
    Use :verify_peer to do validation of all SSL certificates, including the Chef server connections, S3 connections, and any HTTPS remote_file resource URLs used in the chef-client run. This is the recommended setting.
    
+
    If this option is not specified, the setting for ssl_verify_mode in the configuration file is applied.
    
+
    
 
    -p PORT, --ssh-port PORT
    
 
    The SSH port.
    
 
    -P PASSWORD, --ssh-password PASSWORD
    
@@ -118,8 +138,8 @@
 
    The path to the file that contains the encryption key.
    
 
    --sudo
    
 
    Use to execute a bootstrap operation with sudo.
    
-
    --template-file TEMPLATE
    
-
    The path to a template file that will be used during a bootstrap operation. Do not use the --distro option when --template-file is specified.
    
+
    -t TEMPLATE, --bootstrap-template TEMPLATE
    
+
    Use to specify the bootstrap template to use. This may specify the name of a bootstrap template—chef-full, for example—or it may specify the full path to an Embedded Ruby (ERB) template that defines a custom bootstrap. Default value: chef-full, which installs the chef-client using the omnibus installer on all supported platforms.
    
 
    --use-sudo-password
    
 
    Use to perform a bootstrap operation with sudo; specify the password with the -P (or --ssh-password) option.
    
 
    -V -V
    
diff --git a/distro/common/html/knife_cookbook_site.html b/distro/common/html/knife_cookbook_site.html
index 72bb03582d..8815961629 100644
--- a/distro/common/html/knife_cookbook_site.html
+++ b/distro/common/html/knife_cookbook_site.html
@@ -263,6 +263,8 @@ kickstart:
 
    
 
    CATEGORY
    
 
    The cookbook category: "Databases", "Web Servers", "Process Management", "Monitoring & Trending", "Programming Languages", "Package Management", "Applications", "Networking", "Operating Systems & Virtualization", "Utilities", or "Other".
    
+
    -n, --dry-run
    
+
    Use to take no action and only print out results. Default: false.
    
 
    -o PATH:PATH, --cookbook-path PATH:PATH
    
 
    The directory in which cookbooks are created. This can be a colon-separated path.
    
 
    
diff --git a/distro/common/html/knife_data_bag.html b/distro/common/html/knife_data_bag.html
index d56fc589ad..a7a297be95 100644
--- a/distro/common/html/knife_data_bag.html
+++ b/distro/common/html/knife_data_bag.html
@@ -65,7 +65,7 @@
 
    DATA_BAG_ITEM
    
 
    The name of a specific item within a data bag.
    
 
    --secret SECRET
    
-
    The encryption key that is used for values contained within a data bag item.
    
+
    The encryption key that is used for values contained within a data bag item. If secret is not specified, the chef-client will look for a secret at the path specified by the encrypted_data_bag_secret setting in the client.rb file.
    
 
    --secret-file FILE
    
 
    The path to the file that contains the encryption key.
@@ -138,7 +138,7 @@
DATA_BAG_ITEM
The name of a specific item within a data bag.
--secret SECRET
-
The encryption key that is used for values contained within a data bag item.
+
The encryption key that is used for values contained within a data bag item. If secret is not specified, the chef-client will look for a secret at the path specified by the encrypted_data_bag_secret setting in the client.rb file.
--secret-file FILE
The path to the file that contains the encryption key.
@@ -219,7 +219,7 @@
-a, --all
Use to upload all data bags found at the specified path.
--secret SECRET
-
The encryption key that is used for values contained within a data bag item.
+
The encryption key that is used for values contained within a data bag item. If secret is not specified, the chef-client will look for a secret at the path specified by the encrypted_data_bag_secret setting in the client.rb file.
--secret-file FILE
The path to the file that contains the encryption key.
@@ -287,7 +287,7 @@
DATA_BAG_ITEM
The name of a specific item within a data bag.
--secret SECRET
-
The encryption key that is used for values contained within a data bag item.
+
The encryption key that is used for values contained within a data bag item. If secret is not specified, the chef-client will look for a secret at the path specified by the encrypted_data_bag_secret setting in the client.rb file.
--secret-file FILE
The path to the file that contains the encryption key.
diff --git a/distro/common/html/knife_node.html b/distro/common/html/knife_node.html index 755f8ee418..a3d7a51d1c 100644 --- a/distro/common/html/knife_node.html +++ b/distro/common/html/knife_node.html @@ -367,9 +367,9 @@ rs-123456
-a ATTR, --attribute ATTR
The attribute (or attributes) to show.
-l, --long
-
Display long output when searching nodes while using the default summary format.
+
Use to display all attributes in the output and to show the output as JSON.
-m, --medium
-
Display more, but not all, of a node’s data when searching using the default summary format.
+
Use to display normal attributes in the output and to show the output as JSON.
-r, --run-list
Use to show only the run-list.
diff --git a/distro/common/html/knife_raw.html b/distro/common/html/knife_raw.html index b199acae95..e661e9a84a 100644 --- a/distro/common/html/knife_raw.html +++ b/distro/common/html/knife_raw.html @@ -41,7 +41,7 @@

knife raw

-

The knife raw subcommand is used to send a REST request to a specified path using the Chef server API.

+

The knife raw subcommand is used to send a REST request to an endpoint in the Chef server API.

Syntax

This subcommand has the following syntax:

diff --git a/distro/common/html/knife_role.html b/distro/common/html/knife_role.html index 8f7fb52ceb..844de48d37 100644 --- a/distro/common/html/knife_role.html +++ b/distro/common/html/knife_role.html @@ -41,7 +41,7 @@

knife role

-

A role is a way to define certain patterns and processes that exist across nodes in an organization as belonging to a single job function. Each role consists of zero (or more) attributes and a run list. Each node can have zero (or more) roles assigned to it. When a role is run against a node, the configuration details of that node are compared against the attributes of the role, and then the contents of that role’s run list are applied to the node’s configuration details. When a chef-client runs, it merges its own attributes and run lists with those contained within each assigned role.

+

A role is a way to define certain patterns and processes that exist across nodes in an organization as belonging to a single job function. Each role consists of zero (or more) attributes and a run-list. Each node can have zero (or more) roles assigned to it. When a role is run against a node, the configuration details of that node are compared against the attributes of the role, and then the contents of that role’s run-list are applied to the node’s configuration details. When a chef-client runs, it merges its own attributes and run-lists with those contained within each assigned role.

The knife role subcommand is used to manage the roles that are associated with one or more nodes on a Chef server.

Note

diff --git a/distro/common/html/knife_search.html b/distro/common/html/knife_search.html index 2444c4845f..c5006d155e 100644 --- a/distro/common/html/knife_search.html +++ b/distro/common/html/knife_search.html @@ -41,7 +41,7 @@