rmm-chef 0.10.0.rc.0

data/distro/common/man/man8/chef-solr.8

@@ -0,0 +1,114 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-SOLR" "8" "April 2011" "Chef 0.10.0.rc.0" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-solr\fR \- Runs as Chef\'s search server
+.
+.SH "SYNOPSIS"
+\fBchef\-solr\fR \fI(options)\fR
+.
+.TP
+\fB\-c\fR, \fB\-\-config CONFIG\fR
+The configuration file to use
+.
+.TP
+\fB\-d\fR, \fB\-\-daemonize\fR
+Daemonize the process
+.
+.TP
+\fB\-g\fR, \fB\-\-group GROUP\fR
+Group to set privilege to
+.
+.TP
+\fB\-l\fR, \fB\-\-log_level LEVEL\fR
+Set the log level (debug, info, warn, error, fatal)
+.
+.TP
+\fB\-L\fR, \fB\-\-logfile LOGLOCATION\fR
+Set the log file location, defaults to STDOUT \- recommended for daemonizing
+.
+.TP
+\fB\-D\fR, \fB\-\-solr\-data\-dir PATH\fR
+Where the Solr data lives
+.
+.TP
+\fB\-x\fR, \fB\-\-solor\-heap\-size SIZE\fR
+Set the size of the Java Heap
+.
+.TP
+\fB\-H\fR, \fB\-\-solr\-home\-dir PATH\fR
+Solr home directory
+.
+.TP
+\fB\-j\fR, \fB\-\-java\-opts OPTS\fR
+Raw options passed to Java
+.
+.TP
+\fB\-W\fR, \fB\-\-solr\-jetty\-dir PATH\fR
+Where to place the Solr Jetty instance
+.
+.TP
+\fB\-u\fR, \fB\-\-user USER\fR
+User to set privilege to
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show chef\-solr version
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show this message
+.
+.SH "DESCRIPTION"
+Chef\-solr provides search service for Chef\. You need to have both chef\-solr and chef\-expander\-cluster running in order for search to work\.
+.
+.P
+\fBInstallation\fR
+.
+.P
+Make sure you backed up your data if you are upgrading from a previous version\. Run chef\-solr\-installer to upgrade your Chef Solr installation\. Answer "yes" when prompted for confirmation\. The process should look like this:
+.
+.IP "" 4
+.
+.nf
+
+yourshell> chef\-solr\-installer
+Configuration setting solr_heap_size is unknown and will be ignored
+
+Chef Solr is already installed in /var/chef/solr
+Do you want to overwrite the current install? All existing Solr data will be lost\. [y/n] y
+Removing the existing Chef Solr installation
+  rm \-rf /var/chef/solr
+  rm \-rf /var/chef/solr\-jetty
+  rm \-rf /var/chef/solr/data
+Creating Solr Home Directory
+  mkdir \-p /var/chef/solr
+  entering /var/chef/solr
+  tar zxvf /Users/ddeleo/opscode/chef/chef\-solr/solr/solr\-home\.tar\.gz
+Creating Solr Data Directory
+  mkdir \-p /var/chef/solr/data
+Unpacking Solr Jetty
+  mkdir \-p /var/chef/solr\-jetty
+  entering /var/chef/solr\-jetty
+  tar zxvf /Users/ddeleo/opscode/chef/chef\-solr/solr/solr\-jetty\.tar\.gz
+
+Successfully installed Chef Solr\.
+You can restore your search index using `knife index rebuild`
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBchef\-expander\-cluster\fR(8)
+.
+.P
+Full documentation for Chef and chef\-server is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
+.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@ospcode\.com\fR of Opscode (http://www\.opscode\.com), with contributions from the community\. This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR with help2man\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
+.
+.P
+On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.

data/distro/common/markdown/README

@@ -0,0 +1,3 @@
+This directory contains markdown documentation that is used in other places.
+For example, markdown (.mkd) documents that are generated as man pages
+with ronn.

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

@@ -0,0 +1,138 @@
+knife-bootrap(1) -- Install Chef Client on a remote host
+========================================
+
+## SYNOPSIS
+
+__knife__ __bootstrap__ _(options)_
+
+  * `-i`, `--identity-file IDENTITY_FILE`:
+    The SSH identity file used for authentication
+  * `-N`, `--node-name NAME`:
+    The Chef node name for your new node
+  * `-P`, `--ssh-password PASSWORD`:
+    The ssh password
+  * `-x`, `--ssh-user USERNAME`:
+    The ssh username
+  * `--prerelease`:
+    Install pre-release Chef gems
+  * `-r`, `--run-list RUN_LIST`:
+    Comma separated list of roles/recipes to apply
+  * `-P`, `--ssh-password PASSWORD`:
+    The ssh password
+  * `-x`, `--ssh-user USERNAME`:
+    The ssh username
+  * `--template-file TEMPLATE`:
+    Full path to location of template to use
+  * `--sudo`:
+    Execute the bootstrap via sudo
+  * `-d`, `--distro DISTRO`:
+    Bootstrap a distro using a template
+
+## DESCRIPTION
+
+Performs a Chef Bootstrap on the target node. The goal of the bootstrap
+is to get Chef installed on the target system so it can run Chef Client
+with a Chef Server. The main assumption is a baseline OS installation
+exists. This sub-command is used internally by some cloud computing
+plugins.
+
+The bootstrap sub-command supports supplying a template to perform the
+bootstrap steps. If the distro is not specified (via `-d` or `--distro`
+option), an Ubuntu 10.04 host bootstrapped with RubyGems is assumed. The
+__DISTRO__ value corresponds to the base filename of the template, in
+other words `DISTRO`.erb. A template file can be specified with the
+`--template-file` option in which case the __DISTRO__ is not used. The
+sub-command looks in the following locations for the template to use:
+
+* `bootstrap` directory in the installed Chef Knife library.
+* `bootstrap` directory in the `$PWD/.chef`.
+* `bootstrap` directory in the users `$HOME/.chef`.
+
+The default bootstrap templates are scripts that get copied to the
+target node (FQDN). The following distros are supported:
+
+* centos5-gems
+* fedora13-gems
+* ubuntu10.04-gems
+* ubuntu10.04-apt
+
+The gems installations will use RubyGems 1.3.6 and Chef installed as a
+gem. The apt installation will use the Opscode APT repository. The
+RubyGems installation requires installing gems with native extensions,
+so development related packages (ruby-dev, build-essential) are
+installed. These are not installed with the apt installation, as native
+extensions are already compiled in the required packages.
+
+In addition to handling the software installation, these bootstrap
+templates do the following:
+
+  - Write the validation.pem per the local knife configuration.
+  - Write a default config file for Chef (`/etc/chef/client.rb`) using values from the `knife.rb`.
+  - Create a JSON attributes file containing the specified run list and run Chef.
+
+In the case of the RubyGems, the `client.rb` will be written from
+scratch with a minimal set of values; see __EXAMPLES__. In the case of
+APT Package installation, `client.rb` will have the
+`validation_client_name` appended if it is not set to `chef-validator`
+(default config value), and the `node_name` will be added if
+`chef_node_name` option is specified.
+
+When this is complete, the bootstrapped node will have:
+
+  - Latest Chef version installed from RubyGems or APT Packages from Opscode. This may be a later version than the local system.
+  - Be validated with the configured Chef Server.
+  - Have run Chef with its default run list if one is specfied.
+
+Additional custom bootstrap templates can be created and stored in
+`.chef/bootstrap/DISTRO.erb`, replacing __DISTRO__ with the value passed
+with the `-d` or `--distro` option. See __EXAMPLES__ for more
+information.
+
+## EXAMPLES
+Setting up a custom bootstrap is fairly straightforward. Create a
+`.chef/bootstrap` directory in your Chef Repository 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.
+
+## BUGS
+`knife bootstrap` is not capable of bootstrapping multiple hosts in
+parallel.
+
+The bootstrap script is passed as an argument to sh(1) on the remote
+system, so sensitive information contained in the script will be visible
+to other users via the process list using tools such as ps(1).
+
+## SEE ALSO
+   __knife-ssh__(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-client.mkd

@@ -0,0 +1,103 @@
+knife-client(1) -- Manage Chef API Clients
+========================================
+
+## SYNOPSIS
+
+__knife__ __client__ _sub-command_ _(options)_
+
+## SUB-COMMANDS
+Client subcommands follow a basic create, read, update, delete (CRUD)
+pattern. The Following subcommands are available:
+
+## BULK DELETE
+__knife client bulk delete__ _regex_ _(options)_
+
+Delete clients where the client name matches the regular expression
+_regex_ on the Chef Server. The regular expression should be given as a
+quoted string, and not surrounded by forward slashes.
+
+## CREATE
+__knife client create__ _client name_ _(options)_
+
+  * `-a`, `--admin    `:
+    Create the client as an admin
+  * `-f`, `--file FILE`:
+    Write the key to a file
+
+Create a new client. This generates an RSA keypair. The private key will
+be displayed on _STDOUT_ or written to the named file. The public half
+will be stored on the Server. For _chef-client_ systems, the private key
+should be copied to the system as `/etc/chef/client.pem`.
+
+Admin clients should be created for users that will use _knife_ to
+access the API as an administrator. The private key will generally be
+copied to `~/.chef/client\_name.pem` and referenced in the `knife.rb`
+configuration file.
+
+## DELETE
+__knife client delete__ _client name_  _(options)_
+
+Deletes a registered client.
+
+## EDIT
+__client edit__ _client name_ _(options)_
+
+Edit a registered client.
+
+## LIST
+__client list__ _(options)_
+
+  * `-w`, `--with-uri`:
+      Show corresponding URIs
+
+List all registered clients.
+
+## REREGISTER
+__client reregister__ _client name_  _(options)_
+
+  * `-f`, `--file FILE`:
+    Write the key to a file
+
+Regenerate the RSA keypair for a client. The public half will be stored
+on the server and the private key displayed on _STDOUT_ or written to
+the named file. This operation will invalidate the previous keypair used
+by the client, preventing it from authenticating with the Chef Server.
+Use care when reregistering the validator client.
+
+## SHOW
+__client show__ _client name_ _(options)_
+
+  * `-a`, `--attribute ATTR`:
+    Show only one attribute
+
+Show a client. Output format is determined by the --format option.
+
+## DESCRIPTION
+Clients are identities used for communication with the Chef Server API,
+roughly equivalent to user accounts on the Chef Server, except that
+clients only communicate with the Chef Server API and are authenticated
+via request signatures.
+
+In the typical case, there will be one client object on the server for
+each node, and the corresponding client and node will have identical
+names.
+
+In the Chef authorization model, there is one special client, the
+"validator", which is authorized to create new non-administrative
+clients but has minimal privileges otherwise. This identity is used as a
+sort of "guest account" to create a client identity when initially
+setting up a host for management with Chef.
+
+## SEE ALSO
+   __knife-node__(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-configure.mkd

@@ -0,0 +1,70 @@
+knife-configure(1) -- Generate configuration files for knife or Chef Client
+========================================
+
+## SYNOPSIS
+
+__knife__ __configure__ [client] _(options)_
+
+## DESCRIPTION
+Generates a knife.rb configuration file interactively. When given the
+--initial option, also creates a new administrative user.
+
+## CONFIGURE SUBCOMMANDS ##
+
+__knife configure__ _(options)_
+
+  * `-i`, `--initial`:
+    Create an initial API Client
+  * `-r`, `--repository REPO`:
+    The path to your chef-repo
+
+Create a configuration file for knife. This will prompt for values to
+enter into the file. Default values are listed in square brackets if no
+other entry is typed. See __knife__(1) for a description of
+configuration options.
+
+__knife configure client__ _directory_
+
+Read the _knife.rb_ config file and generate a config file suitable for
+use in _/etc/chef/client.rb_ and copy the validation certificate into
+the specified _directory_.
+
+## EXAMPLES
+  * On a freshly installed Chef Server, use _knife configure -i_ to
+    create an administrator and knife configuration file. Leave the
+    field blank to accept the default value. On most systems, the
+    default values are acceptable.
+
+    user@host$ knife configure -i  
+    Please enter the chef server URL: [http://localhost:4000]  
+    Please enter a clientname for the new client: [username]  
+    Please enter the existing admin clientname: [chef-webui]  
+    Please enter the location of the existing admin client's private key: [/etc/chef/webui.pem]  
+    Please enter the validation clientname: [chef-validator]  
+    Please enter the location of the validation key: [/etc/chef/validation.pem]  
+    Please enter the path to a chef repository (or leave blank):  
+    Creating initial API user...  
+    Created (or updated) client[username]  
+    Configuration file written to /home/username/.chef/knife.rb  
+
+    This creates a new administrator client named _username_, writes
+    a configuration file to _/home/username/.chef/knife.rb_, and the
+    private key to _/home/username/.chef/username.pem_. The
+    configuration file and private key may be copied to another system
+    to facilitate administration of the Chef Server from a remote
+    system. Depending on the value given for the Chef Server URL, you
+    may need to modify that setting after copying to a remote host.
+
+## SEE ALSO
+   __knife__(1) __knife-client__(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-cookbook-site.mkd

@@ -0,0 +1,119 @@
+knife-cookbook-site(1) -- Install and update open source cookbooks
+========================================
+
+## SYNOPSIS
+
+__knife__ __cookbook site__ _sub-command_ _(options)_
+
+## COOKBOOK SITE SUB-COMMANDS
+`knife cookbook site` provides the following subcommands:
+
+## INSTALL
+__cookbook site install COOKBOOK [VERSION]__ _(options)_
+
+  * `-d`, `--dependencies`:
+    Grab dependencies automatically
+
+Uses git(1) version control in conjunction with the cookbook site to
+install community contributed cookbooks to your local cookbook
+repository. Running `knife cookbook site install` does the following:
+
+1. A new "pristine copy" branch is created in git for tracking the
+   upstream;
+2. All existing cookbooks are removed from the branch;
+3. The cookbook is downloaded from the cookbook site in tarball form;
+4. The downloaded cookbook is untarred, and its contents commited via git;
+5. The pristine copy branch is merged into the master branch.
+
+By installing cookbook with this process, you can locally modify the
+upstream cookbook in your master branch ant let git maintain your
+changes as a separate patch.  When an updated upstream version becomes
+available, you will be able to merge the upstream changes while
+maintaining your local modifications.
+
+If _-d_ is specified, the process is applied recursively to all the
+cookbooks _COOKBOOK_ depends on (via metadata _dependencies_).
+
+## DOWNLOAD
+__knife cookbook site download COOKBOOK [VERSION]__ _(options)_
+
+  * `-f`, `--file FILE`:
+    The filename to write to
+  * `--force`:
+    Force download deprecated cookbook
+
+Downloads a specific cookbook from the Community site, optionally
+specifying a certain version.
+
+## LIST
+__knife cookbook site list__ _(options)_
+
+  * `-w`, `--with-uri`:
+    Show corresponding URIs
+
+Lists available cookbooks from the Community site.
+
+## SEARCH
+__knife cookbook site search QUERY__ _(options)_
+
+Searches for available cookbooks matching the specified query.
+
+## SHARE
+__knife cookbook site share COOKBOOK CATEGORY__ _(options)_
+
+  * `-k`, `--key KEY`:
+    API Client Key
+  * `-u`, `--user USER`:
+    API Client Username
+  * `-o`, `--cookbook-path PATH:PATH`:
+    A colon-separated path to look for cookbooks in
+
+Uploads the specified cookbook using the given category to the Opscode
+cookbooks site. Requires a login user and certificate for the Opscode
+Cookbooks site. By default, knife will use the username and API key
+you've configured in your configuration file; otherwise you must
+explicitly set these values on the command line or use an alternate
+configuration file.
+
+## UNSHARE
+__knife cookbook site unshare COOKBOOK__
+
+Stops sharing the specified cookbook on the Opscode cookbooks site.
+
+## SHOW
+__knife cookbook site show COOKBOOK [VERSION]__ _(options)_
+
+Shows information from the site about a particular cookbook.
+
+## DESCRIPTION
+The cookbook site, <http://community.opscode.com/>, is a cookbook
+distribution service operated by Opscode. This service provides users
+with a central location to publish cookbooks for sharing with other
+community members.
+
+`knife cookbook site` commands provide an interface to the cookbook
+site's HTTP API. For commands that read data from the API, no account is
+required. In order to upload cookbooks using the `knife cookbook site
+share` command, you must create an account on the cookbook site and
+configure your credentials via command line option or in your knife
+configuration file.
+
+## EXAMPLES
+Uploading cookbooks to the Opscode cookbooks site:
+
+    knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME
+
+## SEE ALSO
+   __knife-cookbook(1)__
+   <http://community.opscode.com/cookbooks>
+
+## 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>
+