diff options
Diffstat (limited to 'distro/common/man/man1')
33 files changed, 0 insertions, 9400 deletions
diff --git a/distro/common/man/man1/README.md b/distro/common/man/man1/README.md deleted file mode 100644 index 9a915fb4cc..0000000000 --- a/distro/common/man/man1/README.md +++ /dev/null @@ -1,58 +0,0 @@ -# Man pages for Knife - -The source of the Chef Documentation is located at -http://docs.opscode.com/. - -This README documents how the man pages for all of the Knife subcommands -that are built into the chef-client are managed. - -## Source Files - -The source files are located in the chef-docs repository: -https://github.com/opscode/chef-docs - -Each Knife subcommand has its own source folder. The folder naming -pattern begins with man_. - -Each man page is a single file called index.html. - -In the conf.py file, the following settings are unique to each man page: - -`today` setting is used to define the Chef version. This is because we -don't want an arbitrary date populated in the file, yet we still need a -version number. For example: `today = 'Chef 11.8`. - -`project` setting is set to be the same as the name of the subcommand. -For example: `project = u'knife-foo'`. - -`Options for man page output` settings are set to be similar across all -man pages, but each one needs to be tailored specifically for the name -of the man page. - -All of the other settings in the General Configuration section should be -left alone. These exist to ensure that all of the doc builds are sharing -the right common elements and have the same overall presentation. - -## Building Docs - -The docs are built using Sphinx and must be set to the `-b man` output. -Currently, the man pages are built locally and then added to the Chef -builds in chef-master. - -## Editing - -These files should never be edited. All of the content is pulled in from -elsewhere in the chef-docs repo at build time. If changes need to be -made, those changes are done elsewhere and then the man pages must be -rebuilt. This is to help ensure that all of the changes are made across -all of the locations in which these documents need to live. For example, -by design, every Knife subcommand with a man page also has an HTML doc -at docs.opscode.com/knife_foo.html. - -## License - -[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/) - -## Questions? - -Open an [Issue](https://github.com/opscode/chef-docs/issues) and ask. diff --git a/distro/common/man/man1/chef-shell.1 b/distro/common/man/man1/chef-shell.1 deleted file mode 100644 index df004c5b0f..0000000000 --- a/distro/common/man/man1/chef-shell.1 +++ /dev/null @@ -1,194 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "CHEF-SHELL" "1" "Chef 12.0" "" "chef-shell" -.SH NAME -chef-shell \- The man page for the chef-shell command line tool. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -chef\-shell is a recipe debugging tool that allows the use of breakpoints within recipes. chef\-shell runs as an Interactive Ruby (IRb) session. chef\-shell supports both recipe and attribute file syntax, as well as interactive debugging features. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -chef\-shell is the new name for Shef as of Chef 11.x\&. chef\-shell is backwards compatible and aside from the name change, has the same set of functionality as with previous releases. -.UNINDENT -.UNINDENT -.sp -The chef\-shell executable is run as a command\-line tool. -.SH MODES -.sp -chef\-shell is tool that allows knife to be run using an Interactive Ruby (IRb) session. chef\-shell currently supports recipe and attribute file syntax, as well as interactive debugging features. chef\-shell has three run modes: -.TS -center; -|l|l|. -_ -T{ -Mode -T} T{ -Description -T} -_ -T{ -Standalone -T} T{ -No cookbooks are loaded, and the run list is empty. This mode is the default. -T} -_ -T{ -Solo -T} T{ -chef\-shell acts as a chef\-solo client. It attempts to load the chef\-solo configuration file and JSON attributes. If the JSON attributes set a run list, it will be honored. Cookbooks will be loaded in the same way that chef\-solo loads them. chef\-solo mode is activated with the \fB\-s\fP or \fB\-\-solo\fP command line option, and JSON attributes are specified in the same way as for chef\-solo, with \fB\-j /path/to/chef\-solo.json\fP\&. -T} -_ -T{ -Client -T} T{ -chef\-shell acts as a chef\-client\&. During startup, it reads the chef\-client configuration file and contacts the Chef server to get attributes and cookbooks. The run list will be set in the same way as normal chef\-client runs. chef\-client mode is activated with the \fB\-z\fP or \fB\-\-client\fP options. You can also specify the configuration file with \fB\-c CONFIG\fP and the server URL with \fB\-S SERVER_URL\fP\&. -T} -_ -.TE -.SH OPTIONS -.sp -This command has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -chef\-shell OPTION VALUE OPTION VALUE ... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -This command has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-standalone\fP -Use to run chef\-shell in standalone mode. -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-h\fP, \fB\-\-help\fP -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. -.TP -.B \fB\-s\fP, \fB\-\-solo\fP -Use to run chef\-shell in chef\-solo mode. -.TP -.B \fB\-S CHEF_SERVER_URL\fP, \fB\-\-server CHEF_SERVER_URL\fP -The URL for the Chef server\&. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.TP -.B \fB\-z\fP, \fB\-\-client\fP -Use to run chef\-shell in chef\-client mode. -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-bootstrap.1 b/distro/common/man/man1/knife-bootstrap.1 deleted file mode 100644 index a4a699872f..0000000000 --- a/distro/common/man/man1/knife-bootstrap.1 +++ /dev/null @@ -1,215 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-BOOTSTRAP" "1" "Chef 12.0" "" "knife bootstrap" -.SH NAME -knife-bootstrap \- The man page for the knife bootstrap subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -A bootstrap is a process that installs the chef\-client on a target system so that it can run as a chef\-client and communicate with a Chef server\&. -.sp -The \fBknife bootstrap\fP subcommand is used to run a bootstrap operation that installs the chef\-client on the target system. The bootstrap operation must specify the IP address or FQDN of the target system. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife bootstrap FQDN_or_IP_ADDRESS (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-A\fP, \fB\-\-forward\-agent\fP -Use to enable SSH agent forwarding. -.TP -.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\-\-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\-\-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\-\-bootstrap\-no\-proxy NO_PROXY_URL_or_IP\fP -A URL or IP address that specifies a location that should not be proxied. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -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 -.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\-\-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\-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\-\-hint HINT_NAME[=HINT_FILE]\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. -.TP -.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\-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 -.B \fB\-P PASSWORD\fP, \fB\-\-ssh\-password PASSWORD\fP -The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) knife will prompt for the password. -.TP -.B \fB\-\-prerelease\fP -Use to install pre\-release gems. -.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\-\-secret SECRET\fP -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. -.TP -.B \fB\-\-sudo\fP -Use to execute a bootstrap operation with sudo\&. -.TP -.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 \-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. -.UNINDENT -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife bootstrap 192.168.1.1 \-x username \-P PASSWORD \-\-sudo -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife bootstrap 192.168.1.1 \-x username \-i ~/.ssh/id_rsa \-\-sudo -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-client.1 b/distro/common/man/man1/knife-client.1 deleted file mode 100644 index 9dbd174c71..0000000000 --- a/distro/common/man/man1/knife-client.1 +++ /dev/null @@ -1,443 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-CLIENT" "1" "Chef 12.0" "" "knife client" -.SH NAME -knife-client \- The man page for the knife client subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -Every request made by the chef\-client to the Chef server must be an authenticated request using the Chef server API and a private key. When the chef\-client makes a request to the Chef server, the chef\-client authenticates each request using a private key located in \fB/etc/chef/client.pem\fP\&. -.sp -However, during the first chef\-client run, this private key does not exist. Instead, the chef\-client will attempt to use the private key assigned to the chef\-validator, located in \fB/etc/chef/validation.pem\fP\&. (If, for any reason, the chef\-validator is unable to make an authenticated request to the Chef server, the initial chef\-client run will fail.) -.sp -During the initial chef\-client run, the chef\-client will register with the Chef server using the private key assigned to the chef\-validator, after which the chef\-client will obtain a \fBclient.pem\fP private key for all future authentication requests to the Chef server\&. -.sp -After the initial chef\-client run has completed successfully, the chef\-validator is no longer required and may be deleted from the node. Use the \fBdelete_validation\fP recipe found in the \fBchef\-client\fP cookbook (\fI\%https://github.com/opscode\-cookbooks/chef\-client\fP) to remove the chef\-validator\&. -.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 Chef server by any entity that uses the Chef server API, such as the chef\-client and knife\&. -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife client\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.SH BULK DELETE -.sp -The \fBbulk delete\fP argument is used to delete any API client that matches a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (\fB/\fP). -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client bulk delete REGEX -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.SH CREATE -.sp -The \fBcreate\fP argument is used to create a new API client\&. This process will generate an RSA key pair for the named API client\&. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. -.INDENT 0.0 -.IP \(bu 2 -For the chef\-client, the private key should be copied to the system as \fB/etc/chef/client.pem\fP\&. -.IP \(bu 2 -For knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file. -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client create CLIENT_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-admin\fP -Use to create a client as an admin client. This is required for any user to access Open Source Chef as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&. -.TP -.B \fB\-f FILE\fP, \fB\-\-file FILE\fP -Use to save a private key to the specified file name. -.TP -.B \fB\-\-validator\fP -Use to create the client as the chef\-validator\&. Default value: \fBtrue\fP\&. -.UNINDENT -.sp -\fBExamples\fP -.sp -To create a chef\-client that can access the Chef server API as an administrator\-\-\-sometimes referred to as an "API chef\-client"\-\-\-with the name "exampleorg" and save its private key to a file, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client create exampleorg \-a \-f "/etc/chef/client.pem" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -When running the \fBcreate\fP argument on Enterprise Chef, be sure to omit the \fB\-a\fP option: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client create exampleorg \-f "/etc/chef/client.pem" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete a registered API client\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client delete CLIENT_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To delete a client with the name "client_foo", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client delete client_foo -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Type \fBY\fP to confirm a deletion. -.SH EDIT -.sp -The \fBedit\fP argument is used to edit the details of a registered API client\&. When this argument is run, knife will open $EDITOR to enable editing of the \fBadmin\fP attribute. (None of the other attributes should be changed using this argument.) When finished, knife will update the Chef server with those changes. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client edit CLIENT_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To edit a client with the name "exampleorg", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client edit exampleorg -.ft P -.fi -.UNINDENT -.UNINDENT -.SH LIST -.sp -The \fBlist\fP argument is used to view a list of registered API client\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client list (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -To verify the API client list for the Chef server, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something similar to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -exampleorg -i\-12345678 -rs\-123456 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To verify that an API client can authenticate to the -Chef server correctly, try getting a list of clients using \fB\-u\fP and \fB\-k\fP options to specify its name and private key: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client list \-u ORGNAME \-k .chef/ORGNAME.pem -.ft P -.fi -.UNINDENT -.UNINDENT -.SH REREGISTER -.sp -The \fBreregister\fP argument is used to regenerate an RSA key pair for an API client\&. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the Chef server\&. -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client reregister CLIENT_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Use to save a private key to the specified file name. -.UNINDENT -.sp -\fBExamples\fP -.sp -To regenerate the RSA key pair for a client named "testclient" and save it to a file named "rsa_key", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client regenerate testclient \-f rsa_key -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to show the details of an API client\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client show CLIENT_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP -The attribute (or attributes) to show. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view a client named "testclient", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife client show testclient -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -admin: false -chef_type: client -json_class: Chef::ApiClient -name: testclient -public_key: -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-configure.1 b/distro/common/man/man1/knife-configure.1 deleted file mode 100644 index 91eb69f1c6..0000000000 --- a/distro/common/man/man1/knife-configure.1 +++ /dev/null @@ -1,161 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-CONFIGURE" "1" "Chef 12.0" "" "knife configure" -.SH NAME -knife-configure \- The man page for the knife configure subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife configure\fP subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax when creating a knife.rb file: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife configure (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -and the following syntax when creating a client.rb file: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife configure client DIRECTORY -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-\-admin\-client\-key PATH\fP -The path to the private key used by the client, typically a file named \fBadmin.pem\fP\&. -.TP -.B \fB\-\-admin\-client\-name NAME\fP -The name of the client, typically the name of the admin client. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.TP -.B \fB\-i\fP, \fB\-\-initial\fP -Use to create a API client, typically an administrator client on a freshly\-installed Chef server\&. -.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\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-r REPO\fP, \fB\-\-repository REPO\fP -The path to the chef\-repo\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-\-validation\-client\-name NAME\fP -The name of the validation client. -.TP -.B \fB\-\-validation\-key PATH\fP -The path to the validation key used by the client, typically a file named \fBvalidation.pem\fP\&. -.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 -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife configure -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife configure client \(aq/directory\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-cookbook-site.1 b/distro/common/man/man1/knife-cookbook-site.1 deleted file mode 100644 index acfcf6b882..0000000000 --- a/distro/common/man/man1/knife-cookbook-site.1 +++ /dev/null @@ -1,552 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.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. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. All of the cookbooks in the community are accessible through a RESTful API located at \fI\%https://supermarket.getchef.com/api/v1/cookbooks\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 Cookbooks Site API directly may make sense. -.sp -The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%https://supermarket.getchef.com/cookbooks\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\&. -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife cookbook site\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.SH DOWNLOAD -.sp -The \fBdownload\fP argument is used to download a cookbook from the community website. A cookbook will be downloaded as a tar.gz archive and placed in the current working directory. If a cookbook (or cookbook version) has been deprecated and the \fB\-\-force\fP option is not used, knife will alert the user that the cookbook is deprecated and then will provide the name of the most recent non\-deprecated version of that cookbook. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site download COOKBOOK_NAME [COOKBOOK_VERSION] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBCOOKBOOK_VERSION\fP -The version of a cookbook to be downloaded. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, the most recent version of the cookbook will be downloaded. -.TP -.B \fB\-f FILE\fP, \fB\-\-file FILE\fP -The file to which a cookbook download is written. -.TP -.B \fB\-\-force\fP -Use to overwrite an existing directory. -.UNINDENT -.sp -\fBExamples\fP -.sp -To download the cookbook \fBgetting\-started\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site download getting\-started -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Downloading getting\-started from the cookbooks site at version 0.3.0 to - /Users/sdanna/opscodesupport/getting\-started\-0.3.0.tar.gz -Cookbook saved: /Users/sdanna/opscodesupport/getting\-started\-0.3.0.tar.gz -.ft P -.fi -.UNINDENT -.UNINDENT -.SH INSTALL -.sp -The \fBinstall\fP argument is used to install a cookbook that has been downloaded from the community site to a local git repository . This action uses the git version control system in conjunction with the \fI\%https://supermarket.getchef.com/cookbooks\fP site to install community\-contributed cookbooks to the local chef\-repo\&. Using this argument does the following: -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.IP 1. 3 -A new "pristine copy" branch is created in git for tracking the upstream. -.IP 2. 3 -All existing versions of a cookbook are removed from the branch. -.IP 3. 3 -The cookbook is downloaded from \fI\%https://supermarket.getchef.com/cookbooks\fP in the tar.gz format. -.IP 4. 3 -The downloaded cookbook is untarred and its contents are committed to git and a tag is created. -.IP 5. 3 -The "pristine copy" branch is merged into the master branch. -.UNINDENT -.UNINDENT -.UNINDENT -.sp -This process allows the upstream cookbook in the master branch to be modified while letting git maintain changes as a separate patch. When an updated upstream version becomes available, those changes can be merged while maintaining any local modifications. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site install COOKBOOK_NAME [COOKBOOK_VERSION] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-b\fP, \fB\-\-use\-current\-branch\fP -Use to ensure that the current branch is used. -.TP -.B \fB\-B BRANCH\fP, \fB\-\-branch BRANCH\fP -The name of the default branch. This will default to the master branch. -.TP -.B \fBCOOKBOOK_VERSION\fP -The version of the cookbook to be installed. If a version is not specified, the most recent version of the cookbook will be installed. -.TP -.B \fB\-D\fP, \fB\-\-skip\-dependencies\fP -Use to ensure that all cookbooks to which the installed cookbook has a dependency will not be installed. -.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 -.sp -\fBExamples\fP -.sp -To install the cookbook \fBgetting\-started\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site install getting\-started -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Installing getting\-started to /Users/sdanna/opscodesupport/.chef/../cookbooks -Checking out the master branch. -Creating pristine copy branch chef\-vendor\-getting\-started -Downloading getting\-started from the cookbooks site at version 0.3.0 to - /Users/sdanna/opscodesupport/.chef/../cookbooks/getting\-started.tar.gz -Cookbook saved: /Users/sdanna/opscodesupport/.chef/../cookbooks/getting\-started.tar.gz -Removing pre\-existing version. -Uncompressing getting\-started version /Users/sdanna/opscodesupport/.chef/../cookbooks. -removing downloaded tarball -1 files updated, committing changes -Creating tag cookbook\-site\-imported\-getting\-started\-0.3.0 -Checking out the master branch. -Updating 4d44b5b..b4c32f2 -Fast\-forward - cookbooks/getting\-started/README.rdoc | 4 +++ - cookbooks/getting\-started/attributes/default.rb | 1 + - cookbooks/getting\-started/metadata.json | 29 ++++++++++++++++++++ - cookbooks/getting\-started/metadata.rb | 6 ++++ - cookbooks/getting\-started/recipes/default.rb | 23 +++++++++++++++ - .../templates/default/chef\-getting\-started.txt.erb | 5 +++ - 6 files changed, 68 insertions(+), 0 deletions(\-) - create mode 100644 cookbooks/getting\-started/README.rdoc - create mode 100644 cookbooks/getting\-started/attributes/default.rb - create mode 100644 cookbooks/getting\-started/metadata.json - create mode 100644 cookbooks/getting\-started/metadata.rb - create mode 100644 cookbooks/getting\-started/recipes/default.rb - create mode 100644 cookbooks/getting\-started/templates/default/chef\-getting\-started.txt.erb -Cookbook getting\-started version 0.3.0 successfully installed -.ft P -.fi -.UNINDENT -.UNINDENT -.SH LIST -.sp -The \fBlist\fP argument is used to view a list of cookbooks that are currently available at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view a list of cookbooks at \fI\%https://supermarket.getchef.com/cookbooks\fP server, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -1password homesick rabbitmq -7\-zip hostname rabbitmq\-management -AmazonEC2Tag hosts rabbitmq_chef -R hosts\-awareness rackspaceknife -accounts htop radiant -ack\-grep hudson rails -activemq icinga rails_enterprise -ad id3lib redis\-package -ad\-likewise iftop redis2 -ant iis redmine -[...truncated...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SEARCH -.sp -The \fBsearch\fP argument is used to search for a cookbook at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. A search query is used to return a list of cookbooks at \fI\%https://supermarket.getchef.com/cookbooks\fP and uses the same syntax as the \fBknife search\fP sub\-command. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site search SEARCH_QUERY (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To search for all of the cookbooks that can be used with Apache, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site search apache* -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -apache2: - cookbook: https://supermarket.chef.io/api/v1/cookbooks/apache2 - cookbook_description: Installs and configures apache2 using Debian symlinks with helper definitions - cookbook_maintainer: opscode - cookbook_name: apache2 -instiki: - cookbook: https://supermarket.chef.io/api/v1/cookbooks/instiki - cookbook_description: Installs instiki, a Ruby on Rails wiki server under passenger+Apache2. - cookbook_maintainer: jtimberman - cookbook_name: instiki -kickstart: - cookbook: https://supermarket.chef.io/api/v1/cookbooks/kickstart - cookbook_description: Creates apache2 vhost and serves a kickstart file. - cookbook_maintainer: opscode - cookbook_name: kickstart -[...truncated...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHARE -.sp -The \fBshare\fP argument is used to add a cookbook to \fI\%https://supermarket.getchef.com/cookbooks\fP\&. This action will require a user account and a certificate for \fI\%https://supermarket.getchef.com\fP\&. By default, knife will use the user name and API key that is identified in the configuration file used during the upload; otherwise these values must be specified on the command line or in an alternate configuration file. If a cookbook already exists on \fI\%https://supermarket.getchef.com/cookbooks\fP, then only an owner or maintainer of that cookbook can make updates. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site share COOKBOOK_NAME CATEGORY (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.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 -.sp -\fBExamples\fP -.sp -To share a cookbook named \fBapache2\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site share "apache2" "Web Servers" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to view information about a cookbook on \fI\%https://supermarket.getchef.com/cookbooks\fP\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site show COOKBOOK_NAME [COOKBOOK_VERSION] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBCOOKBOOK_VERSION\fP -The version of a cookbook to be shown. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, a list of cookbook versions will be returned. -.UNINDENT -.sp -\fBExamples\fP -.sp -To show the details for a cookbook named \fBhaproxy\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site show haproxy -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -average_rating: -category: Networking -created_at: 2009\-10\-25T23:51:07Z -description: Installs and configures haproxy -external_url: -latest_version: https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_3 -maintainer: opscode -name: haproxy -updated_at: 2011\-06\-30T21:53:25Z -versions: - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_3 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_2 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_1 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_0 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/0_8_1 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/0_8_0 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/0_7_0 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.SH UNSHARE -.sp -The \fBunshare\fP argument is used to stop the sharing of a cookbook at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. Only the maintainer of a cookbook may perform this action. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site unshare COOKBOOK_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To unshare a cookbook named \fBgetting\-started\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site unshare getting\-started -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-cookbook.1 b/distro/common/man/man1/knife-cookbook.1 deleted file mode 100644 index ce74c9dd8c..0000000000 --- a/distro/common/man/man1/knife-cookbook.1 +++ /dev/null @@ -1,770 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-COOKBOOK" "1" "Chef 12.0" "" "knife cookbook" -.SH NAME -knife-cookbook \- The man page for the knife cookbook subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -A cookbook is the fundamental unit of configuration and policy distribution. Each cookbook defines a scenario, such as everything needed to install and configure MySQL, and then it contains all of the components that are required to support that scenario, including: -.INDENT 0.0 -.IP \(bu 2 -Attribute values that are set on nodes -.IP \(bu 2 -Definitions that allow the creation of reusable collections of resources -.IP \(bu 2 -File distributions -.IP \(bu 2 -Libraries that extend the chef\-client and/or provide helpers to Ruby code -.IP \(bu 2 -Recipes that specify which resources to manage and the order in which those resources will be applied -.IP \(bu 2 -Custom resources and providers -.IP \(bu 2 -Templates -.IP \(bu 2 -Versions -.IP \(bu 2 -Metadata about recipes (including dependencies), version constraints, supported platforms, and so on -.UNINDENT -.sp -The \fBknife cookbook\fP subcommand is used to interact with cookbooks that are located on the Chef server or the local chef\-repo\&. -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife cookbook\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.SH BULK DELETE -.sp -The \fBbulk delete\fP argument is used to delete cookbook files that match a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/). -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook bulk delete REGEX (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-p\fP, \fB\-\-purge\fP -Use to entirely remove a cookbook (or cookbook version) from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. -.UNINDENT -.sp -\fBExamples\fP -.sp -Use a regular expression to define the pattern used to bulk delete cookbooks: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook bulk delete "^[0\-9]{3}$" \-p -.ft P -.fi -.UNINDENT -.UNINDENT -.SH CREATE -.sp -The \fBcreate\fP argument is used to create a new cookbook directory on the local machine, including the following directories and files: -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -cookbook/attributes -.IP \(bu 2 -cookbook/CHANGELOG.md -.IP \(bu 2 -cookbook/definitions -.IP \(bu 2 -cookbook/files/default -.IP \(bu 2 -cookbook/libraries -.IP \(bu 2 -cookbook/metadata.rb -.IP \(bu 2 -cookbook/providers -.IP \(bu 2 -cookbook/README.md (or .rdoc) -.IP \(bu 2 -cookbook/recipes/default.rb -.IP \(bu 2 -cookbook/resources -.IP \(bu 2 -cookbook/templates/default -.UNINDENT -.UNINDENT -.UNINDENT -.sp -After the cookbook is created, it can be uploaded to the Chef server using the \fBknife upload\fP argument. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook create COOKBOOK_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-C COPYRIGHT_HOLDER\fP, \fB\-\-copyright COPYRIGHT_HOLDER\fP -The name of the copyright holder. This option will place a copyright notice that contains the name of the copyright holder in each of the pre\-created files. If this option is not specified, a copyright name of "your_company_name" will be used instead; it can be easily modified later. -.TP -.B \fB\-I LICENSE\fP, \fB\-\-license LICENSE\fP -The type of license under which a cookbook is distributed: \fBapachev2\fP, \fBgplv2\fP, \fBgplv3\fP, \fBmit\fP, or \fBnone\fP (default). This option will place the appropriate license notice in the pre\-created files: \fBApache v2.0\fP (for \fBapachev2\fP), \fBGPL v2\fP (for \fBgplv2\fP), \fBGPL v3\fP (for \fBgplv3\fP), \fBMIT\fP (for \fBmit\fP), or \fBlicense \(aqProprietary \- All Rights Reserved\fP (for \fBnone\fP). Be aware of the licenses for files inside of a cookbook and be sure to follow any restrictions they describe. -.TP -.B \fB\-m EMAIL\fP, \fB\-\-email EMAIL\fP -The email address for the individual who maintains the cookbook. This option will place an email address in each of the pre\-created files. If this option is not specified, an email name of "your_email" will be used instead; it can be easily modified later. -.TP -.B \fB\-o PATH\fP, \fB\-\-cookbook\-path PATH\fP -The directory in which cookbooks are created. This can be a colon\-separated path. -.TP -.B \fB\-r FORMAT\fP, \fB\-\-readme\-format FORMAT\fP -The document format of the readme file: \fBmd\fP (markdown) and \fBrdoc\fP (Ruby docs). -.UNINDENT -.sp -\fBExamples\fP -.sp -To create a cookbook named "my_cookbook" with copyright, email, license, and readme format options specified, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook create my_cookbook \-C "My Name" \-m "my@email.com" \-I apachev2 \-r md -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -** Creating cookbook my_cookbook -** Creating README for cookbook: my_cookbook -** Creating metadata for cookbook: my_cookbook -.ft P -.fi -.UNINDENT -.UNINDENT -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete a specified cookbook or cookbook version on the Chef server (and not locally). -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook delete COOKBOOK_NAME [COOKBOOK_VERSION] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -Use to delete all cookbooks (and cookbook versions). -.TP -.B \fBCOOKBOOK_VERSION\fP -The version of a cookbook to be deleted. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, knife will prompt for a version. -.TP -.B \fB\-p\fP, \fB\-\-purge\fP -Use to entirely remove a cookbook (or cookbook version) from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged. -.UNINDENT -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook delete cookbook_name version -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -For example: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook delete smartmon 0.8 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Type \fBY\fP to confirm a deletion. -.SH DOWNLOAD -.sp -The \fBdownload\fP argument is used to download a cookbook from the Chef server to the current working directory. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook download COOKBOOK_NAME [COOKBOOK_VERSION] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-d DOWNLOAD_DIRECTORY\fP, \fB\-\-dir DOWNLOAD_DIRECTORY\fP -The directory in which cookbooks are located. -.TP -.B \fB\-f\fP, \fB\-\-force\fP -Use to overwrite an existing directory. -.TP -.B \fB\-N\fP, \fB\-\-latest\fP -Use to download the most recent version of a cookbook. -.UNINDENT -.sp -\fBExamples\fP -.sp -To download a cookbook named "smartmon", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook download smartmon -.ft P -.fi -.UNINDENT -.UNINDENT -.SH LIST -.sp -The \fBlist\fP argument is used to view a list of cookbooks that are currently available on the Chef server\&. The list will contain only the most recent version for each cookbook by default. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook list (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -Use to return all available versions for every cookbook. -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view a list of cookbooks: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook list -.ft P -.fi -.UNINDENT -.UNINDENT -.SH METADATA -.sp -The \fBmetadata\fP argument is used to generate the metadata for one or more cookbooks. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook metadata (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -Use to generate metadata for all cookbooks. -.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 -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook metadata \-a -.ft P -.fi -.UNINDENT -.UNINDENT -.SH METADATA FROM FILE -.sp -The \fBmetadata from file\fP argument is used to load the metadata for a cookbook from a file. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook metadata from file FILE -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook metadata from file /path/to/file -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to view information about a cookbook, parts of a cookbook (attributes, definitions, files, libraries, providers, recipes, resources, and templates), or a file that is associated with a cookbook (including attributes such as checksum or specificity). -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook show COOKBOOK_NAME [COOKBOOK_VERSION] [PART...] [FILE_NAME] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBCOOKBOOK_VERSION\fP -The version of a cookbook to be shown. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, a list of cookbook versions will be returned. -.TP -.B \fB\-f FQDN\fP, \fB\-\-fqdn FQDN\fP -The FQDN of the host. -.TP -.B \fBFILE_NAME\fP -The name of a file that is associated with a cookbook. -.TP -.B \fB\-p PLATFORM\fP, \fB\-\-platform PLATFORM\fP -The platform for which a cookbook is designed. -.TP -.B \fBPART\fP -The part of the cookbook to show: \fBattributes\fP, \fBdefinitions\fP, \fBfiles\fP, \fBlibraries\fP, \fBproviders\fP, \fBrecipes\fP, \fBresources\fP, or \fBtemplates\fP\&. More than one part can be specified. -.TP -.B \fB\-V PLATFORM_VERSION\fP, \fB\-\-platform\-version PLATFORM_VERSION\fP -The version of the platform. -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -To get the list of available versions of a cookbook named "getting\-started", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook show getting\-started -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -getting\-started 0.3.0 0.2.0 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show a list of data about a cookbook using the name of the cookbook and the version, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook show getting\-started 0.3.0 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -attributes: - checksum: fa0fc4abf3f6787aeb5c3c5c35de667c - name: default.rb - path: attributes/default.rb - specificity: default - url: https://somelongurlhere.com -chef_type: cookbook_version -cookbook_name: getting\-started -definitions: [] -files: [] -frozen?: false -json_class: Chef::CookbookVersion -libraries: [] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To only view data about "templates", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook show getting\-started 0.3.0 templates -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -checksum: a29d6f254577b830091f140c3a78b1fe -name: chef\-getting\-started.txt.erb -path: templates/default/chef\-getting\-started.txt.erb -specificity: default -url: https://someurlhere.com -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.SH TEST -.sp -The \fBtest\fP argument is used to test a cookbook for syntax errors. This argument uses Ruby syntax checking to verify every file in a cookbook that ends in .rb and Embedded Ruby (ERB)\&. This argument will respect \&.chefignore files when determining which cookbooks to test for syntax errors. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook test COOKBOOK_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -Use to test all cookbooks. -.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 -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook test cookbook_name -.ft P -.fi -.UNINDENT -.UNINDENT -.SH UPLOAD -.sp -The \fBupload\fP argument is used to upload one or more cookbooks (and any files that are associated with those cookbooks) from a local repository to the Chef server\&. Only files that do not already exist on the Chef server will be uploaded. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Use a \&.chefignore file to prevent the upload of specific files and file types, such as temporary files or files placed in folders by version control systems. The \&.chefignore file must be located in the root of the cookbook repository and must use rules similar to filename globbing (as defined by the Ruby \fBFile.fnmatch\fP syntax). -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Empty directories are not uploaded to the Chef server\&. To upload an empty directory, create a "dot" file\-\-\-e.g. \fB\&.keep\fP\-\-\-in that directory to ensure that the directory itself is not empty. -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook upload [COOKBOOK_NAME...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -Use to upload all cookbooks. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-d\fP, \fB\-\-include\-dependencies\fP -Use to ensure that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded. -.TP -.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP -Use to set the environment version dependency to the cookbook version being uploaded. -.TP -.B \fB\-\-force\fP -Use to update a cookbook even if the \fB\-\-freeze\fP flag has been set. -.TP -.B \fB\-\-freeze\fP -Use to require changes to a cookbook be included as a new version. Only the \fB\-\-force\fP option can override this setting. -.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 -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook upload cookbook_name -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To upload a cookbook, and then prevent other users from being able to make changes to it, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook upload redis \-\-freeze -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Uploading redis... -Upload completed -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -If a cookbook is frozen and the \fB\-\-force\fP option is not specified, knife will return an error message similar to the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Uploading redis... -ERROR: Version 0.1.6 of cookbook redis is frozen. Use \-\-force to override. -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-data-bag.1 b/distro/common/man/man1/knife-data-bag.1 deleted file mode 100644 index a4d45ce60e..0000000000 --- a/distro/common/man/man1/knife-data-bag.1 +++ /dev/null @@ -1,617 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.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. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -A data bag is a global variable that is stored as JSON data and is accessible from a Chef server\&. A data bag is indexed for searching and can be loaded by a recipe or accessed during a search. -.sp -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. -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife data bag\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.SH CREATE -.sp -The \fBcreate\fP argument is used to add a data bag to the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag create DATA_BAG_NAME [DATA_BAG_ITEM] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBDATA_BAG_ITEM\fP -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. 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. -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret\-file\fP, not both. -.UNINDENT -.UNINDENT -.sp -\fBExamples\fP -.sp -To create a data bag named "admins", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag create admins -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Created data_bag[admins] -.ft P -.fi -.UNINDENT -.UNINDENT -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete a data bag or a data bag item from a Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag delete DATA_BAG_NAME [DATA_BAG_ITEM] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBDATA_BAG_ITEM\fP -The name of a specific item within a data bag. -.UNINDENT -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag delete data_bag_name -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To delete an item named "charlie", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag delete admins charlie -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Type \fBY\fP to confirm a deletion. -.SH EDIT -.sp -The \fBedit\fP argument is used to edit the data contained in a data bag. If encryption is being used, the data bag will be decrypted, the data will be made available in the $EDITOR, and then encrypted again before saving it to the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag edit DATA_BAG_NAME [DATA_BAG_ITEM] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBDATA_BAG_ITEM\fP -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. 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. -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret\-file\fP, not both. -.UNINDENT -.UNINDENT -.sp -\fBExamples\fP -.sp -To edit the contents of a data bag, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag edit dogs tibetanspaniel -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -where \fBdogs\fP is the name of the data bag and \fBtibetanspaniel\fP is the name of the data bag item. This will return something similar to the following in the knife editor: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - "name":"data_bag_item_dogs_tibetanspaniel", - "json_class":"Chef::DataBagItem", - "chef_type":"data_bag_item", - "data_bag":"dogs", - "raw_data": - { - "description":"small dog that likes to sit in windows", - "id":"tibetanspaniel" - } -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Make the necessary changes to the key\-value pairs under \fBraw_data\fP and save them. -.sp -To edit an item named "charlie" that is contained in a data bag named "admins", enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag edit admins charlie -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to open the $EDITOR\&. Once opened, you can update the data before saving it to the Chef server\&. For example, by changing: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - "id": "charlie" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - "id": "charlie", - "uid": 1005, - "gid": "ops", - "shell": "/bin/zsh", - "comment": "Crazy Charlie" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.SH FROM FILE -.sp -The \fBfrom file\fP argument is used to: -.INDENT 0.0 -.IP \(bu 2 -Add a data bag item to a data bag -.IP \(bu 2 -Update the contents of an existing data bag item -.UNINDENT -.sp -The data bag itself must already exist on the Chef server and must be specified as part of the command. The contents of the data bag item are specified using a JSON file. This JSON file may be located at a relative or absolute path; its location must be specified as part of the command. The JSON file that defines the contents of the data bag item must at least contain the name of the data bag item\-\-\-\fB"id": "name"\fP\&. -.sp -\fBWARNING:\fP -.INDENT 0.0 -.INDENT 3.5 -A chef\-client must be version 11.6 (or higher) when using the \fBknife data bag from file\fP argument with the Enterprise Chef or Open Source Chef version 11 servers. -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag from file DATA_BAG_NAME_or_PATH -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -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. 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. -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret\-file\fP, not both. -.UNINDENT -.UNINDENT -.sp -\fBExamples\fP -.sp -To create a data bag on the Chef server from a file: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag from file "path to JSON file" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To create a data bag named "devops_data" that contains encrypted data, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag from file devops_data \-\-secret\-file "path to decryption file" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH LIST -.sp -The \fBlist\fP argument is used to view a list of data bags that are currently available on the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag list -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to view the contents of a data bag. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag show DATA_BAG_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBDATA_BAG_ITEM\fP -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. 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. -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -For encrypted data bag items, use \fIeither\fP \fB\-\-secret\fP or \fB\-\-secret\-file\fP, not both. -.UNINDENT -.UNINDENT -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag show admins -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -charlie -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show the contents of a specific item within data bag, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag show admins charlie -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -comment: Crazy Charlie -gid: ops -id: charlie -shell: /bin/zsh -uid: 1005 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show the contents of a data bag named \fBpasswords\fP with an item that contains encrypted data named \fBmysql\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag show passwords mysql -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -## sample: -{ - "id": "mysql", - "pass": "trywgFA6R70NO28PNhMpGhEvKBZuxouemnbnAUQsUyo=\en", - "user": "e/p+8WJYVHY9fHcEgAAReg==\en" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show the decrypted contents of the same data bag, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag show \-\-secret\-file /path/to/decryption/file passwords mysql -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -## sample: -{ - "id": "mysql", - "pass": "thesecret123", - "user": "fred" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag show admins \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-delete.1 b/distro/common/man/man1/knife-delete.1 deleted file mode 100644 index fcbf52a65a..0000000000 --- a/distro/common/man/man1/knife-delete.1 +++ /dev/null @@ -1,127 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-DELETE" "1" "Chef 12.0" "" "knife delete" -.SH NAME -knife-delete \- The man page for the knife delete subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife delete\fP subcommand is used to delete an object from a Chef server\&. This subcommand works similar to \fBknife cookbook delete\fP, \fBknife data bag delete\fP, \fBknife environment delete\fP, \fBknife node delete\fP, and \fBknife role delete\fP, but with a single verb (and a single action). -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife delete [PATTERN...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-\-both\fP -Use to delete both local and remote copies of an object. Default: \fBfalse\fP\&. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-local\fP -Use to delete only the local copy of an object. (A remote copy will not be deleted.) Default: \fBfalse\fP\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-r\fP, \fB\-\-[no\-]recurse\fP -Use \fB\-\-recurse\fP to delete directories recursively. Default: \fB\-\-no\-recurse\fP\&. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-deps.1 b/distro/common/man/man1/knife-deps.1 deleted file mode 100644 index afa384c1a9..0000000000 --- a/distro/common/man/man1/knife-deps.1 +++ /dev/null @@ -1,246 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-DEPS" "1" "Chef 12.0" "" "knife deps" -.SH NAME -knife-deps \- The man page for the knife deps subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife deps\fP subcommand is used to identify dependencies for a node, role, or cookbook. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-\-[no\-]recurse\fP -Use \fB\-\-recurse\fP to list dependencies recursively. This option can only be used when \fB\-\-tree\fP is set to \fBtrue\fP\&. Default: \fB\-\-no\-recurse\fP\&. -.TP -.B \fB\-\-remote\fP -Use to determine dependencies from objects located on the Chef server instead of in the local chef\-repo\&. Default: \fBfalse\fP\&. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.TP -.B \fB\-\-tree\fP -Use to show dependencies in a visual tree structure (including duplicates, if they exist). Default: \fBfalse\fP\&. -.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. -.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\-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 -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps nodes/node_name.json -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps roles/role_name.json -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps cookbooks/cookbook_name.json -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps environments/environment_name.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To find the dependencies for a combination of nodes, cookbooks, roles, and/or environments: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps cookbooks/git.json cookbooks/github.json roles/base.json environments/desert.json nodes/mynode.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -A wildcard can be used to return all of the child nodes. For example, all of the environments: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps environments/*.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Use the \fB\-\-tree\fP option to view the results with structure: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps roles/webserver.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -roles/webserver.json - roles/base.json - cookbooks/github - cookbooks/git - cookbooks/users - cookbooks/apache2 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The output of \fBknife deps\fP can be passed to \fBknife upload\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload \(gaknife deps nodes/*.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The output of \fBknife deps\fP can be passed to \fBknife xargs\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife deps nodes/*.json | xargs knife upload -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-diff.1 b/distro/common/man/man1/knife-diff.1 deleted file mode 100644 index 8bf19ef609..0000000000 --- a/distro/common/man/man1/knife-diff.1 +++ /dev/null @@ -1,226 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-DIFF" "1" "Chef 12.0" "" "knife diff" -.SH NAME -knife-diff \- The man page for the knife diff subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife diff\fP subcommand is used to compare the differences between files and directories on the Chef server and in the chef\-repo\&. For example, to compare files on the Chef server prior to an uploading or downloading files using the \fBknife download\fP and \fBknife upload\fP subcommands, or to ensure that certain files in multiple production environments are the same. This subcommand is similar to the \fBgit diff\fP command that can be used to diff what is in the chef\-repo with what is synced to a git repository. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife diff [PATTERN...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-cookbook\-version VERSION\fP -The version of a cookbook to be downloaded. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-\-diff\-filter=[(A|D|M|T)...[*]]\fP -Use to select only files that have been added (\fBA\fP), deleted (\fBD\fP), modified (\fBM\fP), and/or have had their type changed (\fBT\fP). Any combination of filter characters may be used, including no filter characters. Use \fB*\fP to select all paths if a file matches other criteria in the comparison. Default value: \fBnil\fP\&. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-name\-only\fP -Use to show only the names of modified files. -.TP -.B \fB\-\-name\-status\fP -Use to show only the names of files with a status of \fBAdded\fP, \fBDeleted\fP, \fBModified\fP, or \fBType Changed\fP\&. -.TP -.B \fB\-\-no\-recurse\fP -Use \fB\-\-no\-recurse\fP to disable listing a directory recursively. Default: \fB\-\-recurse\fP\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -\fBknife.rb File Settings\fP -.sp -In addition to the default settings in a knife.rb file, there are other subcommand\-specific settings that can be added. When a subcommand is run, knife will use: -.INDENT 0.0 -.IP 1. 3 -A value passed via the command\-line -.IP 2. 3 -A value contained in the knife.rb file -.IP 3. 3 -The default value -.UNINDENT -.sp -A value passed via the command line will override a value in the knife.rb file; a value in a knife.rb file will override a default value. -.sp -The following \fBknife diff\fP settings can be added to the knife.rb file: -.INDENT 0.0 -.TP -.B \fBknife[:chef_repo_path]\fP -Use to add the \fB\-\-chef\-repo\-path\fP option. -.TP -.B \fBknife[:concurrency]\fP -Use to add the \fB\-\-concurrency\fP option. -.TP -.B \fBknife[:name_only]\fP -Use to add the \fB\-\-name\-only\fP option. -.TP -.B \fBknife[:name_status]\fP -Use to add the \fB\-\-name\-status\fP option. -.TP -.B \fBknife[:recurse]\fP -Use to add the \fB\-\-recurse\fP option. -.TP -.B \fBknife[:repo_mode]\fP -Use to add the \fB\-\-repo\-mode\fP option. -.UNINDENT -.sp -\fBExamples\fP -.sp -To compare the \fBbase.json\fP role to a \fBwebserver.json\fP role, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife diff roles/base.json roles/webserver.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To compare the differences between the local chef\-repo and the files that are on the Chef server, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife diff -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To diff a node named \fBnode\-lb\fP and then only return files that have been added, deleted, modified, or changed, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife diff \-\-name\-status node\-lb -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -node\-lb/recipes/eip.rb -node\-lb/recipes/heartbeat\-int.rb -node\-lb/templates/default/corpsite.conf.erb -node\-lb/files/default/wildcard.node.com.crt -node\-lb/files/default/wildcard.node.com.crt\-2009 -node\-lb/files/default/wildcard.node.com.key -node\-lb/.gitignore -node\-lb/Rakefile -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-download.1 b/distro/common/man/man1/knife-download.1 deleted file mode 100644 index ab232fe613..0000000000 --- a/distro/common/man/man1/knife-download.1 +++ /dev/null @@ -1,258 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-DOWNLOAD" "1" "Chef 12.0" "" "knife download" -.SH NAME -knife-download \- The man page for the knife download subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife download\fP subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the Chef server to the current working directory. It can be used to back up data on the Chef server, inspect the state of one or more files, or to extract out\-of\-process changes users may have made to files on the Chef 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 -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download [PATTERN...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-\-cookbook\-version VERSION\fP -The version of a cookbook to be downloaded. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-\-[no\-]diff\fP -Use to download only new and modified files. Set to \fBfalse\fP to download all files. Default: \fB\-\-diff\fP\&. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-\-[no\-]force\fP -Use \fB\-\-force\fP to download files even when the file on the hard drive is identical to the object on the server (role, cookbook, etc.). By default, files are compared to see if they have equivalent content, and local files are only overwritten if they are different. Default: \fB\-\-no\-force\fP\&. -.TP -.B \fB\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\fP, \fB\-\-dry\-run\fP -Use to take no action and only print out results. Default: \fBfalse\fP\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-\-[no\-]purge\fP -Use \fB\-\-purge\fP to delete local files and directories that do not exist on the Chef server\&. By default, if a role, cookbook, etc. does not exist on the Chef server, the local file for said role will be left alone and NOT deleted. Default: \fB\-\-no\-purge\fP\&. -.TP -.B \fB\-\-[no\-]recurse\fP -Use \fB\-\-no\-recurse\fP to disable downloading a directory recursively. Default: \fB\-\-recurse\fP\&. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.sp -To download the entire chef\-repo from the Chef server, browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download / -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To download the \fBcookbooks/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download cookbooks -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from anywhere in the chef\-repo, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download /cookbooks -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To download the \fBenvironments/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download environments -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from anywhere in the chef\-repo, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download /environments -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To download an environment named "production" from the Chef server, browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download environments/production.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from the \fBenvironments/\fP directory, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download production.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To download the \fBroles/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download roles -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from anywhere in the chef\-repo, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download /roles -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To download all cookbooks that start with "apache" and belong to the "webserver" role, browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife download cookbooks/apache\e* roles/webserver.json -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-edit.1 b/distro/common/man/man1/knife-edit.1 deleted file mode 100644 index bc159e6444..0000000000 --- a/distro/common/man/man1/knife-edit.1 +++ /dev/null @@ -1,121 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-EDIT" "1" "Chef 12.0" "" "knife edit" -.SH NAME -knife-edit \- The man page for the knife edit subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife edit\fP subcommand is used to edit objects on the Chef server\&. This subcommand works similar to \fBknife cookbook edit\fP, \fBknife data bag edit\fP, \fBknife environment edit\fP, \fBknife node edit\fP, and \fBknife role edit\fP, but with a single verb (and a single action). -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife edit (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-local\fP -Use to show files in the local chef\-repo instead of a remote location. Default: \fBfalse\fP\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-environment.1 b/distro/common/man/man1/knife-environment.1 deleted file mode 100644 index d583abe7fa..0000000000 --- a/distro/common/man/man1/knife-environment.1 +++ /dev/null @@ -1,508 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-ENVIRONMENT" "1" "Chef 12.0" "" "knife environment" -.SH NAME -knife-environment \- The man page for the knife environment subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -An environment is a way to map an organization\(aqs real\-life workflow to what can be configured and managed when using Chef 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 Chef server\&. -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife environment\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.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: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment compare [ENVIRONMENT_NAME...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -Use to upload all environments found at the specified path. -.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: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment compare development -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something similar to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C - development -apache 2.3.1 -windows 4.1.2 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To compare cookbook versions for multiple environments: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment compare development staging -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something similar to: -.INDENT 0.0 -.INDENT 3.5 -.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 -.UNINDENT -.UNINDENT -.sp -To compare all cookbook versions for all environments: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment compare \-\-all -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something similar to: -.INDENT 0.0 -.INDENT 3.5 -.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 -.UNINDENT -.UNINDENT -.SH CREATE -.sp -The \fBcreate\fP argument is used to add an environment object to the Chef 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 Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment create ENVIRONMENT_NAME \-d DESCRIPTION -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-d DESCRIPTION\fP, \fB\-\-description DESCRIPTION\fP -The description of the environment. This value will populate the description field for the environment on the Chef server\&. -.UNINDENT -.sp -\fBExamples\fP -.sp -To create an environment named \fBdev\fP with a description of \fBThe development environment.\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment create dev \-d "The development environment." -.ft P -.fi -.UNINDENT -.UNINDENT -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete an environment from a Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment delete ENVIRONMENT_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To delete an environment named \fBdev\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment delete dev -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Type \fBY\fP to confirm a deletion. -.SH EDIT -.sp -The \fBedit\fP argument is used to edit the attributes of an environment. When this argument is run, knife will open $EDITOR to enable editing of \fBENVIRONMENT\fP attributes. When finished, knife will update the Chef server with those changes. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment edit ENVIRONMENT_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To edit an environment named \fBdevops\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment edit devops -.ft P -.fi -.UNINDENT -.UNINDENT -.SH FROM FILE -.sp -The \fBfrom file\fP argument is used to add or update an environment using a JSON or Ruby DSL description. It must be run with the \fBcreate\fP or \fBedit\fP arguments. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment [create | edit] from file FILE (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -Use to upload all environments found at the specified path. -.UNINDENT -.sp -\fBExamples\fP -.sp -To add an environment using data contained in a JSON file: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment create devops from file "path to JSON file" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment edit devops from file "path to JSON file" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH LIST -.sp -The \fBlist\fP argument is used to list all of the environments that are currently available on the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment list \-w -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view a list of environments: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment list \-w -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to display information about the specified environment. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment show ENVIRONMENT_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To view information about the \fBdev\fP environment enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife environment show dev -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -% knife environment show dev -chef_type: environment -cookbook_versions: -default_attributes: -description: -json_class: Chef::Environment -name: dev -override_attributes: - -\e\e -\e\e -\e\e -\e\e -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-exec.1 b/distro/common/man/man1/knife-exec.1 deleted file mode 100644 index b63491185f..0000000000 --- a/distro/common/man/man1/knife-exec.1 +++ /dev/null @@ -1,362 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-EXEC" "1" "Chef 12.0" "" "knife exec" -.SH NAME -knife-exec \- The man page for the knife exec subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife exec\fP subcommand uses the knife configuration file to execute Ruby scripts in the context of a fully configured chef\-client\&. This subcommand is most often used to run scripts that will only access Chef server one time (or otherwise very infrequently). Use this subcommand any time that an operation does not warrant full usage of the knife subcommand library. -.sp -\fBAuthenticated API Requests\fP -.sp -The \fBknife exec\fP subcommand can be used to make authenticated API requests to the Chef server using the following methods: -.TS -center; -|l|l|. -_ -T{ -Method -T} T{ -Description -T} -_ -T{ -\fBapi.delete\fP -T} T{ -Use to delete an object from the Chef server\&. -T} -_ -T{ -\fBapi.get\fP -T} T{ -Use to get the details of an object on the Chef server\&. -T} -_ -T{ -\fBapi.post\fP -T} T{ -Use to add an object to the Chef server\&. -T} -_ -T{ -\fBapi.put\fP -T} T{ -Use to update an object on the Chef server\&. -T} -_ -.TE -.sp -These methods are used with the \fB\-E\fP option, which executes that string locally on the workstation using chef\-shell\&. These methods have the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec \-E \(aqapi.method(/endpoint)\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -where: -.INDENT 0.0 -.IP \(bu 2 -\fBapi.method\fP is the corresponding authentication method \-\-\- \fBapi.delete\fP, \fBapi.get\fP, \fBapi.post\fP, or \fBapi.put\fP -.IP \(bu 2 -\fB/endpoint\fP is an endpoint in the Chef server API -.UNINDENT -.sp -For example, to get the data for a node named "Example_Node": -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec \-E \(aqputs api.get("/nodes/Example_Node")\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -and to ensure that the output is visible in the console, add the \fBputs\fP in front of the API authorization request: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec \-E \(aqputs api.get("/nodes/Example_Node")\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -where \fBputs\fP is the shorter version of the \fB$stdout.puts\fP predefined variable in Ruby\&. -.sp -The following example shows how to add a client named "IBM305RAMAC" and the \fB/clients\fP endpoint, and then return the private key for that user in the console: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ client_desc = { - "name" => "IBM305RAMAC", - "admin" => false - } - - new_client = api.post("/clients", client_desc) - puts new_client["private_key"] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec SCRIPT (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-E CODE\fP, \fB\-\-exec CODE\fP -A string of code that will be executed. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.TP -.B \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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-p PATH:PATH\fP, \fB\-\-script\-path PATH:PATH\fP -A colon\-separated path at which Ruby scripts are located. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.sp -There are three ways to use \fBknife exec\fP to run Ruby script files. For example: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec /path/to/script_file -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec \-E \(aqRUBY CODE\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec -RUBY CODE -^D -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To check the status of knife using a Ruby script named \fBstatus.rb\fP (which looks like): -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -printf "%\-5s %\-12s %\-8s %s\en", "Check In", "Name", "Ruby", "Recipes" -nodes.all do |n| - checkin = Time.at(n[\(aqohai_time\(aq]).strftime("%F %R") - rubyver = n[\(aqlanguages\(aq][\(aqruby\(aq][\(aqversion\(aq] - recipes = n.run_list.expand(_default).recipes.join(", ") - printf "%\-20s %\-12s %\-8s %s\en", checkin, n.name, rubyver, recipes -end -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -and is located in a directory named \fBscripts/\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec scripts/status.rb -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show the available free memory for all nodes, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec \-E \(aqnodes.all {|n| puts "#{n.name} has #{n.memory.total} free memory"}\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To list all of the available search indexes, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife exec \-E \(aqputs api.get("search").keys\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To query a node for multiple attributes using a Ruby script named \fBsearch_attributes.rb\fP (which looks like): -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -% cat scripts/search_attributes.rb -query = ARGV[2] -attributes = ARGV[3].split(",") -puts "Your query: #{query}" -puts "Your attributes: #{attributes.join(" ")}" -results = {} -search(:node, query) do |n| - results[n.name] = {} - attributes.each {|a| results[n.name][a] = n[a]} -end - -puts results -exit 0 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -% knife exec scripts/search_attributes.rb "hostname:test_system" ipaddress,fqdn -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Your query: hostname:test_system -Your attributes: ipaddress fqdn -{"test_system.example.com"=>{"ipaddress"=>"10.1.1.200", "fqdn"=>"test_system.example.com"}} -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-index-rebuild.1 b/distro/common/man/man1/knife-index-rebuild.1 deleted file mode 100644 index 3fe2c52f8c..0000000000 --- a/distro/common/man/man1/knife-index-rebuild.1 +++ /dev/null @@ -1,63 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.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. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife index rebuild\fP subcommand is used to rebuild the search indexes for the open source Chef server\&. This operation is destructive and may take some time. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -This subcommand ONLY works when run against the open source Chef server version 10.x. This subcommand will NOT run against open source Chef server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef\&. -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife index rebuild -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-list.1 b/distro/common/man/man1/knife-list.1 deleted file mode 100644 index c9349fa822..0000000000 --- a/distro/common/man/man1/knife-list.1 +++ /dev/null @@ -1,174 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-LIST" "1" "Chef 12.0" "" "knife list" -.SH NAME -knife-list \- The man page for the knife list subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife list\fP subcommand is used to view a list of objects on the Chef server\&. This subcommand works similar to \fBknife cookbook list\fP, \fBknife data bag list\fP, \fBknife environment list\fP, \fBknife node list\fP, and \fBknife role list\fP, but with a single verb (and a single action). -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife list [PATTERN...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-1\fP -Use to show only one column of results. Default: \fBfalse\fP\&. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-d\fP -Use to prevent a directory\(aqs children from showing when a directory matches a pattern. Default value: \fBfalse\fP\&. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\fP, \fB\-\-flat\fP -Use to show a list of file names. Set to \fBfalse\fP to view ls\-like output. Default: \fBfalse\fP\&. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-local\fP -Use to return only the contents of the local directory. Default: \fBfalse\fP\&. -.TP -.B \fB\-p\fP -Use to show directories with trailing slashes (/). Default: \fBfalse\fP\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-R\fP -Use to list directories recursively. Default: \fBfalse\fP\&. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.sp -For example, to view a list of roles on the Chef server: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife list roles/ -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view a list of roles and environments on the Chef server: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife list roles/ environments/ -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view a list of absolutely everything on the Chef server: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife list \-R / -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-node.1 b/distro/common/man/man1/knife-node.1 deleted file mode 100644 index af7eab9317..0000000000 --- a/distro/common/man/man1/knife-node.1 +++ /dev/null @@ -1,716 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-NODE" "1" "Chef 12.0" "" "knife node" -.SH NAME -knife-node \- The man page for the knife node subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -A node is any physical, virtual, or cloud machine that is configured to be maintained by a chef\-client\&. -.sp -The \fBknife node\fP subcommand is used to manage the nodes that exist on a Chef server\&. -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife node\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.SH BULK DELETE -.sp -The \fBbulk delete\fP argument is used to delete one or more nodes that match a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/). -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node bulk delete REGEX -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -Use a regular expression to define the pattern used to bulk delete nodes: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node bulk delete "^[0\-9]{3}$" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Type \fBY\fP to confirm a deletion. -.SH CREATE -.sp -The \fBcreate\fP argument is used to add a node to the Chef server\&. Node data is stored as JSON on the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node create NODE_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To add a node, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node create node1 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -In the $EDITOR enter the node data in JSON: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -## sample: -{ - "normal": { - }, - "name": "foobar", - "override": { - }, - "default": { - }, - "json_class": "Chef::Node", - "automatic": { - }, - "run_list": [ - "recipe[zsh]", - "role[webserver]" - ], - "chef_type": "node" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -When finished, save it. -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete a node from the Chef server\&. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Deleting a node will not delete any corresponding API clients. -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node delete NODE_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node delete node_name -.ft P -.fi -.UNINDENT -.UNINDENT -.SH EDIT -.sp -The \fBedit\fP argument is used to edit the details of a node on a Chef server\&. Node data is stored as JSON on the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node edit NODE_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-all\fP -Displays a node in the $EDITOR\&. By default, attributes that are default, override, or automatic are not shown. -.UNINDENT -.sp -\fBExamples\fP -.sp -To edit the data for a node named \fBnode1\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node edit node1 \-a -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Update the role data in JSON: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -## sample: -{ - "normal": { - }, - "name": "node1", - "override": { - }, - "default": { - }, - "json_class": "Chef::Node", - "automatic": { - }, - "run_list": [ - "recipe[devops]", - "role[webserver]" - ], - "chef_type": "node" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -When finished, save it. -.SH FROM FILE -.sp -The \fBfrom file\fP argument is used to create a node using existing node data as a template. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node from file FILE -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To add a node using data contained in a JSON file: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node from file "path to JSON file" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH LIST -.sp -The \fBlist\fP argument is used to view all of the nodes that exist on a Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node list (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -To verify the list of nodes that are registered with the Chef server, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something similar to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -i\-12345678 -rs\-123456 -.ft P -.fi -.UNINDENT -.UNINDENT -.SH RUN_LIST ADD -.sp -The \fBrun_list add\fP argument is used to add run\-list items (roles or recipes) to a node. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list add NODE_NAME RUN_LIST_ITEM (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a ITEM\fP, \fB\-\-after ITEM\fP -Use this to add the run list item after the specified run list item. -.TP -.B \fB\-b ITEM\fP, \fB\-\-before ITEM\fP -Use this to add the run list item before the specified run list item. -.UNINDENT -.sp -\fBExamples\fP -.sp -To add a role to a run\-list, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list add node \(aqrole[ROLE_NAME]\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To add roles and recipes to a run\-list, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list add node \(aqrecipe[COOKBOOK::RECIPE_NAME],recipe[COOKBOOK::RECIPE_NAME],role[ROLE_NAME]\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To add a recipe to a run\-list using the fully qualified format, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list add node \(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To add a recipe to a run\-list using the cookbook format, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list add node \(aqCOOKBOOK::RECIPE_NAME\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To add the default recipe of a cookbook to a run\-list, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list add node \(aqCOOKBOOK\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.SH RUN_LIST REMOVE -.sp -The \fBrun_list remove\fP argument is used to remove run\-list items (roles or recipes) from a node. A recipe must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example: \fB\(aqrole[ROLE_NAME]\(aq\fP or \fB\(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq\fP\&. Use a comma to separate roles and recipes when removing more than one, like this: \fB\(aqrecipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]\(aq\fP\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list remove NODE_NAME RUN_LIST_ITEM -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To remove a role from a run\-list, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list remove node \(aqrole[ROLE_NAME]\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To remove a recipe from a run\-list using the fully qualified format, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node run_list remove node \(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to display information about a node. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node show NODE_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP -The attribute (or attributes) to show. -.TP -.B \fB\-l\fP, \fB\-\-long\fP -Use to display all attributes in the output and to show the output as JSON\&. -.TP -.B \fB\-m\fP, \fB\-\-medium\fP -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. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view all data for a node named \fBbuild\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node show build -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Node Name: build -Environment: _default -FQDN: -IP: -Run List: -Roles: -Recipes: -Platform: -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show basic information about a node, truncated and nicely formatted: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife node show <node_name> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show all information about a node, nicely formatted: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife node show \-l <node_name> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To list a single node attribute: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife node show <node_name> \-a <attribute_name> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -where \fB<attribute_name>\fP is something like kernel or platform. (This doesn\(aqt work for nested attributes like \fBnode[kernel][machine]\fP because \fBknife node show\fP doesn\(aqt understand nested attributes.) -.sp -To view the FQDN for a node named \fBi\-12345678\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node show i\-12345678 \-a fqdn -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -fqdn: ip\-10\-251\-75\-20.ec2.internal -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view the run list for a node named \fBdev\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife node show dev \-r -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.sp -To view node information in raw JSON, use the \fB\-l\fP or \fB\-\-long\fP option: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife node show \-l \-F json <node_name> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -and/or: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife node show \-l \-\-format=json <node_name> -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-raw.1 b/distro/common/man/man1/knife-raw.1 deleted file mode 100644 index a484db25bb..0000000000 --- a/distro/common/man/man1/knife-raw.1 +++ /dev/null @@ -1,172 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-RAW" "1" "Chef 12.0" "" "knife raw" -.SH NAME -knife-raw \- The man page for the knife raw subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\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 an endpoint in the Chef server API\&. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife raw REQUEST_PATH (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.TP -.B \fB\-i FILE\fP, \fB\-\-input FILE\fP -The name of a file to be used with the \fBPUT\fP or a \fBPOST\fP request. -.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\-m METHOD\fP, \fB\-\-method METHOD\fP -The request method: \fBDELETE\fP, \fBGET\fP, \fBPOST\fP, or \fBPUT\fP\&. Default value: \fBGET\fP\&. -.TP -.B \fB\-\-[no\-]pretty\fP -Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON\&. Default: \fB\-\-pretty\fP\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.sp -To view information about a client: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife raw /clients/<client_name> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information about a node: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife raw /nodes/<node_name> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To delete a data bag, enter a command similar to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife raw \-m DELETE /data/foo -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something similar to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - "name":"foo", - "json_class":"Chef::DataBag", - "chef_type":"data_bag" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-recipe-list.1 b/distro/common/man/man1/knife-recipe-list.1 deleted file mode 100644 index 3bd5a4c3aa..0000000000 --- a/distro/common/man/man1/knife-recipe-list.1 +++ /dev/null @@ -1,85 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.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. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife recipe list\fP 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 (/). -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife recipe list REGEX -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To view a list of recipes: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife recipe list \(aqcouchdb::*\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -couchdb::main_monitors -couchdb::master -couchdb::default -couchdb::org_cleanu -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-role.1 b/distro/common/man/man1/knife-role.1 deleted file mode 100644 index d5b5616d31..0000000000 --- a/distro/common/man/man1/knife-role.1 +++ /dev/null @@ -1,426 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-ROLE" "1" "Chef 12.0" "" "knife role" -.SH NAME -knife-role \- The man page for the knife role subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\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. -.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 -.sp -The following options may be used with any of the arguments available to the \fBknife role\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.SH BULK DELETE -.sp -The \fBbulk delete\fP argument is used to delete one or more roles that match a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/). -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role bulk delete REGEX -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -Use a regular expression to define the pattern used to bulk delete roles: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role bulk delete "^[0\-9]{3}$" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH CREATE -.sp -The \fBcreate\fP argument is used to add a role to the Chef server\&. Role data is saved as JSON on the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role create ROLE_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-d DESCRIPTION\fP, \fB\-\-description DESCRIPTION\fP -The description of the role. This value will populate the description field for the role on the Chef server\&. -.UNINDENT -.sp -\fBExamples\fP -.sp -To add a role named \fBrole1\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role create role1 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -In the $EDITOR enter the role data in JSON: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -## sample: -{ - "name": "role1", - "default_attributes": { - }, - "json_class": "Chef::Role", - "run_list": [\(aqrecipe[cookbook_name::recipe_name], - role[role_name]\(aq - ], - "description": "", - "chef_type": "role", - "override_attributes": { - } -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -When finished, save it. -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete a role from the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role delete ROLE_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role delete devops -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Type \fBY\fP to confirm a deletion. -.SH EDIT -.sp -The \fBedit\fP argument is used to edit role details on the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role edit ROLE_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To edit the data for a role named \fBrole1\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role edit role1 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Update the role data in JSON: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -## sample: -{ - "name": "role1", - "default_attributes": { - }, - "json_class": "Chef::Role", - "run_list": [\(aqrecipe[cookbook_name::recipe_name], - role[role_name]\(aq - ], - "description": "This is the description for the role1 role.", - "chef_type": "role", - "override_attributes": { - } -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -When finished, save it. -.SH FROM FILE -.sp -The \fBfrom file\fP argument is used to create a role using existing JSON data as a template. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role from file FILE -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To view role details based on the values contained in a JSON file: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role from file "path to JSON file" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH LIST -.sp -The \fBlist\fP argument is used to view a list of roles that are currently available on the Chef server\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view a list of roles on the Chef server and display the URI for each role returned, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role list \-w -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to view the details of a role. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show ROLE_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP -The attribute (or attributes) to show. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-search.1 b/distro/common/man/man1/knife-search.1 deleted file mode 100644 index 3b81898530..0000000000 --- a/distro/common/man/man1/knife-search.1 +++ /dev/null @@ -1,359 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-SEARCH" "1" "Chef 12.0" "" "knife search" -.SH NAME -knife-search \- The man page for the knife search subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\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, 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 -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search INDEX SEARCH_QUERY -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -where \fBINDEX\fP is one of \fBclient\fP, \fBenvironment\fP, \fBnode\fP, \fBrole\fP, or the name of a data bag and \fBSEARCH_QUERY\fP is the search query syntax for the query that will be executed. -.sp -\fBINDEX\fP is implied if omitted, and will default to \fBnode\fP\&. For example: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search \(aq*:*\(aq \-i -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -will return something similar to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -8 items found - -centos\-62\-dev -opensuse\-1203 -ubuntu\-1304\-dev -ubuntu\-1304\-orgtest -ubuntu\-1204\-ohai\-test -ubuntu\-1304\-ifcfg\-test -ohai\-test -win2k8\-dev -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -and is the same search as: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node \(aq*:*" \-i -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -If the \fBSEARCH_QUERY\fP does not contain a colon character (\fB:\fP), then the default query pattern is \fBtags:*#{@query}* OR roles:*#{@query}* OR fqdn:*#{@query}* OR addresses:*#{@query}*\fP, which means the following two search queries are effectively the same: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search ubuntu -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node "tags:*ubuntu* OR roles:*ubuntu* OR fqdn:*ubuntu* (etc.)" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This sub\-command has the following options: -.INDENT 0.0 -.TP -.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP -The attribute (or attributes) to show. -.TP -.B \fB\-b ROW\fP, \fB\-\-start ROW\fP -The row at which return results will begin. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.TP -.B \fB\-i\fP, \fB\-\-id\-only\fP -Use to show only matching object IDs. -.TP -.B \fBINDEX\fP -The name of the index to be queried: \fBclient\fP, \fBenvironment\fP, \fBnode\fP, \fBrole\fP, or \fBDATA_BAG_NAME\fP\&. Default index: \fBnode\fP\&. -.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\-l\fP, \fB\-\-long\fP -Use to display all attributes in the output and to show the output as JSON\&. -.TP -.B \fB\-m\fP, \fB\-\-medium\fP -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. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-q SEARCH_QUERY\fP, \fB\-\-query SEARCH_QUERY\fP -Use to protect search queries that start with a hyphen (\-). A \fB\-q\fP query may be specified as an argument or an option, but not both. -.TP -.B \fB\-r\fP, \fB\-\-run\-list\fP -Use to show only the run\-list. -.TP -.B \fB\-R INT\fP, \fB\-\-rows INT\fP -The number of rows to be returned. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.TP -.B \fBSEARCH_QUERY\fP -The search query used to identify a a list of items on a Chef server\&. This option uses the same syntax as the \fBsearch\fP sub\-command. -.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. -.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\-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 -.sp -To search for the IDs of all nodes running on the Amazon EC2 platform, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node \(aqec2:*\(aq \-i -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -4 items found - -ip\-0A7CA19F.ec2.internal - -ip\-0A58CF8E.ec2.internal - -ip\-0A58E134.ec2.internal - -ip\-0A7CFFD5.ec2.internal -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To search for the instance type (flavor) of all nodes running on the Amazon EC2 platform, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node \(aqec2:*\(aq \-a ec2.instance_type -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -4 items found - -ec2.instance_type: m1.large -id: ip\-0A7CA19F.ec2.internal - -ec2.instance_type: m1.large -id: ip\-0A58CF8E.ec2.internal - -ec2.instance_type: m1.large -id: ip\-0A58E134.ec2.internal - -ec2.instance_type: m1.large -id: ip\-0A7CFFD5.ec2.internal -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To search for all nodes running Ubuntu, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node \(aqplatform:ubuntu\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To search for all nodes running CentOS in the production environment, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node \(aqchef_environment:production AND platform:centos\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To find a nested attribute, use a pattern similar to the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node <query_to_run> \-a <main_attribute>.<nested_attribute> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To build a search query to use more than one attribute, use an underscore (\fB_\fP) to separate each attribute. For example, the following query will search for all nodes running a specific version of Ruby: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node "languages_ruby_version:1.9.3" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To build a search query that can find a nested attribute: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node name:<node_name> \-a kernel.machine -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To test a search query that will be used in a \fBknife ssh\fP command: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife search node "role:web NOT name:web03" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -where the query in the previous example will search all servers that have the \fBweb\fP role, but not on the server named \fBweb03\fP\&. -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-serve.1 b/distro/common/man/man1/knife-serve.1 deleted file mode 100644 index 8760559f32..0000000000 --- a/distro/common/man/man1/knife-serve.1 +++ /dev/null @@ -1,109 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-SERVE" "1" "Chef 12.0" "" "knife serve" -.SH NAME -knife-serve \- The man page for the knife serve subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife serve\fP subcommand is used to run a persistent chef\-zero against the local chef\-repo\&. (chef\-zero is a lightweight Chef server that runs in\-memory on the local machine.) This is the same as running the chef\-client executable with the \fB\-\-local\-mode\fP option. The \fBchef_repo_path\fP is located automatically and the Chef server will bind to the first available port between \fB8889\fP and \fB9999\fP\&. \fBknife serve\fP will print the URL for the local Chef server, so that it may be added to the knife.rb file. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife serve (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-show.1 b/distro/common/man/man1/knife-show.1 deleted file mode 100644 index 94f295afb7..0000000000 --- a/distro/common/man/man1/knife-show.1 +++ /dev/null @@ -1,160 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-SHOW" "1" "Chef 12.0" "" "knife show" -.SH NAME -knife-show \- The man page for the knife show subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife show\fP subcommand is used to view the details of one (or more) objects on the Chef server\&. This subcommand works similar to \fBknife cookbook show\fP, \fBknife data bag show\fP, \fBknife environment show\fP, \fBknife node show\fP, and \fBknife role show\fP, but with a single verb (and a single action). -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife show [PATTERN...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP -The attribute (or attributes) to show. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-local\fP -Use to show local files instead of remote files. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.sp -To show all cookbooks in the \fBcookbooks/\fP directory: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife show cookbooks/ -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or, (if already in the \fBcookbooks/\fP directory in the local chef\-repo): -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife show -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife show roles/ environments/ -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-ssh.1 b/distro/common/man/man1/knife-ssh.1 deleted file mode 100644 index 78555b7293..0000000000 --- a/distro/common/man/man1/knife-ssh.1 +++ /dev/null @@ -1,284 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-SSH" "1" "Chef 12.0" "" "knife ssh" -.SH NAME -knife-ssh \- The man page for the knife ssh subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife ssh\fP subcommand is used to invoke SSH commands (in parallel) on a subset of nodes within an organization, based on the results of a \fI\%search query\fP made to the Chef server\&. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssh SEARCH_QUERY SSH_COMMAND (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-a SSH_ATTR\fP, \fB\-\-attribute SSH_ATTR\fP -The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -.TP -.B \fB\-A\fP, \fB\-\-forward\-agent\fP -Use to enable SSH agent forwarding. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-C NUM\fP, \fB\-\-concurrency NUM\fP -The number of allowed concurrent connections. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-i IDENTITY_FILE\fP, \fB\-\-identity\-file IDENTIFY_FILE\fP -The SSH identity file used for authentication. Key\-based authentication is recommended. -.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\-m\fP, \fB\-\-manual\-list\fP -Use to define a search query as a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP -.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 \fBOTHER\fP -The shell type. Possible values: \fBinteractive\fP, \fBscreen\fP, \fBtmux\fP, \fBmacterm\fP, or \fBcssh\fP\&. (\fBcsshx\fP is deprecated in favor of \fBcssh\fP\&.) -.TP -.B \fB\-p PORT\fP, \fB\-\-ssh\-port PORT\fP -The SSH port. -.TP -.B \fB\-P PASSWORD\fP, \fB\-\-ssh\-password PASSWORD\fP -The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) knife will prompt for the password. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.TP -.B \fBSEARCH_QUERY\fP -The search query used to return a list of servers to be accessed using SSH and the specified \fBSSH_COMMAND\fP\&. This option uses the same syntax as the search sub\-command. -.TP -.B \fBSSH_COMMAND\fP -The command that will be run against the results of a search query. -.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. -.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\-x USER_NAME\fP, \fB\-\-ssh\-user USER_NAME\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 -.sp -To find the uptime of all of web servers running Ubuntu on the Amazon EC2 platform, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssh "role:web" "uptime" \-x ubuntu \-a ec2.public_hostname -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ec2\-174\-129\-127\-206.compute\-1.amazonaws.com 13:50:47 up 1 day, 23:26, 1 user, load average: 0.25, 0.18, 0.11 -ec2\-67\-202\-63\-102.compute\-1.amazonaws.com 13:50:47 up 1 day, 23:33, 1 user, load average: 0.12, 0.13, 0.10 -ec2\-184\-73\-9\-250.compute\-1.amazonaws.com 13:50:48 up 16:45, 1 user, load average: 0.30, 0.22, 0.13 -ec2\-75\-101\-240\-230.compute\-1.amazonaws.com 13:50:48 up 1 day, 22:59, 1 user, load average: 0.24, 0.17, 0.11 -ec2\-184\-73\-60\-141.compute\-1.amazonaws.com 13:50:48 up 1 day, 23:30, 1 user, load average: 0.32, 0.17, 0.15 -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssh \(aqname:*\(aq \(aqsudo chef\-client\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To force a chef\-client run on all of the web servers running Ubuntu on the Amazon EC2 platform, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssh "role:web" "sudo chef\-client" \-x ubuntu \-a ec2.public_hostname -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ec2\-67\-202\-63\-102.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:37 +0000] INFO: Starting Chef Run (Version 0.9.10) -ec2\-174\-129\-127\-206.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:37 +0000] INFO: Starting Chef Run (Version 0.9.10) -ec2\-184\-73\-9\-250.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) -ec2\-75\-101\-240\-230.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) -ec2\-184\-73\-60\-141.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:38 +0000] INFO: Starting Chef Run (Version 0.9.10) -ec2\-174\-129\-127\-206.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Chef Run complete in 1.419243 seconds -ec2\-174\-129\-127\-206.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: cleaning the checksum cache -ec2\-174\-129\-127\-206.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Running report handlers -ec2\-174\-129\-127\-206.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Report handlers complete -ec2\-67\-202\-63\-102.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Chef Run complete in 1.578265 seconds -ec2\-67\-202\-63\-102.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: cleaning the checksum cache -ec2\-67\-202\-63\-102.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Running report handlers -ec2\-67\-202\-63\-102.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:39 +0000] INFO: Report handlers complete -ec2\-184\-73\-9\-250.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.638884 seconds -ec2\-184\-73\-9\-250.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache -ec2\-184\-73\-9\-250.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers -ec2\-184\-73\-9\-250.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete -ec2\-75\-101\-240\-230.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.540257 seconds -ec2\-75\-101\-240\-230.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache -ec2\-75\-101\-240\-230.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers -ec2\-75\-101\-240\-230.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete -ec2\-184\-73\-60\-141.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Chef Run complete in 1.502489 seconds -ec2\-184\-73\-60\-141.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: cleaning the checksum cache -ec2\-184\-73\-60\-141.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Running report handlers -ec2\-184\-73\-60\-141.compute\-1.amazonaws.com [Fri, 22 Oct 2010 14:18:40 +0000] INFO: Report handlers complete -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To query for all nodes that have the \fBwebserver\fP role and then use SSH to run the command \fBsudo chef\-client\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssh "role:webserver" "sudo chef\-client" -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssh name:* "sudo aptitude upgrade \-y" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To specify the shell type used on the nodes returned by a search query: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssh roles:opscode\-omnitruck macterm -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -where \fBscreen\fP is one of the following values: \fBcssh\fP, \fBinteractive\fP, \fBmacterm\fP, \fBscreen\fP, or \fBtmux\fP\&. If the node does not have the shell type installed, knife will return an error similar to the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -you need the rb\-appscript gem to use knife ssh macterm. -\(ga(sudo) gem install rb\-appscript\(ga to install -ERROR: LoadError: cannot load such file \-\- appscript -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-ssl-check.1 b/distro/common/man/man1/knife-ssl-check.1 deleted file mode 100644 index 23b945468d..0000000000 --- a/distro/common/man/man1/knife-ssl-check.1 +++ /dev/null @@ -1,207 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.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. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife ssl check\fP subcommand is used to verify the SSL configuration for the Enterprise Chef and/or Open Source Chef servers, or at another location specified by a URL or URI. -.sp -\fBWARNING:\fP -.INDENT 0.0 -.INDENT 3.5 -When verification of a remote server\(aqs SSL certificate is disabled, the chef\-client will issue a warning similar to "SSL validation of HTTPS requests is disabled. HTTPS connections are still encrypted, but the chef\-client is not able to detect forged replies or man\-in\-the\-middle attacks." To configure SSL for the chef\-client, set \fBssl_verify_mode\fP to \fB:verify_peer\fP (recommended) \fBor\fP \fBverify_api_cert\fP to \fBtrue\fP in the client.rb file. -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl check URI -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-a SSH_ATTR\fP, \fB\-\-attribute SSH_ATTR\fP -The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -.TP -.B \fB\-A\fP, \fB\-\-forward\-agent\fP -Use to enable SSH agent forwarding. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-C NUM\fP, \fB\-\-concurrency NUM\fP -The number of allowed concurrent connections. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-i IDENTITY_FILE\fP, \fB\-\-identity\-file IDENTIFY_FILE\fP -The SSH identity file used for authentication. Key\-based authentication is recommended. -.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\-m\fP, \fB\-\-manual\-list\fP -Use to define a search query as a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP -.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 \fBOTHER\fP -The shell type. Possible values: \fBinteractive\fP, \fBscreen\fP, \fBtmux\fP, \fBmacterm\fP, or \fBcssh\fP\&. (\fBcsshx\fP is deprecated in favor of \fBcssh\fP\&.) -.TP -.B \fB\-p PORT\fP, \fB\-\-ssh\-port PORT\fP -The SSH port. -.TP -.B \fB\-P PASSWORD\fP, \fB\-\-ssh\-password PASSWORD\fP -The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) knife will prompt for the password. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.TP -.B \fBSEARCH_QUERY\fP -The search query used to return a list of servers to be accessed using SSH and the specified \fBSSH_COMMAND\fP\&. This option uses the same syntax as the search sub\-command. -.TP -.B \fBSSH_COMMAND\fP -The command that will be run against the results of a search query. -.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. -.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\-x USER_NAME\fP, \fB\-\-ssh\-user USER_NAME\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 -.sp -The following examples show how to use this knife subcommand: -.sp -\fBVerify the SSL configuration for the Chef server\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl check -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBVerify the SSL configuration for the chef\-client\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl check \-c /etc/chef/client.rb -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBVerify an external server\(aqs SSL certificate\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl check URL_or_URI -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -for example: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl check https://www.getchef.com -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-ssl-fetch.1 b/distro/common/man/man1/knife-ssl-fetch.1 deleted file mode 100644 index 88b0ad1ebf..0000000000 --- a/distro/common/man/man1/knife-ssl-fetch.1 +++ /dev/null @@ -1,207 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.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. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife ssl fetch\fP subcommand is used to copy SSL certificates from an HTTPS server to the \fBtrusted_certs_dir\fP directory that is used by knife and the chef\-client to store trusted SSL certificates. When these certificates match the hostname of the remote server, running \fBknife ssl fetch\fP is the only step required to verify a remote server that is accessed by either knife or the chef\-client\&. -.sp -\fBWARNING:\fP -.INDENT 0.0 -.INDENT 3.5 -It is the user\(aqs responsibility to verify the authenticity of every SSL certificate before downloading it to the \fBtrusted_certs_dir\fP directory. knife will use any certificate in that directory as if it is a 100% trusted and authentic SSL certificate. knife will not be able to determine if any certificate in this directory has been tampered with, is forged, malicious, or otherwise harmful. Therefore it is essential that users take the proper steps before downloading certificates into this directory. -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl fetch URI_FOR_HTTPS_SERVER -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-a SSH_ATTR\fP, \fB\-\-attribute SSH_ATTR\fP -The attribute that is used when opening the SSH connection. The default attribute is the FQDN of the host. Other possible values include a public IP address, a private IP address, or a hostname. -.TP -.B \fB\-A\fP, \fB\-\-forward\-agent\fP -Use to enable SSH agent forwarding. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-C NUM\fP, \fB\-\-concurrency NUM\fP -The number of allowed concurrent connections. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-i IDENTITY_FILE\fP, \fB\-\-identity\-file IDENTIFY_FILE\fP -The SSH identity file used for authentication. Key\-based authentication is recommended. -.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\-m\fP, \fB\-\-manual\-list\fP -Use to define a search query as a space\-separated list of servers. If there is more than one item in the list, put quotes around the entire list. For example: \fB\-\-manual\-list "server01 server 02 server 03"\fP -.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 \fBOTHER\fP -The shell type. Possible values: \fBinteractive\fP, \fBscreen\fP, \fBtmux\fP, \fBmacterm\fP, or \fBcssh\fP\&. (\fBcsshx\fP is deprecated in favor of \fBcssh\fP\&.) -.TP -.B \fB\-p PORT\fP, \fB\-\-ssh\-port PORT\fP -The SSH port. -.TP -.B \fB\-P PASSWORD\fP, \fB\-\-ssh\-password PASSWORD\fP -The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) knife will prompt for the password. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.TP -.B \fBSEARCH_QUERY\fP -The search query used to return a list of servers to be accessed using SSH and the specified \fBSSH_COMMAND\fP\&. This option uses the same syntax as the search sub\-command. -.TP -.B \fBSSH_COMMAND\fP -The command that will be run against the results of a search query. -.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. -.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\-x USER_NAME\fP, \fB\-\-ssh\-user USER_NAME\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 -.sp -The following examples show how to use this knife subcommand: -.sp -\fBFetch the SSL certificates used by Knife from the Chef server\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl fetch -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBFetch the SSL certificates used by the chef\-client from the Chef server\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl fetch \-c /etc/chef/client.rb -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBFetch SSL certificates from a URL or URI\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl fetch URL_or_URI -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -for example: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife ssl fetch https://www.getchef.com -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-status.1 b/distro/common/man/man1/knife-status.1 deleted file mode 100644 index 038cf3a0f0..0000000000 --- a/distro/common/man/man1/knife-status.1 +++ /dev/null @@ -1,234 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-STATUS" "1" "Chef 12.0" "" "knife status" -.SH NAME -knife-status \- The man page for the knife status subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife status\fP subcommand is used to display a brief summary of the nodes on a Chef server, including the time of the most recent successful chef\-client run. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.TP -.B \fB\-H\fP, \fB\-\-hide\-healthy\fP -Use to hide nodes on which a chef\-client run has occurred within the previous hour. -.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\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fBSEARCH_QUERY\fP -The search query used to identify a a list of items on a Chef server\&. This option uses the same syntax as the \fBsearch\fP sub\-command. -.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\fP, \fB\-\-sort\-reverse\fP -Use to sort a list by last run time, descending. -.TP -.B \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.sp -To include run lists in the status, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status \-\-run\-list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -20 hours ago, dev\-vm.chisamore.com, ubuntu 10.04, dev\-vm.chisamore.com, 10.66.44.126, role[lb]. -3 hours ago, i\-225f954f, ubuntu 10.04, ec2\-67\-202\-63\-102.compute\-1.amazonaws.com, 67.202.63.102, role[web]. -3 hours ago, i\-a45298c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 174.129.127.206, role[web]. -3 hours ago, i\-5272a43f, ubuntu 10.04, ec2\-184\-73\-9\-250.compute\-1.amazonaws.com, 184.73.9.250, role[web]. -3 hours ago, i\-226ca64f, ubuntu 10.04, ec2\-75\-101\-240\-230.compute\-1.amazonaws.com, 75.101.240.230, role[web]. -3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141, role[web]. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show the status for nodes on which the chef\-client did not run successfully within the past hour, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status \-\-hide\-healthy -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -1 hour ago, i\-256f884f, ubuntu 12.04, ec2\-67\-202\-63\-102.compute\-1.amazonaws.com, 67.202.63.102, role[web]. -1 hour ago, i\-a47823c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 184.129.143.111, role[lb]. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show the status of a subset of nodes that are returned by a specific query, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status "role:web" \-\-run\-list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -3 hours ago, i\-225f954f, ubuntu 10.04, ec2\-67\-202\-63\-102.compute\-1.amazonaws.com, 67.202.63.102, role[web]. -3 hours ago, i\-a45298c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 174.129.127.206, role[web]. -3 hours ago, i\-5272a43f, ubuntu 10.04, ec2\-184\-73\-9\-250.compute\-1.amazonaws.com, 184.73.9.250, role[web]. -3 hours ago, i\-226ca64f, ubuntu 10.04, ec2\-75\-101\-240\-230.compute\-1.amazonaws.com, 75.101.240.230, role[web]. -3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141, role[web]. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view the status of all nodes in the organization, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -20 hours ago, dev\-vm.chisamore.com, ubuntu 10.04, dev\-vm.chisamore.com, 10.66.44.126 -3 hours ago, i\-225f954f, ubuntu 10.04, ec2\-67\-202\-63\-102.compute\-1.amazonaws.com, 67.202.63.102 -3 hours ago, i\-a45298c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 174.129.127.206 -3 hours ago, i\-5272a43f, ubuntu 10.04, ec2\-184\-73\-9\-250.compute\-1.amazonaws.com, 184.73.9.250 -3 hours ago, i\-226ca64f, ubuntu 10.04, ec2\-75\-101\-240\-230.compute\-1.amazonaws.com, 75.101.240.230 -3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141 -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-tag.1 b/distro/common/man/man1/knife-tag.1 deleted file mode 100644 index 3149f520f1..0000000000 --- a/distro/common/man/man1/knife-tag.1 +++ /dev/null @@ -1,189 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-TAG" "1" "Chef 12.0" "" "knife tag" -.SH NAME -knife-tag \- The man page for the knife tag subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -A tag is a custom description that is applied to a node. A tag, once applied, can be helpful when managing nodes using knife or when building recipes by providing alternate methods of grouping similar types of information. -.sp -The \fBknife tag\fP subcommand is used to apply tags to nodes on a Chef server\&. -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife tag\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.SH CREATE -.sp -The \fBcreate\fP argument is used to add one or more tags to a node. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife tag create NODE_NAME [TAG...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To create tags named \fBseattle\fP, \fBportland\fP, and \fBvancouver\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife tag create node seattle portland vancouver -.ft P -.fi -.UNINDENT -.UNINDENT -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete one or more tags from a node. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife tag delete NODE_NAME [TAG...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To delete tags named \fBdenver\fP and \fBphoenix\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife tag delete node denver phoenix -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Type \fBY\fP to confirm a deletion. -.SH LIST -.sp -The \fBlist\fP argument is used to list all of the tags that have been applied to a node. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife tag list [NODE_NAME...] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-upload.1 b/distro/common/man/man1/knife-upload.1 deleted file mode 100644 index dfc20e0270..0000000000 --- a/distro/common/man/man1/knife-upload.1 +++ /dev/null @@ -1,280 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-UPLOAD" "1" "Chef 12.0" "" "knife upload" -.SH NAME -knife-upload \- The man page for the knife upload subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife upload\fP subcommand is used to upload roles, cookbooks, environments, and data bags to the Chef server from the current working directory in the chef\-repo\&. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be uploaded, and then \fBknife download\fP, which does the opposite of \fBknife upload\fP\&. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload [PATTERN...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-\-[no\-]diff\fP -Use to upload only new and modified files. Set to \fBfalse\fP to upload all files. Default: \fBtrue\fP\&. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-\-[no\-]force\fP -Use \fB\-\-force\fP to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no \fBPOST\fP or \fBPUT\fP is performed unless an actual change would be made). Default: \fB\-\-no\-force\fP\&. -.TP -.B \fB\-\-[no\-]freeze\fP -Use to require changes to a cookbook be included as a new version. Only the \fB\-\-force\fP option can override this setting. Default: \fBfalse\fP\&. -.TP -.B \fB\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\fP, \fB\-\-dry\-run\fP -Use to take no action and only print out results. Default: \fBfalse\fP\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-\-[no\-]purge\fP -Use \fB\-\-purge\fP to delete roles, cookbooks, etc. from the Chef server if their corresponding files do not exist in the chef\-repo\&. By default, such objects are left alone and NOT purged. Default: \fB\-\-no\-purge\fP\&. -.TP -.B \fB\-\-[no\-]recurse\fP -Use \fB\-\-no\-recurse\fP to disable uploading a directory recursively. Default: \fB\-\-recurse\fP\&. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.sp -Browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from anywhere in the chef\-repo, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload / -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload cookbooks -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from anywhere in the chef\-repo, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload /cookbooks -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload environments -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from anywhere in the chef\-repo, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload /environments -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload environments/production.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from the \fBenvironments/\fP directory, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload production.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload roles -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or from anywhere in the chef\-repo, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload /roles -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Browse to the top level of the chef\-repo and enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload cookbooks/apache\e* roles/webserver.json -.ft P -.fi -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife upload \(gaknife deps nodes/*.json\(ga -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-user.1 b/distro/common/man/man1/knife-user.1 deleted file mode 100644 index cdd15b9d14..0000000000 --- a/distro/common/man/man1/knife-user.1 +++ /dev/null @@ -1,356 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-USER" "1" "Chef 12.0" "" "knife user" -.SH NAME -knife-user \- The man page for the knife user subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife user\fP subcommand is used to manage the list of users and their associated RSA public key\-pairs. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -This subcommand ONLY works when run against the open source Chef server version 10.x. This subcommand will NOT run against open source Chef server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef\&. -.UNINDENT -.UNINDENT -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife user\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.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 -.SH CREATE -.sp -The \fBcreate\fP argument is used to create a user. This process will generate an RSA key pair for the named user. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. -.INDENT 0.0 -.IP \(bu 2 -For the user, the private key should be copied to the system as \fB/etc/chef/client.pem\fP\&. -.IP \(bu 2 -For knife, the private key is typically copied to \fB~/.chef/client_name.pem\fP and referenced in the knife.rb configuration file. -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user create USER_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a\fP, \fB\-\-admin\fP -Use to create a client as an admin client. This is required for any user to access Open Source Chef as an administrator. This option only works when used with the open source Chef server and will have no effect when used with Enterprise Chef\&. -.TP -.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Use to save a private key to the specified file name. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. -.TP -.B \fB\-\-user\-key FILE_NAME\fP -All users are assigned a public key. Use to write the public key to a file. -.UNINDENT -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user create "Radio Birdman" \-f /keys/user_name -.ft P -.fi -.UNINDENT -.UNINDENT -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete a registered user. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user delete USER_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user delete "Steve Danno" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH EDIT -.sp -The \fBedit\fP argument is used to edit the details of a user. When this argument is run, knife will open $EDITOR\&. When finished, knife will update the Chef server with those changes. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user edit USER_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -None. -.SH LIST -.sp -The \fBlist\fP argument is used to view a list of registered users. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user list (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -None. -.SH REREGISTER -.sp -The \fBreregister\fP argument is used to regenerate an RSA key pair for a user. The public key will be stored on the Chef server and the private key will be displayed on \fBSTDOUT\fP or written to a named file. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Running this argument will invalidate the previous RSA key pair, making it unusable during authentication to the Chef server\&. -.UNINDENT -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user reregister USER_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Use to save a private key to the specified file name. -.UNINDENT -.sp -\fBExamples\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user reregister "Robert Younger" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to show the details of a user. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user show USER_NAME (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP -The attribute (or attributes) to show. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view a user named \fBDennis Teck\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user show "Dennis Teck" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -chef_type: user -json_class: Chef::User -name: Dennis Teck -public_key: -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife user show "Dennis Teck" \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -(Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP, e.g. \fB\-F yaml\fP for YAML\&.) -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife-xargs.1 b/distro/common/man/man1/knife-xargs.1 deleted file mode 100644 index 1fcc3d9f4a..0000000000 --- a/distro/common/man/man1/knife-xargs.1 +++ /dev/null @@ -1,189 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-XARGS" "1" "Chef 12.0" "" "knife xargs" -.SH NAME -knife-xargs \- The man page for the knife xargs subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife xargs\fP subcommand is used to take patterns from standard input, download as JSON, run a command against the downloaded JSON, and then upload any changes. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife xargs [PATTERN...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-0\fP -Use to show a \fBNULL\fP character (\fB\e0\fP) instead of white space as the separator. Default: \fBfalse\fP\&. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP\&. -.TP -.B \fB\-\-[no\-]diff\fP -Use to show a diff when a file changes. Default: \fB\-\-diff\fP\&. -.TP -.B \fB\-\-dry\-run\fP -Use to prevent changes from being uploaded to the Chef server\&. Default: \fBfalse\fP\&. -.TP -.B \fB\-\-[no\-]force\fP -Use to force the upload of files even if they haven\(aqt been changed. Default: \fB\-\-no\-force\fP\&. -.TP -.B \fB\-I REPLACE_STRING\fP, \fB\-\-replace REPLACE_STRING\fP -Use to define a string that will be used to replace all occurrences of a file name. Default: \fBnil\fP\&. -.TP -.B \fB\-J REPLACE_STRING\fP, \fB\-\-replace\-first REPLACE_STRING\fP -Use to define a string that will be used to replace the first occurrence of a file name. Default: \fBnil\fP\&. -.TP -.B \fB\-\-local\fP -Use to build or execute a command line against a local file. Set to \fBfalse\fP to build or execute against a remote file. Default: \fBfalse\fP\&. -.TP -.B \fB\-n MAX_ARGS\fP, \fB\-\-max\-args MAX_ARGS\fP -The maximum number of arguments per command line. Default: \fBnil\fP\&. -.TP -.B \fB\-p [PATTERN...]\fP, \fB\-\-pattern [PATTERN...]\fP -One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: \fBnil\fP\&. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default value: \fBdefault\fP\&. -.TP -.B \fB\-s LENGTH\fP, \fB\-\-max\-chars LENGTH\fP -The maximum size (in characters) for a command line. Default: \fBnil\fP\&. -.TP -.B \fB\-t\fP -Use to run the print command on the command line. Default: \fBnil\fP\&. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.sp -The following examples show various ways of listing all nodes on the server, and then using Perl to replace \fBgrantmc\fP with \fBgmc\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife list \(aqnodes/*\(aq | knife xargs "perl \-i \-pe \(aqs/grantmc/gmc\(aq" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or without quotes and the backslash escaped: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife list /nodes/\e* | knife xargs "perl \-i \-pe \(aqs/grantmc/gmc\(aq" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or by using the \fB\-\-pattern\fP option: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife xargs \-\-pattern \(aq/nodes.*\(aq "perl \-i \-pe \(aqs/grantmc/gmc\(aq" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. diff --git a/distro/common/man/man1/knife.1 b/distro/common/man/man1/knife.1 deleted file mode 100644 index 9259da8477..0000000000 --- a/distro/common/man/man1/knife.1 +++ /dev/null @@ -1,332 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE" "1" "Chef 12.0" "" "knife" -.SH NAME -knife \- The man page for the knife command line tool. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -knife is a command\-line tool that provides an interface between a local chef\-repo and the Chef server\&. knife helps users to manage: -.INDENT 0.0 -.IP \(bu 2 -Nodes -.IP \(bu 2 -Cookbooks and recipes -.IP \(bu 2 -Roles -.IP \(bu 2 -Stores of JSON data (data bags), including encrypted data -.IP \(bu 2 -Environments -.IP \(bu 2 -Cloud resources, including provisioning -.IP \(bu 2 -The installation of the chef\-client on management workstations -.IP \(bu 2 -Searching of indexed data on the Chef server -.UNINDENT -.sp -Knife subcommands: -.INDENT 0.0 -.IP \(bu 2 -knife bootstrap -.IP \(bu 2 -knife client -.IP \(bu 2 -knife configure -.IP \(bu 2 -knife cookbook -.IP \(bu 2 -knife cookbook site -.IP \(bu 2 -knife data bag -.IP \(bu 2 -knife delete -.IP \(bu 2 -knife deps -.IP \(bu 2 -knife diff -.IP \(bu 2 -knife download -.IP \(bu 2 -knife edit -.IP \(bu 2 -knife environment -.IP \(bu 2 -knife exec -.IP \(bu 2 -knife list -.IP \(bu 2 -knife node -.IP \(bu 2 -knife raw -.IP \(bu 2 -knife recipe list -.IP \(bu 2 -knife role -.IP \(bu 2 -knife search -.IP \(bu 2 -knife show -.IP \(bu 2 -knife ssh -.IP \(bu 2 -knife status -.IP \(bu 2 -knife tag -.IP \(bu 2 -knife upload -.IP \(bu 2 -knife user -.IP \(bu 2 -knife xargs -.UNINDENT -.SH WORKING WITH KNIFE -.sp -knife runs from a management workstation and sits in\-between a Chef server and an organization\(aqs infrastructure. knife interacts with a Chef server by using the same REST API that is used by a chef\-client\&. Role\-based authentication controls (RBAC) can be used to authorize changes when knife is run with Enterprise Chef\&. knife is configured during workstation setup, but subsequent modifications can be made using the knife.rb configuration file. -.SS Common Options -.sp -The following options can be run with all knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. For example, when knife is run from a node that is configured to be managed by the Chef server, this option is used to allow knife to use the same credentials as the chef\-client when communicating with the Chef server\&. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.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. This option is ignored during search queries made using the \fBknife search\fP subcommand. -.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\-h\fP, \fB\-\-help\fP -Shows help for the command. -.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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.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. -.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\-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 -.SS JSON Data Format -.sp -Most data is entered using a text editor in JSON format, unless the \fB\-\-disable\-editing\fP option is entered as part of a command. (Encrypted data bags use YAML, which is a superset of JSON\&.) JSON is a common, language\-independent data format that provides a simple text representation of arbitrary data structures. For more information about JSON, see \fI\%http://www.json.org/\fP or \fI\%http://en.wikipedia.org/wiki/JSON\fP\&. -.SS Set the Text Editor -.sp -Some knife commands, such as \fBknife data bag edit\fP, require that information be edited as JSON data using a text editor. For example, the following command: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife data bag edit admins admin_name -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -will open up the text editor with data similar to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - "id": "admin_name" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Changes to that file can then be made: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - "id": "Justin C." - "description": "I am passing the time by letting time pass over me ..." -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The type of text editor that is used by knife can be configured by adding an entry to the knife.rb file or by setting an \fBEDITOR\fP environment variable. For example, to configure the text editor to always open with vim, add the following to the knife.rb file: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife[:editor] = "/usr/bin/vim" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -When a Microsoft Windows file path is enclosed in a double\-quoted string (" "), the same backslash character (\fB\e\fP) that is used to define the file path separator is also used in Ruby to define an escape character. The knife.rb file is a Ruby file; therefore, file path separators must be escaped. In addition, spaces in the file path must be replaced with \fB~1\fP so that the length of each section within the file path is not more than 8 characters. For example, if EditPad Pro is the text editor of choice and is located at the following path: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -C:\e\eProgram Files (x86)\eEditPad Pro\eEditPad.exe -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -the setting in the knife.rb file would be similar to: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife[:editor] = "C:\e\eProgra~1\e\eEditPa~1\e\eEditPad.exe" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -One approach to working around the double\- vs. single\-quote issue is to put the single\-quotes outside of the double\-quotes. For example, for Notepad++: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife[:editor] = \(aq"C:\eProgram Files (x86)\eNotepad++\enotepad++.exe \-nosession \-multiInst"\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -for Sublime Text: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife[:editor] = \(aq"C:\eProgram Files\eSublime Text 2\esublime_text.exe \-\-wait"\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -for TextPad: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife[:editor] = \(aq"C:\eProgram Files (x86)\eTextPad 7\eTextPad.exe"\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -and for vim: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -knife[:editor] = \(aq"C:\eProgram Files (x86)\evim\evim74\egvim.exe"\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.SS Using Quotes -.sp -Values can be entered with double quotes (" ") or single quotes (\(aq \(aq), but this should be done consistently. -.SS Sub\-commands -.sp -knife comes with a collection of built in subcommands that work together to provide all of the functionality required to take specific actions against any object in an organization, including cookbooks, nodes, roles, data bags, environments, and users. A knife plugin extends the functionality beyond built\-in subcommands. -.sp -knife has the following subcommands: \fBbootstrap\fP, \fBclient\fP, \fBconfigure\fP, \fBcookbook\fP, \fBcookbook site\fP, \fBdata bag\fP, \fBdelete\fP, \fBdeps\fP, \fBdiff\fP, \fBdownload\fP, \fBedit\fP, \fBenvironment\fP, \fBexec\fP, \fBindex rebuild\fP, \fBlist\fP, \fBnode\fP, \fBrecipe list\fP, \fBrole\fP, \fBsearch\fP, \fBshow\fP, \fBssh\fP, \fBstatus\fP, \fBtag\fP, \fBupload\fP, \fBuser\fP, and \fBxargs\fP\&. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -The following subcommands run only against the open source Chef server: \fBindex rebuild\fP and \fBuser\fP\&. -.UNINDENT -.UNINDENT -.SS Syntax -.sp -All knife subcommands have the following syntax: -.INDENT 0.0 -.INDENT 3.5 -knife subcommand [ARGUMENT] (options) -.UNINDENT -.UNINDENT -.sp -Each subcommand has its own set of arguments and options. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -All syntax examples in this document show variables in ALL_CAPS. For example \fB\-u PORT_LIST\fP (where PORT_LIST is a comma\-separated list of local and public UDP ports) or \fB\-F FORMAT\fP (where FORMAT determines the output format, either \fBsummary\fP, \fBtext\fP, \fBjson\fP, \fByaml\fP, or \fBpp\fP). These variables often require specific values that are unique to each organization. -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. |