rmm-chef 0.10.0.rc.0

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

@@ -0,0 +1,253 @@
+knife-cookbook(1) -- upload and manage chef cookbooks
+========================================
+
+## SYNOPSIS
+
+__knife__ __cookbook__ _sub-command_ _(options)_
+
+## SUB-COMMANDS
+`knife cookbook` supports the following sub commands:
+
+## LIST
+__knife cookbook list__ _(options)_
+
+  * `-a`, `--all`:
+    show all versions of a cookbook instead of just the most recent
+  * `-w`, `--with-uri`:
+    show corresponding uris
+
+Lists the cookbooks available on the Chef server.
+
+## SHOW
+__knife 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_
+
+## UPLOAD
+__knife 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
+  * `-E`, `--environment ENVIRONMENT`:
+    An _ENVIRONMENT_ to apply the uploaded cookbooks to. Specifying this
+    option will cause knife to edit the _ENVIRONMENT_ to place a strict
+    version constraint on the cookbook version(s) uploaded.
+  * `--freeze`:
+    Sets the frozen flag on the uploaded cookbook(s) Any future attempt
+    to modify the cookbook without changing the version number will
+    return an error unless --force is specified.
+  * `--force`:
+    Overrides the frozen flag on a cookbook, allowing you to overwrite a
+    cookbook version that has previously been uploaded with the --freeze
+    option.
+
+Uploads one or more cookbooks from your local cookbook repository(ies)
+to the Chef Server. Only files that don't yet exist on the server will
+be uploaded.
+
+## DOWNLOAD
+__knife 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.
+
+## DELETE
+__knife 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.
+
+## BULK DELETE
+__knife 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
+__knife 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"
+
+
+## METADATA
+__knife 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.
+
+## METADATA FROM FILE
+__knife cookbook metadata from file__ _(options)_
+
+load the cookbook metadata from a specified file.
+
+## TEST
+__knife 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).
+
+## RECIPE LIST
+__knife recipe list [PATTERN]__
+
+List available recipes from the server. Specify _PATTERN_ as a regular
+expression to limit the results.
+
+## DESCRIPTION
+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.
+
+On disk, cookbooks are directories with a defined structure. The
+following directories may appear within a cookbook:
+
+  * COOKBOOK/attributes/:
+    Ruby files that define default parameters to be used in recipes
+  * COOKBOOK/definitions/:
+    Ruby files that contain _resource definitions_
+  * COOKBOOK/files/SPECIFICITY:
+    Files of arbitrary type. These files may be downloaded by
+    chef-client(8) when configuring a host.
+  * COOKBOOK/libraries/:
+    Ruby files that contain library code needed for recipes
+  * COOKBOOK/providers/:
+    Ruby files that contain Lightweight Provider definitions
+  * COOKBOOK/recipes/:
+    Ruby files that use Chef's recipe DSL to describe the desired
+    configuration of a system
+  * COOKBOOK/resources/:
+    Ruby files that contain Lightweight Resource definitions
+  * COOKBOOK/templates/SPECIFICITY:
+    ERuby (ERb) template files. These are referenced by _recipes_ and
+    evaluated to dynamically generate configuration files.
+
+__SPECIFICITY__ is a feature of _files_ and _templates_ that allow you
+to specify alternate files to be used on a specific OS platform or host.
+The default specificity setting is _default_, that is files in
+`COOKBOOK/files/default` will be used when a more specific copy is not
+available. Further documentation for this feature is available on the
+Chef wiki: <http://wiki.opscode.com/display/chef/File+Distribution#FileDistribution-FileSpecificity>
+
+Cookbooks also contain a metadata file that defines various properties
+of the cookbook. The most important of these are the _version_ and the
+_dependencies_. The _version_ is used in combination with environments
+to select which copy of a given cookbook is distributed to a node. The
+_dependencies_ are used by the server to determine which additional
+cookbooks must be distributed to a given host when it requires a
+cookbook.
+
+## SEE ALSO
+   __knife-environment(1)__ __knife-cookbook-site(1)__
+   <http://wiki.opscode.com/display/chef/Cookbooks>
+   <http://wiki.opscode.com/display/chef/Metadata>
+
+## 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-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
+

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

