chef 0.10.0.beta.8 → 0.10.0.beta.9

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

@@ -0,0 +1,189 @@
+shef(1) -- Interactive Chef Console
+========================================
+
+## SYNOPSIS
+
+__shef__ [_named configuration_] _(options)_
+
+  * `-S`, `--server CHEF_SERVER_URL`:
+    The chef server URL
+  * `-z`, `--client`:
+    chef-client mode
+  * `-c`, `--config CONFIG`:
+    The configuration file to use
+  * `-j`, `--json-attributes JSON_ATTRIBS`:
+    Load attributes from a JSON file or URL
+  * `-l`, `--log-level LOG_LEVEL`:
+    Set the logging level
+  * `-s`, `--solo`:
+    chef-solo shef session
+  * `-a`, `--standalone`:
+    standalone shef session
+  * `-v`, `--version`:
+    Show chef version
+  * `-h`, `--help`:
+    Show command options
+
+When no --config option is specified, shef attempts to load a default configuration file:
+
+* If a _named configuration_ is given, shef will load ~/.chef/_named
+  configuration_/shef.rb
+* If no _named configuration_ is given shef will load ~/.chef/shef.rb if it exists
+* Shef falls back to loading /etc/chef/client.rb or /etc/chef/solo.rb if -z or
+  -s options are given and no shef.rb can be found.
+* The --config option takes precedence over implicit configuration
+  paths.
+
+## DESCRIPTION
+
+`shef` is an irb(1) (interactive ruby) session customized for Chef.
+`shef` serves two primary functions: it provides a means to
+interact with a Chef Server interactively using a convenient DSL; it
+allows you to define and run Chef recipes interactively.
+
+## SYNTAX
+Shef uses irb's subsession feature to provide multiple modes of
+interaction. In addition to the primary mode which is entered on start,
+`recipe` and `attributes` modes are available.
+
+## PRIMARY MODE
+The following commands are available in the primary
+session:
+
+  * `help`:
+    Prints a list of available commands
+  * `version`:
+    Prints the Chef version
+  * `recipe`:
+    Switches to `recipe` mode
+  * `attributes`:
+    Switches to `attributes` mode
+  * `run_chef`:
+    Initiates a chef run
+  * `reset`:
+    reinitializes shef
+  * `echo :on|:off`:
+    Turns irb's echo function on or off. Echo is _on_ by default.
+  * `tracing :on|:off`:
+    Turns irb's function tracing feature on or off. Tracing is extremely
+    verbose and expected to be of interest primarily to developers.
+  * `node`:
+    Returns the _node_ object for the current host. See knife-node(1)
+    for more information about nodes.
+  * `ohai`:
+    Prints the attributes of _node_
+
+In addition to these commands, shef provides a DSL for accessing data on
+the Chef Server. When working with remote data in shef, you chain method
+calls in the form _object type_._operation_, where _object type_ is in
+plural form. The following object types are available:
+
+  * `nodes`
+  * `roles`
+  * `data_bags`
+  * `clients`
+  * `cookbooks`
+
+For each _object type_ the following operations are available:
+
+  * _object type_.all(_&block_):
+    Loads all items from the server. If the optional code _block_ is
+    given, each item will be passed to the block and the results
+    returned, similar to ruby's `Enumerable#map` method.
+  * _object type_.show(_object name_):
+    Aliased as _object type_.load
+
+    Loads the singular item identified by _object name_.
+  * _object type_.search(_query_, _&block_):
+    Aliased as _object type_.find
+
+    Runs a search against the server and returns the matching items. If
+    the optional code _block_ is given each item will be passed to the
+    block and the results returned.
+
+    The _query_ may be a Solr/Lucene format query given as a String, or
+    a Hash of conditions. If a Hash is given, the options will be ANDed
+    together. To join conditions with OR, use negative queries, or any
+    advanced search syntax, you must provide give the query in String
+    form.
+  * _object type_.transform(:all|_query_, _&block_):
+    Aliased as _object type_.bulk_edit
+
+    Bulk edit objects by processing them with the (required) code _block_.
+    You can edit all objects of the given type by passing the Symbol
+    `:all` as the argument, or only a subset by passing a _query_ as the
+    argument. The _query_ is evaluated in the same way as with
+    __search__.
+
+    The return value of the code _block_ is used to alter the behavior
+    of `transform`. If the value returned from the block is `nil` or
+    `false`, the object will not be saved. Otherwise, the object is
+    saved after being passed to the block. This behavior can be
+    exploited to create a dry run to test a data transformation.
+
+## RECIPE MODE
+Recipe mode implements Chef's recipe DSL. Exhaustively documenting this
+DSL is outside the scope of this document. See the following pages in
+the Chef documentation for more information:
+
+  * <http://wiki.opscode.com/display/chef/Resources>
+  * <http://wiki.opscode.com/display/chef/Recipes>
+
+Once you have defined resources in the recipe, you can trigger a
+convergence run via `run_chef`
+
+## EXAMPLES
+
+* A "Hello World" interactive recipe
+
+  chef > recipe  
+  chef:recipe > echo :off  
+  chef:recipe > file "/tmp/hello\_world"  
+  chef:recipe > run\_chef  
+  [Sat, 09 Apr 2011 08:56:56 -0700] INFO: Processing file[/tmp/hello\_world] action create ((irb#1) line 2)  
+  [Sat, 09 Apr 2011 08:56:56 -0700] INFO: file[/tmp/hello\_world] created file /tmp/hello\_world  
+  chef:recipe > pp ls '/tmp'  
+  [".",  
+  "..",  
+  "hello\_world"]  
+
+* Search for _nodes_ by role, and print their IP addresses
+
+  chef > nodes.find(:roles => 'monitoring-server') {|n| n[:ipaddress] }  
+  => ["10.254.199.5"]  
+
+* Remove the role _obsolete_ from every node in the system
+
+  chef > nodes.transform(:all) {|n| n.run\_list.delete('role[obsolete]') }  
+   => [node[chef098b2.opschef.com], node[ree-woot], node[graphite-dev], node[fluke.localdomain], node[ghost.local], node[kallistec]]  
+
+
+## BUGS
+The name `shef` is clever in print but is confusing when spoken aloud.
+Pronouncing `shef` as `chef console` is an imperfect workaround.
+
+`shef` often does not perfectly replicate the context in which
+chef-client(8) configures a host, which may lead to discrepancies in
+observed behavior.
+
+`shef` has to duplicate much code from chef-client's internal libraries
+and may become out of sync with the behavior of those libraries.
+
+## SEE ALSO
+  chef-client(8) knife(1)
+  <http://wiki.opscode.com/display/chef/Shef>
+
+## AUTHOR
+   Chef was written by Adam Jacob <adam@opscode.com> with many
+   contributions from the community. Shef was written by Daniel DeLeo.
+
+## 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
+   Shef is distributed with Chef. <http://wiki.opscode.com/display/chef/Home>
+
+
+

data/lib/chef/api_client.rb

@@ -7,9 +7,9 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -25,22 +25,23 @@ require 'chef/certificate'
 require 'chef/index_queue'
 require 'chef/mash'
 require 'chef/json_compat'
+require 'chef/search/query'
 
 class Chef
-  class ApiClient 
-    
+  class ApiClient
+
     include Chef::Mixin::FromFile
     include Chef::Mixin::ParamsValidate
     include Chef::IndexQueue::Indexable
-    
-    
+
+
     DESIGN_DOCUMENT = {
       "version" => 1,
       "language" => "javascript",
       "views" => {
         "all" => {
           "map" => <<-EOJS
-          function(doc) { 
+          function(doc) {
             if (doc.chef_type == "client") {
               emit(doc.name, doc);
             }
@@ -49,7 +50,7 @@ class Chef
         },
         "all_id" => {
           "map" => <<-EOJS
-          function(doc) { 
+          function(doc) {
             if (doc.chef_type == "client") {
               emit(doc.name, doc.name);
             }
@@ -60,10 +61,10 @@ class Chef
     }
 
     attr_accessor :couchdb_rev, :couchdb_id, :couchdb
-    
+
     # Create a new Chef::ApiClient object.
     def initialize(couchdb=nil)
-      @name = '' 
+      @name = ''
       @public_key = nil
       @private_key = nil
       @couchdb_rev = nil
@@ -76,7 +77,7 @@ class Chef
     #
     # @params [Optional String] The name must be alpha-numeric plus - and _.
     # @return [String] The current value of the name.
-    def name(arg=nil) 
+    def name(arg=nil)
       set_or_return(
         :name,
         arg,
@@ -84,7 +85,7 @@ class Chef
       )
     end
 
-    # Gets or sets whether this client is an admin. 
+    # Gets or sets whether this client is an admin.
     #
     # @params [Optional True/False] Should be true or false - default is false.
     # @return [True/False] The current value
@@ -97,10 +98,10 @@ class Chef
     end
 
     # Gets or sets the public key.
-    # 
-    # @params [Optional String] The string representation of the public key. 
+    #
+    # @params [Optional String] The string representation of the public key.
     # @return [String] The current value.
-    def public_key(arg=nil) 
+    def public_key(arg=nil)
       set_or_return(
         :public_key,
         arg,
@@ -109,10 +110,10 @@ class Chef
     end
 
     # Gets or sets the private key.
-    # 
+    #
     # @params [Optional String] The string representation of the private key.
     # @return [String] The current value.
-    def private_key(arg=nil) 
+    def private_key(arg=nil)
       set_or_return(
         :private_key,
         arg,
@@ -122,7 +123,7 @@ class Chef
 
     # Creates a new public/private key pair, and populates the public_key and
     # private_key attributes.
-    # 
+    #
     # @return [True]
     def create_keys
       results = Chef::Certificate.gen_keypair(self.name)
@@ -133,7 +134,7 @@ class Chef
 
     # The hash representation of the object.  Includes the name and public_key,
     # but never the private key.
-    # 
+    #
     # @return [Hash]
     def to_hash
       result = {
@@ -148,12 +149,12 @@ class Chef
     end
 
     # The JSON representation of the object.
-    # 
+    #
     # @return [String] the JSON string.
     def to_json(*a)
       to_hash.to_json(*a)
     end
-    
+
     def self.json_create(o)
       client = Chef::ApiClient.new
       client.name(o["name"] || o["clientname"])
@@ -164,7 +165,7 @@ class Chef
       client.index_id = client.couchdb_id
       client
     end
-    
+
     # List all the Chef::ApiClient objects in the CouchDB.  If inflate is set
     # to true, you will get the full list of all ApiClients, fully inflated.
     def self.cdb_list(inflate=false, couchdb=nil)
@@ -172,7 +173,7 @@ class Chef
       lookup = (inflate ? "value" : "key")
       rs["rows"].collect { |r| r[lookup] }
     end
-    
+
     def self.list(inflate=false)
       if inflate
         response = Hash.new
@@ -185,15 +186,15 @@ class Chef
         Chef::REST.new(Chef::Config[:chef_server_url]).get_rest("clients")
       end
     end
-    
+
     # Load a client by name from CouchDB
-    # 
+    #
     # @params [String] The name of the client to load
     # @return [Chef::ApiClient] The resulting Chef::ApiClient object
     def self.cdb_load(name, couchdb=nil)
       (couchdb || Chef::CouchDB.new).load("client", name)
     end
-    
+
     # Load a client by name via the API
     def self.load(name)
       response = Chef::REST.new(Chef::Config[:chef_server_url]).get_rest("clients/#{name}")
@@ -205,7 +206,7 @@ class Chef
         client
       end
     end
-    
+
     # Remove this client from the CouchDB
     #
     # @params [String] The name of the client to delete
@@ -213,17 +214,17 @@ class Chef
     def cdb_destroy
       @couchdb.delete("client", @name, @couchdb_rev)
     end
-    
+
     # Remove this client via the REST API
     def destroy
       Chef::REST.new(Chef::Config[:chef_server_url]).delete_rest("clients/#{@name}")
     end
-    
+
     # Save this client to the CouchDB
     def cdb_save
       @couchdb_rev = @couchdb.store("client", @name, self)["rev"]
     end
-    
+
     # Save this client via the REST API, returns a hash including the private key
     def save(new_key=false, validation=false)
       if validation
@@ -237,23 +238,23 @@ class Chef
       rescue Net::HTTPServerException => e
         # If that fails, go ahead and try and update it
         if e.response.code == "409"
-          r.put_rest("clients/#{name}", { :name => self.name, :admin => self.admin, :private_key => new_key }) 
+          r.put_rest("clients/#{name}", { :name => self.name, :admin => self.admin, :private_key => new_key })
         else
           raise e
         end
       end
-    end 
-    
+    end
+
     # Create the client via the REST API
     def create
       Chef::REST.new(Chef::Config[:chef_server_url]).post_rest("clients", self)
     end
-    
+
     # Set up our CouchDB design document
     def self.create_design_document(couchdb=nil)
       (couchdb ||= Chef::CouchDB.new).create_design_document("clients", DESIGN_DOCUMENT)
     end
-    
+
     # As a string
     def to_s
       "client[#{@name}]"

data/lib/chef/application/knife.rb

@@ -24,7 +24,7 @@ class Chef::Application::Knife < Chef::Application
 
   NO_COMMAND_GIVEN = "You need to pass a sub-command (e.g., knife SUB-COMMAND)\n"
 
-  banner "Usage: #{$0} sub-command (options)"
+  banner "Usage: knife sub-command (options)"
 
   option :config_file,
     :short => "-c CONFIG",

data/lib/chef/client.rb

@@ -22,6 +22,7 @@ require 'chef/config'
 require 'chef/mixin/params_validate'
 require 'chef/log'
 require 'chef/rest'
+require 'chef/api_client'
 require 'chef/platform'
 require 'chef/node'
 require 'chef/role'

data/lib/chef/cookbook/cookbook_version_loader.rb

@@ -56,7 +56,9 @@ class Chef
 
         remove_ignored_files
 
-        if File.exists?(File.join(@cookbook_path, "metadata.json"))
+        if File.exists?(File.join(@cookbook_path, "metadata.rb"))
+          @metadata_filenames << File.join(@cookbook_path, "metadata.rb")
+        elsif File.exists?(File.join(@cookbook_path, "metadata.json"))
           @metadata_filenames << File.join(@cookbook_path, "metadata.json")
         end
 
@@ -88,12 +90,14 @@ class Chef
       # Generates the Cookbook::Metadata object
       def metadata(cookbook_version)
         @metadata = Chef::Cookbook::Metadata.new(cookbook_version)
-        @metadata_filenames.each do |meta_json|
-          begin
-            @metadata.from_json(IO.read(meta_json))
-          rescue JSON::ParserError
-            Chef::Log.error("Couldn't parse cookbook metadata JSON for #@cookbook_name in " + meta_json)
-            raise
+        @metadata_filenames.each do |metadata_file|
+          case metadata_file
+          when /\.rb$/
+            apply_ruby_metadata(metadata_file)
+          when /\.json$/
+            apply_json_metadata(metadata_file)
+          else
+            raise RuntimeError, "Invalid metadata file: #{metadata_file} for cookbook: #{cookbook_version}"
           end
         end
         @metadata
@@ -146,6 +150,24 @@ class Chef
         end
       end
 
+      def apply_ruby_metadata(file)
+        begin
+          @metadata.from_file(file)
+        rescue JSON::ParserError
+          Chef::Log.error("Error evaluating metadata.rb for #@cookbook_name in " + file)
+          raise
+        end
+      end
+
+      def apply_json_metadata(file)
+        begin
+          @metadata.from_json(IO.read(file))
+        rescue JSON::ParserError
+          Chef::Log.error("Couldn't parse cookbook metadata JSON for #@cookbook_name in " + file)
+          raise
+        end
+      end
+
     end
   end
 end