chef-dk 2.6.2 → 3.0.36

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

@@ -1,9 +1,9 @@
-This directory typically contains Chef cookbooks. This repository was
-generated with the '--policy-only' option, which means you have chosen
-to use a workflow where each cookbook is treated as an independent
-software project. As a result, any cookbooks present in this directory
-are independent git projects, and the contents of this directory have
-been added to .gitignore.
-
-Love,
-Chef
+This directory typically contains Chef cookbooks. This repository was
+generated with the '--policy-only' option, which means you have chosen
+to use a workflow where each cookbook is treated as an independent
+software project. As a result, any cookbooks present in this directory
+are independent git projects, and the contents of this directory have
+been added to .gitignore.
+
+Love,
+Chef

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

@@ -1,54 +1,66 @@
-This directory contains the cookbooks used to configure systems in your infrastructure with Chef - an example basic cookbook called `example` has been automatically created for you.
-
-Knife needs to be configured to know where the cookbooks are located with the `cookbook_path` setting. If this is not set, then several cookbook operations will fail to work properly.
-
-    cookbook_path ["./cookbooks"]
-
-This setting tells knife to look for the cookbooks directory in the present working directory. This means the knife cookbook subcommands need to be run in the `chef-repo` directory itself. To make sure that the cookbooks can be found elsewhere inside the repository, use an absolute path. This is a Ruby file, so something like the following can be used:
-
-    current_dir = File.dirname(__FILE__)
-    cookbook_path ["#{current_dir}/../cookbooks"]
-
-Which will set `current_dir` to the location of the knife.rb file itself (e.g. `~/chef-repo/.chef/knife.rb`).
-
-Configure knife to use your preferred copyright holder, email contact and license. Add the following lines to `.chef/knife.rb`.
-
-    cookbook_copyright "Example, Com."
-    cookbook_email     "cookbooks@example.com"
-    cookbook_license   "apachev2"
-
-Supported values for `cookbook_license` are "apachev2", "mit","gplv2","gplv3",  or "none". These settings are used to prefill comments in the default recipe, and the corresponding values in the metadata.rb. You are free to change the the comments in those files.
-
-Create new cookbooks in this directory with Chef.
-
-    chef generate cookbook COOKBOOK
-
-This will create all the cookbook directory components. You don't need to use them all, and can delete the ones you don't need. It also creates a README file, metadata.rb and default recipe.
-
-You can also download cookbooks directly from the Opscode Cookbook Site. There are two subcommands to help with this depending on what your preference is.
-
-The first and recommended method is to use a vendor branch if you're using Git. This is automatically handled with Knife.
-
-    knife cookbook site install COOKBOOK
-
-This will:
-
-* Download the cookbook tarball from the Chef Supermarket.
-* Ensure its on the git master branch.
-* Checks for an existing vendor branch, and creates if it doesn't.
-* Checks out the vendor branch (chef-vendor-COOKBOOK).
-* Removes the existing (old) version.
-* Untars the cookbook tarball it downloaded in the first step.
-* Adds the cookbook files to the git index and commits.
-* Creates a tag for the version downloaded.
-* Checks out the master branch again.
-* Merges the cookbook into master.
-* Repeats the above for all the cookbooks dependencies, downloading them from the community site
-
-The last step will ensure that any local changes or modifications you have made to the cookbook are preserved, so you can keep your changes through upstream updates.
-
-If you're not using Git, use the site download subcommand to download the tarball.
-
-    knife cookbook site download COOKBOOK
-
-This creates the COOKBOOK.tar.gz from in the current directory (e.g., `~/chef-repo`). We recommend following a workflow similar to the above for your version control tool.
+This directory contains the cookbooks used to configure systems in your infrastructure with Chef - an example basic cookbook called `example` has been automatically created for you.
+
+Knife needs to be configured to know where the cookbooks are located with the `cookbook_path` setting. If this is not set, then several cookbook operations will fail to work properly.
+
+```
+cookbook_path ["./cookbooks"]
+```
+
+This setting tells knife to look for the cookbooks directory in the present working directory. This means the knife cookbook subcommands need to be run in the `chef-repo` directory itself. To make sure that the cookbooks can be found elsewhere inside the repository, use an absolute path. This is a Ruby file, so something like the following can be used:
+
+```
+current_dir = File.dirname(__FILE__)
+cookbook_path ["#{current_dir}/../cookbooks"]
+```
+
+Which will set `current_dir` to the location of the knife.rb file itself (e.g. `~/chef-repo/.chef/knife.rb`).
+
+Configure knife to use your preferred copyright holder, email contact and license. Add the following lines to `.chef/knife.rb`.
+
+```
+cookbook_copyright "Example, Com."
+cookbook_email     "cookbooks@example.com"
+cookbook_license   "apachev2"
+```
+
+Supported values for `cookbook_license` are "apachev2", "mit","gplv2","gplv3", or "none". These settings are used to prefill comments in the default recipe, and the corresponding values in the metadata.rb. You are free to change the the comments in those files.
+
+Create new cookbooks in this directory with Chef.
+
+```
+chef generate cookbook COOKBOOK
+```
+
+This will create all the cookbook directory components. You don't need to use them all, and can delete the ones you don't need. It also creates a README file, metadata.rb and default recipe.
+
+You can also download cookbooks directly from the Chef Supermarket site. There are two subcommands to help with this depending on what your preference is.
+
+The first and recommended method is to use a vendor branch if you're using Git. This is automatically handled with Knife.
+
+```
+knife cookbook site install COOKBOOK
+```
+
+This will:
+
+- Download the cookbook tarball from the Chef Supermarket.
+- Ensure its on the git master branch.
+- Checks for an existing vendor branch, and creates if it doesn't.
+- Checks out the vendor branch (chef-vendor-COOKBOOK).
+- Removes the existing (old) version.
+- Untars the cookbook tarball it downloaded in the first step.
+- Adds the cookbook files to the git index and commits.
+- Creates a tag for the version downloaded.
+- Checks out the master branch again.
+- Merges the cookbook into master.
+- Repeats the above for all the cookbooks dependencies, downloading them from the community site
+
+The last step will ensure that any local changes or modifications you have made to the cookbook are preserved, so you can keep your changes through upstream updates.
+
+If you're not using Git, use the site download subcommand to download the tarball.
+
+```
+knife cookbook site download COOKBOOK
+```
+
+This creates the COOKBOOK.tar.gz from in the current directory (e.g., `~/chef-repo`). We recommend following a workflow similar to the above for your version control tool.

