chef-dk 0.13.21 → 0.14.25

data/acceptance/.shared/kitchen_acceptance/.kitchen.vagrant.yml

@@ -1,52 +1,52 @@
-driver:
-  name: vagrant
-  forward_agent: yes
-  customize:
-    cpus: 2
-    memory: 1024
-
-provisioner:
-  name: chef_zero
-  product_name: <%= ENV["KITCHEN_CHEF_PRODUCT"] %>
-  product_version: <%= ENV["KITCHEN_CHEF_VERSION"] %>
-  channel: <%= ENV["KITCHEN_CHEF_CHANNEL"] %>
-  client_rb:
-    audit_mode: :enabled
-  attributes:
-     chef_acceptance: "true"
-     use_system_chef: "true"
-
-platforms:
-<% %w(
-debian-8
-debian-7
-debian-6
-ubuntu-15.10
-ubuntu-14.04
-el-7
-el-6
-el-5
-freebsd-10
-freebsd-9
-fedora-21
-).each do |platform| %>
-  - name: <%= platform %>
-    driver:
-      box: opscode-<%= platform %>
-      box_url: http://opscode-vm-bento.s3.amazonaws.com/vagrant/virtualbox/opscode_<%= platform %>_chef-provisionerless.box
-<% end %>
-# freebsd-8
-# ubuntu-12.04
-# centos-7
-# centos-6
-
-<% %w(
-2012r2
-2012
-2008r2
-).each do |version| %>
-  - name: windows-<%= version %>
-    driver:
-      box: chef/windows-server-<%= version %>-standard
-# URL is atlas
-<% end %>
+driver:
+  name: vagrant
+  forward_agent: yes
+  customize:
+    cpus: 2
+    memory: 1024
+
+provisioner:
+  name: chef_zero
+  product_name: <%= ENV["KITCHEN_CHEF_PRODUCT"] %>
+  product_version: <%= ENV["KITCHEN_CHEF_VERSION"] %>
+  channel: <%= ENV["KITCHEN_CHEF_CHANNEL"] %>
+  client_rb:
+    audit_mode: :enabled
+  attributes:
+     chef_acceptance: "true"
+     use_system_chef: "true"
+
+platforms:
+<% %w(
+debian-8
+debian-7
+debian-6
+ubuntu-15.10
+ubuntu-14.04
+el-7
+el-6
+el-5
+freebsd-10
+freebsd-9
+fedora-21
+).each do |platform| %>
+  - name: <%= platform %>
+    driver:
+      box: opscode-<%= platform %>
+      box_url: http://opscode-vm-bento.s3.amazonaws.com/vagrant/virtualbox/opscode_<%= platform %>_chef-provisionerless.box
+<% end %>
+# freebsd-8
+# ubuntu-12.04
+# centos-7
+# centos-6
+
+<% %w(
+2012r2
+2012
+2008r2
+).each do |version| %>
+  - name: windows-<%= version %>
+    driver:
+      box: chef/windows-server-<%= version %>-standard
+# URL is atlas
+<% end %>

data/acceptance/.shared/kitchen_acceptance/libraries/kitchen.rb

