chef 12.8.1-universal-mingw32 → 12.9.38-universal-mingw32

data/distro/common/markdown/man1/knife-client.mkd

@@ -1,103 +1,103 @@
-knife-client(1) -- Manage Chef API Clients
-========================================
-
-## SYNOPSIS
-
-__knife__ __client__ _sub-command_ _(options)_
-
-## SUB-COMMANDS
-Client subcommands follow a basic create, read, update, delete (CRUD)
-pattern. The Following subcommands are available:
-
-## BULK DELETE
-__knife client bulk delete__ _regex_ _(options)_
-
-Delete clients where the client name matches the regular expression
-_regex_ on the Chef Server. The regular expression should be given as a
-quoted string, and not surrounded by forward slashes.
-
-## CREATE
-__knife client create__ _client name_ _(options)_
-
-  * `-a`, `--admin    `:
-    Create the client as an admin
-  * `-f`, `--file FILE`:
-    Write the key to a file
-
-Create a new client. This generates an RSA keypair. The private key will
-be displayed on _STDOUT_ or written to the named file. The public half
-will be stored on the Server. For _chef-client_ systems, the private key
-should be copied to the system as `/etc/chef/client.pem`.
-
-Admin clients should be created for users that will use _knife_ to
-access the API as an administrator. The private key will generally be
-copied to `~/.chef/client\_name.pem` and referenced in the `knife.rb`
-configuration file.
-
-## DELETE
-__knife client delete__ _client name_  _(options)_
-
-Deletes a registered client.
-
-## EDIT
-__client edit__ _client name_ _(options)_
-
-Edit a registered client.
-
-## LIST
-__client list__ _(options)_
-
-  * `-w`, `--with-uri`:
-      Show corresponding URIs
-
-List all registered clients.
-
-## REREGISTER
-__client reregister__ _client name_  _(options)_
-
-  * `-f`, `--file FILE`:
-    Write the key to a file
-
-Regenerate the RSA keypair for a client. The public half will be stored
-on the server and the private key displayed on _STDOUT_ or written to
-the named file. This operation will invalidate the previous keypair used
-by the client, preventing it from authenticating with the Chef Server.
-Use care when reregistering the validator client.
-
-## SHOW
-__client show__ _client name_ _(options)_
-
-  * `-a`, `--attribute ATTR`:
-    Show only one attribute
-
-Show a client. Output format is determined by the --format option.
-
-## DESCRIPTION
-Clients are identities used for communication with the Chef Server API,
-roughly equivalent to user accounts on the Chef Server, except that
-clients only communicate with the Chef Server API and are authenticated
-via request signatures.
-
-In the typical case, there will be one client object on the server for
-each node, and the corresponding client and node will have identical
-names.
-
-In the Chef authorization model, there is one special client, the
-"validator", which is authorized to create new non-administrative
-clients but has minimal privileges otherwise. This identity is used as a
-sort of "guest account" to create a client identity when initially
-setting up a host for management with Chef.
-
-## SEE ALSO
-   __knife-node__(1)
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Joshua Timberman <joshua@opscode.com>.
-   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io>
-
+knife-client(1) -- Manage Chef API Clients
+========================================
+
+## SYNOPSIS
+
+__knife__ __client__ _sub-command_ _(options)_
+
+## SUB-COMMANDS
+Client subcommands follow a basic create, read, update, delete (CRUD)
+pattern. The Following subcommands are available:
+
+## BULK DELETE
+__knife client bulk delete__ _regex_ _(options)_
+
+Delete clients where the client name matches the regular expression
+_regex_ on the Chef Server. The regular expression should be given as a
+quoted string, and not surrounded by forward slashes.
+
+## CREATE
+__knife client create__ _client name_ _(options)_
+
+  * `-a`, `--admin    `:
+    Create the client as an admin
+  * `-f`, `--file FILE`:
+    Write the key to a file
+
+Create a new client. This generates an RSA keypair. The private key will
+be displayed on _STDOUT_ or written to the named file. The public half
+will be stored on the Server. For _chef-client_ systems, the private key
+should be copied to the system as `/etc/chef/client.pem`.
+
+Admin clients should be created for users that will use _knife_ to
+access the API as an administrator. The private key will generally be
+copied to `~/.chef/client\_name.pem` and referenced in the `knife.rb`
+configuration file.
+
+## DELETE
+__knife client delete__ _client name_  _(options)_
+
+Deletes a registered client.
+
+## EDIT
+__client edit__ _client name_ _(options)_
+
+Edit a registered client.
+
+## LIST
+__client list__ _(options)_
+
+  * `-w`, `--with-uri`:
+      Show corresponding URIs
+
+List all registered clients.
+
+## REREGISTER
+__client reregister__ _client name_  _(options)_
+
+  * `-f`, `--file FILE`:
+    Write the key to a file
+
+Regenerate the RSA keypair for a client. The public half will be stored
+on the server and the private key displayed on _STDOUT_ or written to
+the named file. This operation will invalidate the previous keypair used
+by the client, preventing it from authenticating with the Chef Server.
+Use care when reregistering the validator client.
+
+## SHOW
+__client show__ _client name_ _(options)_
+
+  * `-a`, `--attribute ATTR`:
+    Show only one attribute
+
+Show a client. Output format is determined by the --format option.
+
+## DESCRIPTION
+Clients are identities used for communication with the Chef Server API,
+roughly equivalent to user accounts on the Chef Server, except that
+clients only communicate with the Chef Server API and are authenticated
+via request signatures.
+
+In the typical case, there will be one client object on the server for
+each node, and the corresponding client and node will have identical
+names.
+
+In the Chef authorization model, there is one special client, the
+"validator", which is authorized to create new non-administrative
+clients but has minimal privileges otherwise. This identity is used as a
+sort of "guest account" to create a client identity when initially
+setting up a host for management with Chef.
+
+## SEE ALSO
+   __knife-node__(1)
+
+## AUTHOR
+   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
+
+## DOCUMENTATION
+   This manual page was written by Joshua Timberman <joshua@opscode.com>.
+   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
+
+## CHEF
+   Knife is distributed with Chef. <http://docs.chef.io>
+