data/lib/chef-dk/skeletons/code_generator/files/default/delivery-config.json

@@ -1,17 +1,17 @@
-{
-  "version": "2",
-  "build_cookbook": {
-    "name": "build_cookbook",
-    "path": ".delivery/build_cookbook"
-  },
-  "delivery-truck": {
-    "lint": {
-      "enable_cookstyle": true
-    }
-  },
-  "skip_phases": [],
-  "job_dispatch": {
-    "version": "v2"
-  },
-  "dependencies": []
-}
+{
+  "version": "2",
+  "build_cookbook": {
+    "name": "build_cookbook",
+    "path": ".delivery/build_cookbook"
+  },
+  "delivery-truck": {
+    "lint": {
+      "enable_cookstyle": true
+    }
+  },
+  "skip_phases": [],
+  "job_dispatch": {
+    "version": "v2"
+  },
+  "dependencies": []
+}

data/lib/chef-dk/skeletons/code_generator/files/default/delivery-project.toml

@@ -1,36 +1,36 @@
-# Delivery Prototype for Local Phases Execution
-#
-# The purpose of this file is to prototype a new way to execute
-# phases locally on your workstation. The delivery-cli will read
-# this file and execute the command(s) that are configured for
-# each phase. You can customize them by just modifying the phase
-# key on this file.
-#
-# By default these phases are configured for Cookbook Workflow only
-#
-# As this is still a prototype we are not modifying the current
-# config.json file and it will continue working as usual.
-
-[local_phases]
-unit = "chef exec rspec spec/"
-lint = "chef exec cookstyle"
-# Foodcritic includes rules only appropriate for community cookbooks
-# uploaded to Supermarket. We turn off any rules tagged "supermarket"
-# by default. If you plan to share this cookbook you should remove
-# '-t ~supermarket' below to enable supermarket rules.
-syntax = "chef exec foodcritic . -t ~supermarket"
-provision = "chef exec kitchen create"
-deploy = "chef exec kitchen converge"
-smoke = "chef exec kitchen verify"
-# The functional phase is optional, you can define it by uncommenting
-# the line below and running the command: `delivery local functional`
-# functional = ""
-cleanup = "chef exec kitchen destroy"
-
-# Remote project.toml file
-#
-# Specify a remote URI location for the `project.toml` file.
-# This is useful for teams that wish to centrally manage the behavior
-# of the `delivery local` command across many different projects.
-#
-# remote_file = "https://url/project.toml"
+# Delivery Prototype for Local Phases Execution
+#
+# The purpose of this file is to prototype a new way to execute
+# phases locally on your workstation. The delivery-cli will read
+# this file and execute the command(s) that are configured for
+# each phase. You can customize them by just modifying the phase
+# key on this file.
+#
+# By default these phases are configured for Cookbook Workflow only
+#
+# As this is still a prototype we are not modifying the current
+# config.json file and it will continue working as usual.
+
+[local_phases]
+unit = "chef exec rspec spec/"
+lint = "chef exec cookstyle"
+# Foodcritic includes rules only appropriate for community cookbooks
+# uploaded to Supermarket. We turn off any rules tagged "supermarket"
+# by default. If you plan to share this cookbook you should remove
+# '-t ~supermarket' below to enable supermarket rules.
+syntax = "chef exec foodcritic . -t ~supermarket"
+provision = "chef exec kitchen create"
+deploy = "chef exec kitchen converge"
+smoke = "chef exec kitchen verify"
+# The functional phase is optional, you can define it by uncommenting
+# the line below and running the command: `delivery local functional`
+# functional = ""
+cleanup = "chef exec kitchen destroy"
+
+# Remote project.toml file
+#
+# Specify a remote URI location for the `project.toml` file.
+# This is useful for teams that wish to centrally manage the behavior
+# of the `delivery local` command across many different projects.
+#
+# remote_file = "https://url/project.toml"

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

