knife-ec2 0.12.0 → 0.13.0

data/README.md

@@ -1,101 +1,140 @@
-Knife EC2
-=========
-[![Gem Version](https://badge.fury.io/rb/knife-ec2.svg)](http://badge.fury.io/rb/knife-ec2)
+# Knife EC2
+[![Gem Version](https://badge.fury.io/rb/knife-ec2.svg)](https://rubygems.org/gems/knife-ec2)
 [![Build Status](https://travis-ci.org/chef/knife-ec2.svg?branch=master)](https://travis-ci.org/chef/knife-ec2)
 [![Dependency Status](https://gemnasium.com/chef/knife-ec2.svg)](https://gemnasium.com/chef/knife-ec2)
 
-This is the official Chef Knife plugin for EC2. This plugin gives knife the ability to create, bootstrap, and manage EC2 instances.
+This is the official Chef Knife plugin for Amazon EC2. This plugin gives knife the ability to create, bootstrap, and manage EC2 instances.
+- Documentation: [https://github.com/chef/knife-ec2/blob/master/README.md](https://github.com/chef/knife-ec2/blob/master/README.md)
+- Source: [https://github.com/chef/knife-ec2/tree/master](https://github.com/chef/knife-ec2/tree/master)
+- Issues: [https://github.com/chef/knife-ec2/issues](https://github.com/chef/knife-ec2/issues)
+- IRC: `#chef` and `#chef-hacking` on Freenode
+- Mailing list: [https://discourse.chef.io/](https://discourse.chef.io/)
 
-* Documentation: <http://docs.chef.io/plugin_knife_ec2.html>
-* Source: <http://github.com/chef/knife-ec2/tree/master>
-* Issues: <https://github.com/chef/knife-ec2/issues>
-* IRC: `#chef` and `#chef-hacking` on Freenode
-* Mailing list: <http://lists.chef.io>
-
-Note: Documentation needs to be updated in chef docs
-
-Installation
-------------
-
-If you're using [ChefDK](http://downloads.chef.io/chef-dk/), simply install the
-Gem:
+## Installation
+If you're using [ChefDK](https://downloads.chef.io/chef-dk/), simply install the Gem:
 
 ```bash
-chef gem install knife-ec2
+$ chef gem install knife-ec2
 ```
 
 If you're using bundler, simply add Chef and Knife EC2 to your `Gemfile`:
 
 ```ruby
-gem 'chef'
 gem 'knife-ec2'
 ```
 
-If you are not using bundler, you can install the gem manually. Be sure you are running Chef 0.10.10 or higher, as earlier versions do not support plugins.
-
-    $ gem install chef
+If you are not using bundler, you can install the gem manually from Rubygems:
 
-This plugin is distributed as a Ruby Gem. To install it, run:
-
-    $ gem install knife-ec2
+```bash
+$ gem install knife-ec2
+```
 
 Depending on your system's configuration, you may need to run this command with root privileges.
 
+## Configuration
+In order to communicate with the Amazon's EC2 API you will need to pass Knife your AWS Access Key, Secret Access Key, and if using STS your session token. This can be done in several ways:
 
-Configuration
--------------
-In order to communicate with the Amazon's EC2 API you will have to tell Knife about your AWS Access Key and Secret Access Key. The easiest way to accomplish this is to create some entries in your `knife.rb` file:
+### Knife.rb Configuration
+The easiest way to configure your Amazon EC2 credentials for knife-ec2 is to specify them in your your `knife.rb` file:
 
 ```ruby
 knife[:aws_access_key_id] = "Your AWS Access Key ID"
 knife[:aws_secret_access_key] = "Your AWS Secret Access Key"
 ```
 
-If your `knife.rb` file will be checked into a SCM system (ie readable by others) you may want to read the values from environment variables:
+Additionally if using AWS STS:
+
+```ruby
+knife[:aws_session_token] = "Your AWS Session Token"
+```
+
+Note: If your `knife.rb` file will be checked into a source control management system, or is otherwise accessible by others, you may want to use one of the other configuration methods to avoid exposing your credentials.
+
+### Environmental Variables
+Knife-ec2 can also read your credentials from shell environmental variables. Export `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_SESSION_TOKEN` variables in your shell then add the following configuration to your `knife.rb` file:
 
 ```ruby
 knife[:aws_access_key_id] = ENV['AWS_ACCESS_KEY_ID']
 knife[:aws_secret_access_key] = ENV['AWS_SECRET_ACCESS_KEY']
-# Optional if you're using Amazon's STS
+```
+
+Additionally if using AWS STS:
+
+```ruby
 knife[:aws_session_token] = ENV['AWS_SESSION_TOKEN']
 ```
 
-You also have the option of passing your AWS API Key/Secret into the individual knife subcommands using the `-A` (or `--aws-access-key-id`) `-K` (or `--aws-secret-access-key`) command options
+### CLI Arguments
+You also have the option of passing your AWS API Key/Secret into the individual knife subcommands using the `--aws-access-key-id` and `--aws-secret-access-key` command options
+
+Example of provisioning a new t2.micro Ubuntu 14.04 webserver:
 
 ```bash
-# provision a new m1.small Ubuntu 10.04 webserver
-$ knife ec2 server create -r 'role[webserver]' -I ami-7000f019 -f m1.small -A 'Your AWS Access Key ID' -K "Your AWS Secret Access Key"
+$ knife ec2 server create -r 'role[webserver]' -I ami-cd0fd6be -f t2.micro --aws-access-key-id 'Your AWS Access Key ID' --aws-secret-access-key "Your AWS Secret Access Key"
+```
+
+### AWS Credential File
+Amazon's newer credential config file format is also supported by knife:
+
+```
+[default]
+aws_access_key_id = Your AWS Access Key ID
+aws_secret_access_key = Your AWS Secret Access Key
+```
+
+In this case, you can point the `aws_credential_file` option to this file in your `knife.rb` file, like so:
+
+```ruby
+knife[:aws_credential_file] = "/path/to/credentials/file"
+```
+Since the Knife config file is just Ruby you can also avoid hardcoding your home directory, which creates a configuration that can be used for any user:
+
+```ruby
+knife[:aws_credential_file] = File.join(ENV['HOME'], "/.aws/credentials")
 ```
 
-If you are working with Amazon's command line tools, there is a good chance
-you already have a file with these keys somewhere in this format:
 
-    AWSAccessKeyId=Your AWS Access Key ID
-    AWSSecretKey=Your AWS Secret Access Key
+If you have multiple profiles in your credentials file you can define which profile to use. The `default` profile will be used if not supplied,
 
+```ruby
+knife[:aws_profile] = "personal"
+```
 
-The new config file format used by Amazon's command line tools is also supported:
+### AWS Configuration File
+Amazon's newer configuration file format is also supported by knife:
 
-    [default]
-    aws_access_key_id = Your AWS Access Key ID
-    aws_secret_access_key = Your AWS Secret Access Key
+```
+[default]
+region = "specify_any_supported_region"
+```
 
-In this case, you can point the <tt>aws_credential_file</tt> option to
-this file in your <tt>knife.rb</tt> file, like so:
+In this case you can point the `aws_config_file` option to this file in your `knife.rb` file, like so:
 
 ```ruby
-knife[:aws_credential_file] = "/path/to/credentials/file/in/above/format"
+knife[:aws_config_file] = "/path/to/configuration/file"
+```
+Since the Knife config is just Ruby you can also avoid hardcoding your name directory, which creates a config that can be used for any user:
+
+```ruby
+knife[:aws_config_file] = File.join(ENV['HOME'], "/.aws/configuration")
 ```
 
-If you have multiple profiles in your credentials file you can define which
-profile to use. The `default` profile will be used if not supplied,
+
+If you have multiple profiles in your configuration file you can define which profile to use. The `default` profile will be used if not supplied,
 
 ```ruby
 knife[:aws_profile] = "personal"
 ```
 
-Additionally the following options may be set in your `knife.rb`:
+In this case configuration file format is:
+```
+[profile personal]
+region = "specify_any_supported_region"
+```
+
 
+## Additional knife.rb Configuration Options
+The following configuration options may be set in your `knife.rb`:
 - flavor
 - image
 - availability_zone
@@ -105,9 +144,8 @@ Additionally the following options may be set in your `knife.rb`:
 - distro
 - template_file
 
-Using Cloud-Based Secret Data
------------------------------
-knife-ec2 now includes the ability to retrieve the encrypted data bag secret and validation keys directly from a cloud-based assets store (currently on S3 is supported). To enable this functionality, you must first upload keys to S3 and give them appropriate permissions. The following is a suggested set of IAM permissions required to make this work:
+## Using Cloud-Based Secret Data
+knife-ec2 now includes the ability to retrieve the encrypted data bag secret and validation keys directly from a cloud-based assets store (currently only S3 is supported). To enable this functionality, you must first upload keys to S3 and give them appropriate permissions. The following is a suggested set of IAM permissions required to make this work:
 
 ```json
 {
@@ -119,7 +157,7 @@ knife-ec2 now includes the ability to retrieve the encrypted data bag secret and
         "s3:List*"
       ],
       "Resource": [
-        "arn:aws:s3:::provisioning.bucket.com/chef/*"
+        "arn:aws:s3:::example.com/chef/*"
       ]
     }
   ]
@@ -127,63 +165,80 @@ knife-ec2 now includes the ability to retrieve the encrypted data bag secret and
 ```
 
 ### Supported URL format
-- `http` or `https` based: 'http://provisioning.bucket.com/chef/my-validator.pem'
+- `http` or `https` based: 'http://example.com/chef/my-validator.pem'
 - `s3` based:  's3://chef/my-validator.pem'
 
 ### Use the following configuration options in `knife.rb` to set the source URLs:
+
 ```ruby
-knife[:validation_key_url] = 'http://provisioning.bucket.com/chef/my-validator.pem'
-knife[:s3_secret] = 'http://provisioning.bucket.com/chef/encrypted_data_bag_secret'
+knife[:validation_key_url] = 'http://example.com/chef/my-validator.pem'
+knife[:s3_secret] = 'http://example.com/chef/encrypted_data_bag_secret'
 ```
 
 ### Alternatively, URLs can be passed directly on the command line:
 - Validation Key: `--validation-key-url s3://chef/my-validator.pem`
 - Encrypted Data Bag Secret: `--s3-secret s3://chef/encrypted_data_bag_secret`
 
-Subcommands
------------
+## knife-ec2 Subcommands
 This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a `--help` flag
 
+### `knife ec2 server create`
+Provisions a new server in the Amazon EC2 and then perform a Chef bootstrap (using the SSH or WinRM protocols). 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 (provided by the provisioning). It is primarily intended for Chef Client systems that talk to a Chef server.  The examples below create Linux and Windows instances:
+
+```
+# Create some instances -- knife configuration contains the AWS credentials
 
-#### `knife ec2 server create`
-Provisions a new server in the Amazon EC2 and then perform a Chef bootstrap
-(using the SSH or WinRM protocols). 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 (provided by the provisioning). It is primarily intended for Chef Client systems that talk to a Chef server.  The examples below create Linux and Windows instances:
+# A Linux instance via ssh
+knife ec2 server create -I ami-d0f89fb9 --ssh-key your-public-key-id -f m1.medium --ssh-user ubuntu --identity-file ~/.ssh/your-private-key
+
+# A Windows instance via the WinRM protocol -- --ssh-key is still required due to EC2 API operations that need it to grant access to the Windows instance
+# `--spot-price` option lets you specify the spot pricing
+knife ec2 server create -I ami-173d747e -G windows -f m1.medium --user-data ~/your-user-data-file -x '.\a_local_user' -P 'yourpassword' --ssh-key your-public-key-id --spot-price price-in-USD
+
+# Pass --server-connect-attribute to specify the instance attribute that we will try to connect to via ssh/winrm
+# Possible values of --server-connect-attribute: private_dns_name, private_ip_address, dns_name, public_ip_address
+# If --server-connect-attribute is not specified, knife attempts to determine if connecting to the instance's public or private IP is most appropriate based on other settings
+knife ec2 server create -I ami-173d747e -x ubuntu --server-connect-attribute public_ip_address
+```
 
-    # Create some instances -- knife configuration contains the AWS credentials
+View additional information on configuring Windows images for bootstrap in the documentation for [knife-windows](https://docs.chef.io/plugin_knife_windows.html).
 
-    # A Linux instance via ssh
-    knife ec2 server create -I ami-d0f89fb9 --ssh-key your-public-key-id -f m1.medium --ssh-user ubuntu --identity-file ~/.ssh/your-private-key
 
-    # A Windows instance via the WinRM protocol -- --ssh-key is still required due to EC2 API operations that need it to grant access to the Windows instance
-    # `--spot-price` option lets you specify the spot pricing
-    knife ec2 server create -I ami-173d747e -G windows -f m1.medium --user-data ~/your-user-data-file -x '.\a_local_user' -P 'yourpassword' --ssh-key your-public-key-id --spot-price price-in-USD
+#### Bootstrap Windows (2012 R2 and above platform) instance without user-data through winrm ssl transport
 
-View additional information on configuring Windows images for bootstrap in the documentation for [knife-windows](http://docs.chef.io/plugin_knife_windows.html).
+Users can bootstrap the Windows instance without the need to provide the user-data. `knife-ec2` has the ability to bootstrap the Windows instance through `winrm protocol` using the `ssl` transport. This requires users to set `--winrm-transport` option as `ssl` and `--winrm-ssl-verify-mode` option as `verify_none`. This will do the necessary winrm ssl transport configurations on the target node and the bootstrap will just work.
 
-##### Options for bootstrapping Windows
+***Note***: Users also need to pass the `--security-group-ids` option with IDs of the security group(s) having the required ports opened like `5986` for winrm ssl transport. In case if `--security-group-ids` option is not passed then make sure that the default security group in your account has the required ports opened.
 
-The `knife ec2 server create` command also supports the following
-options for bootstrapping a Windows node after the VM s created:
+Below is the sample command to create a Windows instance and bootstrap it through `ssl` transport without passing any user-data:
 
-    :winrm_password                The WinRM password
-    :winrm_authentication_protocol Defaults to negotiate, supports kerberos, can be set to basic for debugging
-    :winrm_transport               Defaults to plaintext, use ssl for improved privacy
-    :winrm_port                    Defaults to 5985 plaintext transport, or 5986 for SSL
-    :ca_trust_file                 The CA certificate file to use to verify the server when using SSL
-    :winrm_ssl_verify_mode         Defaults to verify_peer, use verify_none to skip validation of the server certificate during testing
-    :kerberos_keytab_file          The Kerberos keytab file used for authentication
-    :kerberos_realm                The Kerberos realm used for authentication
-    :kerberos_service              The Kerberos service used for authentication
+```
+knife ec2 server create -N chef-node-name -I your-windows-image -f flavor-of-server -x '.\a_local_user' -P 'yourpassword' --ssh-key your-public-key-id --winrm-transport ssl --winrm-ssl-verify-mode verify_none --security-group-ids your-security-groups -VV
+```
+
+#### Options for bootstrapping Windows
+The `knife ec2 server create` command also supports the following options for bootstrapping a Windows node after the VM s created:
+
+```
+:winrm_password                The WinRM password
+:winrm_authentication_protocol Defaults to negotiate, supports kerberos, can be set to basic for debugging
+:winrm_transport               Defaults to plaintext, use ssl for improved security
+:winrm_port                    Defaults to 5985 plaintext transport, or 5986 for SSL
+:ca_trust_file                 The CA certificate file to use to verify the server when using SSL
+:winrm_ssl_verify_mode         Defaults to verify_peer, use verify_none to skip validation of the server certificate during testing
+:kerberos_keytab_file          The Kerberos keytab file used for authentication
+:kerberos_realm                The Kerberos realm used for authentication
+:kerberos_service              The Kerberos service used for authentication
+```
 
-#### `knife ec2 server delete`
+### `knife ec2 server delete`
 Deletes an existing server in the currently configured AWS account. **By default, this does not delete the associated node and client objects from the Chef server. To do so, add the `--purge` flag**
 
-#### `knife ec2 server list`
+### `knife ec2 server list`
 Outputs a list of all servers in the currently configured AWS account. **Note, this shows all instances associated with the account, some of which may not be currently managed by the Chef server.**
 
-License and Authors
--------------------
-- Author:: Adam Jacob (<adam@chef.io>)
+## License and Authors
+- Author:: Adam Jacob ([adam@chef.io](mailto:adam@chef.io))
 
 ```text
 Copyright 2009-2015 Chef Software, Inc.

data/RELEASE_NOTES.md

@@ -6,47 +6,31 @@ Example Note:
 ## Example Heading
 Details about the thing that changed that needs to get included in the Release Notes in markdown.
 -->
-# knife-ec2 0.12.0 release notes:
+# knife-ec2 0.13.0 release notes:
 
-This release of `knife-ec2` adds features like spot pricing, EBS volume encryption support and some bug fixes. There is also a dependency update for the `fog` gem and 'em-winrm' dependency is removed.
+This release of `knife-ec2` adds feature to bootstrap Windows instances over SSL without the need for users to provide the `user-data`. Also, it adds support for users to pass `AWS config file` option on the `CLI` containing the `AWS configurations` to read the config like `region` information.
 
-## Compatibility note for Windows nodes: `--winrm-authentication-protocol basic`
-In this version of `knife-ec2`, the default authentication protocol
-for Windows nodes is now `negotiate`for the `server create` subcommand. This can
-cause bootstraps to fail if the remote Windows node is not configured
-for `negotiate`. To work around this and retain the behavior of
-previous releases, you can specify use `basic` authentication in your
-`knife` configuration file or on the command line  as in
-this example:
+***Note:*** The bootstrap (over SSL without the `user-data`) feature for Windows is available only for Windows 2012 R2 and above platform.
 
-        knife ec2 server create -I ami-173d747e -G windows -f m1.medium --user-data ~/your-user-data-file -x 'a_local_user' -P 'yourpassword' --ssh-key your-public-key-id --winrm-authentication-protocol basic
 
-## Acknowledgements
-Our thanks go to contributor **Peer Allan** for adding
-[knife-ec2:#305](https://github.com/chef/knife-ec2/pull/305). This
-enables the use of standard AWS credential configuration from `~/.aws/credentials`.
-
-## Release information
-
-See the [CHANGELOG](https://github.com/chef/knife-ec2/blob/0.12.0/CHANGELOG.md) for a list of all changes in this release, and review
-[DOC_CHANGES.md](https://github.com/chef/knife-ec2/blob/0.12.0/DOC_CHANGES.md) for relevant documentation updates.
+## Features added in knife-ec2 0.13.0
 
-Issues with `knife-ec2` should be reported in the issue system at
-https://github.com/opscode/knife-ec2/issues. Learn more about how you can
-contribute features and bug fixes to `knife-ec2` at https://github.com/opscode/knife-ec2/blob/master/CONTRIBUTING.md.
+* `--[no-]create-ssl-listener` option to add `ssl listener` on Windows instance to bootstrap the instance through `winrm ssl transport` without the need for users to pass the `user-data`. Default value of this option is `true`.
+* Support for `~/.aws/config` file for reading aws configurations. Use `--aws-config-file` option for the same.
+* Support to read `aws_session_token` from `~/.aws/credentials` file.
+* Support for `ec2 classic link`, options are `--classic-link-vpc-id` and `--classic-link-vpc-security-groups-ids`.
+* Support for `m4`, `d2`, `t2` and `g2` ebs encryption flavors.
+* Use `--format json` option to list the `ec2 servers` in the json format. Default output format is `summary` though.
+* Use `--attach-network-interface` option to attach additional `network interfaces` to the instance.
+* Added `--disable-api-termination` option to allow users to disable the termination of the instance using the Amazon EC2 console, CLI and API. However, this option won't work for `spot instances` as `termination protection` cannot be enabled for `spot instances`.
+* Added `--spot-wait-mode` option to enable users to give their decision on CLI whether to `wait` for the `spot request fulfillment` or to `exit` before the `spot request fulfillment`. Default value for this option is `prompt` which will prompt the user to give their choice.
 
-## Features added in knife-ec2 0.12.0
-
-* Support for `~/.aws/credentials` credential configuration (Peer Allan)
-* Validatorless bootstrap for Windows nodes
-* --forward-agent ssh agent forwarding support
-* `--msi-url`, `--install-as-service`, `--bootstrap-install-command`
-  for Windows nodes
+## Acknowledgements
 
-## knife-ec2 on RubyGems and Github
-https://rubygems.org/gems/knife-ec2
-https://github.com/opscode/knife-ec2
+Our thanks go to contributor **Quentin de Metz** for adding
+[knife-ec2:#322](https://github.com/chef/knife-ec2/pull/322). This
+enables the support for `Classic Link` in the `knife ec2 server create` command.
 
-## Issues fixed in knife-ec2 0.11.0
-See the [0.12.0 CHANGELOG](https://github.com/chef/knife-ec2/blob/0.12.0/CHANGELOG.md)
-for the complete list of issues fixed in this release.
+Our thanks go to contributor **Eric Herot** for adding
+[knife-ec2:#375](https://github.com/chef/knife-ec2/pull/375). This
+enables the users to add additional `Network Interfaces` to the instance before the bootstrap process.

data/Rakefile

@@ -1,56 +1,56 @@
-#
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Author:: Daniel DeLeo (<dan@opscode.com>)
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Copyright:: Copyright (c) 2008, 2010 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.
-#
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-# require 'rubygems'
-# require 'rake/gempackagetask'
-require 'rdoc/task'
-
-begin
-  require 'sdoc'
-  require 'rdoc/task'
-
-  RDoc::Task.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.'
-end
-
-begin
-  require 'rspec/core/rake_task'
-
-  task :default => :spec
-
-  desc 'Run all specs in spec directory'
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.pattern = 'spec/unit/**/*_spec.rb'
-  end
-
-rescue LoadError
-  STDERR.puts "\n*** RSpec not available. (sudo) gem install rspec to run unit tests. ***\n\n"
-end
+#
+# Author:: Adam Jacob (<adam@chef.io>)
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+# Copyright:: Copyright (c) 2008-2015 Chef Software, 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.
+#
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# require 'rubygems'
+# require 'rake/gempackagetask'
+require 'rdoc/task'
+
+begin
+  require 'sdoc'
+  require 'rdoc/task'
+
+  RDoc::Task.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.'
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  task :default => :spec
+
+  desc 'Run all specs in spec directory'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+
+rescue LoadError
+  STDERR.puts "\n*** RSpec not available. (sudo) gem install rspec to run unit tests. ***\n\n"
+end