monkey_king 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba401a00ad2c74b982115b664aa720eddfd385c3
-  data.tar.gz: f73252403a6856213d29264012d58e213e94afa7
+  metadata.gz: beb82abaa898573f203304c24f512196d2188232
+  data.tar.gz: b303c14f5e6000d5287456d75db0ca2c39570be9
 SHA512:
-  metadata.gz: c096ba127dcf5d3e50329d7be704af6fd7b550e0f150fb9a48673b4def4f7b44ce8f856094790e09f3d30a8919bc3a76d6406e991369b1abbee53938c849b5b8
-  data.tar.gz: 3430a7109bc73e40eebd7a0adc8225817a7ce655ec250797f7ab6c4b8bca34d31af75375f8b71b6cddbd49a15eb1549d513082c5ea03d0b9e6128fc331ff7646
+  metadata.gz: 4a5aabc89c3e9404a0df74936f165f37c3db1c5fcc8dc917a48e18969d6f1b8d163ea3ec249ba43349ed994123a05a3dfadfec84b340ebdd50b1d366d98b7588
+  data.tar.gz: 20c4198faa50e4a02a4ec7949ff32f9f19570b1da17ab3fb24f8b17e83cba75014e5011a8e734539e38b1d5b2188084610cf2d04c076eea6403f644cfa350944

data/README.md

@@ -1,8 +1,63 @@
 # MonkeyKing
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/monkey_king`. To experiment with that code, run `bin/console` for an interactive prompt.
+Monkey king is a tool which is initially designed for generating deployment manifests for a bosh deployment based on an existing deployment, and it could also be used for other purposes like performing functions on keys/values in yaml files based on yaml tags.
+
+
+Here is some scenarios about how it works:
+## Using secret generation
+The `!MK:secret` directive generates a random secret of the same length as the value it replaces.
+BEFORE
+```
+---
+meta:
+  secret: !MK:secret old_secret
+  another_secret: !MK:secret old_secret
+  not_secret: not_secret
+```
+
+AFTER
+```
+---
+meta:
+  secret: !MK:secret new_secret
+  another_secret: !MK:secret new_secret
+  not_secret: not_secret
+```
+
+## Using environment variables
+The `!MK:env:<variable_name>` directive pulls values from environment variables and replaces the tagged keys/values
+
+Given:
+
+```
+export id1=id1_from_env
+export id2=id2_from_env
+```
+
+Before:
+```
+---
+meta1:
+  not_secret: not_secret
+  layer1:
+  - id1: !MK:env:id1 id1_before
+  - layer2:
+    - id2: !MK:env:id2 id2_before
+  - !MK:env:id1 id3: !MK:env:id1 id1_before
+```
+
+After:
+```
+---
+meta1:
+  not_secret: not_secret
+  layer1:
+  - id1: !MK:env:id1 id1_from_env
+  - layer2:
+    - id2: !MK:env:id2 id2_from_env
+  - !MK:env:id1 id1_from_env: !MK:env:id1 id1_from_env
+```
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -21,8 +76,54 @@ Or install it yourself as:
     $ gem install monkey_king
 
 ## Usage
+```
+$ mk help
+Commands:
+  help [COMMAND]   	Help!
+  clone REPO DIR...	Clone the repo and replace secret and env annotation
+  replace GLOBS... 	Replace secret and env annotation for existing directory
+```
+```
+$ mk help clone
+Clone the repo and replace secret and env annotation
 
-TODO: Write usage instructions here
+Usage: clone REPO DIR...
+
+Options:
+      --dir DIR
+      --repo REPO
+```
+```
+$ mk help replace
+Replace secret and env annotation for existing directory
+
+Usage: replace GLOBS...
+
+Options:
+      --globs GLOBS
+```
+
+Example 1: clone the repo and replace all the manifest under bosh-init directory.
+
+```
+$ mk clone --repo git@github.com:[USERNAME]/[DEPLOYMENT].git bosh-init
+Cloning into '[DEPLOYMENT]'...
+remote: Counting objects: 346, done.
+remote: Total 346 (delta 0), reused 0 (delta 0), pack-reused 346
+Receiving objects: 100% (346/346), 179.86 KiB | 0 bytes/s, done.
+Resolving deltas: 100% (157/157), done.
+Checking connectivity... done.
+Transforming [DEPLOYMENT]/bosh-init/bosh-init.yml...
+Done.
+```
+
+Example 2: replace all the manifest under bosh-init directory.
+
+```
+$ mk replace deployment0/bosh-init/*.yml
+Transforming deployment0/bosh-init/bosh-init.yml...
+Done.
+```
 
 ## Development
 

data/lib/monkey_king/clone_command.rb

@@ -6,10 +6,10 @@ module MonkeyKing
 
     desc "Clone the repo and replace secret and env annotation"
     input :repo, :argument => true
-    input :dir, :argument => :splat
+    input :dir, :argument => [:splat, true]
     def clone
       repo = input[:repo]
-      sub_dir = input[:dir]
+      sub_dir = Array(input[:dir])
 
       directory = repo.split('/').last.split('.').first
       parser = MonkeyKing::Parser.new
@@ -28,13 +28,17 @@ module MonkeyKing
           overwrite_file.write transformed_content
         end
       end
+      puts "Done."
     end
 
-    desc "Clone the repo and replace secret and env annotation"
+    desc "Replace secret and env annotation for existing directory"
     input :globs, :argument => :splat
     def replace
       globs = input[:globs]
       parser = MonkeyKing::Parser.new
+      if globs.empty?
+        raise 'no globs given in the argument'
+      end
 
       deployment_yaml_files = []
       deployment_yaml_files += Dir.glob(globs)
@@ -51,6 +55,7 @@ module MonkeyKing
           puts "skipping non-yaml file #{file}..."
         end
       end
+      puts "Done."
     end
 
   end

data/lib/monkey_king/version.rb

@@ -1,3 +1,3 @@
 module MonkeyKing
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monkey_king
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - cloudops_hosted
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mothership