@@ -1,22 +1,22 @@
-.vagrant
-*~
-*#
-.#*
-\#*#
-.*.sw[a-z]
-*.un~
-
-# Bundler
-Gemfile.lock
-gems.locked
-bin/*
-.bundle/*
-
-# test kitchen
-.kitchen/
-.kitchen.local.yml
-
-# Chef
-Berksfile.lock
-.zero-knife.rb
-Policyfile.lock.json
+.vagrant
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+
+# Bundler
+Gemfile.lock
+gems.locked
+bin/*
+.bundle/*
+
+# test kitchen
+.kitchen/
+.kitchen.local.yml
+
+# Chef
+Berksfile.lock
+.zero-knife.rb
+Policyfile.lock.json

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

@@ -1,24 +1,24 @@
-# 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.
-
-# Repository Directories
-
-This repository contains several directories, and each directory contains a README file that describes what it is for in greater detail, and how to use it for managing your systems with Chef.
-
-- `cookbooks/` - Cookbooks you download or create.
-- `data_bags/` - Store data bags and items in .json in the repository.
-- `roles/` - Store roles in .rb or .json in the repository.
-- `environments/` - Store environments in .rb or .json in the repository.
-
-# 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>
-
-# Next Steps
-
-Read the README file in each of the subdirectories for more information about what goes in those directories.
+# 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.
+
+# Repository Directories
+
+This repository contains several directories, and each directory contains a README file that describes what it is for in greater detail, and how to use it for managing your systems with Chef.
+
+- `cookbooks/` - Cookbooks you download or create.
+- `data_bags/` - Store data bags and items in .json in the repository.
+- `roles/` - Store roles in .rb or .json in the repository.
+- `environments/` - Store environments in .rb or .json in the repository.
+
+# 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>
+
+# Next Steps
+
+Read the README file in each of the subdirectories for more information about what goes in those directories.

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

@@ -1,27 +1,27 @@
-# Example
-
-An example cookbook
-
-## Requirements
-
-### Platform:
-
-_No platforms defined_
-
-### Cookbooks:
-
-_No dependencies defined_
-
-## Attributes
-
-- `node['example']['name']` - Defaults to `Sam Doe`.
-
-## Recipes
-
-- example::default
-
-## License and Maintainer
-
-Maintainer:: (<>)
-
-License:: All rights reserved
+# Example
+
+An example cookbook
+
+## Requirements
+
+### Platform:
+
+_No platforms defined_
+
+### Cookbooks:
+
+_No dependencies defined_
+
+## Attributes
+
+- `node['example']['name']` - Defaults to `Sam Doe`.
+
+## Recipes
+
+- example::default
+
+## License and Maintainer
+
+Maintainer:: (<>)
+
+License:: All rights reserved

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

@@ -1,8 +1,8 @@
-# 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.
-
-# Set a default name
-default['example']['name'] = 'Sam Doe'
-
-# For further information, see the Chef documentation (https://docs.chef.io/essentials_cookbook_attribute_files.html).
+# 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.
+
+# Set a default name
+default['example']['name'] = 'Sam Doe'
+
+# For further information, see the Chef documentation (https://docs.chef.io/attributes.html).

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

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-name 'example'
-description 'An example cookbook'
-maintainer 'Example maintainer'
-maintainer_email 'maintainer@example.com'
-license 'Apache-2.0'
-version '1.0.0'
+# frozen_string_literal: true
+name 'example'
+description 'An example cookbook'
+maintainer 'Example maintainer'
+maintainer_email 'maintainer@example.com'
+license 'Apache-2.0'
+version '1.0.0'

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

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
-# This is a Chef recipe file. It can be used to specify resources which will
-# apply configuration to a server.
-
-log "Welcome to Chef, #{node['example']['name']}!" do
-  level :info
-end
-
-# For more information, see the documentation: https://docs.chef.io/recipes.html
+# frozen_string_literal: true
+# This is a Chef recipe file. It can be used to specify resources which will
+# apply configuration to a server.
+
+log "Welcome to Chef, #{node['example']['name']}!" do
+  level :info
+end
+
+# For more information, see the documentation: https://docs.chef.io/recipes.html