clc-promote 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cc35177c05853e5ebedbc92108bfad0fe143355
-  data.tar.gz: c2f0586fedd03adff7a45cdf65b7d72b8008eba5
+  metadata.gz: 6bb2e8ce77e8107d62b221d47dcd485a1b8cfd78
+  data.tar.gz: 484229a859e81b88a960bafc7c5ef690a75c7faf
 SHA512:
-  metadata.gz: 44ed3925abcc6c61d15d6e56c99fde9bd16956c9533fabc2ecfe2d3fba3f57e453c6e51877f15976523aab5f5146b88cfc96852e870cba2eb55aab3844d995d4
-  data.tar.gz: c7fd0aace5ab30dd38fda484d208e1db7f890b036512fbeca59acd49fdad23d6c6a2d85fdfbeb1df780f2acca985cda91b6bae41a3f08ca2a9df1dc22cac3da8
+  metadata.gz: 6efb5d1e4c07b4bf5279729caf7415fa1007809f66a683632658d79127785e9f25b5442f2e3d6bedefbe4dadbfa6980798c83453848ae2a170885b88a2f56e4f
+  data.tar.gz: 14fc885442580739a00e46ab152d27baf4ef7adfa33d5d7d6451c3036f504dab57d2039fbdfe524673a246bf85fadb57b303e364fe0481df3751c6e537673efc

data/README.md

@@ -1,2 +1,107 @@
-# CLC-Promote
-Provides versioning and promotion logic for chef artifacts.
+# CLC-Promote Gem
+Drives our CI/CD pipeline and provides functionality for:
+* Versioning cookbooks, data bags and environments
+* Manages Cookbook version constraints within environments
+* Manages the uploading of chef artifacts from CI to the QA chef Server and eventually to the production chef server
+* Promotes one environment's cookbooks to another
+
+This functionality is exposed via a collectin of rake tasks used on the CI server and a knife plugin used to perform deployments.
+
+## Configuration
+CLC-Promote uses configuration settings to determine the values of:
+* Chef Server to contact
+* User and `.pem` file to use for authentication
+* Location of the chef repo
+
+### Knife Configuration
+When using the `knife promote` commands, these are pulled from your `knife.rb` file as long as you are inside of the chef-repo.You can also set these using the usual knife parameters.
+
+Additional knife config settings are used when interacting with a production chef server. The typical chef server config settings in a `knife.rb` are used for talking to a QA server. Production server settings are stored in the following settings:
+```ruby
+knife[:promote_prod_url] = "https://chef.t3n.dom/organizations/clc_prod"
+knife[:promote_prod_user] = user
+knife[:promote_prod_client_key] = "#{current_dir}/#{node_name}_VA1.pem"
+```
+
+### Rake Configuration
+The Rake Tasks receive these values by passing a config object to the `RakeTasks` class.
+```ruby
+config = Promote::Config.new({
+  :repo_root => REPO_TOPDIR,
+  :node_name => 'provisioner',
+  :client_key => ENV['client_key'] || File.join(REPO_TOPDIR, 'cookbooks/provisioner/files/provisioner.pem'),
+  :chef_server_url => ENV['chef_server_url'] || "https://172.22.10.121/organizations/clc_qa"
+  })
+Promote::RakeTasks.new(config)
+```
+
+The `Config` class can receive the following settings:
+Setting                   | 
+:repo_root                | **mandatory**
+:cookbook_directory       | Defaults to `#{root}/cookbooks`
+:environment_directory    | Defaults to `#{root}/environments`
+:data_bag_directory       | Defaults to `#{root}/data_bags`
+:temp_directory           | Defaults to `/tmp/promote`
+:node_name                | **mandatory**
+:client_key               | **mandatory**
+:chef_server_url          | **mandatody**
+
+
+## CLC-Promote Rake Tasks
+**Note:** See the [below section on versioning](/gems/clc-promote#How are version numbers generated) for details on how versin numbers are generated.
+
+### Promote:version_cookbook
+Bumps the version of an individual cookbook. 
+
+### Promote:version_cookbooks
+Same as `Promote:version_cookbook` but iterates all cookbooks.
+
+### Promote:version_environment
+Bumps the version of an individual environment file.
+
+### Promote:version_environments
+Same as `Promote:version_environment` but iterates all environment files.
+
+### Promote:version_data_bag
+Bumps the version of an individual databag entry.
+
+### Promote:version_data_bags
+Bumps the versions of all databag entries.
+
+### Promote:sync_berksfiles
+Performs a berks install on all cookbooks in the chef repo.
+
+### Promote:upload_cookbooks
+Uploads all cookbooks to the chef server. **Note**: only cookbooks that have been bumped will be uploaded. Uploaded cookbooks are frozen.
+
+### Promote:upload_environment
+Uploads an environment file to the chef server
+
+### Promote:upload_data_bags
+Uploads all data bage to the chef server
+
+### Promote: constrain_environment
+Given an environment and its environment cookbook, this task edits the environment file and creates cookbook constraints based on the `Berksfile.lock` of the environment cookbook.
+
+### Promote:promote_environment
+Promotes one environment from another environment by copying the cookbook constraints of the source environment to the target (promoted) environment.
+
+## How are version numbers generated?
+Version numbers are based on the last version tag which forms the major and minor version numbers and the number of commits in that tag which forms the build number. The number of commits are calculated from the root of the artifact being versioned. For instance, a cookbook's version would be based on the number of commits performed on all files within the top level directory of the cookbook being versioned.
+
+## Knife Promote
+The knife promote command deploys an environment to production.
+
+```
+knife promote environment [source environment] [target environment]
+```
+
+This command performs the following:
+
+1. Copies the cookbook version constraints from source to target
+2. Commits the constraints to version control
+3. Uploads the target environment to the QA chef server
+4. Downloads all data bags from QA
+5. Performs a version diff on all cookbooks between the target environment and production chef server
+6. Downloads all cookbooks from qa that are not on the prod server
+7. uploads all new cookbooks, the target environment and databags to the production chef server.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clc-promote
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - CenturyLink Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: clc-git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"