chef 11.10.0.rc.0 → 11.10.0.rc.1

data/distro/common/man/man1/knife-client.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-CLIENT" "1" "Chef 11.8.0" "" "knife client"
+.TH "KNIFE-CLIENT" "1" "Chef 11.10.0" "" "knife client"
 .SH NAME
 knife-client \- The man page for the knife client subcommand.
 .
@@ -36,14 +36,6 @@ When a node runs the chef\-client for the first time, it generally does not yet
 Once the chef\-client has registered itself with the server, it no longer uses the validation client for anything. It is recommended that you delete the private key for the chef\-validator from the host after the host has registered or use the \fBdelete_validation\fP recipe that can be found in the \fBchef\-client\fP cookbook (\fI\%https://github.com/opscode-cookbooks/chef-client\fP).
 .sp
 The \fBknife client\fP subcommand is used to manage an API client list and their associated RSA public key\-pairs. This allows authentication requests to be made to the server by any entity that uses the Chef Server API, such as the chef\-client and Knife.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife client [ARGUMENT] (options)
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife client\fP subcommand:

data/distro/common/man/man1/knife-configure.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-CONFIGURE" "1" "Chef 11.8.0" "" "knife configure"
+.TH "KNIFE-CONFIGURE" "1" "Chef 11.10.0" "" "knife configure"
 .SH NAME
 knife-configure \- The man page for the knife configure subcommand.
 .
@@ -35,7 +35,7 @@ The \fBknife configure\fP subcommand is used to create the knife.rb and client.r
 .sp
 \fBSyntax\fP
 .sp
-This argument has the following syntax:
+This argument has the following syntax when creating a knife.rb file:
 .sp
 .nf
 .ft C
@@ -43,6 +43,14 @@ $ knife configure (options)
 .ft P
 .fi
 .sp
+and the following syntax when creating a client.rb file:
+.sp
+.nf
+.ft C
+$ knife configure client DIRECTORY
+.ft P
+.fi
+.sp
 \fBOptions\fP
 .sp
 This subcommand has the following options:
@@ -120,16 +128,12 @@ Indicates that the chef\-client will be run in local mode, which allows all comm
 .sp
 \fBExamples\fP
 .sp
-To create a knife.rb file, enter:
-.sp
 .nf
 .ft C
 $ knife configure
 .ft P
 .fi
 .sp
-To configure a client.rb, enter:
-.sp
 .nf
 .ft C
 $ knife configure client \(aq/directory\(aq

data/distro/common/man/man1/knife-cookbook-site.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.8.0" "" "knife cookbook site"
+.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 11.10.0" "" "knife cookbook site"
 .SH NAME
 knife-cookbook-site \- The man page for the knife cookbook site subcommand.
 .
@@ -34,14 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%https://cookbooks.opscode.com\fP. All of the cookbooks in the community are accessible through a REST API located at \fI\%https://cookbooks.opscode.com/api/v1/\fP by using any of the supported endpoints. In most cases, using Knife and the \fBknife cookbook site\fP sub\-command (and any of its arguments) is the recommended method of interacting with these cookbooks, but in some cases, using the REST API directly may make sense.
 .sp
 The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%https://cookbooks.opscode.com\fP. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: \fBdownload\fP, \fBsearch\fP, \fBinstall\fP, and \fBlist\fP.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife cookbook site [ARGUMENT] (options)
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife cookbook site\fP subcommand:

data/distro/common/man/man1/knife-cookbook.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-COOKBOOK" "1" "Chef 11.8.0" "" "knife cookbook"
+.TH "KNIFE-COOKBOOK" "1" "Chef 11.10.0" "" "knife cookbook"
 .SH NAME
 knife-cookbook \- The man page for the knife cookbook subcommand.
 .
@@ -54,14 +54,6 @@ Metadata about recipes (including dependencies), version constraints, supported
 .UNINDENT
 .sp
 The \fBknife cookbook\fP subcommand is used to interact with cookbooks that are located on the server or the local chef\-repo.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife cookbook [ARGUMENT] (options)
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife cookbook\fP subcommand:
@@ -143,7 +135,7 @@ Indicates that a cookbook (or cookbook version) will be removed entirely from th
 .sp
 \fBExamples\fP
 .sp
-To bulk delete many cookbooks, use a regular expression to define the pattern:
+Use a regular expression to define the pattern used to bulk delete cookbooks:
 .sp
 .nf
 .ft C
@@ -265,7 +257,13 @@ Indicates that a cookbook (or cookbook version) will be removed entirely from th
 .sp
 \fBExamples\fP
 .sp
-To delete version "0.8" from a cookbook named "smartmon", enter:
+.nf
+.ft C
+$ knife cookbook delete cookbook_name version
+.ft P
+.fi
+.sp
+For example:
 .sp
 .nf
 .ft C
@@ -375,8 +373,6 @@ The directory in which cookbook are created. This can be a colon\-separated path
 .sp
 \fBExamples\fP
 .sp
-To generate metadata for all cookbooks:
-.sp
 .nf
 .ft C
 $ knife cookbook metadata \-a
@@ -402,8 +398,6 @@ This command does not have any specific options.
 .sp
 \fBExamples\fP
 .sp
-To view cookbook metadata from a JSON file:
-.sp
 .nf
 .ft C
 $ knife cookbook metadta from file /path/to/file
@@ -553,11 +547,9 @@ The directory in which cookbook are created. This can be a colon\-separated path
 .sp
 \fBExamples\fP
 .sp
-To test a cookbook named "getting\-started", enter:
-.sp
 .nf
 .ft C
-$ knife cookbook test getting\-started
+$ knife cookbook test cookbook_name
 .ft P
 .fi
 .SH UPLOAD
@@ -600,11 +592,9 @@ The directory in which cookbook are created. This can be a colon\-separated path
 .sp
 \fBExamples\fP
 .sp
-To upload a cookbook named "getting\-started":
-.sp
 .nf
 .ft C
-$ knife cookbook upload getting\-started
+$ knife cookbook upload cookbook_name
 .ft P
 .fi
 .sp

data/distro/common/man/man1/knife-data-bag.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-DATA-BAG" "1" "Chef 11.8.0" "" "knife data bag"
+.TH "KNIFE-DATA-BAG" "1" "Chef 11.10.0" "" "knife data bag"
 .SH NAME
 knife-data-bag \- The man page for the knife data bag subcommand.
 .
@@ -33,17 +33,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .sp
 A data bag is a global variable that is stored as JSON data and is accessible from a server. A data bag is indexed for searching and can be loaded by a recipe or accessed during a search. The contents of a data bag can vary, but they often include sensitive information (such as database passwords).
 .sp
-The contents of a data bag can be encrypted using \fI\%shared secret encryption\fP. This allows a data bag to store confidential information (such as a database password) or to be managed in a source control system (without plain\-text data appearing in revision history).
+A data bag item may be encrypted using \fI\%shared secret encryption\fP. This allows each data bag item to store confidential information (such as a database password) or to be managed in a source control system (without plain\-text data appearing in revision history). Each data bag item may be encrypted individually; if a data bag contains multiple encrypted data bag items, these data bag items are not required to share the same encryption keys.
 .sp
 The \fBknife data bag\fP subcommand is used to manage arbitrary stores of globally available JSON data.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife data bag [ARGUMENT] (options)
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife data bag\fP subcommand:
@@ -123,7 +115,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.
+The encryption key that is used for values contained within a data bag item.
 .TP
 .B \fB\-\-secret\-file FILE\fP
 The path to the file that contains the encryption key.
@@ -174,11 +166,9 @@ The name of a specific item within a data bag.
 .sp
 \fBExamples\fP
 .sp
-To a data bag named "admins", enter:
-.sp
 .nf
 .ft C
-$ knife data bag delete admins
+$ knife data bag delete data_bag_name
 .ft P
 .fi
 .sp
@@ -214,7 +204,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.
+The encryption key that is used for values contained within a data bag item.
 .TP
 .B \fB\-\-secret\-file FILE\fP
 The path to the file that contains the encryption key.
@@ -298,7 +288,7 @@ This argument has the following options:
 Indicates that all data bags found at the specified path will be uploaded.
 .TP
 .B \fB\-\-secret SECRET\fP
-The encryption key that is used for values contained within a data bag.
+The encryption key that is used for values contained within a data bag item.
 .TP
 .B \fB\-\-secret\-file FILE\fP
 The path to the file that contains the encryption key.
@@ -349,8 +339,6 @@ Indicates that the corresponding URIs will be shown.
 .sp
 \fBExamples\fP
 .sp
-For example, to view a list of data bags on the server, enter:
-.sp
 .nf
 .ft C
 $ knife data bag list
@@ -379,7 +367,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.
+The encryption key that is used for values contained within a data bag item.
 .TP
 .B \fB\-\-secret\-file FILE\fP
 The path to the file that contains the encryption key.
@@ -390,15 +378,13 @@ For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret
 .sp
 \fBExamples\fP
 .sp
-To show the contents of a data bag, enter:
-.sp
 .nf
 .ft C
 $ knife data bag show admins
 .ft P
 .fi
 .sp
-to return:
+to return something like:
 .sp
 .nf
 .ft C

data/distro/common/man/man1/knife-delete.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-DELETE" "1" "Chef 11.8.0" "" "knife delete"
+.TH "KNIFE-DELETE" "1" "Chef 11.10.0" "" "knife delete"
 .SH NAME
 knife-delete \- The man page for the knife delete subcommand.
 .

data/distro/common/man/man1/knife-deps.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-DEPS" "1" "Chef 11.8.0" "" "knife deps"
+.TH "KNIFE-DEPS" "1" "Chef 11.10.0" "" "knife deps"
 .SH NAME
 knife-deps \- The man page for the knife deps subcommand.
 .
@@ -120,32 +120,24 @@ Indicates that the chef\-client will be run in local mode, which allows all comm
 .sp
 \fBExamples\fP
 .sp
-To find the dependencies for a node:
-.sp
 .nf
 .ft C
 $ knife deps nodes/node_name.json
 .ft P
 .fi
 .sp
-To find the dependencies for a role:
-.sp
 .nf
 .ft C
 $ knife deps roles/role_name.json
 .ft P
 .fi
 .sp
-To find the dependencies for a cookbook:
-.sp
 .nf
 .ft C
 $ knife deps cookbooks/cookbook_name.json
 .ft P
 .fi
 .sp
-To find the dependencies for an environment:
-.sp
 .nf
 .ft C
 $ knife deps environments/environment_name.json
@@ -160,7 +152,7 @@ $ knife deps cookbooks/git.json cookbooks/github.json roles/base.json environmen
 .ft P
 .fi
 .sp
-To use a wildcard to return all the child nodes:
+A wildcard can be used to return all of the child nodes. For example, all of the environments:
 .sp
 .nf
 .ft C
@@ -189,7 +181,7 @@ roles/webserver.json
 .ft P
 .fi
 .sp
-To pass the output of \fBknife deps\fP to \fBknife upload\fP, do something like the following:
+The output of \fBknife deps\fP can be passed to \fBknife upload\fP:
 .sp
 .nf
 .ft C
@@ -197,7 +189,7 @@ $ knife upload \(gaknife deps nodes/*.json
 .ft P
 .fi
 .sp
-To pass the output of \fBknife deps\fP to \fBknife xargs\fP:
+The output of \fBknife deps\fP can be passed to \fBknife xargs\fP:
 .sp
 .nf
 .ft C

data/distro/common/man/man1/knife-diff.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-DIFF" "1" "Chef 11.8.0" "" "knife diff"
+.TH "KNIFE-DIFF" "1" "Chef 11.10.0" "" "knife diff"
 .SH NAME
 knife-diff \- The man page for the knife diff subcommand.
 .

data/distro/common/man/man1/knife-download.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-DOWNLOAD" "1" "Chef 11.8.0" "" "knife download"
+.TH "KNIFE-DOWNLOAD" "1" "Chef 11.10.0" "" "knife download"
 .SH NAME
 knife-download \- The man page for the knife download subcommand.
 .
@@ -31,7 +31,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" Man page generated from reStructuredText.
 .
 .sp
-The \fBknife download\fP subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the server to the current working directory.. It can be used to back up data on the server, inspect the state of one or more files, or to extract out\-of\-process changes users may have made to files on the server, such as if a user made a change that bypassed version source control. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be downloaded, and then \fBknife upload\fP, which does the opposite of \fBknife download\fP.
+The \fBknife download\fP subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the server to the current working directory. It can be used to back up data on the server, inspect the state of one or more files, or to extract out\-of\-process changes users may have made to files on the server, such as if a user made a change that bypassed version source control. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be downloaded, and then \fBknife upload\fP, which does the opposite of \fBknife download\fP.
 .sp
 \fBSyntax\fP
 .sp

data/distro/common/man/man1/knife-edit.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-EDIT" "1" "Chef 11.8.0" "" "knife edit"
+.TH "KNIFE-EDIT" "1" "Chef 11.10.0" "" "knife edit"
 .SH NAME
 knife-edit \- The man page for the knife edit subcommand.
 .

data/distro/common/man/man1/knife-environment.1

@@ -1,4 +1,4 @@
-.TH "KNIFE-ENVIRONMENT" "1" "Chef 11.8.0" "" "knife environment"
+.TH "KNIFE-ENVIRONMENT" "1" "Chef 11.10.0" "" "knife environment"
 .SH NAME
 knife-environment \- The man page for the knife environment subcommand.
 .
@@ -34,14 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 An environment is a way to map an organization\(aqs real\-life workflow to what can be configured and managed when using server. Every organization begins with a single environment called the \fB_default\fP environment, which cannot be modified (or deleted). Additional environments can be created to reflect each organization\(aqs patterns and workflow. For example, creating \fBproduction\fP, \fBstaging\fP, \fBtesting\fP, and \fBdevelopment\fP environments. Generally, an environment is also associated with one (or more) cookbook versions.
 .sp
 The \fBknife environment\fP subcommand is used to manage environments within a single organization on the server.
-.sp
-This subcommand has the following syntax:
-.sp
-.nf
-.ft C
-$ knife environment [ARGUMENT] (options)
-.ft P
-.fi
 .SH COMMON OPTIONS
 .sp
 The following options may be used with any of the arguments available to the \fBknife environment\fP subcommand:
@@ -98,6 +90,113 @@ Indicates that the response to all confirmation prompts will be "Yes" (and that
 .B \fB\-z\fP, \fB\-\-local\-mode\fP
 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.
 .UNINDENT
+.SH COMPARE
+.sp
+The \fBcompare\fP argument is used to compare the cookbook version constraints that are set on one (or more) environments.
+.sp
+\fBSyntax\fP
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+$ knife environment compare [ENVIRONMENT_NAME...] (options)
+.ft P
+.fi
+.sp
+\fBOptions\fP
+.sp
+This argument has the following options:
+.INDENT 0.0
+.TP
+.B \fB\-a\fP, \fB\-\-all\fP
+Indicates that all environments found at the specified path will be uploaded.
+.TP
+.B \fB\-m\fP, \fB\-\-mismatch\fP
+Use to show only matching versions.
+.UNINDENT
+.sp
+\fBExample\fP
+.sp
+To compare cookbook versions for a single environment:
+.sp
+.nf
+.ft C
+$ knife environment compare development
+.ft P
+.fi
+.sp
+to return something similar to:
+.sp
+.nf
+.ft C
+           development
+apache     2.3.1
+windows    4.1.2
+.ft P
+.fi
+.sp
+To compare cookbook versions for multiple environments:
+.sp
+.nf
+.ft C
+$ knife environment compare development staging
+.ft P
+.fi
+.sp
+to return something similar to:
+.sp
+.nf
+.ft C
+              development    staging
+apache        2.3.1          1.2.2
+windows       4.1.2          1.0.0
+postgresql    1.0.0          1.0.0
+.ft P
+.fi
+.sp
+To compare all cookbook versions for all environments:
+.sp
+.nf
+.ft C
+$ knife environment compare \-\-all
+.ft P
+.fi
+.sp
+to return something similar to:
+.sp
+.nf
+.ft C
+                   staging  development
+ulimit             latest   latest
+redisio            latest   latest
+journly            latest   latest
+aws                latest   latest
+test               latest   latest
+unicorn            latest   latest
+sensu              latest   latest
+runit              latest   latest
+templater          latest   latest
+powershell         latest   latest
+openssl            latest   latest
+rbenv              latest   latest
+rabbitmq           latest   latest
+postgresql         latest   latest
+mysql              latest   latest
+ohai               latest   latest
+git                latest   latest
+erlang             latest   latest
+ssh_known_hosts    latest   latest
+nginx              latest   latest
+database           latest   latest
+yum                latest   latest
+xfs                latest   latest
+apt                latest   latest
+dmg                latest   latest
+chef_handler       latest   latest
+windows            1.0.0    4.1.2
+.ft P
+.fi
 .SH CREATE
 .sp
 The \fBcreate\fP argument is used to add an environment object to the server. When this argument is run, Knife will open $EDITOR to enable editing of the \fBENVIRONMENT\fP description field (unless a description is specified as part of the command). When finished, Knife will add the environment to the server.