knife-server 0.3.3 → 1.0.0

data/.travis.yml

@@ -1,6 +1,16 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 1.9.2
-  - 1.8.7
-  - ree
+- 1.9.3
+- 1.9.2
+- ruby-head
+- 1.8.7
+- ree
+
+env:
+- "CHEF_VERSION=11.4.0"
+- "CHEF_VERSION=10.24.0"
+- "CHEF_VERSION=0.10.10"
+
+matrix:
+  allow_failures:
+  - rvm: ruby-head

data/CHANGELOG.md

@@ -1,7 +1,47 @@
-## 0.3.4.dev (unreleased)
+## 1.0.0 / 2013-02-28
 
+### Breaking Changes
 
-## 0.3.3 (December 24, 2012)
+* Default Chef Server installed is the latest Chef 11 (erchef) version from
+  Omnibus packages via the `"chef11/omnibus"` template. All platform supported
+  by the Omnibus packages should work out of the box. Chef Server 10 is still
+  supported by setting the --bootstrap-version flag to "10". ([@fnichol][])
+* WebUI is no longer configured to start up by default (--enable-webui flag
+  introduced to re-enable). For more details, please read
+  http://lists.opscode.com/sympa/arc/chef-dev/2013-02/msg00023.html.
+  ([@fnichol][])
+* The knife-ec2 gem is no longer a direct dependency; you must add install this
+  gem or add it to your Gemfile in order to use `knife server bootstrap ec2`.
+  ([@fnichol][])
+
+### New features
+
+* First class support for RHEL platform family nodes including CentOS,
+  Scientific, RHEL, Amazon Linux, etc. Seriously, this is huge. ([@danryan][],
+  [@erikh][])
+* Support for installing Chef 11 (erchef) servers from Omnibus packages.
+  ([@fnicho][])
+* Add --log-level flag to help debug bootstrap template output. ([@fnichol][])
+* Support all relevant options from `Chef::Knife::Bootstrap` and
+  `Chef::Knife::Ec2ServerCreate` in the standalone and ec2 subcommands. This
+  includes --bootstrap-version, ssh options, ebs options, etc. ([@fnichol][])
+* An auto mode (set via --platform auto) which will detect the node's platform
+  and run the appropriate template for Chef 10 servers. Currently only
+  supported with standalone subcommand. ([@erikh][])
+
+### Improvements
+
+* Ensure config parameters are applied in the right order for Chef 10/11.
+  ([@fnichol][])
+* Add matrix build support to TravisCI for multiple versions of Chef.
+  ([@fnichol][])
+* Update README badges (better consistency). ([@fnichol][])
+* Update CHANGLOG format headings for Vandamme/Gemnasium compatability.
+  ([@fnichol][])
+* Update README documentation with 1.0.0 changes. ([@fnichol][])
+
+
+## 0.3.3 / 2012-12-24
 
 ### Bug fixes
 
@@ -9,7 +49,7 @@
   identity-file when `nil` is passed in. ([@erikh][])
 
 
-## 0.3.2 (December 19, 2012)
+## 0.3.2 / 2012-12-19
 
 ### Improvements
 
@@ -23,7 +63,7 @@
   users of this gem. ([@fnichol][])
 
 
-## 0.3.1 (December 12, 2012)
+## 0.3.1 / 2012-12-12
 
 ### Bug fixes
 
@@ -41,7 +81,7 @@
 * Update usage section in README.
 
 
-## 0.3.0 (July 7, 2012)
+## 0.3.0 / 2012-07-07
 
 ### New features
 
@@ -50,7 +90,7 @@
   ([@fnichol][])
 
 
-## 0.2.2 (July 4, 2012)
+## 0.2.2 / 2012-07-04
 
 ### New features
 
@@ -62,7 +102,7 @@
 * Add Code Climate badge to README. ([@fnichol][])
 
 
-## 0.2.1 (July 3, 2012)
+## 0.2.1 / 2012-07-03
 
 ### Improvements
 
@@ -70,7 +110,7 @@
   http://wiki.opscode.com/display/chef/Knife+Plugins. ([@fnichol][])
 
 
-## 0.2.0 (July 3, 2012)
+## 0.2.0 / 2012-07-03
 
 ### Bug fixes
 
@@ -85,10 +125,11 @@
   ([@fnichol][])
 
 
-## 0.1.0 (June 23, 2012)
+## 0.1.0 / 2012-06-23
 
 The initial release.
 