@@ -1,51 +1,51 @@
-module KitchenAcceptance
-  class Kitchen < Chef::Resource
-    resource_name :kitchen
-
-    property :command, String, name_property: true
-    property :driver, %w(ec2 vagrant), coerce: proc { |v| v.to_s }, default: lazy { ENV["KITCHEN_DRIVER"] || :ec2 }
-    property :instances, String, default: lazy { ENV["KITCHEN_INSTANCES"] ? ENV["KITCHEN_INSTANCES"] : "" }
-    property :kitchen_dir, String, default: Chef.node['chef-acceptance']['suite-dir']
-    property :chef_product, String, default: lazy {
-      ENV["KITCHEN_CHEF_PRODUCT"] || begin
-        # Figure out if we're in chefdk or chef
-        if ::File.exist?(::File.expand_path("../../chef-dk.gemspec", node['chef-acceptance']['suite-dir']))
-          "chefdk"
-        else
-          "chef"
-        end
-      end
-    }
-    property :chef_channel, String, default: lazy {
-      ENV["KITCHEN_CHEF_CHANNEL"] ||
-      # Pick up current if we can't connect to artifactory
-      (ENV["ARTIFACTORY_USERNAME"] ? "unstable" : "current")
-    }
-    property :chef_version, String, default: lazy {
-      ENV["KITCHEN_CHEF_VERSION"] ||
-      # If we're running the chef or chefdk projects in jenkins, pick up the project name.
-      (ENV["PROJECT_NAME"] == chef_product ? ENV["OMNIBUS_BUILD_VERSION"] : nil) ||
-      "latest"
-    }
-    property :artifactory_username, String, default: lazy { ENV["ARTIFACTORY_USERNAME"] ? ENV["ARTIFACTORY_USERNAME"] : "" }
-    property :artifactory_password, String, default: lazy { ENV["ARTIFACTORY_PASSWORD"] ? ENV["ARTIFACTORY_PASSWORD"] : "" }
-    property :env, Hash, default: {}
-    property :kitchen_options, String, default: lazy { ENV["PROJECT_NAME"] ? "-c -l debug" : "-c" }
-
-    action :run do
-      execute "bundle exec kitchen #{command}#{instances ? " #{instances}" : ""}#{kitchen_options ? " #{kitchen_options}" : ""}" do
-        cwd kitchen_dir
-        env({
-          "KITCHEN_DRIVER" => driver,
-          "KITCHEN_INSTANCES" => instances,
-          "KITCHEN_LOCAL_YAML" => ::File.expand_path("../../.kitchen.#{driver}.yml", __FILE__),
-          "KITCHEN_CHEF_PRODUCT" => chef_product,
-          "KITCHEN_CHEF_CHANNEL" => chef_channel,
-          "KITCHEN_CHEF_VERSION" => chef_version,
-          "ARTIFACTORY_USERNAME" => artifactory_username,
-          "ARTIFACTORY_PASSWORD" => artifactory_password
-        }.merge(new_resource.env))
-      end
-    end
-  end
-end
+module KitchenAcceptance
+  class Kitchen < Chef::Resource
+    resource_name :kitchen
+
+    property :command, String, name_property: true
+    property :driver, %w(ec2 vagrant), coerce: proc { |v| v.to_s }, default: lazy { ENV["KITCHEN_DRIVER"] || :ec2 }
+    property :instances, String, default: lazy { ENV["KITCHEN_INSTANCES"] ? ENV["KITCHEN_INSTANCES"] : "" }
+    property :kitchen_dir, String, default: Chef.node['chef-acceptance']['suite-dir']
+    property :chef_product, String, default: lazy {
+      ENV["KITCHEN_CHEF_PRODUCT"] || begin
+        # Figure out if we're in chefdk or chef
+        if ::File.exist?(::File.expand_path("../../chef-dk.gemspec", node['chef-acceptance']['suite-dir']))
+          "chefdk"
+        else
+          "chef"
+        end
+      end
+    }
+    property :chef_channel, String, default: lazy {
+      ENV["KITCHEN_CHEF_CHANNEL"] ||
+      # Pick up current if we can't connect to artifactory
+      (ENV["ARTIFACTORY_USERNAME"] ? "unstable" : "current")
+    }
+    property :chef_version, String, default: lazy {
+      ENV["KITCHEN_CHEF_VERSION"] ||
+      # If we're running the chef or chefdk projects in jenkins, pick up the project name.
+      (ENV["PROJECT_NAME"] == chef_product ? ENV["OMNIBUS_BUILD_VERSION"] : nil) ||
+      "latest"
+    }
+    property :artifactory_username, String, default: lazy { ENV["ARTIFACTORY_USERNAME"] ? ENV["ARTIFACTORY_USERNAME"] : "" }
+    property :artifactory_password, String, default: lazy { ENV["ARTIFACTORY_PASSWORD"] ? ENV["ARTIFACTORY_PASSWORD"] : "" }
+    property :env, Hash, default: {}
+    property :kitchen_options, String, default: lazy { ENV["PROJECT_NAME"] ? "-c -l debug" : "-c" }
+
+    action :run do
+      execute "bundle exec kitchen #{command}#{instances ? " #{instances}" : ""}#{kitchen_options ? " #{kitchen_options}" : ""}" do
+        cwd kitchen_dir
+        env({
+          "KITCHEN_DRIVER" => driver,
+          "KITCHEN_INSTANCES" => instances,
+          "KITCHEN_LOCAL_YAML" => ::File.expand_path("../../.kitchen.#{driver}.yml", __FILE__),
+          "KITCHEN_CHEF_PRODUCT" => chef_product,
+          "KITCHEN_CHEF_CHANNEL" => chef_channel,
+          "KITCHEN_CHEF_VERSION" => chef_version,
+          "ARTIFACTORY_USERNAME" => artifactory_username,
+          "ARTIFACTORY_PASSWORD" => artifactory_password
+        }.merge(new_resource.env))
+      end
+    end
+  end
+end

