chef 0.7.16 → 0.8.2

data/README.rdoc

@@ -46,6 +46,7 @@ Install the following RubyGems.
 * webrat
 * merb-core
 * roman-merb_cucumber
+* thin
 
 Ohai is also by Opscode and available on GitHub, http://github.com/opscode/ohai/tree/master.
 
@@ -61,25 +62,25 @@ Once everything is installed, run the dev:features rake task. Since the features
 
 The dev:features task:
 
-* Installs chef, chef-server, chef-server-slice gems. It will fail if required gems above are missing.
-* Starts chef-server on ports 4000 and 4001.
-* Starts chef-indexer.
 * Starts CouchDB on port 5984.
-* Starts the stompserver on port 61613.
+* Starts rabbitmq
+* Starts solr
+* Starts chef-indexer.
+* Starts chef-server on port 4000
+
 
 You'll know its running when you see:
 
-   ~ Activating slice 'ChefServerSlice' ...
-  merb : worker (port 4000) ~ Starting Mongrel at port 4000
-  merb : worker (port 4000) ~ Successfully bound to port 4000
-  merb : worker (port 4001) ~ Starting Mongrel at port 4001
-  merb : worker (port 4001) ~ Successfully bound to port 4001
+~ Activating slice 'ChefServerApi' ...
+merb : worker (port 4000) ~ Starting Thin at port 4000
+merb : worker (port 4000) ~ Using Thin adapter on host 0.0.0.0 and port 4000.
+merb : worker (port 4000) ~ Successfully bound to port 4000
 
 You'll want to leave this terminal running the dev environment.
 
 == Web Interface:
 
-With the dev environment running, you can now access the web interface via http://localhost:4000/. Supply an OpenID to log in.
+With the dev environment running, you can now access the web interface via http://localhost:4000/.
 
 == Spec testing:
 

data/bin/chef-client

@@ -18,9 +18,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-$: << File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 require 'rubygems'
 require 'chef/application/client'
 
-Chef::Application::Client.new.run
+Chef::Application::Client.new.run

data/bin/chef-solo

@@ -18,7 +18,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-$: << File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 require 'rubygems'
 require 'chef/application/solo'

data/bin/knife

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+#
+# ./knife - Chef CLI interface 
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2009 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+
+require 'rubygems'
+require 'chef/application/knife'
+
+Chef::Application::Knife.new.run
+

data/bin/shef

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+#
+# ./shef - Run the shef REPL
+#
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Copyright:: Copyright (c) 2009
+# License:: Apache License, Version 2.0
+#
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# TODO::EVIL
+require "rubygems"
+require "mixlib/cli"
+
+require "irb"
+require "irb/completion"
+
+# TODO::EVIL
+begin
+  require "#{File.dirname(__FILE__)}/../lib/chef"
+rescue LoadError
+  # the bin got moved, e.g., by rubygems
+end
+require "chef/shef"
+
+# dirty hack to make IRB initialize shef
+module IRB
+  class << self
+    alias :run_original_config :run_config
+  
+    def run_config
+      run_original_config
+      Shef.init
+    end
+  end
+end
+
+Shef.parse_opts
+IRB.start

data/distro/README

@@ -0,0 +1,2 @@
+Init scripts meant to be used with a gem installation via the bootstrap
+cookbook.

data/distro/common/man/man8/knife.8

@@ -0,0 +1,375 @@
+.TH CHEF: "1" "December 2009" "knife: 0.8.0" "System Administration Utilities"
+.SH NAME
+knife: \- Chef server REST API utility
+.SH SYNOPSIS
+.B knife
+\fIsub-command (options)\fR
+.SH DESCRIPTION
+.TP
+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.
+.TP
+Unless otherwise specified, output is in JSON format, and input files are also JSON format.
+.SH GENERAL OPTIONS
+.TP
+\fB\-s\fR, \fB\-\-server\-url\fR URL
+Chef Server URL
+.TP
+\fB\-k\fR, \fB\-\-key\fR KEY
+API Client Key
+.TP
+\fB\-c\fR, \fB\-\-config\fR CONFIG
+The configuration file to use
+.TP
+\fB\-e\fR, \fB\-\-editor\fR EDITOR
+Set the editor to use for interactive commands
+.TP
+\fB\-l\fR, \fB\-\-log_level\fR LEVEL
+Set the log level (debug, info, warn, error, fatal)
+.TP
+\fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
+Set the log file location, defaults to STDOUT
+.TP
+\fB\-n\fR, \fB\-\-no\-editor\fR
+Do not open EDITOR, just accept the data as is
+.TP
+\fB\-u\fR, \fB\-\-user\fR USER
+API Client Username
+.TP
+\fB\-p\fR, \fB\-\-print\-after\fR
+Show the data after a destructive operation
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show chef version
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Say yes to all prompts for confirmation
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show usage information.
+.SH SUB-COMMANDS
+Knife sub-commands are structured as "NOUN verb NOUN (options)". The sub-commands are meant to be intuitively named.
+.SH CLIENT SUB-COMMANDS
+.TP
+Sub-commands related to working with clients, which are registered entities that access the Chef server.
+.TP
+.B client bulk delete REGEX \fI(options)\fR
+.PP
+Delete clients on the Chef server based on a regular expression.
+.PP
+The regular expression (REGEX) here should be in quotes, not //'s.
+.TP
+.B client create CLIENT (options)
+.TP
+\fB\-f\fR, \fB\-\-file\fR FILE
+Write the key to a file
+.PP
+Create a new client.
+.PP
+.B client delete CLIENT (options)
+.PP
+Deletes a registered client.
+.PP
+.B client edit CLIENT (options)
+.PP
+Edit a registered client.
+.PP
+.B client list (options)
+.TP
+\fB\-w\fR, \fB\-\-with\-uri\fR
+Show corresponding URIs
+.PP
+List all registered clients.
+.PP
+.B client reregister CLIENT (options)
+.TP
+\fB\-f\fR, \fB\-\-file\fR FILE
+Write the key to a file
+.PP
+Regenerate the private key for a client.
+.PP
+.B client show CLIENT (options)
+.TP
+\fB\-a\fR, \fB\-\-attribute\fR [ATTR]
+Show only one attribute
+.PP
+Show a client.
+.SH COOKBOOK SUB-COMMANDS
+.TP
+Cookbooks are the fundamental unit of distribution in Chef. They encapsulate all the recipes of resources and the assets used to configure a particular aspect of the infrastructure.
+.PP
+.B cookbook bulk delete COOKBOOK REGEX (options)
+.PP
+Delete cookbooks based on a regular expression.
+.PP
+The regular expression (REGEX) here should be in quotes, not //'s.
+.PP
+.B cookbook delete COOKBOOK (options)
+.PP
+Delete a single named COOKBOOK.
+.PP
+.B cookbook download COOKBOOK (options)
+.TP
+\fB\-f\fR, \fB\-\-file\fR FILE
+The filename to write to
+.PP
+Download a cookbook from the server as a gzip(1)'ed, tar(1) archive.
+.PP
+.B cookbook list (options)
+.TP
+\fB\-w\fR, \fB\-\-with\-uri\fR
+Show corresponding URIs
+.PP
+List all cookbooks.
+.PP
+.B cookbook metadata COOKBOOK (options)
+.TP
+\fB\-a\fR, \fB\-\-all\fR
+Generate metadata for all cookbooks, rather than just a single cookbook
+.PP
+Generate cookbook metadata for the named COOKBOOK.
+.TP
+\fB\-o\fR, \fB\-\-cookbook\-path\fR PATH:PATH
+A colon\-separated path to look for cookbooks in
+.PP
+.B cookbook show COOKBOOK [PART] [FILENAME] (options)
+.TP
+\fB\-f\fR, \fB\-\-fqdn\fR FQDN
+The FQDN of the host to see the file for
+.TP
+\fB\-p\fR, \fB\-\-platform\fR PLATFORM
+The platform to see the file for
+.TP
+\fB\-V\fR, \fB\-\-platform\-version\fR VERSION
+The platform version to see the file for
+.PP
+Show the particular part of a COOKBOOK. PART can be one of:
+.TP
+\fIattributes definitions files libraries providers recipes resources templates\fR
+.PP
+.B cookbook upload COOKBOOK (options)
+.TP
+\fB\-a\fR, \fB\-\-all\fR
+Upload all cookbooks, rather than just a single cookbook
+.TP
+\fB\-o\fR, \fB\-\-cookbook\-path\fR PATH:PATH
+A colon\-separated path to look for cookbooks in
+.PP
+Upload a cookbook to the server.
+.SH DATA BAG SUB-COMMANDS
+.PP
+Data bags are stores of JSON blobs. These blobs are called items. They are free form and indexed by the search mechanism on the Chef server.
+.PP
+.B data bag create BAG [ITEM] (options)
+.PP
+Create a new data bag, or item in a data bag.
+.PP
+.B data bag delete BAG [ITEM] (options)
+.PP
+Delete a data bag, or item from a data bag.
+.PP
+.B data bag edit BAG ITEM (options)
+.PP
+Edit an item in a data bag.
+.PP
+.B data bag list (options)
+.TP
+\fB\-w\fR, \fB\-\-with\-uri\fR
+Show corresponding URIs
+.PP
+List the available data bags.
+.PP
+.B data bag show BAG [ITEM] (options)
+.PP
+Show a specific data bag or an item in a data bag.
+.SH NODE SUB-COMMANDS
+.PP
+Nodes are the entities which are configured with Chef, typically servers or workstations. Nodes are registered as a client, typcially of the same name, but a single client might represent one or more nodes.
+.PP
+.B node bulk delete REGEX (options)
+.TP
+Delete nodes based on a regular expression.
+.PP
+The regular expression (REGEX) here should be in quotes, not //'s.
+.PP
+.B node create NODE (options)
+.PP
+Create a new node.
+.PP
+.B node delete NODE (options)
+.PP
+Delete a single node.
+.PP
+.B node edit NODE (options)
+.PP
+Edit a node.
+.PP
+.B node from file FILE (options)
+.PP
+Create a node from a JSON file.
+.PP
+.B node list (options)
+.TP
+\fB\-w\fR, \fB\-\-with\-uri\fR
+Show corresponding URIs
+.PP
+List all nodes.
+.PP
+.B node run_list add [NODE] [ENTRY] (options)
+.TP
+\fB\-a\fR, \fB\-\-after\fR [ITEM]
+Place the ENTRY in the run list after ITEM
+.PP
+Add a recipe or role to the node's run_list.
+.PP
+.B node run_list remove [NODE] [ENTRY] (options)
+.PP
+Remove a recipe or role from the node's run_list.
+.PP
+.B node show NODE (options)
+.TP
+\fB\-a\fR, \fB\-\-attribute\fR [ATTR]
+Show only one attribute
+.TP
+\fB\-r\fR, \fB\-\-run\-list\fR
+Show only the run list
+.PP
+Show a node.
+.SH ROLE SUB-COMMANDS
+.PP
+Roles provide a mechanism to apply a set of recipes and attributes to nodes. For example, the 'webserver' role might instruct Chef to add a recipe for Apache, and specify a default domain to use.
+.PP
+.B role bulk delete REGEX (options)
+.TP
+Delete roles based on a regular expression.
+.PP
+The regular expression (REGEX) here should be in quotes, not //'s.
+.PP
+.B role create ROLE (options)
+.TP
+\fB\-d\fR, \fB\-\-description\fR
+The role description
+.PP
+Create a new role.
+.PP
+.B role delete ROLE (options)
+.PP
+Delete a role.
+.PP
+.B role edit ROLE (options)
+Edit a role.
+.PP
+.B role from file FILE (options)
+.PP
+Update a role from a file.
+.PP
+.B role list (options)
+.TP
+\fB\-w\fR, \fB\-\-with\-uri\fR
+Show corresponding URIs
+.PP
+List roles.
+.PP
+.B role show ROLE (options)
+.TP
+\fB\-a\fR, \fB\-\-attribute\fR [ATTR]
+Show only one attribute
+.PP
+Show a specific role.
+.SH GENERAL SUB-COMMANDS
+.PP
+The following are general sub-commands that do not fit within the other object types used in Chef.
+.PP
+.B configure (options)
+.TP
+\fB\-r\fR, \fB\-\-repository\fR REPO
+The path to your chef\-repo
+.PP
+Create a configuration file for knife. This will prompt for values to enter into the file. See "\fBCONFIGURATION\fR" below for available options.
+.PP
+.B ec2 instance data [RUN LIST...] (options)
+.TP
+\fB\-e\fR, \fB\-\-edit\fR
+Edit the instance data
+.PP
+Chef is commonly used with Amazon AWS EC2 nodes. This command will generate instance metadata that can be used to automatically configure an EC2 instance with Chef.
+.PP
+.B search INDEX QUERY (options)
+.TP
+\fB\-a\fR, \fB\-\-attribute\fR [ATTR]
+Show only one attribute
+.TP
+\fB\-i\fR, \fB\-\-id\-only\fR
+Show only the ID of matching objects
+.TP
+\fB\-R\fR, \fB\-\-rows\fR INT
+The number of rows to return
+.TP
+\fB\-r\fR, \fB\-\-run\-list\fR
+Show only the run list
+.TP
+\fB\-o\fR, \fB\-\-sort\fR SORT
+The order to sort the results in
+.TP
+\fB\-b\fR, \fB\-\-start\fR ROW
+The row to start returning results at
+.PP
+Search indexes are a powerful feature of the Chef server and the search subcommand allows searching any of the available indexes using the SOLR query syntax.
+.PP
+.B ssh QUERY COMMAND (options)
+.TP
+\fB\-a\fR, \fB\-\-attribute\fR ATTR
+The attribute to use for opening the connection \- default is fqdn
+.TP
+\fB\-C\fR, \fB\-\-concurrency\fR NUM
+The number of concurrent connections
+.PP
+The ssh sub-command requires the net-ssh-multi Ruby library.
+.PP
+.SH CONFIGURATION
+The knife configuration file is a Ruby DSL. If it exists, knife uses the settings for \fBGENERAL OPTIONS\fR defaults.
+.TP
+.B log_level
+A Ruby symbol specifying the log level. Corresponds to the \-l or \-\-log_level option. Default is :info.
+.TP
+.B log_location
+Corresponds to the \-L or \-\-logfile option. Default is STDOUT.
+.TP
+.B 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.
+.TP
+.B 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.
+.TP
+.B 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.
+.TP
+.B cache_type
+The type of cache to use. Default is \fIBasicFile\fR. 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.
+.TP
+.B cache_options
+Specifies various options to use for caching. Default reads the Chef client configuration (/etc/chef/checksums).
+.TP
+.B 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.
+.TP
+.B 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.
+.SH FILES
+.PP
+\fI~/.chef/knife.rb\fR
+.TP
+Ruby DSL configuration file for Knife. See "\fBCONFIGURATION\fR".
+.SH SEE ALSO
+.PP
+Full documentation for Chef and Knife is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
+.PP
+JSON is JavaScript Object Notation and more information can be found at http://json.org/.
+.PP
+SOLR is an open source search engine. The Chef Server includes a SOLR installation. More information about SOLR, including search query syntax, can be found at http://lucene.apache.org/solr/.
+.SH AUTHOR
+Chef was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
+This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted
+to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
+.PP
+On Debian systems, the complete text of the Apache 2.0 License can be found in
+/usr/share/common-licenses/Apache-2.0.