knife-ec2 0.18.2 → 0.19.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a82e2799872d734ac239029be1fdbac5babaffb9a87a961d9c6e27ee999fa31
-  data.tar.gz: f455dfad31d7b24e83d211b7da5eaa73c2dde85011291f54b4bf769d5e08585d
+  metadata.gz: 210fda04e631953dc8b84274ed591ecac3e227d8d2580b945e67c839c3d74933
+  data.tar.gz: 3d3823d890a88338bd47b26e117429a84fdd3a96573f568a96bf04a19585d62d
 SHA512:
-  metadata.gz: b76e7859c0e5dce52658d9762edd269a3b3b6ef4fc6f35f38f19f91529c493430702d2fc87a3de2015a266d7334915b2747959232e148804c8e4a096e23086aa
-  data.tar.gz: 53d04b84f41c0e02fcf03e671eacbbb2e0505bfee68374fe037c2883e2e1fec35e838ac0ef1def79ce27b7a1021f15bf2f7afc37119c665814b681645ba0d65e
+  metadata.gz: 60e078f29f93de0ac1a3646b0a1753dacb8e0f354a7305d0019fe3a123d4151bc3b20b1ee21e297d4d5c19e353fdd3838d715391a23b1a08d3202c329f79d220
+  data.tar.gz: 52e6175ceb27c8d1e6edc080ee534d1dd6027d47d4c47ef1a92703116b502fd3700f16f4dbf96d5368df7ab7384af1d246404142558bb997e93cd94126f5f6d9

data/.expeditor/config.yml

@@ -1,41 +1,38 @@
-# Documentation available at http://expeditor.es.chef.io
-
+# Documentation available at https://expeditor.chef.io/docs/getting-started/
+---
 # Slack channel in Chef Software slack to send notifications about build failures, etc
 slack:
   notify_channel: sustaining-notify
 
+# This publish is triggered by the `built_in:publish_rubygems` artifact_action.
 rubygems:
   - knife-ec2
 
 github:
+  # This deletes the GitHub PR branch after successfully merged into the release branch
+  delete_branch_on_merge: true
   # The tag format to use (e.g. v1.0.0)
   version_tag_format: "v{{version}}"
-  delete_branch_on_merge: true
-  # Which Github branches to build gems from, and what versions
-  # (as determined by the value in the VERSION file) those branches are responsible
-  # for building.
-  release_branch:
-    - master:
-        version_constraint: 0.*
-
-promote:
-  action:
-    - built_in:publish_rubygems
-    - built_in:rollover_changelog
+  # allow bumping the minor release via label
+  minor_bump_labels:
+    - "Expeditor: Bump Minor Version"
 
 # These actions are taken, in order they are specified, anytime a Pull Request is merged.
 merge_actions:
   - built_in:bump_version:
       ignore_labels:
-        - "Version: Skip Bump"
         - "Expeditor: Skip Version Bump"
         - "Expeditor: Skip All"
   - bash:.expeditor/update_version.sh:
       only_if: built_in:bump_version
   - built_in:update_changelog:
       ignore_labels:
-        - "Meta: Exclude From Changelog"
         - "Expeditor: Exclude From Changelog"
         - "Expeditor: Skip All"
   - built_in:build_gem:
       only_if: built_in:bump_version
