Move README to root.

Author: flaccid

README.rdoc

@@ -0,0 +1,188 @@
+= DESCRIPTION:
+
+Installs and configures Jenkins CI server & node slaves.  Resource providers to support automation via jenkins-cli, including job create/update.
+
+= REQUIREMENTS:
+
+== Chef:
+
+* Chef version 0.9.10 or higher
+
+== Platform:
+
+* 'default' - Server installation - currently supports Red Hat/CentOS 5.x and Ubuntu 8.x/9.x/10.x
+
+* 'node_ssh' - Any platform that is running sshd.
+
+* 'node_jnlp' - Unix platforms. (depends on runit recipe)
+
+* 'node_windows' - Windows platforms only.  Depends on .NET Framework, which can be installed with the windows::dotnetfx recipe.
+
+== Java:
+
+Jenkins requires Java 1.5 or higher, which can be installed via the Opscode java cookbook or windows::java recipe.
+
+== Jenkins node authentication:
+
+If your Jenkins instance requires authentication, you'll either need to embed user:pass in the jenkins.server.url or issue a jenkins-cli.jar login command prior to using the jenkins::node_* recipes.  For example, define a role like so:
+
+  name "jenkins_ssh_node"
+  description "cli login & register ssh slave with Jenkins"
+  run_list %w(vmw::jenkins_login jenkins::node_ssh)
+
+Where the jenkins_login recipe is simply:
+
+  jenkins_cli "login --username #{node[:jenkins][:username]} --password #{node[:jenkins][:password]}"
+
+= ATTRIBUTES: 
+
+* jenkins[:mirror] - Base URL for downloading Jenkins (server)
+* jenkins[:java_home] - Java install path, used for for cli commands
+* jenkins[:server][:home] - JENKINS_HOME directory
+* jenkins[:server][:user] - User the Jenkins server runs as
+* jenkins[:server][:group] - Jenkins user primary group
+* jenkins[:server][:port] - TCP listen port for the Jenkins server
+* jenkins[:server][:url] - Base URL of the Jenkins server
+* jenkins[:server][:plugins] - Download the latest version of plugins in this list, bypassing update center
+* jenkins[:node][:name] - Name of the node within Jenkins
+* jenkins[:node][:description] - Jenkins node description
+* jenkins[:node][:executors] - Number of node executors
+* jenkins[:node][:home] - Home directory ("Remote FS root") of the node
+* jenkins[:node][:labels] - Node labels
+* jenkins[:node][:mode] - Node usage mode, "normal" or "exclusive" (tied jobs only)
+* jenkins[:node][:launcher] - Node launch method, "jnlp", "ssh" or "command"
+* jenkins[:node][:availability] - "always" keeps node on-line, "demand" off-lines when idle
+* jenkins[:node][:in_demand_delay] - number of minutes for which jobs must be waiting in the queue before attempting to launch this slave.
+* jenkins[:node][:idle_delay] - number of minutes that this slave must remain idle before taking it off-line. 
+* jenkins[:node][:env] - "Node Properties" -> "Environment Variables"
+* jenkins[:node][:user] - user the slave runs as
+* jenkins[:node][:ssh_host] - Hostname or IP Jenkins should connect to when launching an SSH slave
+* jenkins[:node][:ssh_port] - SSH slave port
+* jenkins[:node][:ssh_user] - SSH slave user name (only required if jenkins server and slave user is different)
+* jenkins[:node][:ssh_pass] - SSH slave password (not required when server is installed via default recipe)
+* jenkins[:node][:ssh_private_key] - jenkins master defaults to: `~/.ssh/id_rsa` (created by the default recipe)
+* jenkins[:node][:jvm_options] - SSH slave JVM options
+* jenkins[:iptables_allow] - if iptables is enabled, add a rule passing 'jenkins[:server][:port]'
+* jenkins[:http_proxy][:variant] - use `nginx` or `apache2` to proxy traffic to jenkins backend (`nil` by default)
+* jenkins[:http_proxy][:www_redirect] - add a redirect rule for 'www.*' URL requests ("disable" by default)
+* jenkins[:http_proxy][:listen_ports] - list of HTTP ports for the HTTP proxy to listen on ([80] by default)
+* jenkins[:http_proxy][:host_name] - primary vhost name for the HTTP proxy to respond to (`node[:fqdn]` by default)
+* jenkins[:http_proxy][:host_aliases] - optional list of other host aliases to respond to (empty by default)
+* jenkins[:http_proxy][:client_max_body_size] - max client upload size ("1024m" by default, nginx only)
+
+= USAGE:
+
+== 'default' recipe
+
+Installs a Jenkins CI server using the http://jenkins-ci.org/redhat RPM.  The recipe also generates an ssh private key and stores the ssh public key in the node 'jenkins[:pubkey]' attribute for use by the node recipes.
+
+== 'node_ssh' recipe
+
+Creates the user and group for the Jenkins slave to run as and sets `.ssh/authorized_keys` to the 'jenkins[:pubkey]' attribute.  The 'jenkins-cli.jar'[1] is downloaded from the Jenkins server and used to manage the nodes via the 'groovy'[2] cli command.  Jenkins is configured to launch a slave agent on the node using its SSH slave plugin[3].
+
+[1] http://wiki.jenkins-ci.org/display/JENKINS/Jenkins+CLI
+[2] http://wiki.jenkins-ci.org/display/JENKINS/Jenkins+Script+Console
+[3] http://wiki.jenkins-ci.org/display/JENKINS/SSH+Slaves+plugin
+
+== 'node_jnlp' recipe
+
+Creates the user and group for the Jenkins slave to run as and '/jnlpJars/slave.jar' is downloaded from the Jenkins server.  Depends on runit_service from the runit cookbook.
+
+== 'node_windows' recipe
+
+Creates the home directory for the node slave and sets 'JENKINS_HOME' and 'JENKINS_URL' system environment variables.  The 'winsw'[1] Windows service wrapper will be downloaded and installed, along with generating `jenkins-slave.xml` from a template.  Jenkins is configured with the node as a 'jnlp'[2] slave and '/jnlpJars/slave.jar' is downloaded from the Jenkins server.  The 'jenkinsslave' service will be started the first time the recipe is run or if the service is not running.  The 'jenkinsslave' service will be restarted if '/jnlpJars/slave.jar' has changed.  The end results is functionally the same had you chosen the option to "Let Jenkins control this slave as a Windows service"[3].
+
+[1] http://weblogs.java.net/blog/2008/09/29/winsw-windows-service-wrapper-less-restrictive-license
+[2] http://wiki.jenkins-ci.org/display/JENKINS/Distributed+builds
+[3] http://wiki.jenkins-ci.org/display/JENKINS/Installing+Jenkins+as+a+Windows+service
+
+== 'proxy_nginx' recipe
+
+Uses the nginx::source recipe from the nginx cookbook to install an HTTP frontend proxy. To automatically activate this recipe set the `node[:jenkins][:http_proxy][:variant]` to `nginx`.
+
+== 'proxy_apache2' recipe
+
+Uses the apache2 recipe from the apache2 cookbook to install an HTTP frontend proxy. To automatically activate this recipe set the `node[:jenkins][:http_proxy][:variant]` to `apache2`.
+
+== 'jenkins_cli' resource provider
+
+This resource can be used to execute the Jenkins cli from your recipes.  For example, install plugins via update center and restart Jenkins:
+
+    %w(git URLSCM build-publisher).each do |plugin|
+      jenkins_cli "install-plugin #{plugin}"
+      jenkins_cli "safe-restart"
+    end
+
+== 'jenkins_node' resource provider
+
+This resource can be used to configure nodes as the 'node_ssh' and 'node_windows' recipes do or "Launch slave via execution of command on the Master".
+
+    jenkins_node node[:fqdn] do
+      description  "My node for things, stuff and whatnot"
+      executors    5
+      remote_fs    "/var/jenkins"
+      launcher     "command"
+      command      "ssh -i my_key #{node[:fqdn]} java -jar #{remote_fs}/slave.jar"
+      env          "ANT_HOME" => "/usr/local/ant", "M2_REPO" => "/dev/null"
+    end
+
+== 'jenkins_job' resource provider
+
+This resource manages jenkins jobs, supporting the following actions:
+
+   :create, :update, :delete, :build, :disable, :enable
+
+The 'create' and 'update' actions require a jenkins job config.xml.  Example:
+
+    git_branch = 'master'
+    job_name = "sigar-#{branch}-#{node[:os]}-#{node[:kernel][:machine]}"
+
+    job_config = File.join(node[:jenkins][:node][:home], "#{job_name}-config.xml")
+
+    jenkins_job job_name do
+      action :nothing
+      config job_config
+    end
+
+    template job_config do
+      source "sigar-jenkins-config.xml"
+      variables :job_name => job_name, :branch => git_branch, :node => node[:fqdn]
+      notifies :update, resources(:jenkins_job => job_name), :immediately
+      notifies :build, resources(:jenkins_job => job_name), :immediately
+    end
+
+== 'manage_node' library
+
+The script to generate groovy that manages a node can be used standalone.  For example:
+
+    % ruby manage_node.rb name slave-hostname remote_fs /home/jenkins ... | java -jar jenkins-cli.jar -s http://jenkins:8080/ groovy =
+
+= ISSUES
+
+* CLI authentication - http://issues.jenkins-ci.org/browse/JENKINS-3796
+
+* CLI *-node commands fail with "No argument is allowed: nameofslave" - http://issues.jenkins-ci.org/browse/JENKINS-5973
+
+= LICENSE & AUTHOR:
+
+This is a downstream fork of Doug MacEachern's Hudson cookbook (https://github.com/dougm/site-cookbooks) and therefore deserves all the glory.
+
+Author:: Doug MacEachern (<[email protected]>)
+
+Contributor:: Fletcher Nichol <[email protected]>
+Contributor:: Roman Kamyk <[email protected]>
+Contributor:: Darko Fabijan <[email protected]>
+
+Copyright:: 2010, VMware, Inc
+
+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.