+[@danryan]: https://github.com/danryan
 [@erikh]: https://github.com/erikh
 [@fnichol]: https://github.com/fnichol
 [@iafonov]: https://github.com/iafonov

data/Gemfile

@@ -5,4 +5,7 @@ gemspec
 
 group :test do
   gem 'rake', '~> 0.9'
+
+  # allow CI to override the version of Chef for matrix testing
+  gem 'chef', (ENV['CHEF_VERSION'] || '>= 0.10.10')
 end

data/README.md

@@ -1,6 +1,7 @@
 # <a name="title"></a> Knife::Server
 
-[![Build Status](https://secure.travis-ci.org/fnichol/knife-server.png?branch=master)](http://travis-ci.org/fnichol/knife-server) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fnichol/knife-server)
+[![Build Status](https://secure.travis-ci.org/fnichol/knife-server.png?branch=master)](http://travis-ci.org/fnichol/knife-server)
+[![Code Climate](https://codeclimate.com/github/fnichol/knife-server.png)](https://codeclimate.com/github/fnichol/knife-server)
 
 An Opscode Chef knife plugin to manage Chef Servers. Bootstrap a new Chef
 Server on Amazon's EC2 or a standalone server. Backup and restore your Chef
@@ -12,8 +13,27 @@ Follow the [installation](#installation) instructions, then you are ready
 to create your very own Chef Server running Ubuntu on Amazon's EC2 service:
 
 ```bash
-$ knife server bootstrap ec2 --ssh-user ubuntu \
-  --node-name chefapalooza.example.com
+$ knife server bootstrap ec2 \
+  --node-name chefapalooza.example.com \
+  --aws-access-key-id $AWS_ACCESS_KEY_ID \
+  --aws-secret-access-key $AWS_SECRET_ACCESS_KEY \
+  --region us-east-1 \
+  --availability-zone us-east-1b \
+  --image ami-de0d9eb7 \
+  --ssh-user ubuntu \
+  --flavor m1.small \
+  --ssh-key id_rsa-aws \
+  --identity-file ~/.ssh/id_rsa-aws
+```
+
+Be sure to substitute with your access key id, secret access key, ssh key id,
+and identity file (private SSH key). If you have most of these settings set
+up in a `knife.rb` file, it becomes much shorter:
+
+```bash
+$ knife server bootstrap ec2 \
+  --node-name chefapalooza.example.com \
+  --ssh-user ubuntu
 ```
 
 Or maybe you want to try out a Chef Server using [Vagrant][vagrant_site]?
@@ -23,13 +43,16 @@ $ cat <<VAGRANTFILE > Vagrantfile
 Vagrant::Config.run do |config|
   config.vm.box = "precise64"
   config.vm.box_url = "http://files.vagrantup.com/precise64.box"
-  config.vm.network :hostonly, "192.168.33.11"
+  config.vm.network :hostonly, "192.168.33.10"
   config.vm.customize ["modifyvm", :id, "--memory", 2048]
 end
 VAGRANTFILE
 $ vagrant up
-$ knife server bootstrap standalone --ssh-user vagrant \
-  --node-name chefapalooza.example.com --host 192.168.33.11
+$ knife server bootstrap standalone \
+  --node-name chefapalooza.example.com \
+  --host 192.168.33.10 \
+  --ssh-user vagrant \
+  --ssh--password vagrant
 ```
 
 Taking a backup of all node, role, data bag, and environment data is also a
@@ -69,7 +92,14 @@ Add this line to your application's Gemfile:
 gem 'knife-server'
 ```
 
-And then execute:
+**Note** If you want to use the `bootstrap ec2` subcommand you will need to
+explicitly add this to your Gemfile with:
+
+```ruby
+gem 'knife-ec2'
+```
+
+Finally execute:
 
 ```bash
 $ bundle
@@ -81,6 +111,9 @@ Or install it yourself as:
 $ gem install knife-server
 ```
 
+(Don't forget a `gem install knife-ec2` if using the `bootstrap ec2`
+subcommand).
+
 Next, you **must** set up a [knife.rb configuration](#installation-knife) so
 that the shipped Knife subcommands know where to place and modify key files,
 backup directories, etc.
@@ -141,23 +174,26 @@ These subcommands will install and configure an Open Source Chef Server on
 several different clouds/environments. The high level step taken are as
 follows:
 
-1. Provision or use a node and install the Chef Server software fronted by
-   an Apache2 instance handling SSL for the API port (TCP/443) and the
-   WebUI web application (TCP/444).
+1. Provision or use a node and install the Chef Server software. If it is a
+   Chef 10 server, configure an Apache2 instance to front the server instance
+   handling SSL for the API port (TCP/443) and the WebUI web application
+   (TCP/444, if enabled).
 2. Fetch the validation key from the server and install it onto the
    workstation issuing the knife subcommand. The validation key will be
    installed at the path defined in the knife `validation_key` variable.
    If a key already exists at that path a backup copy will be made in the
    same directory.
-3. Create an initial admin client key called `root` in the root user's account
+3. Create an initial admin user key called `root` in the root user's account
    on the server which can be used for local administration of the Chef
-   Server.
-4. Create an admin client key with the name defined in the knife
+   Server. If it is a Chef 10 installation, an admin client key will be
+   generated instead.
+4. Create an admin user key with the name defined in the knife
    `node_name` configuration variable and install it onto the workstation
-   issuing the knife subcommand. The client key will be installed at the
+   issuing the knife subcommand. The user key will be installed at the
    path defined in the knife `client_key` configuration variable. If a key
    already exists at that path a backup copy will be made in the same
-   directory.
+   directory. If it is a Chef 10 installation, an admin client key will be
+   generated instead.
 
 **Note** `knife server bootstrap` can not be invoked directly; a subcommand
 must be selected which determines the provisioning strategy.
@@ -178,7 +214,9 @@ The platform type that will be bootstrapped. By convention a bootstrap
 template of `chef-server-#{platform}.erb` will be searched for in the
 template lookup locations (gems, .chef directory, etc.).
 
-The default value is `"debian"` which support Debian and Ubuntu platforms.
+The default value is `"omnibus"` which supports all platforms for which Omnibus
+packages have been created. For more details, visit the [Install
+Chef][install_chef] page and click on *"Chef Server"*.
 
 ##### --ssh-user USER (-x)
 
@@ -194,9 +232,15 @@ The SSH port used when bootstrapping the Chef Server node.
 
 The default value is `"22"`.
 
+##### --[no-]host-key-verify
+
+Verify and cache SSH host key when connecting.
+
+The default value is `true`
+
 ##### --identity-file IDENTITY\_FILE (-i)
 
-The SSH identity file used for authentication.
+The SSH identity file (private SSH key) used for authentication.
 
 ##### --prerelease
 
@@ -204,7 +248,9 @@ Installs a pre-release Chef gem rather than a stable release version.
 
 ##### --bootstrap-version VERSION
 
-The version of Chef to install.
+The version of Chef to install. For Chef 11 installations (the default), you
+can provide the version of Omnibus package you want installed. To install a
+Chef 10 server, set this value to `"10"`.
 
 ##### --template-file TEMPLATE
 
@@ -214,11 +260,18 @@ The full path to location of template to use.
 
 Bootstraps the Chef Server using a particular bootstrap template.
 
-The default is `"chef-server-#{platform}"`.
+The default is `"chef11/#{platform}"`.
+
+##### --[no-]webui-enable
+
+Whether or no the WebUI interface will be installed and enabled.
+
+The default value is `false`.
 
 ##### --webui-password PASSWORD
 
-The initial password for the WebUI admin account.
+The initial password for the WebUI admin account, root user account, and
+workstation user account.
 
 The default value is `"chefchef"`.
 
@@ -230,6 +283,10 @@ The default value is `"chefchef"`.
 
 ### <a name="knife-server-bootstrap-ec2"></a> knife server bootstrap ec2
 
+**Note:** You must install the [knife-ec2 gem][knife-ec2] to use this
+subcommand. This was done to keep the dependencies of this library lighter and
+to make future cloud adapter support easier to add.
+
 Provisions an EC2 instance on the Amazon Web Services (AWS) cloud and sets
 up an Open Source Chef Server as described [above](#knife-server-bootstrap).
 In addition, the following steps are taken initially:
@@ -242,6 +299,16 @@ In addition, the following steps are taken initially:
 
 #### Configuration
 
+This subcommand imports all relavent options from the knife-ec2 gem. For
+detailed documentation relating to these options, please visit the [docs
+page][docs_knife_ec2].
+
+##### --availability-zone ZONE (-Z)
+
+The availability zone for the EC2 instance.
+
+The default value is `"us-east-1b"`.
+
 ##### --aws-access-key-id KEY (-A)
 
 Your AWS access key ID.
@@ -254,16 +321,17 @@ Your AWS API secret access key.
 
 This option is **required**.
 
-##### --region REGION
+##### --ebs-optimized
 
-The desired AWS region, such as `"us-east-1"` or `"us-west-2"`.
+Enabled optimized EBS I/O.
 
-The default value is `"us-east-1"` but is strongly encouraged to be set
-explicitly.
+##### --ebs-size SIZE
 
-##### --ssh-key KEY (-S)
+The size of the EBS volume in GB, for EBS-backed instances.
 
-The AWS SSH key id.
+##### --ebs-no-delete-on-term
+
+Do not delete EBS volumn on instance termination.
 
 ##### --flavor FLAVOR (-f)
 
@@ -271,21 +339,30 @@ The flavor of EC2 instance (m1.small, m1.medium, etc).
 
 The default value is `"m1.small"`.
 
+##### --groups X,Y,Z (-G)
+
+The security groups for this EC2 instance.
+
+The default value is `"infrastructure"`.
+
 ##### --image IMAGE (-I)
 
 The AMI for the EC2 instance.
 
-##### --availability-zone ZONE (-Z)
+##### --region REGION
 
-The availability zone for the EC2 instance.
+The desired AWS region, such as `"us-east-1"` or `"us-west-2"`.
 
-The default value is `"us-east-1b"`.
+The default value is `"us-east-1"` but is strongly encouraged to be set
+explicitly.
 
-##### --groups X,Y,Z (-G)
+##### --subnet SUBNET-ID (-s)
 
-The security groups for this EC2 instance.
+Create node in this Virtual Private Cloud Subnet ID (implies VPC mode).
 
-The default value is `"infrastructure"`.
+##### --ssh-key KEY (-S)
+
+The AWS SSH key id.
 
 ##### --tags T=V\[,T=V,...\] (-T)
 
@@ -296,15 +373,8 @@ The resulting set will include:
 * `"Node=#{config[:chef_node_name]}"`
 * `"Role=chef_server"`
 
-##### --ebs-size SIZE
-
-The size of the EBS volume in GB, for EBS-backed instances.
-
-##### --ebs-no-delete-on-term
-
-Do not delete EBS volumn on instance termination.
-
 ### <a name="knife-server-bootstrap-standalone"></a> knife server bootstrap standalone
+
 Provisions a standalone server that is reachable on the network and sets up
 an Open Source Chef Server as described [above](#knife-server-bootstrap). You
 are responsible for providing the server so it could be a physical machine,
@@ -462,7 +532,9 @@ Apache License, Version 2.0 (see [LICENSE][license])
 [chef_bootstrap_knife_rb]:  https://github.com/fnichol/chef-bootstrap-repo/blob/master/.chef/knife.rb
 [chef_bootstrap_repo]:      https://github.com/fnichol/chef-bootstrap-repo/
 [docs_knife]:               http://docs.opscode.com/config_rb_knife.html
+[docs_knife_ec2]:           http://docs.opscode.com/plugin_knife_ec2.html
 [jtimberman]:               https://github.com/jtimberman
+[install_chef]:             http://www.opscode.com/chef/install/
 [knife-ec2]:                https://github.com/opscode/knife-ec2
 [stevendanna]:              https://github.com/stevendanna
 [vagrant_site]:             http://vagrantup.com/

data/knife-server.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency "fog",       "~> 1.3"
   gem.add_dependency "net-ssh"
   gem.add_dependency "chef",      ">= 0.10.10"
-  gem.add_dependency "knife-ec2", ">= 0.5.12"
+
+  gem.add_development_dependency "knife-ec2", ">= 0.5.12"
 
   gem.add_development_dependency "rspec", "~> 2.10"
   gem.add_development_dependency "fakefs", "~> 0.4.0"

data/lib/chef/knife/bootstrap/_common.sh

@@ -0,0 +1,24 @@
+#
+# Partial: _common.sh
+#
+# Common functions used by the rest of the program.
+#
+
+banner()  { echo "-----> $*" ; }
+info()    { echo "       $*" ; }
+warn()    { echo ">>>>>> $*" >&2 ; }
+
+report_bug() {
+  warn "Please file a bug report at https://github.com/fnichol/knife-server/issues"
+  warn " "
+  warn "Please detail your operating system, version and any other relevant details"
+}
+
+exists() {
+  if command -v $1 &>/dev/null
+  then
+    return 0
+  else
+    return 1
+  fi
+}