+
+promote:
+  actions:
+    - built_in:rollover_changelog
+    - built_in:publish_rubygems

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Order is important. The last matching pattern has the most precedence.
+
+*               @chef/msys-developers
+.expeditor/**   @chef/jex-team

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Description
+
+[Please describe what this change achieves]
+
+### Issues Resolved
+
+[List any existing issues this PR resolves, or any Discourse or
+StackOverflow discussion that's relevant]
+
+### Check List
+
+- [ ] New functionality includes tests
+- [ ] All tests pass
+- [ ] All commits have been signed-off for the Developer Certificate of Origin. See <https://github.com/chef/chef/blob/master/CONTRIBUTING.md#developer-certification-of-origin-dco>

data/.gitignore

@@ -35,7 +35,6 @@ Icon?
 
 Gemfile.lock
 Guardfile
-.rspec
 
 .rvmrc
 .rbenv-gemsets

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-fd

data/.rubocop.yml

@@ -0,0 +1,30 @@
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/chef/knife/ec2_server_create.rb'
+
+Lint/EmptyWhen:
+  Exclude:
+    - 'lib/chef/knife/ec2_server_create.rb'
+
+Lint/ParenthesesAsGroupedExpression:
+  Exclude:
+    - 'lib/chef/knife/ec2_base.rb'
+    - 'lib/chef/knife/ec2_server_create.rb'
+    - 'spec/unit/ec2_ami_list_spec.rb'
+    - 'spec/unit/ec2_server_create_spec.rb'
+
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - 'lib/chef/knife/ec2_server_create.rb'
+    - 'lib/chef/knife/ec2_server_delete.rb'
+
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/chef/knife/ec2_base.rb'
+    - 'lib/chef/knife/ec2_server_list.rb'
+    - 'spec/unit/ec2_ami_list_spec.rb'
+
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/chef/knife/ec2_server_create.rb'

data/.travis.yml

@@ -1,27 +1,20 @@
+sudo: false
 language: ruby
 cache: bundler
-dist: trusty
-sudo: false
 
-# Early warning system to catch if Rubygems breaks something
-before_install:
-  - gem update --system
-  - gem uninstall bundler -a -x
-  - gem install bundler
-  - rm -f .bundle/config
-
-rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-  - ruby-head
-  
 matrix:
+  include:
+    - rvm: 2.3.7
+    - rvm: 2.4.4
+    - rvm: 2.5.1
+    - rvm: ruby-head
   allow_failures:
     - rvm: ruby-head
 
-script: bundle exec rake spec
-
 branches:
   only:
   - master
+
+bundler_args: --without docs development
+
+script: bundle exec rake

data/CHANGELOG.md

@@ -4,24 +4,46 @@ Note: this log contains only changes from knife-ec2 release 0.8.0 and later
 -- it does not contain the changes from prior releases. To view change history
 prior to release 0.8.0, please visit the [source repository](https://github.com/chef/knife-ec2/commits).
 
-<!-- latest_release 0.18.2 -->
-## [v0.18.2](https://github.com/chef/knife-ec2/tree/v0.18.2) (2018-07-05)
+<!-- latest_release 0.19.10 -->
+## [v0.19.10](https://github.com/chef/knife-ec2/tree/v0.19.10) (2018-08-06)
 
 #### Merged Pull Requests
-- MSYS-798 - Fixes for windows administrator password [#524](https://github.com/chef/knife-ec2/pull/524) ([dheerajd-msys](https://github.com/dheerajd-msys))
+- If no keys specified on CLI/config use an AWS credential file if present [#548](https://github.com/chef/knife-ec2/pull/548) ([tas50](https://github.com/tas50))
 <!-- latest_release -->
 
-<!-- release_rollup since=0.18.0 -->
-### Changes since 0.18.0 release
+<!-- release_rollup since=0.18.2 -->
+### Changes since 0.18.2 release
 
 #### Merged Pull Requests
-- MSYS-798 - Fixes for windows administrator password [#524](https://github.com/chef/knife-ec2/pull/524) ([dheerajd-msys](https://github.com/dheerajd-msys)) <!-- 0.18.2 -->
-- [MSYS-824] fix breaking tag changes &amp; deprecation warning [#527](https://github.com/chef/knife-ec2/pull/527) ([dheerajd-msys](https://github.com/dheerajd-msys)) <!-- 0.18.1 -->
+- If no keys specified on CLI/config use an AWS credential file if present [#548](https://github.com/chef/knife-ec2/pull/548) ([tas50](https://github.com/tas50)) <!-- 0.19.10 -->
+- Remove executables from gemspec and cleanup test files [#549](https://github.com/chef/knife-ec2/pull/549) ([tas50](https://github.com/tas50)) <!-- 0.19.9 -->
+- Remove mime-types dependency [#550](https://github.com/chef/knife-ec2/pull/550) ([tas50](https://github.com/tas50)) <!-- 0.19.8 -->
+- Remove readline dep which we&#39;re not using [#547](https://github.com/chef/knife-ec2/pull/547) ([tas50](https://github.com/tas50)) <!-- 0.19.7 -->
+- Removed deprecated options distro and template_file flags in server create command [#542](https://github.com/chef/knife-ec2/pull/542) ([tas50](https://github.com/tas50)) <!-- 0.19.6 -->
+- Provide a unique console color for us-east-1f availability zone [#541](https://github.com/chef/knife-ec2/pull/541) ([tas50](https://github.com/tas50)) <!-- 0.19.5 -->
+- Improve the AMI missing error and improve the readme example [#543](https://github.com/chef/knife-ec2/pull/543) ([tas50](https://github.com/tas50)) <!-- 0.19.4 -->
+- Lazy load deps and avoid double loading [#544](https://github.com/chef/knife-ec2/pull/544) ([tas50](https://github.com/tas50)) <!-- 0.19.3 -->
+- Allow for fog-aws 1.0 - 3.0 dep to bring in bugfixes and new region support [#545](https://github.com/chef/knife-ec2/pull/545) ([tas50]
+- Clarify which AWS CLI tools we&#39;re talking about [#540](https://github.com/chef/knife-ec2/pull/540) ([tas50](https://github.com/tas50)) <!-- 0.19.2 -->
+- Fix knife ami list --group flag description [#539](https://github.com/chef/knife-ec2/pull/539) ([tas50](https://github.com/tas50)) <!-- 0.19.1 -->
+- Rewrite the credentials section of the readme with new recommendations [#538](https://github.com/chef/knife-ec2/pull/538) ([tas50](https://github.com/tas50)) <!-- 0.19.0 -->
+- Update installation instructions in the readme to push ChefDK [#537](https://github.com/chef/knife-ec2/pull/537) ([tas50](https://github.com/tas50)) <!-- 0.18.7 -->
+- Add codeowners and PR template files [#533](https://github.com/chef/knife-ec2/pull/533) ([tas50](https://github.com/tas50)) <!-- 0.18.6 -->
+- Move contributing docs out of the repo [#535](https://github.com/chef/knife-ec2/pull/535) ([tas50](https://github.com/tas50)) <!-- 0.18.5 -->
+- Bump copyrights &amp; minor readme updates [#532](https://github.com/chef/knife-ec2/pull/532) ([tas50](https://github.com/tas50)) <!-- 0.18.4 -->
+- Drop Ruby 2.2 + Add Chefstyle + align testing with other projects [#530](https://github.com/chef/knife-ec2/pull/530) ([tas50](https://github.com/tas50)) <!-- 0.18.3 -->
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
+## [v0.18.2](https://github.com/chef/knife-ec2/tree/v0.18.2) (2018-07-06)
+
+#### Merged Pull Requests
+- [MSYS-824] fix breaking tag changes &amp; deprecation warning [#527](https://github.com/chef/knife-ec2/pull/527) ([dheerajd-msys](https://github.com/dheerajd-msys))
+- MSYS-798 - Fixes for windows administrator password [#524](https://github.com/chef/knife-ec2/pull/524) ([dheerajd-msys](https://github.com/dheerajd-msys))
 <!-- latest_stable_release -->
 
+
+
 ## Latest Release 0.18.0 (2018-04-05)
 * [knife-ec2:#520](https://github.com/chef/knife-ec2/pull/520) Options `--aws-tag` and `--chef-tag` are added for tagging EC2 instance in AWS and Chef separately.
 

data/DOC_CHANGES.md

@@ -1,17 +1,7 @@
 <!---
-This file is reset everytime when a new release is done. Contents of this file is for the currently unreleased version.
+This file is reset every time when a new release is done. Contents of this file is for the currently unreleased version.
 -->
 
 # knife-ec2 doc changes
 
-Documentation changes are given below for **knife-ec2 version 0.18.0**.
-
-## `knife ec2 server create` subcommand changes
-
-### `--aws-tag` option
-
-The `--aws-tag` option is used for tagging the EC2 instances in AWS as `key=value` pair. Use this option like e.g. `--aws-tag <key1=value1>`. Multiple tags can be added by specifying the option multiple times.
-
-### `--chef-tag` option
-
-The `--chef-tag` option is used for tagging the EC2 instances on the Chef server. Use this option like e.g. `--chef-tag <myTag>`. Multiple tags can be added by specifying the option multiple times.
+## 0.19.0

data/Gemfile

@@ -1,4 +1,28 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
 gemspec
 
-gem 'rb-readline', '>= 0.5.5'
+group :docs do
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
+end
+
+group :test do
+  gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master"
+  gem "rspec", "~> 3.0"
+  gem "rake"
+  gem "chef", ">= 13.0"
+end
+
+group :development do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+end
+
+instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
+
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/README.md

@@ -1,21 +1,16 @@
 # 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 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/)
 
 ## Installation
-If you're using [ChefDK](https://downloads.chef.io/chef-dk/), simply install the Gem:
 
-```bash
-$ chef gem install knife-ec2
-```
+We highly recommend using [ChefDK](https://downloads.chef.io/chef-dk/), which includes knife-ec2 out of the box. If for some reason you can't use ChefDK you can manually install the gem.
 
 If you're using bundler, simply add Chef and Knife EC2 to your `Gemfile`:
 
@@ -32,67 +27,36 @@ $ 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:
-
-### 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"
-```
-
-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']
-```
 
-Additionally if using AWS STS:
+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. The knife-ec2 plugin supports multiple methods for configuring these credentials including:
+  - AWS configuration / credential files (preferred method)
+  - knife.rb / config.rb configuration files
+  - environmental variables
+  - command line arguments
 
-```ruby
-knife[:aws_session_token] = ENV['AWS_SESSION_TOKEN']
-```
+### AWS Configuration / Credential Files
 
-### 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
+The preferred method of storing credentials for AWS is to use Amazon's own credential and configuration files. The files allow for multiple "profiles", each with their own set of credentials. Also since these credentials aren't stored in your knife.rb/config.rb files you don't have to worry about accidentally checking credentials into a git repository. The configs can be created by hand or generated automatically by running `aws configure` if the AWS Command Line Interface (awscli) is installed.
 
-Example of provisioning a new t2.micro Ubuntu 14.04 webserver:
 
-```bash
-$ 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"
-```
+See Amazon's [Configuration and Credentials Files](https://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html) documentation for additional information on the file format and default locations for Linux/Mac & Windows hosts.
 
-### AWS Credential File
-Amazon's newer credential config file format is also supported by knife:
+#### Alternative Config Files Location
 
-```
-[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:
+If you're not storing the files in their default directory you'll need to specify the location in your `knife.rb`/`config.rb` files:
 
 ```ruby
 knife[:aws_credential_file] = "/path/to/credentials/file"
+knife[:aws_config_file] = "/path/to/configuration/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")
+knife[:aws_config_file] = File.join(ENV['HOME'], "/path/to/configuration/file")
 ```
 
+#### Specifying the AWS Profile
 
 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,
 
@@ -100,40 +64,52 @@ If you have multiple profiles in your credentials file you can define which prof
 knife[:aws_profile] = "personal"
 ```
 
-### AWS Configuration File
-Amazon's newer configuration file format is also supported by knife:
-
-```
-[default]
-region = "specify_any_supported_region"
-```
+### Config.rb / Knife.rb Configuration
 
-In this case you can point the `aws_config_file` option to this file in your `knife.rb` file, like so:
+If you prefer to keep all of your configuration in a single location with Chef you can store your Amazon EC2 credentials in Chef's `knife.rb` or `config.rb` files:
 
 ```ruby
-knife[:aws_config_file] = "/path/to/configuration/file"
+knife[:aws_access_key_id] = "Your AWS Access Key ID"
+knife[:aws_secret_access_key] = "Your AWS Secret Access Key"
 ```
-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:
+
+Additionally if using AWS STS:
 
 ```ruby
-knife[:aws_config_file] = File.join(ENV['HOME'], "/.aws/configuration")
+knife[:aws_session_token] = "Your AWS Session Token"
 ```
 
+Note: If your `knife.rb` or `config.rb` files will be checked into a source control management system, or are otherwise accessible by others, you may want to use one of the other configuration methods to avoid exposing your credentials.
+
+### Environmental Variables
 
-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,
+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_profile] = "personal"
+knife[:aws_access_key_id] = ENV['AWS_ACCESS_KEY_ID']
+knife[:aws_secret_access_key] = ENV['AWS_SECRET_ACCESS_KEY']
 ```
 
-In this case configuration file format is:
+Additionally if using AWS STS:
+
+```ruby
+knife[:aws_session_token] = ENV['AWS_SESSION_TOKEN']
 ```
-[profile personal]
-region = "specify_any_supported_region"
+
+### 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 16.04 webserver:
+
+```bash
+$ knife ec2 server create -r 'role[webserver]' -I ami-5e8bb23b -f t2.micro --aws-access-key-id 'Your AWS Access Key ID' --aws-secret-access-key "Your AWS Secret Access Key" -ssh-key my_key_name --region us-west-2
 ```
 
+Note: Passing credentials via the command line exposes the credentials in your shell's history and should be avoided unless absolutely necessary.
+
+## Additional config.rb & knife.rb Configuration Options
 
-## Additional knife.rb Configuration Options
 The following configuration options may be set in your `knife.rb`:
 - flavor
 - image
@@ -141,10 +117,9 @@ The following configuration options may be set in your `knife.rb`:
 - ssh_key_name
 - aws_session_token
 - region
-- 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 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
@@ -165,6 +140,7 @@ knife-ec2 now includes the ability to retrieve the encrypted data bag secret and
 ```
 
 ### Supported URL format
+
 - `http` or `https` based: 'http://example.com/chef/my-validator.pem'
 - `s3` based:  's3://chef/my-validator.pem'
 
@@ -176,16 +152,19 @@ 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`
 
 ## 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:
 
-```
+```bash
 # Create some instances -- knife configuration contains the AWS credentials
 
 # A Linux instance via ssh
@@ -205,7 +184,7 @@ View additional information on configuring Windows images for bootstrap in the d
 
 #### Adding server_id to the node name
 
-Users can also include the ec2 server id in the node name by placing `%s` in the string passed to the `--chef-node-name` option. The %s is replaced by the ec2 server id dynamically. 
+Users can also include the ec2 server id in the node name by placing `%s` in the string passed to the `--chef-node-name` option. The %s is replaced by the ec2 server id dynamically.
 e.g. `-N "www-server-%s" or  --chef-node-name "www-server-%s"`
 
 #### Tagging node in Chef
@@ -230,6 +209,7 @@ knife ec2 server create -N chef-node-name -I your-windows-image -f flavor-of-ser
 ```
 
 #### 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:
 
 ```
@@ -244,6 +224,7 @@ The `knife ec2 server create` command also supports the following options for bo
 :kerberos_service              The Kerberos service used for authentication
 ```
 ### `knife ec2 ami list`
+
 This command provides the feature to list all EC2 AMIs. It also provides the feature to filter the AMIs based on owner and platform.
 
 ```
@@ -251,6 +232,7 @@ knife ec2 ami list
 ```
 
 #### Options for AMIs list
+
 - **Owner:**
   By default owner is aws-marketplace but you can specify following owner with the help of -o or --owner:
 
@@ -279,20 +261,35 @@ knife ec2 ami 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.**
 
 ### `knife ec2 flavor list`
+
 Outputs a list of all instance types comprising varying combinations of CPU, memory, storage, and architecture capacity of the currently configured AWS account. **Note, this shows all instances type associated with the account.**
 
 ### `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**
 
-## License and Authors
-- Author:: Adam Jacob ([adam@chef.io](mailto:adam@chef.io))
+## Development Documentation
 
-```text
-Copyright 2009-2015 Chef Software, Inc.
+All documentation is written using YARD. You can generate a by running:
+
+```
+rake docs
+```
 
+## Contributing
+
+For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md)
+
+## License & Copyright
+
+- Copyright:: Copyright (c) 2009-2018 Chef Software, Inc.
+- License:: Apache License, Version 2.0
+
+```text
 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