chef provision docs don't show some features of ChefDK::ProvisioningData.context

[danielsdeleo]

Upstream bug: chef-boneyard/chef-dk#618

In particular: in order for the chef provision -d (destroy) option to work, the user must set the action on machine resources to ChefDK::ProvisioningData.context.action. An example of this is provided in https://www.chef.io/blog/2015/08/18/policyfiles-a-guided-tour/ copied below:

context = ChefDK::ProvisioningData.context

# Set the port dynamically via the command line:
target_port = context.opts.port

with_driver 'vagrant:~/.vagrant.d/boxes' do

  options = {
    vagrant_options: {
      'vm.box' => 'opscode-ubuntu-14.04',
      'vm.network' => ":forwarded_port, guest: 80, host: #{target_port}"
    },
    convergence_options: context.convergence_options
  }


  machine context.node_name do
    machine_options(options)

    # This forces a chef run every time, which is sensible for `chef provision`
    # use cases.
    converge(true)
    action(context.action)
  end
end

By default, ChefDK::ProvisioningData.context.action will be :converge, but if the user passes the -d option to chef provision, ChefDK::ProvisioningData.context.action will be set to :destroy.

The relevant code for this behavior is here:

• https://github.com/chef/chef-dk/blob/44b6ace69daf7b7f9e6a645d845b37d4e086ca0f/lib/chef-dk/command/provision.rb#L264-L281
• https://github.com/chef/chef-dk/blob/44b6ace69daf7b7f9e6a645d845b37d4e086ca0f/lib/chef-dk/command/provision.rb#L291-L297