knife-sharp 0.4.1 → 0.4.2

data/README.md

@@ -2,13 +2,14 @@
 
 knife-sharp adds several handy features to knife, adapted to our workflow @ Fotolia.
 Features:
-* align : sync data bags, roles and cookbook versions between a local git branches and a chef server
+* align : sync data bags, roles and cookbook versions between a local git branch and a chef server
 * backup : dump environments, roles and data bags to local json files
 * server : switch between chef servers using multiple knife.rb config files
 
 # Tell me more
 
-When you want an environment to reflect a given branch you have to check by hand (or using our consistency plugin), and some mistakes can be made. This plugin aims to help to push the right version into an environment.
+When you want an environment to reflect a given branch you have to check by hand (or using our consistency plugin), and some mistakes can be made.
+This plugin aims to help to push the right version into an environment.
 
 It also allows to adopt a review workflow for main chef components :
 * Track data bags, roles (as JSON files) and cookbooks in your Chef git repository
@@ -21,48 +22,91 @@ It also allows to adopt a review workflow for main chef components :
 
 <pre>
 $ git branch
-...
+[...]
+* ldap
 master
-* syslog_double
-...
-$ knife environment show sandboxnico
+[...]
+
+$ knife environment show production
 chef_type:            environment
 cookbook_versions:
-...
-  syslog:  0.0.16
-...
-$ knife sharp align syslog_double sandboxnico
-
-Will change in environment sandboxnico :
-* syslog gets version 0.0.17
-Upload and set version into environment sandboxnico ? Y/N
-Y
-Successfull upload for syslog
-Aligning 1 cookbooks
-Aligning data bags
-* infrastructure/mail data bag item is not up-to-date
-Update infrastructure/mail data bag item on server ? Y/N/(A)ll/(Q)uit [N] n
-* Skipping infrastructure/mail data bag item
-Aligning roles
-* Dev_Server role is not up-to-date (run list)
-Update Dev_Server role on server ? Y/N/(A)ll/(Q)uit [N] n
-* Skipping Dev_Server role
+[...]
+  apache:  0.0.6
+  ldap:  0.0.3
+[...]
+
+$ knife sharp align ldap production
+== Cookbooks ==
+* ldap is not up-to-date (local: 0.0.4/remote: 0.0.3)
+* apache is not up-to-date (local: 0.0.7/remote: 0.0.6)
+> Update ldap cookbook to 0.0.4 on server ? Y/N/(A)ll/(Q)uit [N] y
+> Update apache cookbook to 0.0.4 on server ? Y/N/(A)ll/(Q)uit [N] y
+== Data bags ==
+* infrastructure/services data bag item is not up-to-date
+* Skipping infrastructure/services data bag (ignore list)
+* Data bags are up-to-date.
+== Roles ==
+* Roles are up-to-date.
+> Proceed ? (Y/N) y
+* Uploading cookbook(s) ldap, apache
+* Bumping ldap to 0.0.4 for environment production
+* Bumping apache to 0.0.7 for environment production
 </pre>
 
 Then we can check environment :
 
 <pre>
-$ knife environment show sandboxnico
+$ knife environment show production
 chef_type:            environment
 cookbook_versions:
-...
-  syslog:  0.0.17
-...
-$ knife sharp align syslog_double sandboxnico
-Nothing to do : sandboxnico has same versions as syslog_double
+[...]
+  apache:  0.0.7
+  ldap:  0.0.4
+[...]
+
+$ knife sharp align ldap production
+== Cookbooks ==
+* Environment production is up-to-date.
+[...]
 </pre>
 
