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

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

@@ -0,0 +1,8 @@
+knife-tag(1) -- Apply tags to nodes on a Chef Server
+========================================
+
+## SYNOPSIS
+
+__knife__ __tag__ _subcommand_ _(options)_
+
+## TAG SUBCOMMANDS

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

@@ -0,0 +1,261 @@
+knife(1) -- Chef Server REST API utility
+========================================
+
+## SYNOPSIS
+
+__knife__ _sub-command_ _(options)_
+
+## DESCRIPTION
+
+This manual page documents knife, a command-line utility used to
+interact with a Chef server directly through the RESTful API. Knife uses
+sub-commands to take various actions on different types of Chef objects.
+Some sub-commands take additional options. General options follow
+sub-commands and their options. A configuration file can be created for
+common defaults.
+
+Unless otherwise specified, output is in JSON format, and input files
+are also JSON format.
+
+The Chef class `Chef::Config` that configures the behavior of how knife
+runs has options that correspond to command-line options. These are
+noted as `Chef::Config` values.
+
+## GENERAL OPTIONS
+
+  * `-s`, `--server-url` URL:
+    Chef Server URL, corresponds to `Chef::Config` `chef_server_url`.
+  * `-k`, `--key` KEY:
+    API Client Key, corresponds to `Chef::Config` `client_key`.
+  * `-c`, `--config` CONFIG:
+    The configuration file to use
+  * `-e`, `--editor` EDITOR:
+    Set the editor to use for interactive commands
+  * `-F`, `--format` FORMAT:
+    Which format to use for output
+  * `-l`, `--log_level` LEVEL:
+    Set the log level (debug, info, warn, error, fatal), corresponds to `Chef::Config` `log_level`.
+  * `-L`, `--logfile` LOGLOCATION:
+    Set the log file location, defaults to STDOUT, corresponds to `Chef::Config` `log_location`.
+  * `-n`, `--no-editor`:
+    Do not open EDITOR, just accept the data as is
+  * `-u`, `--user` USER:
+    API Client Username, corresponds to `Chef::Config` `node_name`.
+  * `-p`, `--print-after`:
+    Show the data after a destructive operation
+  * `-v`, `--version`:
+    Show chef version
+  * `-y`, `--yes`:
+    Say yes to all prompts for confirmation
+  * `-h`, `--help`:
+    Show this message
+
+Usage information for sub-commands can be displayed with `knife SUB-COMMAND --help`.
+
+## SUB-COMMANDS
+
+Knife sub-commands are structured as _NOUN verb NOUN (options)_. The
+sub-commands are meant to be intuitively named. Because the Chef Server
+API is RESTful, sub-commands generally utilize CRUD operations.
+
+* create (create)
+* list and show (read)
+* edit (update)
+* delete (destroy)
+
+Objects stored on the server support these, as described below.
+
+## GENERAL SUB-COMMANDS
+
+__recipe list [PATTERN]__
+
+List available recipes from the server. Specify _PATTERN_ as a regular expression to limit the results.
+
+
+## CONFIGURATION
+
+The knife configuration file is a Ruby DSL to set configuration
+parameters for Knife's __GENERAL OPTIONS__. The default location for the
+config file is `~/.chef/knife.rb`. If managing multiple Chef
+repositories, per-repository config files can be created. The file must
+be `.chef/knife.rb` in the current directory of the repository.
+
+If the config file exists, knife uses these settings for __GENERAL OPTIONS__ defaults.
+
+`log_level`
+
+A Ruby symbol specifying the log level. Corresponds to `-l` or `--log_level` option. Default is _:info_. Valid values are:
+
+  * :info
+  * :debug
+  * :warn
+  * :fatal
+
+`log_location`
+
+Corresponds to the `-L` or `--log-file` option. Defaults is __STDOUT__.
+Valid values are __STDOUT__ or a filename.
+
+`node_name`
+
+User to authenticate to the Chef server. Corresponds to the `-u` or
+`--user` option. This is requested from the user when running this
+sub-command.
+
+`client_key`
+
+Private key file to authenticate to the Chef server. Corresponds to the
+`-k` or `--key` option. This is requested from the user when running
+this sub-command.
+
+`chef_server_url`
+
+URL of the Chef server. Corresponds to the `-s` or `--server-url`
+option. This is requested from the user when running this sub-command.
+
+`cache_type`
+
+The type of cache to use. Default is BasicFile. This can be any type of
+Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper,
+File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant,
+Xattr, YAML.
+
+`cache_options`
+
+Specifies various options to use for caching. Default reads the Chef
+client configuration (/etc/chef/checksums).
+
+`validation_client_name`
+
+Specifies the name of the client used to validate new clients. This is
+requested from the user when running the configuration sub-command.
+
+`validation_key`
+
+Specifies the private key file to use for generating ec2 instance data
+for validating new clients. This is implied from the
+`validation_client_name`.
+
+`cookbook_copyright`
+`cookbook_email`
+`cookbook_license`
+
+Used by `knife cookbook create` sub-command to specify the copyright
+holder, maintainer email and license (respectively) for new cookbooks.
+The copyright holder is listed as the maintainer in the cookbook's
+metadata and as the Copyright in the comments of the default recipe. The
+maintainer email is used in the cookbook metadata. The license
+determines what preamble to put in the comment of the default recipe,
+and is listed as the license in the cookbook metadata. Currently
+supported licenses are "apachev2" and "none". Any other values will
+result in an empty license in the metadata (needs to be filled in by the
+author), and no comment preamble in the default recipe.
+
+`knife[:aws_access_key_id]`
+`knife[:aws_secret_access_key]`
+
+Specifies the Amazon AWS EC2 credentials to use when running the ec2 sub-commands.
+
+`knife[:rackspace_api_username]`
+`knife[:rackspace_api_key]`
+
+Specifies the Rackspace Cloud credentials to use when running the rackspace sub-commands.
+
+`knife[:terremark_username]`
+`knife[:terremark_password]`
+`knife[:terremark_service]`
+
+Specifies the Terremark vCloud credentials to use when running the terremark sub-commands.
+
+`knife[:slicehost_password]`
+
+Specifies the Slicehost password to use when running the slicdehost sub-commands.
+
+## FILES
+
+_~/.chef/knife.rb_
+
+Ruby DSL configuration file for knife. See __CONFIGURATION__.
+
+## CHEF WORKFLOW
+
+When working with Chef and Knife in the local repository, the recommended workflow outline looks like:
+
+* Create repository. A skeleton sample is provided at _http://github.com/opscode/chef-repo/_.
+* Configure knife, see __CONFIGURATION__.
+* Download cookbooks from the Opscode cookbooks site, see __COOKBOOK SITE SUB-COMMANDS__.
+* Or, create new cookbooks, see `cookbook create` sub-command.
+* Commit changes to the version control system. See your tool's documentation.
+* Upload cookbooks to the Chef Server, see __COOKBOOK SUB-COMMANDS__.
+* Launch instances in the Cloud, OR provision new hosts; see __CLOUD COMPUTING SUB-COMMANDS__ and __BOOTSTRAP SUB-COMMANDS__.
+* Watch Chef configure systems!
+
+A note about git: Opscode and many folks in the Chef community use git,
+but it is not required, except in the case of the `cookbook site vendor`
+sub-command, as it uses git directly. Version control is strongly
+recommended though, and git fits with a lot of the workflow paradigms.
+
+## EXAMPLES
+
+Example client config (`/etc/chef/client.rb`) from `knife configure
+client`. The same configuration is used when using the `knife bootstrap`
+command with the default `gem` templates that come with Chef.
+
+    log_level        :info
+    log_location     STDOUT
+    chef_server_url  'https://api.opscode.com/organizations/ORGNAME'
+    validation_client_name 'ORGNAME-validator'
+
+Setting up a custom bootstrap is fairly straightforward. Create
+`.chef/bootstrap` in your Chef Repository directory or in
+`$HOME/.chef/bootstrap`. Then create the ERB template file.
+
+    mkdir ~/.chef/bootstrap
+    vi ~/.chef/bootstrap/debian5.0-apt.erb
+
+For example, to create a new bootstrap template that should be used when
+setting up a new Debian node. Edit the template to run the commands, set
+up the validation certificate and the client configuration file, and
+finally to run chef-client on completion. The bootstrap template can be
+called with:
+
+    knife bootstrap mynode.example.com --template-file ~/.chef/bootstrap/debian5.0-apt.erb
+
+Or,
+
+    knife bootstrap mynode.example.com --distro debian5.0-apt
+
+The `--distro` parameter will automatically look in the
+`~/.chef/bootstrap` directory for a file named `debian5.0-apt.erb`.
+
+Templates provided by the Chef installation are located in
+`BASEDIR/lib/chef/knife/bootstrap/*.erb`, where _BASEDIR_ is the
+location where the package or Gem installed the Chef client libraries.
+
+Uploading cookbooks to the Opscode cookbooks site using the user/certificate specifically:
+
+    knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME
+
+## ENVIRONMENT
+  * `EDITOR`:
+    The text editor to use for editing data. The --editor option takes
+    precedence over this value, and the --no-editor option supresses
+    data editing entirely.
+
+## SEE ALSO
+
+Full documentation for Chef is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home/.
+
+JSON is JavaScript Object Notation and more information can be found at http://json.org/.
+
+SOLR is an open source search engine. The Chef Server includes a SOLR installation. More information about SOLR, including the search query syntax, can be found at http://lucene.apache.org/solr/.
+
+Git is a version control system and documented at http://git-scm.com/.
+
+This manual page was generated in nroff from Markdown with ronn. Ryan Tomayko wrote ronn and more information can be found at http://rtomayko.github.com/ronn/ronn.5.html.
+
+## AUTHOR
+
+Chef was written by Adam Jacob <adam@opscode.com> of Opscode (<http://www.opscode.com>), with contributions from the community. 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.
+
+On Debian systems, the complete text of the Apache 2.0 License can be found in `/usr/share/common-licenses/Apache-2.0`.

data/lib/chef/cookbook/metadata.rb

@@ -27,22 +27,41 @@ require 'chef/version_constraint'
 
 class Chef
   class Cookbook
+
     # == Chef::Cookbook::Metadata
     # Chef::Cookbook::Metadata provides a convenient DSL for declaring metadata
     # about Chef Cookbooks.
     class Metadata
 
+      NAME              = 'name'.freeze
+      DESCRIPTION       = 'description'.freeze
+      LONG_DESCRIPTION  = 'long_description'.freeze
+      MAINTAINER        = 'maintainer'.freeze
+      MAINTAINER_EMAIL  = 'maintainer_email'.freeze
+      LICENSE           = 'license'.freeze
+      PLATFORMS         = 'platforms'.freeze
+      DEPENDENCIES      = 'dependencies'.freeze
+      RECOMMENDATIONS   = 'recommendations'.freeze
+      SUGGESTIONS       = 'suggestions'.freeze
+      CONFLICTING       = 'conflicting'.freeze
+      PROVIDING         = 'providing'.freeze
+      REPLACING         = 'replacing'.freeze
+      ATTRIBUTES        = 'attributes'.freeze
+      GROUPINGS         = 'groupings'.freeze
+      RECIPES           = 'recipes'.freeze
+      VERSION           = 'version'.freeze
+
       COMPARISON_FIELDS = [ :name, :description, :long_description, :maintainer,
                             :maintainer_email, :license, :platforms, :dependencies,
                             :recommendations, :suggestions, :conflicting, :providing,
                             :replacing, :attributes, :groupings, :recipes, :version]
 
-      VERSION_CONSTRAINTS = {:depends     => "dependencies",
-                             :recommends  => "recommendations",
-                             :suggests    => "suggestions",
-                             :conflicts   => "conflicting",
-                             :provides    => "providing",
-                             :replaces    => "replacing" }
+      VERSION_CONSTRAINTS = {:depends     => DEPENDENCIES,
+                             :recommends  => RECOMMENDATIONS,
+                             :suggests    => SUGGESTIONS,
+                             :conflicts   => CONFLICTING,
+                             :provides    => PROVIDING,
+                             :replaces    => REPLACING }
 
       include Chef::Mixin::CheckHelper
       include Chef::Mixin::ParamsValidate
@@ -402,23 +421,23 @@ class Chef
 
       def to_hash
         {
-          'name'             => self.name,
-          'description'      => self.description,
-          'long_description' => self.long_description,
-          'maintainer'       => self.maintainer,
-          'maintainer_email' => self.maintainer_email,
-          'license'          => self.license,
-          'platforms'        => self.platforms,
-          'dependencies'     => self.dependencies,
-          'recommendations'  => self.recommendations,
-          'suggestions'      => self.suggestions,
-          'conflicting'      => self.conflicting,
-          'providing'        => self.providing,
-          'replacing'        => self.replacing,
-          'attributes'       => self.attributes,
-          'groupings'        => self.groupings,
-          'recipes'          => self.recipes,
-          'version'          => self.version
+          NAME             => self.name,
+          DESCRIPTION      => self.description,
+          LONG_DESCRIPTION => self.long_description,
+          MAINTAINER       => self.maintainer,
+          MAINTAINER_EMAIL => self.maintainer_email,
+          LICENSE          => self.license,
+          PLATFORMS        => self.platforms,
+          DEPENDENCIES     => self.dependencies,
+          RECOMMENDATIONS  => self.recommendations,
+          SUGGESTIONS      => self.suggestions,
+          CONFLICTING      => self.conflicting,
+          PROVIDING        => self.providing,
+          REPLACING        => self.replacing,
+          ATTRIBUTES       => self.attributes,
+          GROUPINGS        => self.groupings,
+          RECIPES          => self.recipes,
+          VERSION          => self.version
         }
       end
 
@@ -433,23 +452,23 @@ class Chef
       end
 
       def from_hash(o)
-        @name                         = o['name'] if o.has_key?('name')
-        @description                  = o['description'] if o.has_key?('description')
-        @long_description             = o['long_description'] if o.has_key?('long_description')
-        @maintainer                   = o['maintainer'] if o.has_key?('maintainer')
-        @maintainer_email             = o['maintainer_email'] if o.has_key?('maintainer_email')
-        @license                      = o['license'] if o.has_key?('license')
-        @platforms                    = o['platforms'] if o.has_key?('platforms')
-        @dependencies                 = handle_deprecated_constraints(o['dependencies']) if o.has_key?('dependencies')
-        @recommendations              = handle_deprecated_constraints(o['recommendations']) if o.has_key?('recommendations')
-        @suggestions                  = handle_deprecated_constraints(o['suggestions']) if o.has_key?('suggestions')
-        @conflicting                  = handle_deprecated_constraints(o['conflicting']) if o.has_key?('conflicting')
-        @providing                    = o['providing'] if o.has_key?('providing')
-        @replacing                    = handle_deprecated_constraints(o['replacing']) if o.has_key?('replacing')
-        @attributes                   = o['attributes'] if o.has_key?('attributes')
-        @groupings                    = o['groupings'] if o.has_key?('groupings')
-        @recipes                      = o['recipes'] if o.has_key?('recipes')
-        @version                      = o['version'] if o.has_key?('version')
+        @name                         = o[NAME] if o.has_key?(NAME)
+        @description                  = o[DESCRIPTION] if o.has_key?(DESCRIPTION)
+        @long_description             = o[LONG_DESCRIPTION] if o.has_key?(LONG_DESCRIPTION)
+        @maintainer                   = o[MAINTAINER] if o.has_key?(MAINTAINER)
+        @maintainer_email             = o[MAINTAINER_EMAIL] if o.has_key?(MAINTAINER_EMAIL)
+        @license                      = o[LICENSE] if o.has_key?(LICENSE)
+        @platforms                    = o[PLATFORMS] if o.has_key?(PLATFORMS)
+        @dependencies                 = handle_deprecated_constraints(o[DEPENDENCIES]) if o.has_key?(DEPENDENCIES)
+        @recommendations              = handle_deprecated_constraints(o[RECOMMENDATIONS]) if o.has_key?(RECOMMENDATIONS)
+        @suggestions                  = handle_deprecated_constraints(o[SUGGESTIONS]) if o.has_key?(SUGGESTIONS)
+        @conflicting                  = handle_deprecated_constraints(o[CONFLICTING]) if o.has_key?(CONFLICTING)
+        @providing                    = o[PROVIDING] if o.has_key?(PROVIDING)
+        @replacing                    = handle_deprecated_constraints(o[REPLACING]) if o.has_key?(REPLACING)
+        @attributes                   = o[ATTRIBUTES] if o.has_key?(ATTRIBUTES)
+        @groupings                    = o[GROUPINGS] if o.has_key?(GROUPINGS)
+        @recipes                      = o[RECIPES] if o.has_key?(RECIPES)
+        @version                      = o[VERSION] if o.has_key?(VERSION)
         self
       end
 
@@ -588,5 +607,22 @@ INVALID
       end
 
     end
+
+    #== Chef::Cookbook::MinimalMetadata
+    # MinimalMetadata is a duck type of Cookbook::Metadata, used
+    # internally by Chef Server when determining the optimal set of
+    # cookbooks for a node.
+    #
+    # MinimalMetadata objects typically contain only enough information
+    # to solve the cookbook collection for a run list, but not enough to
+    # generate the proper response
+    class MinimalMetadata < Metadata
+      def initialize(name, params)
+        @name = name
+        from_hash(params)
+      end
+    end
+
+
   end
 end

data/lib/chef/cookbook_version.rb

@@ -3,7 +3,8 @@
 # Author:: Christopher Walters (<cw@opscode.com>)
 # Author:: Tim Hinderliter (<tim@opscode.com>)
 # Author:: Seth Falcon (<seth@opscode.com>)
-# Copyright:: Copyright 2008-2010 Opscode, Inc.
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright 2008-2011 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -29,6 +30,80 @@ require 'chef/cookbook/metadata'
 require 'chef/version_class'
 
 class Chef
+
+  #== Chef::MinimalCookbookVersion
+  # MinimalCookbookVersion is a duck type of CookbookVersion, used
+  # internally by Chef Server as an optimization when determining the
+  # optimal cookbook set for a chef-client.
+  #
+  # MinimalCookbookVersion objects contain only enough information to
+  # solve the cookbook collection for a given run list. They *do not*
+  # contain enough information to generate the response.
+  #
+  # See also: Chef::CookbookVersionSelector
+  class MinimalCookbookVersion
+
+    include Comparable
+
+    ID   = "id".freeze
+    NAME = 'name'.freeze
+    KEY  = 'key'.freeze
+    VERSION = 'version'.freeze
+    VALUE   = 'value'.freeze
+    DEPS    = 'deps'.freeze
+
+    DEPENDENCIES      = 'dependencies'.freeze
+
+    # Loads the full list of cookbooks, using a couchdb view to fetch
+    # only the id, name, version, and dependency constraints. This is
+    # enough information to solve for the cookbook collection for a
+    # given run list. After solving for the cookbook collection, you
+    # need to call +load_full_versions_of+ to convert
+    # MinimalCookbookVersion objects to their non-minimal counterparts
+    def self.load_all(couchdb)
+      # Example:
+      # {"id"=>"1a806f1c-b409-4d8e-abab-fa414ff5b96d", "key"=>"activemq", "value"=>{"version"=>"0.3.3", "deps"=>{"java"=>">= 0.0.0", "runit"=>">= 0.0.0"}}}
+      couchdb ||= Chef::CouchDB.new
+      couchdb.get_view("cookbooks", "all_with_version_and_deps")["rows"].map {|params| self.new(params) }
+    end
+
+    # Loads the non-minimal CookbookVersion objects corresponding to
+    # +minimal_cookbook_versions+ from couchdb using a bulk GET.
+    def self.load_full_versions_of(minimal_cookbook_versions, couchdb)
+      database_ids = Array(minimal_cookbook_versions).map {|mcv| mcv.couchdb_id }
+      couchdb ||= Chef::CouchDB.new
+      couchdb.bulk_get(*database_ids)
+    end
+
+    attr_reader :couchdb_id
+    attr_reader :name
+    attr_reader :version
+    attr_reader :deps
+
+    def initialize(params)
+      @couchdb_id = params[ID]
+      @name = params[KEY]
+      @version = params[VALUE][VERSION]
+      @deps    = params[VALUE][DEPS]
+    end
+
+    # Returns the Cookbook::MinimalMetadata object for this cookbook
+    # version.
+    def metadata
+      @metadata ||= Cookbook::MinimalMetadata.new(@name, DEPENDENCIES => @deps)
+    end
+
+    def legit_version
+      @legit_version ||= Chef::Version.new(@version)
+    end
+
+    def <=>(o)
+      raise Chef::Exceptions::CookbookVersionNameMismatch if self.name != o.name
+      raise "Unexpected comparison to #{o}" unless o.respond_to?(:legit_version)
+      legit_version <=> o.legit_version
+    end
+  end
+
   # == Chef::CookbookVersion
   # CookbookVersion is a model object encapsulating the data about a Chef
   # cookbook. Chef supports maintaining multiple versions of a cookbook on a
@@ -44,7 +119,7 @@ class Chef
     COOKBOOK_SEGMENTS = [ :resources, :providers, :recipes, :definitions, :libraries, :attributes, :files, :templates, :root_files ]
 
     DESIGN_DOCUMENT = {
-      "version" => 7,
+      "version" => 8,
       "language" => "javascript",
       "views" => {
         "all" => {
@@ -74,6 +149,15 @@ class Chef
           }
           EOJS
         },
+        "all_with_version_and_deps" => {
+          "map" => <<-JS
+          function(doc) {
+            if (doc.chef_type == "cookbook_version") {
+              emit(doc.cookbook_name, {version: doc.version, deps: doc.metadata.dependencies});
+            }
+          }
+          JS
+        },
         "all_latest_version" => {
           "map" => %q@
           function(doc) {