data/acceptance/.shared/kitchen_acceptance/metadata.rb

@@ -1 +1 @@
-name "kitchen_acceptance"
+name "kitchen_acceptance"

data/acceptance/Gemfile

@@ -2,9 +2,10 @@ source "https://rubygems.org"
 
 gem "chef-acceptance", github: "chef/chef-acceptance"
 gem "test-kitchen"
-gem "kitchen-ec2", github: "test-kitchen/kitchen-ec2", branch: "jk/image-search-only"
+gem "kitchen-ec2"
 gem "kitchen-inspec"
 gem "kitchen-vagrant"
 gem "windows_chef_zero"
 gem "winrm-fs"
+gem "winrm-elevated"
 gem "berkshelf"

data/acceptance/Gemfile.lock

@@ -1,36 +1,23 @@
 GIT
   remote: git://github.com/chef/chef-acceptance.git
-  revision: 49458ec493dbd12588680eea9f2f9beb76463d09
+  revision: 4abda84e2fadd0452b77a8a88d4fd534843ced55
   specs:
     chef-acceptance (0.2.0)
       mixlib-shellout (~> 2.0)
       thor (~> 0.19)
 
-GIT
-  remote: git://github.com/test-kitchen/kitchen-ec2.git
-  revision: 61458c354d71a4156263e7f8b33e51c6edcb5aa6
-  branch: jk/image-search-only
-  specs:
-    kitchen-ec2 (1.0.0.dev.0)
-      aws-sdk (~> 2)
-      excon
-      multi_json
-      retryable (~> 2.0)
-      test-kitchen (~> 1.4, >= 1.4.1)
-      ubuntu_ami (~> 0.4.1)
-
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
     artifactory (2.3.2)
-    aws-sdk (2.2.34)
-      aws-sdk-resources (= 2.2.34)
-    aws-sdk-core (2.2.34)
+    aws-sdk (2.3.4)
+      aws-sdk-resources (= 2.3.4)
+    aws-sdk-core (2.3.4)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.2.34)
-      aws-sdk-core (= 2.2.34)
-    berkshelf (4.3.2)
+    aws-sdk-resources (2.3.4)
+      aws-sdk-core (= 2.3.4)
+    berkshelf (4.3.3)
       addressable (~> 2.3, >= 2.3.4)
       berkshelf-api-client (~> 2.0, >= 2.0.2)
       buff-config (~> 1.0)
@@ -65,7 +52,7 @@ GEM
     celluloid-io (0.16.2)
       celluloid (>= 0.16.0)
       nio4r (>= 1.1.0)
-    chef-config (12.9.38)
+    chef-config (12.10.24)
       fuzzyurl (~> 0.8.0)
       mixlib-config (~> 2.0)
       mixlib-shellout (~> 2.0)
@@ -85,16 +72,17 @@ GEM
       ffi (>= 1.0.1)
     gyoku (1.3.1)
       builder (>= 2.1.2)
-    hashie (3.4.3)
-    hitimes (1.2.3)
-    httpclient (2.7.1)
-    inspec (0.18.0)
+    hashie (3.4.4)
+    hitimes (1.2.4)
+    httpclient (2.7.2)
+    inspec (0.22.0)
+      hashie (~> 3.4)
       json (~> 1.8)
       method_source (~> 0.8)
       pry (~> 0)
-      r-train (~> 0.10.4)
+      r-train (~> 0.12)
       rainbow (~> 2)
-      rspec (~> 3.3)
+      rspec (~> 3)
       rspec-its (~> 1.2)
       rubyzip (~> 1.1)
       thor (~> 0.19)
@@ -102,8 +90,14 @@ GEM
       json_pure (>= 1.8.1)
     json (1.8.3)
     json_pure (1.8.3)
-    kitchen-inspec (0.12.5)
-      inspec (>= 0.14.1, < 1.0.0)
+    kitchen-ec2 (1.0.0)
+      aws-sdk (~> 2)
+      excon
+      multi_json
+      retryable (~> 2.0)
+      test-kitchen (~> 1.4, >= 1.4.1)
+    kitchen-inspec (0.13.0)
+      inspec (>= 0.20.0, < 1.0.0)
       test-kitchen (~> 1.6)
     kitchen-vagrant (0.20.0)
       test-kitchen (~> 1.4)
@@ -119,15 +113,15 @@ GEM
       rspec-expectations (~> 3.2)
       rspec-mocks (~> 3.2)
     mixlib-config (2.2.1)