-It will upload the cookbooks (to ensure they meet the one on the branch you're working on) and will set the version to the required number.
+Cookbooks, data_bags and roles are uploaded, and cookbook versions updated in given environment.
+
+To use all of these features, your knife.rb(s) must provide paths for cookbooks, data bags and roles (see [configuration](#Configuration))
+
+### Ignore list
+
+In a "multi chef server" environment (e.g development/production), you might want to ignore some updates on a given chef server, for instance:
+  * not uploading a test cookbook on your production server
+  * not updating DNS domain with production's one on your dev server
+  * avoid overriding data you are currently working on
+
+Those items can be specified in sharp config file:
+```yaml
+prod: # chef server name, knife-prod.rb client config
+  ignore_cookbooks: [ tests ]
+
+dev:
+  ignore_databags: [ infrastructure/dns ]
+  ignore_roles: [ webserver ]
+```
+
+(more in [sharp-config](ext/sharp-config.yml))
+
+### Downgrading cookbook versions
+
+By default, `knife sharp align` will only try to upgrade cookbook (e.g local version > server version)
+It is possible to allow downgrading using `--force-align` (`-f`) command line switch.
+
+Example:
+<pre>
+knife sharp align master production -f
+On server dev
+== Cookbooks ==
+* syslog is to be downgraded (local: 0.0.44/remote: 0.0.45)
+* sudo is to be downgraded (local: 0.0.8/remote: 0.0.9)
+[...]
+</pre>
 
 ## Backup
 
@@ -137,25 +181,33 @@ The plugin will search in 2 places for its config file :
 
 An example config file is provided in ext/.
 
-A working knife setup is also required (cookbook/role/data bag paths depending on the desired features)
+A working knife setup is also required (cookbook/role/data bag paths depending on the desired features).
+
+Fully enabled Sharp needs:
+```ruby
+cookbook_path            '/home/jamiez/chef/cookbooks'
+data_bag_path            '/home/jamiez/chef/data_bags'
+role_path                '/home/jamiez/chef/roles'
+```
+in knife.rb
 
 ## Cookbooks path & git
 If your cookbook_path is not the root of your git directory then the grit gem will produce an error. This can be circumvented by adding the following directive in your config file :
 
-<pre>
+```yaml
 global:
   git_cookbook_path: "/home/nico/sysadmin/chef/"
-</pre>
+```
 
 As we version more than the cookbooks in the repo.
 
 ## Logging
 It's good to have things logged. The plugin can do it for you. Add this to your config file
-<pre>
+```yaml
 logging:
   enabled: true
   destination: "~/.chef/sharp.log"
-</pre>
+```
 
 It will log uploads, bumps and databags to the standard logger format.
 
@@ -163,12 +215,12 @@ It will log uploads, bumps and databags to the standard logger format.
 
 want a completion on changing servers ?
 
-<pre>
+```sh
 alias kss="knife sharp server"
 
 function knife_servers { reply=($(ls .chef/knife-*.rb | sed -r 's/.*knife-([a-zA-Z0-9]+)\.rb/\1/' )); }
 compctl -K knife_servers kss
-</pre>
+```
 
 # Credits
 

data/ext/sharp-config.yml

@@ -20,8 +20,10 @@ notification:
 
 # ignore cookbooks/data bags/roles depending on chef server
 # key is the name of your server (in a knife sharp server sense)
-sandboxnico:
+production:
   ignore_cookbooks: [ tests ]
+
+sandboxnico:
   ignore_databags: [ staff/admin, infrastructure/mail ]
   ignore_roles: [ webserver ]
 

data/lib/chef/knife/sharp-align.rb

@@ -14,6 +14,12 @@ module KnifeSharp
         :default => false
     end
 
+    option :force_align,
+      :short => "-f",
+      :long => "--force-align",
+      :description => "force local cookbook versions, allow downgrade",
+      :default => false
+
     option :dump_remote_only,
       :short => "-B",
       :long => "--dump-remote-only",
@@ -149,6 +155,9 @@ module KnifeSharp
         if Chef::VersionConstraint.new("> #{remote_versions[cb]}").include?(local_versions[cb])
           updated_versions[cb] = local_versions[cb]
           ui.msg "* #{cb} is not up-to-date (local: #{local_versions[cb]}/remote: #{remote_versions[cb]})"
+        elsif Chef::VersionConstraint.new("> #{local_versions[cb]}").include?(remote_versions[cb]) and config[:force_align]
+          updated_versions[cb] = local_versions[cb]
+          ui.msg "* #{cb} is to be downgraded (local: #{local_versions[cb]}/remote: #{remote_versions[cb]})"
         end
       end
 

data/lib/knife-sharp.rb

@@ -1,3 +1,3 @@
 module KnifeSharp
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-sharp
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef