chef 0.10.0.beta.7 → 0.10.0.beta.8

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

@@ -0,0 +1,101 @@
+knife-client(1) -- Manage Chef API Clients
+========================================
+
+## SYNOPSIS
+
+__knife__ __client__ _sub-command_ _(options)_
+
+## 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.
+
+## CLIENT SUB-COMMANDS
+
+## 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.
+
+## 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://wiki.opscode.com/display/chef/Home>
+

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

@@ -0,0 +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://wiki.opscode.com/display/chef/Home>
+

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

@@ -0,0 +1,69 @@
+knife-cookbook-site(1) -- Install and update open source cookbooks
+========================================
+
+## SYNOPSIS
+
+__knife__ __cookbook site__ _sub-command_ _(options)_
+
+## COOKBOOK SITE SUB-COMMANDS
+
+The following sub-commands are still in the context of cookbooks, but they make use of Opscode's Cookbook Community site, _http://cookbooks.opscode.com/_. That site has an API, and these sub-commands utilize that API, rather than the Chef Server API.
+
+__cookbook site download COOKBOOK [VERSION]__ _(options)_
+
+  * `-f`, `--file FILE`:
+    The filename to write to
+
+Downloads a specific cookbook from the Community site, optionally specifying a certain version.
+
+__cookbook site list__ _(options)_
+
+  * `-w`, `--with-uri`:
+    Show corresponding URIs
+
+Lists available cookbooks from the Community site.
+
+__cookbook site search QUERY__ _(options)_
+
+Searches the Community site with the specified query.
+
+__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. See __EXAMPLES__ for usage if the Opscode user and certificate pair are not used for authenticating with the Chef Server. In other words, if the Chef Server is not the Opscode Platform.
+
+__cookbook site unshare COOKBOOK__
+
+Stops sharing the specified cookbook on the Opscode cookbooks site.
+
+__cookbook site show COOKBOOK [VERSION]__ _(options)_
+
+Shows information from the site about a particular cookbook.
+
+__cookbook site vendor COOKBOOK [VERSION]__ _(options)_
+
+  * `-d`, `--dependencies`:
+    Grab dependencies automatically
+
+Uses `git` version control in conjunction with the cookbook site to download upstream cookbooks. A new vendor branch is created in git, the cookbook downloaded from the site and untarred, then the master branch is merged. This allows the user to track upstream changes to cookbooks while merging in customizations. If _-d_ is specified, all the cookbooks it depends on (via metadata _dependencies_) are downloaded and untarred as well, each using their own vendor branch.
+
+
+## SEE ALSO
+   __knife-environment__(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://wiki.opscode.com/display/chef/Home>
+

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

@@ -0,0 +1,136 @@
+knife-cookbook(1) -- Upload and manage Chef cookbooks
+========================================
+
+## SYNOPSIS
+
+__knife__ __cookbook__ _sub-command_ _(options)_
+
+## COOKBOOK SUB-COMMANDS
+
+Cookbooks are the fundamental unit of distribution in Chef. They encapsulate all recipes of resources and assets used to configure a particular aspect of the infrastructure. The following sub-commands can be used to manipulate the cookbooks stored on the Chef Server.
+
+__cookbook bulk delete REGEX__ _(options)_
+
+  * `-p`, `--purge`:
+    Purge files from backing store. This will disable any cookbook that contains any of the same files as the cookbook being purged.
+
+Delete cookbooks on the Chef Server based on a regular expression. The regular expression (_REGEX_) should be in quotes, not in //'s.
+
+__cookbook create COOKBOOK__ _(options)_
+
+  * `-o`, `--cookbook-path PATH`:
+    The directory where the cookbook will be created
+  * `-r`, `--readme-format FORMAT`:
+    Format of the README file
+  * `-C`, `--copyright COPYRIGHT`:
+    Name of Copyright holder
+  * `-I`, `--license LICENSE`:
+    License for cookbook, apachev2 or none
+  * `-E`, `--email EMAIL`:
+    Email address of cookbook maintainer
+
+This is a helper command that creates a new cookbook directory in the `cookbook_path`. The following directories and files are created for the named cookbook.
+
+* COOKBOOK/attributes
+* COOKBOOK/definitions
+* COOKBOOK/files/default
+* COOKBOOK/libraries
+* COOKBOOK/metadata.rb
+* COOKBOOK/providers
+* COOKBOOK/README.rdoc
+* COOKBOOK/recipes/default.rb
+* COOKBOOK/resources
+* COOKBOOK/templates/default
+
+Supported README formats are 'rdoc' (default), 'md', 'mkd', 'txt'. The README file will be written with the specified extension and a set of helpful starting headers.
+
+Specify `-C` or `--copyright` with the name of the copyright holder as your name or your company/organization name in a quoted string. If this value is not specified an all-caps string `YOUR_COMPANY_NAME` is used which can be easily changed with find/replace.
+
+Specify `-I` or `--license` with the license that the cookbook is distributed under for sharing with other people or posting to the Opscode Cookbooks site. Be aware of the licenses of files you put inside the cookbook and follow any restrictions they describe. When using `none` (default) or `apachev2`, comment header text and metadata file are pre-filled. The `none` license will be treated as non-redistributable.
+
+Specify `-E` or `--email` with the email address of the cookbook's maintainer. If this value is not specified, an all-caps string `YOUR_EMAIL` is used which can easily be changed with find/replace.
+
+The cookbook copyright, license and email settings can be filled in the `knife.rb`, for example with default values:
+
+    cookbook_copyright "YOUR_COMPANY_NAME"
+    cookbook_license "none"
+    cookbook_email "YOUR_EMAIL"
+
+__cookbook delete COOKBOOK [VERSION]__ _(options)_
+
+  * `-a`, `--all`:
+    Delete all versions
+  * `-p`, `--purge`:
+    Purge files from backing store. This will disable any cookbook that contains any of the same files as the cookbook being purged.
+
+Delete the specified _VERSION_ of the named _COOKBOOK_. If no version is specified, and only one version exists on the server, that version will be deleted. If multiple versions are available on the server, you will be prompted for a version to delete.
+
+__cookbook download COOKBOOK [VERSION]__ _(options)_
+
+  * `-d`, `--dir DOWNLOAD_DIRECTORY`:
+    The directory to download the cookbook into
+  * `-f`, `--force`:
+    Overwrite an existing directory with the download
+  * `-N`, `--latest`:
+    Download the latest version of the cookbook
+
+Download a cookbook from the Chef Server. If no version is specified and only one version exists on the server, that version will be downloaded. If no version is specified and multiple versions are available on the server, you will be prompted for a version to download.
+
+__cookbook list__ _(options)_
+
+  * `-w`, `--with-uri`:
+    Show corresponding URIs
+
+List all the cookbooks.
+
+__cookbook metadata COOKBOOK__ _(options)_
+
+  * `-a`, `--all`:
+    Generate metadata for all cookbooks, rather than just a single cookbook
+  * `-o`, `--cookbook-path PATH:PATH`:
+    A colon-separated path to look for cookbooks in
+
+Generate cookbook metadata for the named _COOKBOOK_. The _PATH_ used here specifies where the cookbooks directory is located and corresponds to the `cookbook_path` configuration option.
+
+__cookbook metadata from FILE__ _(options)_
+
+Load the cookbook metadata from a specified file.
+
+__cookbook show COOKBOOK [VERSION] [PART] [FILENAME]__ _(options)_
+
+  * `-f`, `--fqdn FQDN               `:
+    The FQDN of the host to see the file for
+  * `-p`, `--platform PLATFORM       `:
+    The platform to see the file for
+  * `-V`, `--platform-version VERSION`:
+    The platform version to see the file for
+
+Show a particular part of a _COOKBOOK_ for the specified _VERSION_. _PART_ can be one of:
+
+  * _attributes_
+  * _definitions_
+  * _files_
+  * _libraries_
+  * _providers_
+  * _recipes_
+  * _resources_
+  * _templates_
+
+__cookbook test [COOKBOOKS...]__ _(options)_
+
+  * `-a`, `--all`:
+    Test all cookbooks, rather than just a single cookbook
+  * `-o`, `--cookbook-path PATH:PATH`:
+    A colon-separated path to look for cookbooks in
+
+Test the specified cookbooks for syntax errors. This uses the built-in Ruby syntax checking option for files in the cookbook ending in `.rb`, and the ERB syntax check for files ending in `.erb` (templates).
+
+__cookbook upload [COOKBOOKS...]__ _(options)_
+
+  * `-a`, `--all`:
+    Upload all cookbooks, rather than just a single cookbook
+  * `-o`, `--cookbook-path PATH:PATH`:
+    A colon-separated path to look for cookbooks in
+
+Uploads the specified cookbooks to the Chef Server. The actual upload executes a number of commands, most of which occur on the local machine. The cookbook is staged in a temporary location. Then the `cookbook_path` (or `-o PATH`) is processed to search for the named cookbook, and each occurance is copied in the order specified. A syntax check is performed a la `cookbook test`, above. The metadata is generated, a la `cookbook metadata`. A gzip(1)'ed, tar(1) file is created, and is uploaded to the server.
+

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

@@ -0,0 +1,117 @@
+knife-data-bag(1) -- Store arbitrary data on a Chef Server
+========================================
+
+## SYNOPSIS
+
+__knife__ __data bag__ _sub-command_ _(options)_
+
+## DESCRIPTION
+Data bags are stores of arbitrary JSON data. Each data bag is a
+collection that may contain many items. Data Bag Items are indexed by
+the Chef Server and can be searched via __knife-search__(1).
+
+Data bags are available to all nodes configured by __chef-client__(8),
+and are therefore a convenient mechanism to store global information,
+such as lists of administrative accounts that should be configured on
+all hosts.
+
+## DATA BAG SUB-COMMANDS
+
+## CREATE
+__knife data bag create__ _bag name_ [item id] _(options)_
+
+  * `-s`, `--secret SECRET`:
+   A secret key used to encrypt the data bag item. See __encryption support__ below.
+  * `--secret-file SECRET_FILE`:
+   The path to a file containing the secret key to be used to encrypt
+   the data bag item.
+
+If _item id_ is given, creates a new, empty data bag item and opens it for
+editing in your editor. The data bag will be created if it does not
+exist.
+
+If _item id_ is not given, the data bag will be created.
+
+## DELETE
+__knife data bag delete__ _bag name_ [item id] _(options)_
+
+Delete a data bag, or an item from a data bag.
+
+## EDIT
+__knife data bag edit__ _bag name_ _item id_ _(options)_
+
+  * `-s`, `--secret SECRET`:
+   A secret key used to encrypt the data bag item. See __encryption support__ below.
+  * `--secret-file SECRET_FILE`:
+   The path to a file containing the secret key to be used to encrypt
+   the data bag item.
+
+Edit an item in a data bag.
+
+## FROM FILE
+__knife data bag from file__ _bag name_ _file_ _(options)_
+
+  * `-s`, `--secret SECRET`:
+   A secret key used to encrypt the data bag item. See __encryption support__ below.
+  * `--secret-file SECRET_FILE`:
+   The path to a file containing the secret key to be used to encrypt
+   the data bag item.
+
+Load a data bag item from a JSON file. If _file_ is a relative or
+absolute path to the file, that file will be used. Otherwise, the _file_
+parameter is treated as the base name of a data bag file in a Chef
+repository, and `knife` will search for the file in
+`./data_bags/bag_name/file`. For example `knife data bag from file users
+dan.json` would attempt to load the file `./data_bags/users/dan.json`.
+
+## LIST
+__knife data bag list__ _(options)_
+
+  * `-w`, `--with-uri`:
+    Show corresponding URIs
+
+Lists the data bags that exist on the Chef Server.
+
+## SHOW
+__knife data bag show BAG [ITEM]__ _(options)_
+
+  * `-s`, `--secret SECRET`:
+   A secret key used to encrypt the data bag item. See __encryption support__ below.
+  * `--secret-file SECRET_FILE`:
+   The path to a file containing the secret key to be used to encrypt
+   the data bag item.
+
+Show a specific data bag or an item in a data bag. The output will be
+formatted according to the --format option.
+
+## ENCRYPTION SUPPORT
+Data Bag Items may be encrypted to keep their contents secret. This may
+be desireable when storing sensitive information such as database
+passwords, API keys, etc.
+
+Data Bag Item encryption uses the AES-256 CBC symmetric key algorithm.
+
+__CAVEATS:__ Keys are not encrypted; only values are encrypted. The "id"
+of a Data Bag Item is not encrypted, since it is used by Chef Server to
+store the item in its database. For example, given the following data bag item:
+    {"id": "important_passwords", "secret_password": "opensesame"}
+The key "secret\_password" will be visible to an evesdropper, but the
+value "opensesame" will be protected. Both the key "id" and its value
+"important\_passwords" will be visible to an evesdropper.
+
+Chef Server does not provide a secure mechanism for distributing
+encryption keys.
+
+## SEE ALSO
+   __knife-search__(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://wiki.opscode.com/display/chef/Home
+