-    mixlib-install (1.0.6)
-      artifactory (>= 2.3.0)
-      mixlib-shellout (>= 2.2.6)
-      mixlib-versioning (>= 1.1.0)
+    mixlib-install (1.0.11)
+      artifactory
+      mixlib-shellout
+      mixlib-versioning
     mixlib-log (1.6.0)
     mixlib-shellout (2.2.6)
     mixlib-versioning (1.1.0)
-    molinillo (0.4.4)
-    multi_json (1.11.2)
+    molinillo (0.4.5)
+    multi_json (1.12.0)
     multipart-post (2.0.0)
     net-scp (1.2.1)
       net-ssh (>= 2.6.5)
@@ -140,17 +134,17 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    r-train (0.10.4)
+    r-train (0.12.0)
       docker-api (~> 1.26.2)
       json (~> 1.8)
-      mixlib-shellout (~> 2.1)
+      mixlib-shellout (~> 2.0)
       net-scp (~> 1.2)
       net-ssh (>= 2.9, < 4.0)
       winrm (~> 1.6)
       winrm-fs (~> 0.3)
     rainbow (2.1.0)
     retryable (2.0.3)
-    ridley (4.5.0)
+    ridley (4.5.1)
       addressable
       buff-config (~> 1.0)
       buff-extensions (~> 1.0)
@@ -195,7 +189,7 @@ GEM
     solve (2.0.3)
       molinillo (~> 0.4.2)
       semverse (~> 1.1)
-    test-kitchen (1.7.3)
+    test-kitchen (1.8.0)
       mixlib-install (~> 1.0, >= 1.0.4)
       mixlib-shellout (>= 1.2, < 3.0)
       net-scp (~> 1.1)
@@ -205,13 +199,12 @@ GEM
     thor (0.19.1)
     timers (4.0.4)
       hitimes
-    ubuntu_ami (0.4.1)
     varia_model (0.4.1)
       buff-extensions (~> 1.0)
       hashie (>= 2.0.2, < 4.0.0)
     windows_chef_zero (2.0.0)
       test-kitchen (>= 1.2.1)
-    winrm (1.7.3)
+    winrm (1.8.1)
       builder (>= 2.1.2)
       gssapi (~> 1.2)
       gyoku (~> 1.0)
@@ -219,6 +212,9 @@ GEM
       logging (>= 1.6.1, < 3.0)
       nori (~> 2.0)
       rubyntlm (~> 0.6.0)
+    winrm-elevated (0.4.0)
+      winrm (~> 1.5)
+      winrm-fs (~> 0.4.2)
     winrm-fs (0.4.2)
       erubis (~> 2.7)
       logging (>= 1.6.1, < 3.0)
@@ -231,11 +227,12 @@ PLATFORMS
 DEPENDENCIES
   berkshelf
   chef-acceptance!
-  kitchen-ec2!
+  kitchen-ec2
   kitchen-inspec
   kitchen-vagrant
   test-kitchen
   windows_chef_zero
+  winrm-elevated
   winrm-fs
 
 BUNDLED WITH

data/acceptance/README.md

