tylerrick-chef 0.10.8

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>

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

@@ -0,0 +1,37 @@
+knife-exec(1) -- Run user scripts using the Chef API DSL
+========================================
+
+## SYNOPSIS
+
+__knife__ __exec__ _(options)_
+
+  * `-E`, `--exec CODE`:
+    Provide a snippet of code to evaluate on the command line
+
+## DESCRIPTION
+`knife exec` runs arbitrary ruby scripts in a context similar to that of
+the shef(1) DSL. See the shef documentation for a description of the
+commands available.
+
+## EXAMPLES
+  * Make an API call against an arbitrary endpoint:
+    knife exec -E 'api.get("nodes/fluke.localdomain/cookbooks")'  
+    => list of cookbooks for the node _fluke.localdomain_
+  * Remove the role _obsolete_ from all nodes:
+    knife exec -E 'nodes.transform(:all){|n| n.run\_list.delete("role[obsolete]")}'
+  * Generate the expanded run list for hosts in the `webserver` role:
+    knife exec -E 'nodes.find(:roles => "webserver") {|n| n.expand!; n[:recipes]}'
+
+## SEE ALSO
+   __shef(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-index.mkd

@@ -0,0 +1,30 @@
+knife-index(1) -- Rebuild the search index on a Chef Server
+========================================
+
+## SYNOPSIS
+
+__knife__ __index rebuild__ _(options)_
+
+  * `-y`, `--yes`:
+    don't bother to ask if I'm sure
+
+## DESCRIPTION
+Rebuilds all the search indexes on the server. This is accomplished by
+deleting all objects from the search index, and then forwarding each
+item in the database to __chef-expander__(8) via __rabbitmq-server__(1).
+Depending on the number of objects in the database, it may take some
+time for all objects to be indexed and available for search.
+
+## 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-node.mkd

@@ -0,0 +1,130 @@
+knife-node(1) -- Manage the hosts in your infrastructure
+========================================
+
+## SYNOPSIS
+
+__knife__ __node__ _sub-command_ _(options)_
+
+## DESCRIPTION
+Nodes are data structures that represent hosts configured with Chef.
+Nodes have a __name__, a String that uniquely identifies the node,
+__attributes__, a nested Hash of properties that describe how the host
+should be configured, a __chef\_environment__, a String representing the
+environment to which the node belongs, and a __run\_list__, an ordered
+list of __recipes__ or __roles__ that chef-client should apply when
+configuring a host.
+
+When a host communicates with a Chef Server, it authenticates using its
+__node\_name__ for identification and signs its reqests with a private
+key.  The Server validates the request by looking up a __client__ object
+with a name identical to the __node\_name__ submitted with the request
+and verifes the signature using the public key for that __client__
+object. __NOTE__ that the __client__ is a different object in the
+system. It is associated with a node by virtue of having a matching
+name.
+
+By default __chef-client__(8) will create a node using the FQDN of the
+host for the node name, though this may be overridden by configuration
+settings.
+
+## NODE SUB-COMMANDS
+The following `node` subcommands are available:
+
+## BULK DELETE
+__knife node bulk delete__ _regex_ _(options)_
+
+Deletes nodes for which the name matches the regular expression _regex_
+on the Chef Server. The regular expression should be given in quotes,
+and should not be surrounded with forward slashes (as is typical of
+regular expression literals in scripting languages).
+
+## CREATE
+__knife node create__ _name_ _(options)_
+
+Create a new node. Unless the --no-editor option is given, an empty node
+object will be created and displayed in your text editor. If the editor
+exits with a successful exit status, the node data will be posted to the
+Chef Server to create the node.
+
+## DELETE
+__knife node delete__ _name_ _(options)_
+
+Deletes the node identified by _name_ on the Chef Server.
+
+## EDIT
+__knife node edit__ _name_ _(options)_
+
+  * `-a`, `--all`:
+    Display all node data in the editor. By default, default, override,
+    and automatic attributes are not shown.
+
+Edit the node identified by _name_. Like __knife node create__, the node
+will be displayed in your text editor unless the -n option is present.
+
+## FROM FILE
+__knife node from file__ _file_ _(options)_
+
+Create a node from a JSON format _file_.
+
+## LIST
+__knife node list__ _(options)_
+
+  * `-w`, `--with-uri`:
+    Show corresponding URIs
+
+List all nodes.
+
+## RUN\_LIST ADD
+__knife node run_list add__ _name_ _run list item_ _(options)_
+
+  * `-a`, `--after ITEM`:
+    Place the ENTRY in the run list after ITEM
+
+Add the _run list item_ to the node's `run_list`. See Run list
+
+## RUN\_LIST REMOVE
+__knife node run_list remove__ _node name_ _run list item_ _(options)_
+
+Remove the _run list item_ from the node's `run_list`.
+
+## SHOW
+__knife node show__ _node name_ _(options)_
+
+  * `-a`, `--attribute [ATTR]`:
+    Show only one attribute
+  * `-r`, `--run-list        `:
+    Show only the run list
+  * `-F`, `--format FORMAT`:
+    Display the node in a different format.
+  * `-m`, `--medium`:
+    Display more, but not all, of the node's data when using the default
+    _summary_ format
+
+Displays the node identified by _node name_ on stdout. 
+
+## RUN LIST ITEM FORMAT
+Run list items may be either roles or recipes. When adding a role to a
+run list, the correct syntax is "role[ROLE\_NAME]"
+
+When adding a recipe to a run list, there are several valid formats:
+
+  * Fully Qualified Format:
+    "recipe[COOKBOOK::RECIPE\_NAME]", for example, "recipe[chef::client]"
+  * Cookbook Recipe Format:
+    For brevity, the recipe part of the fully qualified format may be omitted, and recipes specified as "COOKBOOK::RECIPE\_NAME", e.g., "chef::client"
+  * Default Recipe Format:
+    When adding the default recipe of a cookbook to a run list, the recipe name may be omitted as well, e.g., "chef::default" may be written as just "chef"
+
+## SEE ALSO
+  __knife-client__(1) __knife-search__(1) __knife-role__(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>
+