data/distro/common/markdown/man1/knife-configure.mkd

@@ -1,70 +1,70 @@
-knife-configure(1) -- Generate configuration files for knife or Chef Client
-========================================
-
-## SYNOPSIS
-
-__knife__ __configure__ [client] _(options)_
-
-## DESCRIPTION
-Generates a knife.rb configuration file interactively. When given the
---initial option, also creates a new administrative user.
-
-## CONFIGURE SUBCOMMANDS ##
-
-__knife configure__ _(options)_
-
-  * `-i`, `--initial`:
-    Create an initial API Client
-  * `-r`, `--repository REPO`:
-    The path to your chef-repo
-
-Create a configuration file for knife. This will prompt for values to
-enter into the file. Default values are listed in square brackets if no
-other entry is typed. See __knife__(1) for a description of
-configuration options.
-
-__knife configure client__ _directory_
-
-Read the _knife.rb_ config file and generate a config file suitable for
-use in _/etc/chef/client.rb_ and copy the validation certificate into
-the specified _directory_.
-
-## EXAMPLES
-  * On a freshly installed Chef Server, use _knife configure -i_ to
-    create an administrator and knife configuration file. Leave the
-    field blank to accept the default value. On most systems, the
-    default values are acceptable.
-
-    user@host$ knife configure -i
-    Please enter the chef server URL: [http://localhost:4000]
-    Please enter a clientname for the new client: [username]
-    Please enter the existing admin clientname: [chef-webui]
-    Please enter the location of the existing admin client's private key: [/etc/chef/webui.pem]
-    Please enter the validation clientname: [chef-validator]
-    Please enter the location of the validation key: [/etc/chef/validation.pem]
-    Please enter the path to a chef repository (or leave blank):
-    Creating initial API user...
-    Created (or updated) client[username]
-    Configuration file written to /home/username/.chef/knife.rb
-
-    This creates a new administrator client named _username_, writes
-    a configuration file to _/home/username/.chef/knife.rb_, and the
-    private key to _/home/username/.chef/username.pem_. The
-    configuration file and private key may be copied to another system
-    to facilitate administration of the Chef Server from a remote
-    system. Depending on the value given for the Chef Server URL, you
-    may need to modify that setting after copying to a remote host.
-
-## SEE ALSO
-   __knife__(1) __knife-client__(1)
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Joshua Timberman <joshua@opscode.com>.
-   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io>
-
+knife-configure(1) -- Generate configuration files for knife or Chef Client
+========================================
+
+## SYNOPSIS
+
+__knife__ __configure__ [client] _(options)_
+
+## DESCRIPTION
+Generates a knife.rb configuration file interactively. When given the
+--initial option, also creates a new administrative user.
+
+## CONFIGURE SUBCOMMANDS ##
+
+__knife configure__ _(options)_
+
+  * `-i`, `--initial`:
+    Create an initial API Client
+  * `-r`, `--repository REPO`:
+    The path to your chef-repo
+
+Create a configuration file for knife. This will prompt for values to
+enter into the file. Default values are listed in square brackets if no
+other entry is typed. See __knife__(1) for a description of
+configuration options.
+
+__knife configure client__ _directory_
+
+Read the _knife.rb_ config file and generate a config file suitable for
+use in _/etc/chef/client.rb_ and copy the validation certificate into
+the specified _directory_.
+
+## EXAMPLES
+  * On a freshly installed Chef Server, use _knife configure -i_ to
+    create an administrator and knife configuration file. Leave the
+    field blank to accept the default value. On most systems, the
+    default values are acceptable.
+
+    user@host$ knife configure -i
+    Please enter the chef server URL: [http://localhost:4000]
+    Please enter a clientname for the new client: [username]
+    Please enter the existing admin clientname: [chef-webui]
+    Please enter the location of the existing admin client's private key: [/etc/chef/webui.pem]
+    Please enter the validation clientname: [chef-validator]
+    Please enter the location of the validation key: [/etc/chef/validation.pem]
+    Please enter the path to a chef repository (or leave blank):
+    Creating initial API user...
+    Created (or updated) client[username]
+    Configuration file written to /home/username/.chef/knife.rb
+
+    This creates a new administrator client named _username_, writes
+    a configuration file to _/home/username/.chef/knife.rb_, and the
+    private key to _/home/username/.chef/username.pem_. The
+    configuration file and private key may be copied to another system
+    to facilitate administration of the Chef Server from a remote
+    system. Depending on the value given for the Chef Server URL, you
+    may need to modify that setting after copying to a remote host.
+
+## SEE ALSO
+   __knife__(1) __knife-client__(1)
+
+## AUTHOR
+   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
+
+## DOCUMENTATION
+   This manual page was written by Joshua Timberman <joshua@opscode.com>.
+   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
+
+## CHEF
+   Knife is distributed with Chef. <http://docs.chef.io>
+

data/distro/common/markdown/man1/knife-cookbook-site.mkd

@@ -1,123 +1,123 @@
-knife-cookbook-site(1) -- Install and update open source cookbooks
-========================================
-
-## SYNOPSIS
-
-__knife__ __cookbook site__ _sub-command_ _(options)_
-
-## COOKBOOK SITE SUB-COMMANDS
-`knife cookbook site` provides the following subcommands:
-
-## INSTALL
-__cookbook site install COOKBOOK [VERSION]__ _(options)_
-
-  * `-D`, `--skip-dependencies `:
-    Skip automatic installation of dependencies.
-  * `-o`, `--cookbook-path PATH`:
-    Install cookbooks to PATH
-  * `-B`, `--branch BRANCH`:
-    Default branch to work with [defaults to master]
-
-Uses git(1) version control in conjunction with the cookbook site to
-install community contributed cookbooks to your local cookbook
-repository. Running `knife cookbook site install` does the following:
-
-1. A new "pristine copy" branch is created in git for tracking the
-   upstream;
-2. All existing cookbooks are removed from the branch;
-3. The cookbook is downloaded from the cookbook site in tarball form;
-4. The downloaded cookbook is untarred, and its contents committed via git;
-5. The pristine copy branch is merged into the master branch.
-
-By installing cookbook with this process, you can locally modify the
-upstream cookbook in your master branch and let git maintain your
-changes as a separate patch.  When an updated upstream version becomes
-available, you will be able to merge the upstream changes while
-maintaining your local modifications.
-
-Unless _--skip-dependencies_ is specified, the process is applied recursively to all the
-cookbooks _COOKBOOK_ depends on (via metadata _dependencies_).
-
-## DOWNLOAD
-__knife cookbook site download COOKBOOK [VERSION]__ _(options)_
-
-  * `-f`, `--file FILE`:
-    The filename to write to
-  * `--force`:
-    Force download deprecated cookbook
-
-Downloads a specific cookbook from the Community site, optionally
-specifying a certain version.
-
-## LIST
-__knife cookbook site list__ _(options)_
-
-  * `-w`, `--with-uri`:
-    Show corresponding URIs
-
-Lists available cookbooks from the Community site.
-
-## SEARCH
-__knife cookbook site search QUERY__ _(options)_
-
-Searches for available cookbooks matching the specified query.
-
-## SHARE
-__knife cookbook site share COOKBOOK CATEGORY__ _(options)_
-
-  * `-k`, `--key KEY`:
-    API Client Key
-  * `-u`, `--user USER`:
-    API Client Username
-  * `-o`, `--cookbook-path PATH:PATH`:
-    A colon-separated path to look for cookbooks in
-
-Uploads the specified cookbook using the given category to the Opscode
-cookbooks site. Requires a login user and certificate for the Opscode
-Cookbooks site. By default, knife will use the username and API key
-you've configured in your configuration file; otherwise you must
-explicitly set these values on the command line or use an alternate
-configuration file.
-
-## UNSHARE
-__knife cookbook site unshare COOKBOOK__
-
-Stops sharing the specified cookbook on the Opscode cookbooks site.
-
-## SHOW
-__knife cookbook site show COOKBOOK [VERSION]__ _(options)_
-
-Shows information from the site about a particular cookbook.
-
-## DESCRIPTION
-The cookbook site, <http://community.opscode.com/>, is a cookbook
-distribution service operated by Opscode. This service provides users
-with a central location to publish cookbooks for sharing with other
-community members.
-
-`knife cookbook site` commands provide an interface to the cookbook
-site's HTTP API. For commands that read data from the API, no account is
-required. In order to upload cookbooks using the `knife cookbook site
-share` command, you must create an account on the cookbook site and
-configure your credentials via command line option or in your knife
-configuration file.
-
-## EXAMPLES
-Uploading cookbooks to the Opscode cookbooks site:
-
-    knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME
-
-## SEE ALSO
-   __knife-cookbook(1)__
-   <http://community.opscode.com/cookbooks>
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Joshua Timberman <joshua@opscode.com>.
-   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io>
-
+knife-cookbook-site(1) -- Install and update open source cookbooks
+========================================
+
+## SYNOPSIS
+
+__knife__ __cookbook site__ _sub-command_ _(options)_
+
+## COOKBOOK SITE SUB-COMMANDS
+`knife cookbook site` provides the following subcommands:
+
+## INSTALL
+__cookbook site install COOKBOOK [VERSION]__ _(options)_
+
+  * `-D`, `--skip-dependencies `:
+    Skip automatic installation of dependencies.
+  * `-o`, `--cookbook-path PATH`:
+    Install cookbooks to PATH
+  * `-B`, `--branch BRANCH`:
+    Default branch to work with [defaults to master]
+
+Uses git(1) version control in conjunction with the cookbook site to
+install community contributed cookbooks to your local cookbook
+repository. Running `knife cookbook site install` does the following:
+
+1. A new "pristine copy" branch is created in git for tracking the
+   upstream;
+2. All existing cookbooks are removed from the branch;
+3. The cookbook is downloaded from the cookbook site in tarball form;
+4. The downloaded cookbook is untarred, and its contents committed via git;
+5. The pristine copy branch is merged into the master branch.
+
+By installing cookbook with this process, you can locally modify the
+upstream cookbook in your master branch and let git maintain your
+changes as a separate patch.  When an updated upstream version becomes
+available, you will be able to merge the upstream changes while
+maintaining your local modifications.
+
+Unless _--skip-dependencies_ is specified, the process is applied recursively to all the
+cookbooks _COOKBOOK_ depends on (via metadata _dependencies_).
+
+## DOWNLOAD
+__knife cookbook site download COOKBOOK [VERSION]__ _(options)_
+
+  * `-f`, `--file FILE`:
+    The filename to write to
+  * `--force`:
+    Force download deprecated cookbook
+
+Downloads a specific cookbook from the Community site, optionally
+specifying a certain version.
+
+## LIST
+__knife cookbook site list__ _(options)_
+
+  * `-w`, `--with-uri`:
+    Show corresponding URIs
+
+Lists available cookbooks from the Community site.
+
+## SEARCH
+__knife cookbook site search QUERY__ _(options)_
+
+Searches for available cookbooks matching the specified query.
+
+## SHARE
+__knife cookbook site share COOKBOOK CATEGORY__ _(options)_
+
+  * `-k`, `--key KEY`:
+    API Client Key
+  * `-u`, `--user USER`:
+    API Client Username
+  * `-o`, `--cookbook-path PATH:PATH`:
+    A colon-separated path to look for cookbooks in
+
+Uploads the specified cookbook using the given category to the Opscode
+cookbooks site. Requires a login user and certificate for the Opscode
+Cookbooks site. By default, knife will use the username and API key
+you've configured in your configuration file; otherwise you must
+explicitly set these values on the command line or use an alternate
+configuration file.
+
+## UNSHARE
+__knife cookbook site unshare COOKBOOK__
+
+Stops sharing the specified cookbook on the Opscode cookbooks site.
+
+## SHOW
+__knife cookbook site show COOKBOOK [VERSION]__ _(options)_
+
+Shows information from the site about a particular cookbook.
+
+## DESCRIPTION
+The cookbook site, <http://community.opscode.com/>, is a cookbook
+distribution service operated by Opscode. This service provides users
+with a central location to publish cookbooks for sharing with other
+community members.
+
+`knife cookbook site` commands provide an interface to the cookbook
+site's HTTP API. For commands that read data from the API, no account is
+required. In order to upload cookbooks using the `knife cookbook site
+share` command, you must create an account on the cookbook site and
+configure your credentials via command line option or in your knife
+configuration file.
+
+## EXAMPLES
+Uploading cookbooks to the Opscode cookbooks site:
+
+    knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME
+
+## SEE ALSO
+   __knife-cookbook(1)__
+   <http://community.opscode.com/cookbooks>
+
+## AUTHOR
+   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
+
+## DOCUMENTATION
+   This manual page was written by Joshua Timberman <joshua@opscode.com>.
+   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
+
+## CHEF
+   Knife is distributed with Chef. <http://docs.chef.io>
+