@@ -1,132 +1,132 @@
-# Acceptance Testing for Chef DK
-This folder contains acceptance tests that are required for ChefDK
-release readiness.
-
-## Getting started
-The tests use the _chef-acceptance_ gem as the high level framework.
-All the gems needed to run these tests can be installed with Bundler.
-
-### Important Note!
-Before running chef-acceptance, you *MUST* do the following on your current session:
-
-```
-export APPBUNDLER_ALLOW_RVM=true
-```
-
-## Pre-requisites / One time set up
-
-### Set up for local VM (Vagrant)
-
-If you intend to run the acceptance tests on a local VM, the supported solution is to use Vagrant.
-Ensure that Vagrant is installed on the machine that tests will run from, along with a
-virtualization driver (E.g.: VirtualBox).
-
-Set up the KITCHEN_DRIVER environment variable appropriately (value should be "vagrant").  E.g.:
-```
-export KITCHEN_DRIVER=vagrant
-```
-Add this to your shell profile or startup script as needed.
-
-### Set up for cloud VM (EC2)
-
-If you intend to run the acceptance tests on a cloud VM, the supported solution is to use EC2.
-
-The steps you will need to do are:
-
-1. Add your AWS credentials to the machine - e.g., to the ~/.aws/credentials directory.
-   - The easiest way to do this is to download the aws command line (`brew install awscli` on OS/X) and run `aws configure`.
-2. Create or import a SSH key to AWS. (If you already have one, you can skip the import/create)
-   - In the AWS console, click Key Pairs, then Create Key Pair or Import Key Pair.
-3. Copy or move the private key file (USERNAME.pem) to the SSH folder (e.g. `~/.ssh/USERNAME.pem`).
-   - If you Created a key pair in step 2, download the private key and move it to `~/.ssh`.
-   - If you Importd a key pair in step 2, just ensure your private key is in `~/.ssh` and has the same name as the key pair (`~/.ssh/USERNAME` or `~/.ssh/USERNAME.pem`).
-4. Set AWS_SSH_KEY_ID to the SSH key name.
-   - This is **optional** if your AWS SSH key name is your local username.
-   - You may want to set this in your shell `.profile`.
-
-     ```shell
-     export AWS_SSH_KEY_ID=name-of-private-key
-     ```
-5. Set the private key to only be readable by root
-
-   ```shell
-   chmod 0400 ~/.ssh/USERNAME.pem
-   ```
-6. Set up the KITCHEN_DRIVER environment variable appropriately (value should be "ec2"). (This is optional, as ec2 is the default.) E.g.:
-
-   ```shell
-   export KITCHEN_DRIVER=ec2
-   ```
-   Add this to your shell profile or startup script as needed.
-7. **Connect to Chef VPN**. The instances you create will not have public IPs!
-
-## Setting up and running a test suite
-To get started, do a bundle install from the acceptance directory:
-```shell
-chef/acceptance$ bundle install --binstubs
-```
-
-To get some basic info and ensure chef-acceptance can be run, do:
-```shell
-chef/acceptance$ bin/chef-acceptance info
-```
-
-To run a particular test suite, do the following:
-```shell
-chef/acceptance$ bin/chef-acceptance test TEST_SUITE
-```
-
-To restrict which OS's will run, use the KITCHEN_INSTANCES environment variable:
-
-```shell
-chef/acceptance$ export KITCHEN_INSTANCES=*-ubuntu-1404
-chef/acceptance$ bin/chef-acceptance test cookbook-git
-```
-
-If KITCHEN_INSTANCES is not specified, the default instances are default-ubuntu-1404 and default-windows-windows-2012r2. All selected instances will be run in *parallel* if the driver supports it (ec2 does, vagrant doesn't).
-
-## Optional Settings
-
-In addition to the environment settings above, there are a number of
-key values that are available to set for changing the way the acceptance
-tests are run.
-
-### KITCHEN_CHEF_CHANNEL
-
-Use this setting to specify which channel we will pull the chef build from.
-The default is to use the "current" channel, unless the ARTIFACTORY_USERNAME is set
-(which normally happens when running under Jenkins), in which case the default is
-changed to "unstable".
-
-```shell
-export KITCHEN_CHEF_CHANNEL=name-of-channel
-```
-
-
-### KITCHEN_CHEF_VERSION
-
-Use this setting to override the version of the Chef client that is installed. The default is to get the latest version in the desired channel.
-
-```shell
-export KITCHEN_CHEF_VERSION=version-of-chef-client
-```
-
-### ARTIFACTORY_USERNAME / ARTIFACTORY_PASSWORD
-
-If the desired channel to get the Chef client from is "unstable", the following settings need to be exported:
-
-```shell
-export ARTIFACTORY_USERNAME=username
-export ARTIFACTORY_PASSWORD=password
-```
-
-## Future Work
-
-Currently, there is no simple mechanism for chef-acceptance
-to build an Omnibus package of the developers local chef
-instance and run acceptance tests on it - the only packages
-that can be exercised are ones that come from one of the
-pipeline channels (unstable, current or stable).
-
-This is not an issue when adding acceptance tests for pre-existing functionality (as that functionality is presumed
-to already be in a build in one of the pipeline channels).
+# Acceptance Testing for Chef DK
+This folder contains acceptance tests that are required for ChefDK
+release readiness.
+
+## Getting started
+The tests use the _chef-acceptance_ gem as the high level framework.
+All the gems needed to run these tests can be installed with Bundler.
+
+### Important Note!
+Before running chef-acceptance, you *MUST* do the following on your current session:
+
+```
+export APPBUNDLER_ALLOW_RVM=true
+```
+
+## Pre-requisites / One time set up
+
+### Set up for local VM (Vagrant)
+
+If you intend to run the acceptance tests on a local VM, the supported solution is to use Vagrant.
+Ensure that Vagrant is installed on the machine that tests will run from, along with a
+virtualization driver (E.g.: VirtualBox).
+
+Set up the KITCHEN_DRIVER environment variable appropriately (value should be "vagrant").  E.g.:
+```
+export KITCHEN_DRIVER=vagrant
+```
+Add this to your shell profile or startup script as needed.
+
+### Set up for cloud VM (EC2)
+
+If you intend to run the acceptance tests on a cloud VM, the supported solution is to use EC2.
+
+The steps you will need to do are:
+
+1. Add your AWS credentials to the machine - e.g., to the ~/.aws/credentials directory.
+   - The easiest way to do this is to download the aws command line (`brew install awscli` on OS/X) and run `aws configure`.
+2. Create or import a SSH key to AWS. (If you already have one, you can skip the import/create)
+   - In the AWS console, click Key Pairs, then Create Key Pair or Import Key Pair.
+3. Copy or move the private key file (USERNAME.pem) to the SSH folder (e.g. `~/.ssh/USERNAME.pem`).
+   - If you Created a key pair in step 2, download the private key and move it to `~/.ssh`.
+   - If you Importd a key pair in step 2, just ensure your private key is in `~/.ssh` and has the same name as the key pair (`~/.ssh/USERNAME` or `~/.ssh/USERNAME.pem`).
+4. Set AWS_SSH_KEY_ID to the SSH key name.
+   - This is **optional** if your AWS SSH key name is your local username.
+   - You may want to set this in your shell `.profile`.
+
+     ```shell
+     export AWS_SSH_KEY_ID=name-of-private-key
+     ```
+5. Set the private key to only be readable by root
+
+   ```shell
+   chmod 0400 ~/.ssh/USERNAME.pem
+   ```
+6. Set up the KITCHEN_DRIVER environment variable appropriately (value should be "ec2"). (This is optional, as ec2 is the default.) E.g.:
+
+   ```shell
+   export KITCHEN_DRIVER=ec2
+   ```
+   Add this to your shell profile or startup script as needed.
+7. **Connect to Chef VPN**. The instances you create will not have public IPs!
+
+## Setting up and running a test suite
+To get started, do a bundle install from the acceptance directory:
+```shell
+chef/acceptance$ bundle install --binstubs
+```
+
+To get some basic info and ensure chef-acceptance can be run, do:
+```shell
+chef/acceptance$ bin/chef-acceptance info
+```
+
+To run a particular test suite, do the following:
+```shell
+chef/acceptance$ bin/chef-acceptance test TEST_SUITE
+```
+
+To restrict which OS's will run, use the KITCHEN_INSTANCES environment variable:
+
+```shell
+chef/acceptance$ export KITCHEN_INSTANCES=*-ubuntu-1404
+chef/acceptance$ bin/chef-acceptance test cookbook-git
+```
+
+If KITCHEN_INSTANCES is not specified, the default instances are default-ubuntu-1404 and default-windows-windows-2012r2. All selected instances will be run in *parallel* if the driver supports it (ec2 does, vagrant doesn't).
+
+## Optional Settings
+
+In addition to the environment settings above, there are a number of
+key values that are available to set for changing the way the acceptance
+tests are run.
+
+### KITCHEN_CHEF_CHANNEL
+
+Use this setting to specify which channel we will pull the chef build from.
+The default is to use the "current" channel, unless the ARTIFACTORY_USERNAME is set
+(which normally happens when running under Jenkins), in which case the default is
+changed to "unstable".
+
+```shell
+export KITCHEN_CHEF_CHANNEL=name-of-channel
+```
+
+
+### KITCHEN_CHEF_VERSION
+
+Use this setting to override the version of the Chef client that is installed. The default is to get the latest version in the desired channel.
+
+```shell
+export KITCHEN_CHEF_VERSION=version-of-chef-client
+```
+
+### ARTIFACTORY_USERNAME / ARTIFACTORY_PASSWORD
+
+If the desired channel to get the Chef client from is "unstable", the following settings need to be exported:
+
+```shell
+export ARTIFACTORY_USERNAME=username
+export ARTIFACTORY_PASSWORD=password
+```
+
+## Future Work
+
+Currently, there is no simple mechanism for chef-acceptance
+to build an Omnibus package of the developers local chef
+instance and run acceptance tests on it - the only packages
+that can be exercised are ones that come from one of the
+pipeline channels (unstable, current or stable).
+
+This is not an issue when adding acceptance tests for pre-existing functionality (as that functionality is presumed
+to already be in a build in one of the pipeline channels).