chef-dk 3.11.3 → 3.12.0

data/lib/chef-dk/skeletons/code_generator/files/default/gitignore

@@ -14,7 +14,7 @@ bin/*
 
 # test kitchen
 .kitchen/
-.kitchen.local.yml
+kitchen.local.yml
 
 # Chef
 Berksfile.lock

data/lib/chef-dk/skeletons/code_generator/files/default/repo/README.md

@@ -1,8 +1,6 @@
 # Overview
 
-Every Chef installation needs a Chef Repository. This is the place where cookbooks, roles, config files and other artifacts for managing systems with Chef will live. We strongly recommend storing this repository in a version control system such as Git and treat it like source code.
-
-While we prefer Git, and make this repository available via GitHub, you are welcome to download a tar or zip archive and use your favorite version control system to manage the code.
+Every Chef Infra installation needs a Chef Repository. This is the place where cookbooks, policyfiles, config files and other artifacts for managing systems with Chef Infra will live. We strongly recommend storing this repository in a version control system such as Git and treating it like source code.
 
 # Repository Directories
 
@@ -15,9 +13,7 @@ This repository contains several directories, and each directory contains a READ
 
 # Configuration
 
-The config file, `.chef/knife.rb` is a repository specific configuration file for knife. If you're using the Chef Platform, you can download one for your organization from the management console. If you're using the Open Source Chef Server, you can generate a new one with `knife configure`. For more information about configuring Knife, see the Knife documentation.
-
-<https://docs.chef.io/knife.html>
+The config file, `.chef/config.rb` is a repository-specific configuration file for the knife command line tool. If you're using the Hosted Chef platform, you can download one for your organization from the management console. You can also generate a new config.rb by running `knife configure`. For more information about configuring Knife, see the Knife documentation at https://docs.chef.io/knife.html
 
 # Next Steps
 

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/README.md

@@ -4,7 +4,7 @@ An example cookbook
 
 ## Requirements
 
-### Platform:
+### Platforms:
 
 _No platforms defined_
 

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/attributes/default.rb

@@ -1,6 +1,5 @@
-# frozen_string_literal: true
-# This is a Chef attributes file. It can be used to specify default and override
-# attributes to be applied to nodes that run this cookbook.
+# This is a Chef Infra Client attributes file. It can be used to specify default
+# and override attributes to be applied to nodes that run this cookbook.
 
 # Set a default name
 default['example']['name'] = 'Sam Doe'

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/metadata.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 name 'example'
 description 'An example cookbook'
 maintainer 'Example maintainer'

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb

@@ -1,8 +1,7 @@
-# frozen_string_literal: true
-# This is a Chef recipe file. It can be used to specify resources which will
-# apply configuration to a server.
+# This is a Chef Infra Client recipe file. It can be used to specify resources
+# which will apply configuration to a server.
 
-log "Welcome to Chef, #{node['example']['name']}!" do
+log "Welcome to Chef Infra Client, #{node['example']['name']}!" do
   level :info
 end
 

data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/README.md

@@ -1,18 +1,18 @@
 # Data Bags
 
-This directory contains directories of the various data bags you create for your infrastructure. Each subdirectory corresponds to a data bag on the Chef Server, and contains JSON files of the items that go in the bag.
+This directory contains directories of the various data bags you create for your infrastructure. Each subdirectory corresponds to a data bag on the Chef Infra Server, and contains JSON files of the items that go in the bag.
 
-For example, in this directory you'll find an example data bag directory called `example`, which contains an item definition called `example_item.json`
+For example, in this directory, you'll find an example data bag directory called `example`, which contains an item definition called `example_item.json`
 
-Before uploading this item to the server, we must first create the data bag on the Chef Server.
+Before uploading this item to the server, we must first create the data bag on the Chef Infra Server.
 
     knife data bag create example
 
-Then we can upload the items in the data bag's directory to the Chef Server.
+Then we can upload the items in the data bag's directory to the Chef Infra Server.
 
     knife data bag from file example example_item.json
 
-For more information on data bags, see the Chef wiki page:
+For more information on data bags, see the Chef docs site:
 
 https://docs.chef.io/data_bags.html
 
@@ -51,6 +51,6 @@ Use the secret_key to view the contents.
     password:  abc123
 
 
-For more information on encrypted data bags, see the Chef wiki page:
+For more information on encrypted data bags, see the Chef docs site:
 
 https://docs.chef.io/data_bags.html

data/lib/chef-dk/skeletons/code_generator/files/default/repo/dot-chef-repo.txt

@@ -1,6 +1,6 @@
 .chef-repo.txt
 ==============
 
-This file gives ChefDK's generators a hint that you are using a Chef Repo and
-this is the root directory of your Chef Repo. ChefDK's generators use this to
-generate code that is designed to work with the Chef Repo workflow.
+This file gives the Chef CLI's generators a hint that you are using a Chef Infra
+Repo and this is the root directory of your Chef Infra Repo. Chef CLI's generators
+use this to generate code that is designed to work with the Chef Repo workflow.

data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/README.md

@@ -1,9 +1,9 @@
-Create environments here, in either the Role Ruby DSL (.rb) or JSON (.json) files. To install environments on the server, use knife.
+Create environments here, in either the Role Ruby DSL (.rb) or JSON (.json) files. To install environments on the Chef Infra Server, use the knife command.
 
-For example, in this directory you'll find an example environment file called `example.json` which can be uploaded to the Chef Server:
+For example, in this directory, you'll find an example environment file called `example.json` which can be uploaded to the Chef Infra Server:
 
     knife environment from file environments/example.json
 
-For more information on environments, see the Chef wiki page:
+For more information on environments, see the Chef docs site:
 
 https://docs.chef.io/environments.html

data/lib/chef-dk/skeletons/code_generator/files/default/repo/policyfiles/README.md

@@ -1,4 +1,4 @@
-Create policyfiles here. When using a chef-repo, give your policyfiles
+Create Policyfiles here. When using a chef-repo, give your Policyfiles
 the same filename as the name set in the policyfile itself, and use the
 `.rb` file extension.
 

data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/README.md

@@ -1,9 +1,9 @@
 Create roles here, in either the Role Ruby DSL (.rb) or JSON (.json) files. To install roles on the server, use knife.
 
-For example, in this directory you'll find an example role file called `example.json` which can be uploaded to the Chef Server:
+For example, in this directory, you'll find an example role file called `example.json` which can be uploaded to the Chef Infra Server:
 
     knife role from file roles/example.json
 
-For more information on roles, see the Chef wiki page:
+For more information on roles, see the Chef docs site:
 
 https://docs.chef.io/roles.html

data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper.rb

@@ -1,3 +1,2 @@
-# frozen_string_literal: true
 require 'chefspec'
 require 'chefspec/berkshelf'

data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper_policyfile.rb

@@ -1,3 +1,2 @@
-# frozen_string_literal: true
 require 'chefspec'
 require 'chefspec/policyfile'

data/lib/chef-dk/skeletons/code_generator/metadata.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
+# ~FC067 ~FC065 ~FC064
 name             'code_generator'
 maintainer       'Chef Software, Inc.'
 maintainer_email 'dev@chef.io'

data/lib/chef-dk/skeletons/code_generator/recipes/app.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 context = ChefDK::Generator.context
 app_dir = File.join(context.app_root, context.app_name)
 cookbooks_dir = context.cookbook_root
@@ -11,7 +9,7 @@ directory app_dir
 # Top level files
 
 # Test Kitchen
-template "#{app_dir}/.kitchen.yml" do
+template "#{app_dir}/kitchen.yml" do
   source 'kitchen.yml.erb'
   helpers(ChefDK::Generator::TemplateHelper)
 end

data/lib/chef-dk/skeletons/code_generator/recipes/attribute.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 attribute_dir = File.join(cookbook_dir, 'attributes')

data/lib/chef-dk/skeletons/code_generator/recipes/build_cookbook.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 context = ChefDK::Generator.context
 delivery_project_dir = context.delivery_project_dir
 pipeline = context.pipeline
@@ -16,7 +14,7 @@ cookbook_file config_json do
   not_if { File.exist?(config_json) }
 end
 
-# Adding a new prototype file for delivery-cli local commands
+# Adding the delivery local-mode config
 cookbook_file project_toml do
   source 'delivery-project.toml'
   not_if { File.exist?(project_toml) }
@@ -72,8 +70,8 @@ directory "#{build_cookbook_dir}/recipes"
 end
 
 # Test Kitchen build node
-cookbook_file "#{build_cookbook_dir}/.kitchen.yml" do
-  source 'build_cookbook/.kitchen.yml'
+cookbook_file "#{build_cookbook_dir}/kitchen.yml" do
+  source 'build_cookbook/kitchen.yml'
 end
 
 directory "#{build_cookbook_dir}/data_bags/keys" do

data/lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb

@@ -1,11 +1,9 @@
-# frozen_string_literal: true
-
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 
 silence_chef_formatter unless context.verbose
 
-generator_desc('Ensuring correct cookbook file content')
+generator_desc('Ensuring correct cookbook content')
 
 # cookbook root dir
 directory cookbook_dir
@@ -71,7 +69,7 @@ template "#{cookbook_dir}/LICENSE" do
 end
 
 # Test Kitchen
-template "#{cookbook_dir}/.kitchen.yml" do
+template "#{cookbook_dir}/kitchen.yml" do
   if context.kitchen == 'dokken'
     # kitchen-dokken configuration works with berkshelf and policyfiles
     source 'kitchen_dokken.yml.erb'
@@ -85,7 +83,7 @@ template "#{cookbook_dir}/.kitchen.yml" do
   action :create_if_missing
 end
 
-# Inspec
+# InSpec
 directory "#{cookbook_dir}/test/integration/default" do
   recursive true
 end

data/lib/chef-dk/skeletons/code_generator/recipes/cookbook_file.rb

@@ -1,9 +1,7 @@
-# frozen_string_literal: true
-
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
-files_dir = File.join(cookbook_dir, 'files', 'default')
-cookbook_file_path = File.join(cookbook_dir, 'files', 'default', context.new_file_basename)
+files_dir = File.join(cookbook_dir, 'files')
+cookbook_file_path = File.join(files_dir, context.new_file_basename)
 
 directory files_dir do
   recursive true

data/lib/chef-dk/skeletons/code_generator/recipes/helpers.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 libraries_dir = File.join(cookbook_dir, 'libraries')

data/lib/chef-dk/skeletons/code_generator/recipes/policyfile.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 context = ChefDK::Generator.context
 policyfile_path = File.join(context.policyfile_dir, "#{context.new_file_basename}.rb")
 

data/lib/chef-dk/skeletons/code_generator/recipes/recipe.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 recipe_path = File.join(cookbook_dir, 'recipes', "#{context.new_file_basename}.rb")
@@ -14,7 +12,7 @@ if File.directory?(File.join(cookbook_dir, 'test', 'recipes'))
     It appears that you have InSpec tests located at "test/recipes". This location can
     cause issues with Foodcritic and has been deprecated in favor of "test/integration/default".
     Please move your existing InSpec tests to the newly created "test/integration/default"
-    directory, and update the 'inspec_tests' value in your .kitchen.yml file(s) to
+    directory, and update the 'inspec_tests' value in your kitchen.yml file(s) to
     point to "test/integration/default".
   EOH
 end
@@ -34,7 +32,7 @@ template spec_path do
   action :create_if_missing
 end
 
-# Inspec
+# InSpec
 directory inspec_dir do
   recursive true
 end

data/lib/chef-dk/skeletons/code_generator/recipes/repo.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 context = ChefDK::Generator.context
 repo_dir = File.join(context.repo_root, context.repo_name)
 

data/lib/chef-dk/skeletons/code_generator/recipes/resource.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 

data/lib/chef-dk/skeletons/code_generator/recipes/template.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 template_dir = File.join(cookbook_dir, 'templates')

data/lib/chef-dk/skeletons/code_generator/templates/default/Policyfile.rb.erb

@@ -1,4 +1,4 @@
-# Policyfile.rb - Describe how you want Chef to build your system.
+# Policyfile.rb - Describe how you want Chef Infra Client to build your system.
 #
 # For more information on the Policyfile feature, visit
 # https://docs.chef.io/policyfile.html

data/lib/chef-dk/skeletons/code_generator/templates/default/build_cookbook/recipe.rb.erb

@@ -3,6 +3,7 @@
 # Recipe:: <%= @phase %>
 #
 <%= license_description('#') %>
+
 <% if build_cookbook_parent_is_cookbook -%>
 include_recipe 'delivery-truck::<%= @phase %>'
 <% end -%>

data/lib/chef-dk/skeletons/code_generator/templates/default/inspec_default_test.rb.erb

@@ -1,7 +1,7 @@
 # InSpec test for recipe <%= cookbook_name %>::<%= recipe_name %>
 
 # The InSpec reference, with examples and extensive documentation, can be
-# found at http://inspec.io/docs/reference/resources/
+# found at https://www.inspec.io/docs/reference/resources/
 
 unless os.windows?
   # This is an example test, replace with your own test.

data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen.yml.erb

@@ -2,6 +2,13 @@
 driver:
   name: vagrant
 
+## The forwarded_port port feature lets you connect to ports on the VM guest via
+## localhost on the host.
+## see also: https://www.vagrantup.com/docs/networking/forwarded_ports.html
+
+#  network:
+#    - ["forwarded_port", {guest: 80, host: 8080}]
+
 provisioner:
   name: chef_zero
   # You may wish to disable always updating cookbooks in CI or other testing environments.
@@ -9,11 +16,16 @@ provisioner:
   #   always_update_cookbooks: <%%= !ENV['CI'] %>
   always_update_cookbooks: true
 
+  ## product_name and product_version specifies a specific Chef product and version to install.
+  ## see the Chef documentation for more details: https://docs.chef.io/config_yml_kitchen.html
+  #  product_name: chef
+  #  product_version: 14
+
 verifier:
   name: inspec
 
 platforms:
-  - name: ubuntu-16.04
+  - name: ubuntu-18.04
   - name: centos-7
 
 suites:

data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen_dokken.yml.erb

@@ -12,14 +12,19 @@ verifier:
   name: inspec
 
 platforms:
-  # @see https://github.com/someara/dokken-images
-  # @see https://hub.docker.com/r/dokken/
-  - name: ubuntu-16.04
+  # @see https://github.com/chef-cookbooks/testing_examples/blob/master/kitchen.dokken.yml
+  # @see https://hub.docker.com/u/dokken
+  - name: ubuntu-18.04
     driver:
-      image: dokken/ubuntu-16.04
+      image: dokken/ubuntu-18.04
+      pid_one_command: /bin/systemd
+      intermediate_instructions:
+        - RUN /usr/bin/apt-get update
+
   - name: centos-7
     driver:
       image: dokken/centos-7
+      pid_one_command: /usr/lib/systemd/systemd
 
 suites:
   - name: default

data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen_policyfile.yml.erb

@@ -4,7 +4,7 @@ driver:
 
 ## The forwarded_port port feature lets you connect to ports on the VM guest via
 ## localhost on the host.
-## see also: https://docs.vagrantup.com/v2/networking/forwarded_ports.html
+## see also: https://www.vagrantup.com/docs/networking/forwarded_ports.html
 
 #  network:
 #    - ["forwarded_port", {guest: 80, host: 8080}]
@@ -12,17 +12,16 @@ driver:
 provisioner:
   name: chef_zero
 
-## require_chef_omnibus specifies a specific chef version to install. You can
-## also set this to `true` to always use the latest version.
-## see also: https://docs.chef.io/config_yml_kitchen.html
-
-#  require_chef_omnibus: 12.8.1
+  ## product_name and product_version specifies a specific Chef product and version to install.
+  ## see the Chef documentation for more details: https://docs.chef.io/config_yml_kitchen.html
+  #  product_name: chef
+  #  product_version: 14
 
 verifier:
   name: inspec
 
 platforms:
-  - name: ubuntu-16.04
+  - name: ubuntu-18.04
   - name: centos-7
 
 suites: