chef 11.10.0.rc.0 → 11.10.0.rc.1

data/Rakefile

@@ -26,31 +26,11 @@ require './tasks/rspec.rb'
 
 GEM_NAME = "chef"
 
-# This has to be here or else the docs get generated *after* the gem is created
-task :gem => 'docs:all'
-
 Dir[File.expand_path("../*gemspec", __FILE__)].reverse.each do |gemspec_path|
   gemspec = eval(IO.read(gemspec_path))
   Gem::PackageTask.new(gemspec).define
 end
 
-begin
-  require 'sdoc'
-
-  Rake::RDocTask.new do |rdoc|
-    rdoc.title = "Chef Ruby API Documentation"
-    rdoc.main = "README.rdoc"
-    rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator
-    rdoc.template = 'direct' # lighter template
-    rdoc.rdoc_files.include("README.rdoc", "LICENSE", "spec/tiny_server.rb", "lib/**/*.rb")
-    rdoc.rdoc_dir = "rdoc"
-  end
-rescue LoadError
-  puts "sdoc is not available. (sudo) gem install sdoc to generate rdoc documentation."
-rescue TypeError
-  puts "sdoc is not working on ruby-2.0.0 and throwing an odd TypeError, rdoc generation will be disabled on ruby 2.0 until that gets fixed."
-end
-
 task :install => :package do
   sh %{gem install pkg/#{GEM_NAME}-#{Chef::VERSION}.gem --no-rdoc --no-ri}
 end
@@ -68,61 +48,6 @@ task :ship => :gem do
   end
 end
 
-RONN_OPTS = "--manual='Chef Manual' --organization='Chef #{Chef::VERSION}' --date='#{Time.new.strftime('%Y-%m-%d')}'"
-
-namespace :docs do
-  desc "Regenerate HTML manual from markdown"
-  task :html
-
-  desc "Regenerate help topics from man pages"
-  task :list do
-    topics = Array.new
-
-    Dir['distro/common/man/man1/*.1'].each do |man|
-      topics << File.basename(man, '.1')
-    end
-
-    File.open('lib/chef/knife/help_topics.rb', 'w') do |f|
-      f.puts "# Do not edit this file by hand"
-      f.puts "# This file is autogenerated by the docs:list rake task from the available manpages\n\n"
-
-      f.puts "HELP_TOPICS = #{topics.inspect}"
-    end
-  end
-
-  # we can have ronn in the path, but not in the bundle, require both
-  ronn_in_bundle = true
-  begin
-    require 'ronn'
-  rescue LoadError
-    ronn_in_bundle = false
-  end
-
-  if ronn_in_bundle && system('which ronn > /dev/null')
-    ['distro/common/markdown/man1/*.mkd', 'distro/common/markdown/man8/*.mkd'].each do |dir|
-      Dir[dir].each do |mkd|
-        basename = File.basename(mkd, '.mkd')
-        if dir =~ /man1/
-          htmlfile = "distro/common/html/#{basename}.1.html"
-        elsif dir =~ /man8/
-          htmlfile = "distro/common/html/#{basename}.8.html"
-        end
-
-         file(htmlfile => [mkd, 'lib/chef/version.rb']) do
-           sh "ronn -5 #{RONN_OPTS} --style=toc #{mkd} --pipe > #{htmlfile}"
-         end
-         task :html => htmlfile
-      end
-    end
-  else
-    puts "get with the program and install ronn"
-  end
-
-  task :all => [:list, :html]
-end
-
-task :docs => "docs:all"
-
 begin
   require 'yard'
   DOC_FILES = [ "README.rdoc", "LICENSE", "spec/tiny_server.rb", "lib/**/*.rb" ]

data/distro/common/html/_sources/ctl_chef_client.txt

@@ -0,0 +1,36 @@
+=====================================================
+chef-client
+=====================================================
+
+.. include:: ../../includes_chef_client/includes_chef_client.rst
+
+.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client.rst
+
+.. note:: .. include:: ../../includes_config/includes_config_rb_client.rst
+
+Options
+=====================================================
+.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_11-8_options.rst
+
+Run with Elevated Privileges
+=====================================================
+.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_elevated_privileges.rst
+
+Linux
+-----------------------------------------------------
+.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_elevated_privileges_linux.rst
+
+Windows
+-----------------------------------------------------
+.. include:: ../../includes_ctl_chef_client/includes_ctl_chef_client_elevated_privileges_windows.rst
+
+Examples
+=====================================================
+
+**Start a Chef run when the chef-client is running as a daemon**
+
+.. include:: ../../step_ctl_chef_client/step_ctl_chef_client_start_chef_run_daemon.rst
+
+**Start a Chef run manually**
+
+.. include:: ../../step_ctl_chef_client/step_ctl_chef_client_start_chef_run_manual.rst

data/distro/common/html/_sources/ctl_chef_server.txt

@@ -0,0 +1,26 @@
+=====================================================
+chef-server-ctl
+=====================================================
+
+.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server.rst
+
+Options
+=====================================================
+.. include:: ../../includes_ctl_chef_server/includes_ctl_chef_server_options.rst
+
+
+Examples
+=====================================================
+The following examples show how to use |chef server ctl| to manage services.
+
+**View the status of a service**
+
+.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_view_service_status.rst
+
+**Restart a service**
+
+.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_restart_service.rst
+
+**Restart all services**
+
+.. include:: ../../step_ctl_chef_server/step_ctl_chef_server_restart_all_services.rst

data/distro/common/html/_sources/ctl_chef_shell.txt

@@ -0,0 +1,15 @@
+=====================================================
+chef-shell
+=====================================================
+
+.. include:: ../../includes_chef_shell/includes_chef_shell.rst
+
+.. include:: ../../includes_ctl_chef_shell/includes_ctl_chef_shell.rst
+
+Modes
+=====================================================
+.. include:: ../../includes_chef_shell/includes_chef_shell_modes.rst
+
+Options
+=====================================================
+.. include:: ../../includes_ctl_chef_shell/includes_ctl_chef_shell_options.rst

data/distro/common/html/_sources/ctl_chef_solo.txt

@@ -0,0 +1,25 @@
+=====================================================
+chef-solo
+=====================================================
+
+.. include:: ../../includes_chef_solo/includes_chef_solo.rst
+
+.. include:: ../../includes_ctl_chef_solo/includes_ctl_chef_solo.rst
+
+Options
+=====================================================
+.. include:: ../../includes_ctl_chef_solo/includes_ctl_chef_solo_options.rst
+
+Examples
+=====================================================
+**Use a URL**
+
+.. include:: ../../step_ctl_chef_solo/step_ctl_chef_solo_use_url.rst
+
+**Use a directory**
+
+.. include:: ../../step_ctl_chef_solo/step_ctl_chef_solo_use_directory.rst
+
+**Use a URL for cookbook and JSON data**
+
+.. include:: ../../step_ctl_chef_solo/step_ctl_chef_solo_url_for_cookbook_and_json.rst

data/distro/common/html/_sources/index.txt

@@ -0,0 +1,126 @@
+=====================================================
+|chef client| Man Pages
+=====================================================
+
+The following command line interfaces are available in the |chef client|:
+
+* :doc:`ctl_chef_client`
+* :doc:`ctl_chef_server`
+* :doc:`ctl_chef_shell`
+* :doc:`ctl_chef_solo`
+* :doc:`knife`
+
+knife
+=====================================================
+.. include:: ../../includes_knife/includes_knife.rst
+
+The following sections describe functionality common to all |knife| subcommands:
+
+* :doc:`knife_using`
+* :doc:`knife_common_options`
+
+|knife| includes the following sub-commands: 
+
+.. list-table::
+   :widths: 150 450
+   :header-rows: 1
+
+   * - Sub-command
+     - Description
+   * - :doc:`knife_bootstrap`
+     - .. include:: ../../includes_knife/includes_knife_bootstrap.rst
+   * - :doc:`knife_client`
+     - .. include:: ../../includes_knife/includes_knife_client.rst
+   * - :doc:`knife_configure`
+     - .. include:: ../../includes_knife/includes_knife_configure.rst
+   * - :doc:`knife_cookbook`
+     - .. include:: ../../includes_knife/includes_knife_cookbook.rst
+   * - :doc:`knife_cookbook_site`
+     - .. include:: ../../includes_knife/includes_knife_site_cookbook.rst
+   * - :doc:`knife_data_bag`
+     - .. include:: ../../includes_knife/includes_knife_data_bag.rst
+   * - :doc:`knife_delete`
+     - .. include:: ../../includes_knife/includes_knife_delete.rst
+   * - :doc:`knife_deps`
+     - .. include:: ../../includes_knife/includes_knife_deps.rst
+   * - :doc:`knife_diff`
+     - .. include:: ../../includes_knife/includes_knife_diff.rst
+   * - :doc:`knife_download`
+     - .. include:: ../../includes_knife/includes_knife_download.rst
+   * - :doc:`knife_edit`
+     - .. include:: ../../includes_knife/includes_knife_edit.rst
+   * - :doc:`knife_environment`
+     - .. include:: ../../includes_knife/includes_knife_environment.rst
+   * - :doc:`knife_exec`
+     - .. include:: ../../includes_knife/includes_knife_exec.rst
+   * - :doc:`knife_index_rebuild`
+     - .. include:: ../../includes_knife/includes_knife_index_rebuild.rst
+   * - :doc:`knife_list`
+     - .. include:: ../../includes_knife/includes_knife_list.rst
+   * - :doc:`knife_node`
+     - .. include:: ../../includes_knife/includes_knife_node.rst
+   * - :doc:`knife_raw`
+     - .. include:: ../../includes_knife/includes_knife_raw.rst
+   * - :doc:`knife_recipe_list`
+     - .. include:: ../../includes_knife/includes_knife_recipe_list.rst
+   * - :doc:`knife_role`
+     - .. include:: ../../includes_knife/includes_knife_role.rst
+   * - :doc:`knife_search`
+     - .. include:: ../../includes_knife/includes_knife_search.rst
+   * - :doc:`knife_show`
+     - .. include:: ../../includes_knife/includes_knife_show.rst
+   * - :doc:`knife_ssh`
+     - .. include:: ../../includes_knife/includes_knife_ssh.rst
+   * - :doc:`knife_status`
+     - .. include:: ../../includes_knife/includes_knife_status.rst
+   * - :doc:`knife_tag`
+     - .. include:: ../../includes_knife/includes_knife_tag.rst
+   * - :doc:`knife_upload`
+     - .. include:: ../../includes_knife/includes_knife_upload.rst
+   * - :doc:`knife_user`
+     - .. include:: ../../includes_knife/includes_knife_user.rst
+   * - :doc:`knife_xargs`
+     - .. include:: ../../includes_knife/includes_knife_xargs.rst
+
+
+.. Hide the TOC from this file.
+
+.. toctree::
+   :hidden:
+
+   ctl_chef_client
+   ctl_chef_server
+   ctl_chef_shell
+   ctl_chef_solo
+   knife
+   knife_common_options
+   knife_bootstrap
+   knife_client
+   knife_configure
+   knife_cookbook
+   knife_cookbook_site
+   knife_data_bag
+   knife_delete
+   knife_deps
+   knife_diff
+   knife_download
+   knife_edit
+   knife_environment
+   knife_exec
+   knife_index_rebuild
+   knife_list
+   knife_node
+   knife_raw
+   knife_recipe_list
+   knife_role
+   knife_search
+   knife_show
+   knife_ssh
+   knife_status
+   knife_tag
+   knife_upload
+   knife_user
+   knife_using
+   knife_xargs
+
+

data/distro/common/html/_sources/knife.txt

@@ -0,0 +1,74 @@
+=====================================================
+knife
+=====================================================
+
+.. include:: ../../includes_knife/includes_knife.rst
+
+The following sections describe functionality common to all |knife| subcommands:
+
+* :doc:`knife_using`
+* :doc:`knife_common_options`
+
+|knife| includes the following sub-commands: 
+
+.. list-table::
+   :widths: 150 450
+   :header-rows: 1
+
+   * - Sub-command
+     - Description
+   * - :doc:`knife_bootstrap`
+     - .. include:: ../../includes_knife/includes_knife_bootstrap.rst
+   * - :doc:`knife_client`
+     - .. include:: ../../includes_knife/includes_knife_client.rst
+   * - :doc:`knife_configure`
+     - .. include:: ../../includes_knife/includes_knife_configure.rst
+   * - :doc:`knife_cookbook`
+     - .. include:: ../../includes_knife/includes_knife_cookbook.rst
+   * - :doc:`knife_cookbook_site`
+     - .. include:: ../../includes_knife/includes_knife_site_cookbook.rst
+   * - :doc:`knife_data_bag`
+     - .. include:: ../../includes_knife/includes_knife_data_bag.rst
+   * - :doc:`knife_delete`
+     - .. include:: ../../includes_knife/includes_knife_delete.rst
+   * - :doc:`knife_deps`
+     - .. include:: ../../includes_knife/includes_knife_deps.rst
+   * - :doc:`knife_diff`
+     - .. include:: ../../includes_knife/includes_knife_diff.rst
+   * - :doc:`knife_download`
+     - .. include:: ../../includes_knife/includes_knife_download.rst
+   * - :doc:`knife_edit`
+     - .. include:: ../../includes_knife/includes_knife_edit.rst
+   * - :doc:`knife_environment`
+     - .. include:: ../../includes_knife/includes_knife_environment.rst
+   * - :doc:`knife_exec`
+     - .. include:: ../../includes_knife/includes_knife_exec.rst
+   * - :doc:`knife_index_rebuild`
+     - .. include:: ../../includes_knife/includes_knife_index_rebuild.rst
+   * - :doc:`knife_list`
+     - .. include:: ../../includes_knife/includes_knife_list.rst
+   * - :doc:`knife_node`
+     - .. include:: ../../includes_knife/includes_knife_node.rst
+   * - :doc:`knife_raw`
+     - .. include:: ../../includes_knife/includes_knife_raw.rst
+   * - :doc:`knife_recipe_list`
+     - .. include:: ../../includes_knife/includes_knife_recipe_list.rst
+   * - :doc:`knife_role`
+     - .. include:: ../../includes_knife/includes_knife_role.rst
+   * - :doc:`knife_search`
+     - .. include:: ../../includes_knife/includes_knife_search.rst
+   * - :doc:`knife_show`
+     - .. include:: ../../includes_knife/includes_knife_show.rst
+   * - :doc:`knife_ssh`
+     - .. include:: ../../includes_knife/includes_knife_ssh.rst
+   * - :doc:`knife_status`
+     - .. include:: ../../includes_knife/includes_knife_status.rst
+   * - :doc:`knife_tag`
+     - .. include:: ../../includes_knife/includes_knife_tag.rst
+   * - :doc:`knife_upload`
+     - .. include:: ../../includes_knife/includes_knife_upload.rst
+   * - :doc:`knife_user`
+     - .. include:: ../../includes_knife/includes_knife_user.rst
+   * - :doc:`knife_xargs`
+     - .. include:: ../../includes_knife/includes_knife_xargs.rst
+

data/distro/common/html/_sources/knife_bootstrap.txt

@@ -0,0 +1,56 @@
+=====================================================
+knife bootstrap 
+=====================================================
+
+.. include:: ../../includes_chef/includes_chef_bootstrap.rst
+
+.. include:: ../../includes_knife/includes_knife_bootstrap.rst
+
+.. note:: To bootstrap the |chef client| on |windows| machines, the `knife-windows <http://docs.opscode.com/plugin_knife_windows.html>`_ plugins is required, which includes the necessary bootstrap scripts that are used to do the actual installation.
+
+Syntax
+=====================================================
+.. include:: ../../includes_knife/includes_knife_bootstrap_syntax.rst
+
+Options
+=====================================================
+.. note:: Review the list of :doc:`common options </knife_common_options>` available to this (and all) |knife| subcommands and plugins.
+
+.. include:: ../../includes_knife/includes_knife_bootstrap_options.rst
+
+Custom Templates
+=====================================================
+The ``chef-full`` distribution uses the |omnibus installer|. For most bootstrap operations, regardless of the platform on which the target node is running, using the ``chef-full`` distribution is the best approach for installing the |chef client| on a target node. In some situations, using another supported distribution is necessary. And in some situations, a custom template may be required. For example, the default bootstrap operation relies on an Internet connection to get the distribution to the target node. If a target node cannot access the Internet, then a custom template can be used to define a specific location for the distribution so that the target node may access it during the bootstrap operation.
+
+A custom bootstrap template file (``template_filename.erb``) must be located in a ``bootstrap/`` directory. Use the ``--distro`` option with the ``knife bootstrap`` subcommand to specify the bootstrap template file. For example, a bootstrap template file named "british_sea_power.erb":
+
+.. code-block:: bash
+
+   $ knife bootstrap 123.456.7.8 -x username -P password --sudo --distro "british_sea_power.erb"
+
+The following examples show how a bootstrap template file can be customized for various platforms.
+
+Ubuntu 12.04
+-----------------------------------------------------
+.. include:: ../../includes_knife/includes_knife_bootstrap_example_ubuntu.rst
+
+Debian and Apt
+-----------------------------------------------------
+.. include:: ../../includes_knife/includes_knife_bootstrap_example_debian.rst
+
+Microsoft Windows
+-----------------------------------------------------
+.. include:: ../../includes_knife/includes_knife_bootstrap_example_windows.rst
+
+Examples
+=====================================================
+The following examples show how to use this |knife| subcommand:
+
+**Use an SSH password**
+
+.. include:: ../../step_knife/step_knife_bootstrap_use_ssh_password.rst
+
+**Use a file that contains a private key**
+
+.. include:: ../../step_knife/step_knife_bootstrap_use_file_with_private_key.rst
+