From 0e3c1776b01b1a8ca55335b1eca5a002b1bcfe6b Mon Sep 17 00:00:00 2001 From: Alexander Dupuy Date: Mon, 16 Mar 2015 18:50:20 +0100 Subject: [PATCH 1/2] remove left-over documentation and configuration from Rakefile removal --- README.md | 39 ++------------------------------------- config/rake.rb | 38 -------------------------------------- 2 files changed, 2 insertions(+), 75 deletions(-) delete mode 100644 config/rake.rb diff --git a/README.md b/README.md index 3174245c3..90a64dee4 100644 --- a/README.md +++ b/README.md @@ -10,53 +10,18 @@ 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. -* `certificates/` - SSL certificates generated by `rake ssl_cert` live here. -* `config/` - Contains the Rake configuration file, `rake.rb`. * `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. -Rake Tasks -========== - -The repository contains a `Rakefile` that includes tasks that are installed with the Chef libraries. To view the tasks available with in the repository with a brief description, run `rake -T`. - -The default task (`default`) is run when executing `rake` with no arguments. It will call the task `test_cookbooks`. - -The following tasks are not directly replaced by knife sub-commands. - -* `bundle_cookbook[cookbook]` - Creates cookbook tarballs in the `pkgs/` dir. -* `install` - Calls `update`, `roles` and `upload_cookbooks` Rake tasks. -* `ssl_cert` - Create self-signed SSL certificates in `certificates/` dir. -* `update` - Update the repository from source control server, understands git and svn. - -The following tasks duplicate functionality from knife and may be removed in a future version of Chef. - -* `metadata` - replaced by `knife cookbook metadata -a`. -* `new_cookbook` - replaced by `knife cookbook create`. -* `role[role_name]` - replaced by `knife role from file`. -* `roles` - iterates over the roles and uploads with `knife role from file`. -* `test_cookbooks` - replaced by `knife cookbook test -a`. -* `test_cookbook[cookbook]` - replaced by `knife cookbook test COOKBOOK`. -* `upload_cookbooks` - replaced by `knife cookbook upload -a`. -* `upload_cookbook[cookbook]` - replaced by `knife cookbook upload COOKBOOK`. - Configuration ============= -The repository uses two configuration files. +The repository contains a knife configuration file. -* config/rake.rb * .chef/knife.rb -The first, `config/rake.rb` configures the Rakefile in two sections. - -* Constants used in the `ssl_cert` task for creating the certificates. -* Constants that set the directory locations used in various tasks. - -If you use the `ssl_cert` task, change the values in the `config/rake.rb` file appropriately. These values were also used in the `new_cookbook` task, but that task is replaced by the `knife cookbook create` command which can be configured below. - -The second config file, `.chef/knife.rb` is a repository specific configuration file for knife. If you're using Hosted Chef, 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. +The knife configuration file `.chef/knife.rb` is a repository specific configuration file for knife. If you're using Hosted Chef, 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 diff --git a/config/rake.rb b/config/rake.rb deleted file mode 100644 index f0d5516c2..000000000 --- a/config/rake.rb +++ /dev/null @@ -1,38 +0,0 @@ -# Configure the Rakefile's tasks. - -### -# Company and SSL Details -# Used with the ssl_cert task. -### - -# The company name - used for SSL certificates, and in various other places -COMPANY_NAME = "Example Com" - -# The Country Name to use for SSL Certificates -SSL_COUNTRY_NAME = "US" - -# The State Name to use for SSL Certificates -SSL_STATE_NAME = "Several" - -# The Locality Name for SSL - typically, the city -SSL_LOCALITY_NAME = "Locality" - -# What department? -SSL_ORGANIZATIONAL_UNIT_NAME = "Operations" - -# The SSL contact email address -SSL_EMAIL_ADDRESS = "ops@example.com" - -# License for new Cookbooks -# Can be :apachev2 or :none -NEW_COOKBOOK_LICENSE = :apachev2 - -### -# Useful Extras (which you probably don't need to change) -### - -# The top of the repository checkout -TOPDIR = File.expand_path(File.join(File.dirname(__FILE__), "..")) - -# Where to store certificates generated with ssl_cert -CADIR = File.expand_path(File.join(TOPDIR, "certificates")) From dc0298d40b5ab79df9720e6d22846bcc9b5428e5 Mon Sep 17 00:00:00 2001 From: Alexander Dupuy Date: Mon, 16 Mar 2015 18:55:21 +0100 Subject: [PATCH 2/2] add reference to "new" (Chef 0.10+) environments in top-level README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 90a64dee4..7831c452f 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ This repository contains several directories, and each directory contains a READ * `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 =============