@@ -0,0 +1,151 @@
+knife-environment(1) -- Define cookbook policies for the environments in your infrastructure
+========================================
+
+## SYNOPSIS
+
+__knife__ __environment__ _sub-command_ _(options)_
+
+## SUBCOMMANDS
+Environment subcommands follow a basic create, read, update, delete
+(CRUD) pattern. The following subcommands are available:
+
+## CREATE
+__knife environment create__ _environment_ _(options)_
+
+  * `-d`, `--description DESCRIPTION`:
+    The value of the description field.
+
+Create a new environment object on the Chef Server. The envrionment will
+be opened in the text editor for editing prior to creation if the -n
+option is not present.
+
+## DELETE
+__knife environment delete__ _environment_ _(options)_
+
+Destroy an environment on the Chef Server. A prompt for confirmation
+will be displayed if the -y options is not given.
+
+## EDIT
+__knife environment edit__ _environment_ _(options)_
+
+Fetch _environment_ and display it in the text editor for editing. The
+environment will be saved to the Chef Server when the editing session
+exits.
+
+## FROM FILE
+__knife environment from file__ _file_ _(options)_
+
+Create or update an environment from the JSON or Ruby format _file_. See
+__format__ for the proper format of this file.
+
+## LIST
+__knife environment list__ _(options)_
+  * `-w`, `--with-uri`:
+    Show the resource URI for each environment
+
+## SHOW
+__knife environment show__ _environment_ _(options)_
+
+## DESCRIPTION
+Environments provide a means to apply policies to hosts in your
+infrastructure based on business function. For example, you may have a
+separate copy of your infrastructure called "dev" that runs the latest
+version of your application and should use the newest versions of your
+cookbooks when configuring systems, and a production instance of your
+infrastructure where you wish to update code and cookbooks in a more
+controlled fashion. In Chef, this function is implemented with
+_environments_.
+
+Environments contain two major components: a set of cookbook version
+constraints and environment attributes.
+
+## SYNTAX
+A cookbook version constraint is comprised of a _cookbook name_ and a
+_version constraint_. The _cookbook name_ is the name of a cookbook in
+your system, and the _version constraint_ is a String describing the
+version(s) of that cookbook allowed in the environment.  Only one
+_version constraint_ is supported for a given _cookbook name_.
+
+The exact syntax used to define a cookbook version constraint varies
+depending on whether you use the JSON format or the Ruby format. In the
+JSON format, the cookbook version constraints for an environment are
+represented as a single JSON object, like this:
+
+    {"apache2": ">= 1.5.0"}
+
+In the Ruby format, the cookbook version contraints for an environment
+are represented as a Ruby Hash, like this:
+
+    {"apache2" => ">= 1.5.0"}
+
+A _version number_ is a String comprised of two or three digits
+separated by a dot (.) character, or in other words, strings of the form
+"major.minor" or "major.minor.patch". "1.2" and "1.2.3" are examples of
+valid version numbers. Version numbers containing more than three digits
+or alphabetic characters are not supported.
+
+A _version constraint_ String is composed of an _operator_ and a
+_version number_. The following operators are available:
+
+  * `= VERSION`:
+    Equality. Only the exact version specified may be used.
+  * `> VERSION`:
+    Greater than. Only versions greater than `VERSION` may be used.
+  * `>= VERSION`:
+    Greater than or equal to. Only versions equal to VERSION or greater
+    may be used.
+  * `< VERSION`:
+    Less than. Only versions less than VERSION may be used.
+  * `<= VERSION`:
+    Less than or equal to. Only versions lesser or equal to VERSION may
+    be used.
+  * `~> VERSION`:
+    Pessimistic greater than. Depending on the number of components in
+    the given VERSION, the constraint will be optimistic about future
+    minor or patch revisions only. For example, `~> 1.1` will match any
+    version less than `2.0` and greater than or equal to `1.1.0`,
+    whereas `~> 2.0.5` will match any version less than `2.1.0` and
+    greater than or equal to `2.0.5`.
+
+## FORMAT
+The JSON format of an envioronment is as follows:
+
+    {
+      "name": "dev",
+      "description": "The development environment",
+      "cookbook_versions": {
+        "couchdb": "= 11.0.0"
+      },
+      "json_class": "Chef::Environment",
+      "chef_type": "environment",
+      "default_attributes": {
+        "apache2": { "listen_ports": [ "80", "443" ] }
+      },
+      "override_attributes": {
+        "aws_s3_bucket": "production"
+      }
+    }
+
+The Ruby format of an environment is as follows:
+
+    name "dev"
+    description "The development environment"
+    cookbook_versions  "couchdb" => "= 11.0.0"
+    default_attributes "apache2" => { "listen_ports" => [ "80", "443" ] }
+    override_attributes "aws_s3_bucket" => "production"
+
+
+## SEE ALSO
+   __knife-node(1)__ __knife-cookbook(1)__ __knife-role(1)__
+  <http://wiki.opscode.com/display/chef/Environments>
+  <http://wiki.opscode.com/display/chef/Version+Constraints>
+
+## AUTHOR
+   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
+
+## DOCUMENTATION
+   This manual page was written by Daniel DeLeo <dan@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>