CHEF-34729 Updated the documentation for test-kitchen 4.0.0

content/tools/kitchen/_index.md

@@ -30,6 +30,21 @@ The key concepts in Test Kitchen are:
 - A driver is the lifecycle that implements the actions associated with a specific instance---create the instance, do what's needed to converge on that instance (such as installing Chef Infra Client, uploading cookbooks, and starting a Chef Infra Client run), setup anything else needed for testing, verify one (or more) suites post-converge, and then destroy that instance
 - A provisioner is the component on which the Chef Infra Client code will be run, either using chef-zero or chef-solo with the `chef_zero` and `chef_solo` provisioners, respectively
 
+## Test Kitchen and Omnitruck API support
+
+Chef has deprecated the Omnitruck API used to download Chef Infra Client.
+When the Omnitruck API reaches end of life, any version of Test Kitchen earlier than 4.0.0 will stop working.
+
+## Progress Chef license support
+
+Test Kitchen 4 and later supports authenticated downloads from the Chef commercial downloads API using a Progress Chef license key.
+You must provide your license key using one of the following methods:
+
+- Set [`chef_license_key` in your `kitchen.yml` file](config_yml_kitchen#provisioner-settings)
+- Set the `CHEF_LICENSE_KEY` environment variable on the machine running Test Kitchen
+
+For more information, see the [Chef licensing documentation](https://docs.chef.io/licensing/).
+
 ## Bento
 
 {{< readfile file="content/reusable/md/bento.md" >}}

content/tools/kitchen/config_yml_kitchen.md

@@ -36,7 +36,7 @@ about Test Kitchen.
 
 {{< readfile file="content/reusable/md/test_kitchen_yml_syntax.md" >}}
 
-## Provisioner Settings
+## Provisioner settings
 
 Test Kitchen can configure the chef-zero provisioner with the following
 Chef-specific settings:
@@ -47,6 +47,11 @@ Chef-specific settings:
 `chef_client_path`
 : Chef Infra Client provisioner only.
 
+`chef_license_key`
+: The Progress Chef license key used for authenticated Chef Infra Client downloads.
+
+  This setting is required when using Test Kitchen 4.0.0 or later. You can also set this using the `CHEF_LICENSE_KEY` environment variable. For more information, see the [Chef licensing documentation](https://docs.chef.io/licensing/).
+
 `chef_metadata_url`
 : **This will be deprecated in a future version.**
 
@@ -213,7 +218,7 @@ These settings may be added to the `provisioner` section of the
 
   Default value: auto detected
 
-## Transport Settings
+## Transport settings
 
 Kitchen can configure a transport with the following settings for either
 `ssh` or `winrm` transports:
@@ -322,7 +327,7 @@ where:
 - `chef_omnibus_url` is used to specify the URL from which Chef Infra Client is downloaded
 - the `attributes` for the `config` test suite contain specific client.rb settings for use with this test suite
 
-## Driver Settings
+## Driver settings
 
 Driver-specific configuration settings may be required. Use a block
 similar to:
@@ -456,7 +461,7 @@ suites:
   attributes: {}
 ```
 
-### chef-splunk Cookbook
+### chef-splunk cookbook
 
 The following `kitchen.yml` file is part of the `chef-splunk` cookbook and
 is used to help ensure the installation of the Splunk client and server
@@ -499,7 +504,7 @@ suites:
           enable_ssl: true
 ```
 
-### yum Cookbook
+### yum cookbook
 
 The following `kitchen.yml` file is part of the `yum` cookbook:
 
@@ -522,7 +527,7 @@ suites:
       - recipe[yum_test::test_repo]
 ```
 
-### Platform Attributes
+### Platform attributes
 
 The following `kitchen.yml` file sets up a simple tiered configuration of
 Chef Infra Server, including two front-end servers, a single
@@ -595,7 +600,7 @@ suites:
       - recipe[chef-server::backend]
 ```
 
-### Kitchen Converge On System Reboot
+### Kitchen converge on system reboot
 
 Test-Kitchen can handle reboots (when initiated from Chef Infra Client)
 by setting `retry_on_exit_code`, `max_retries` and `wait_for_retry`