vagrant-flow 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d12223aa802b6bc1cb214ed04de5b5663f78c5
-  data.tar.gz: c0eed0a83ea084a0df6d2b10e44a209205a715d8
+  metadata.gz: 987d348d2383b329ac2e6d646ffb9a84da357da2
+  data.tar.gz: 11aaca9f68aa6db12f372e3eb92c29c1c8fd6395
 SHA512:
-  metadata.gz: 4e1f371af3f7581d71fdb5c2cb597ad6063375eeb05df6381fbfe2ebbf713a77284c06d6c373e63d3f215de4ebfe35e85e9098c2fd441ee0892bc565842b05cc
-  data.tar.gz: d7cd6f083e7bb8f7a9e75ab4a2d5a5cb99baca2b081453fb026d2e3076b00ca10ab131dc2fbb7877c5492fcd65f5a0bb0c1589c4b69de8edb61a9bf9ff179b07
+  metadata.gz: 4c335c7777a4c0f1684b3dbda635c78b14877aa679754d2fffdc2a672c9f9285d57611ea019090597165ff0cbc136e4e15d8c8d75e5893700a3009d064170aa5
+  data.tar.gz: 21e55b67a680606edccfbe4cb57e7dbf8735eac405117de095fadeae97f0e46b443c3f7522e7955b7dda7db11d63ac7a4bbb58452760b691d18b39e79cd3269e

data/README.md

@@ -24,18 +24,66 @@ Or install it yourself as:
 
 ## Usage
 ```
+Usage: vagrant ansible-inventory [-hgpq]
+This plugin looks for groupconfig.yml as the default configuration
+Do not use -p and -g options together!
+
+    -g, --group_config_file FILEPATH (Optional) YAML file containing group config
+    -p, --vagrantfileparse           (Optional) Read in the VAGRANTFILE's ansible group config
+    -q, --quiet                      (Optional) Suppress output to STDOUT and STDERR
+    -h, --help                       (Optional) Print this help
+```
+
+## Example usages
+This will look for a file in the pwd named groupconfig.yml and attempt to make the inventory
+```
+vagrant ansible-inventory
+```
+
+
+
+This will look for a file in the pwd named myOwnGroupConfig.yml and attempt to make the inventory
+```
+vagrant ansible-inventory -g myOwnGroupConfig.yml
+```
+
+
+
+This will parse the vagrant file for ansible group configs
+```
+vagrant ansible-inventory -p
+```
+
+
+
+
+
+## Use case
+```
 #Bring up your vagrant machines
 vagrant up
-#Run ansible inventory
+#Run ansible inventory (this assumes the file groupconfig.yml exists)
 vagrant ansible-inventory
 #point ansible-playbook to the generated vagrant-flow_ansible_inventory, and point them to whatever playbook you'd like
 ansible-playbook -i path/to/vagrant-flow_ansible_inventory my_playbook.yml
 ```
 ## Usage Expectations
+#### Don't mix the -p and -g options.  Unexpected things will happen.
 
-This plugin expects your vagrantfile to contain a configuration to define groups for all your VMs.  
+Example groupconfig.yml file (for use with no optional command line arguments or  by pointing to non-default file with -g option)
+```
+---
+common:children:
+- testgroup
+- servergroup
+testgroup:
+- testbox
+servergroup:
+- server1
+- server2
+```
 
-Example VAGRANTFILE excerpt:
+Example VAGRANTFILE excerpt (for use with -p option):
 ```
 config.vm.provision "ansible" do |ansible|
     #ansible.playbook is required, but emptyplaybook.yml can do nothing, 
@@ -49,7 +97,7 @@ config.vm.provision "ansible" do |ansible|
   end
 ```
 
-Example playbook.yml:
+Example playbook.yml to use after ansible-inventory has run with command `ansible-playbook -i vagrant-flow_ansible_inventory playbook.yml`:
 ```
 ---
   #Configures the groups defined in common:children

data/create_sample_ansible-inventory_input-file.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+
+
+
+###This shows how to make a valid configuration file in YAML format for vagrant-flow to consume with the ansible-inventory command
+
+x = {
+ "common:children"=>["jenkins","server"],
+ "jenkins"=>["jenkinsdp"],
+ "server"=>["sparkngin1","sparkngin2"],
+}
+
+begin
+  File.open('groupconfig.yml', 'w') {|f| f.write x.to_yaml }
+rescue
+  warn "Could not write file groupconfig.yml"
+end
+
+y = YAML.load(x.to_yaml)
+
+y.each {|key,value|
+  puts key
+  puts value
+  puts "\n"
+}
+

data/lib/vagrant-flow/command.rb

@@ -1,5 +1,6 @@
 require 'optparse'
 require "vagrant"
+require "yaml"
 
 module VagrantPlugins
   module VagrantFlow
@@ -19,28 +20,37 @@ module VagrantPlugins
         machines_configs = {}
         inventory_configs = {}
         
+        default_group_config_file = "groupconfig.yml"
         options = {}
         options[:destroy_on_error] = true
         options[:parallel] = false
         options[:provision_ignore_sentinel] = false
-
+        options[:quiet] = false
+        
+        #Setting to read in a file other than default_group_config_File
+        options[:custom_config_file] = false
+        #Setting to parse the VAGRANTFILE's ansible group config
+        options[:vagrantFileAnsibleConfig] = false
+        
+        #Parse option, look up OptionParser documentation 
         opts = OptionParser.new do |o|
           # o.banner = "Usage: vagrant ansible-inventory [vm-name] [options] [-h]"
-          o.banner = "Usage: vagrant ansible-inventory [-h]"
+          o.banner = "A NeverWinterDP technology from the Department of Badass.\n\n"+
+                      "Usage: vagrant ansible-inventory [-hgpq]\nThis looks for groupconfig.yml as the default configuration\n"+
+                      "Do not use -p and -g options together!"
           o.separator ""
-
-          # Don't use either of these, just keeping them here as examples of what options are possible 
-          #o.on("--provision-with x,y,z", Array,
-          #        "Enable only certain provisioners, by type.") do |list|
-          #  options[:provision_types] = list.map { |type| type.to_sym }
-          #end
+          o.on("-g", "--group_config_file FILEPATH", "(Optional) YAML file containing group config") do |f|
+            options[:custom_config_file] = f        
+          end
+          
+          o.on("-p", "--vagrantfileparse", "(Optional) Read in the VAGRANTFILE's ansible group config") do |f|
+            options[:vagrantFileAnsibleConfig] = true
+          end
+          
+          o.on("-q", "--quiet", "(Optional) Suppress output to STDOUT and STDERR") do |f|
+            options[:quiet] = true
+          end
           
-          # This option isn't used.
-          #o.on("--[no-]parallel",
-          #     "Enable or disable parallelism if provider supports it.") do |parallel|
-          #  options[:parallel] = parallel
-          #end
-
         end
 
         # Parse the options # Builtin from the Command Class
@@ -48,6 +58,8 @@ module VagrantPlugins
         # Automatically detects -h for help
         argv = parse_options(opts)
         return if !argv
+        
+        
 
         # The following are already setup by the parent class
         # @env
@@ -56,10 +68,11 @@ module VagrantPlugins
 
         # Go over each VM and bring it up
         @logger.debug("'ansible-inventory' created for the whole env")
-
         
+        #Initialize group_machines, the has containing group=>machinename configs
+        group_machines={}
         
-        provisioners = {}
+        #Get info about the vagrant boxes
         with_target_vms(argv, :provider => options[:provider]) do |machine|
           # @env.ui
           # output methods: :ask, :detail, :warn, :error, :info, :output, :success
@@ -79,9 +92,6 @@ module VagrantPlugins
           }
           # Outputs to the stdout
           
-          #The provisioning information from teh vagrant file, this will contain our defined ansible groups
-          provisioners = machine.config.vm.provisioners
-          
           inventory_configs = {
             :vagrant_file_dir => machine.env.root_path,
             :vagrant_flow_file => machine.env.root_path.join("vagrant-flow_ansible_inventory")
@@ -90,6 +100,43 @@ module VagrantPlugins
           machines_configs[variables[:host_key]]= variables
         end
         
+        #Hash containing group/machine configuration
+        group_machines={}
+        #Determine group_machines based on what config options are passed in
+        #Read in config from vagrantfile's ansible config
+        if options[:vagrantFileAnsibleConfig] == true
+          provisioners = []
+          with_target_vms(argv, :provider => options[:provider]) do |machine|
+            #The provisioning information from teh vagrant file, this will contain our defined ansible groups
+            #Concatenate all the provisioner configs together
+            if machine.config.vm.provisioners
+              provisioners.concat(machine.config.vm.provisioners)
+            end
+          end
+          #Since Vagrant machines will likely contain the same configs,
+          #Merge the config together to remove duplicate entries in our
+          #group/machine configuration
+          provisioners.each {|prov|
+            group_machines = group_machines.merge(prov.config.groups)
+          }
+        #Read in config from yaml file
+        else
+          #Use config option if specified
+          if options[:custom_config_file] != false
+              default_group_config_file = options[:custom_config_file]
+          end
+          begin
+            #Load YAML
+            group_machines = YAML.load_file(default_group_config_file)
+          rescue
+            #Give warning if no file could be found
+            if not options[:quiet]
+              warn "Could not open file: "+default_group_config_file.to_s
+            end
+          end
+        end
+        
+        
         
         # Outputs to the stdout
         # @env.ui.info(machine.name)
@@ -120,33 +167,43 @@ module VagrantPlugins
         #PP.pp(outputs)
         #puts "\n\n"
         
+        
+        
         inventory_configs[:vagrant_flow_file].open('w') do |file|
           header_txt="# Generated by vagrant-flow, part of NeverwinterDP\n\n"
-          safe_puts(header_txt)
+          if not options[:quiet]
+            safe_puts(header_txt)
+          end
           file.write(header_txt)
           
           #Now we maps from our VAGRANTFILE defined groups in our provisioners.config.groups
           #To our configuration strings we got from outputs
-          provisioners.each do |prov|
-            prov.config.groups.each do |groupname,machines|
+          group_machines.each do |groupname,machines|
+            if not options[:quiet]
               puts "["+groupname+"]\n"
-              file.write "["+groupname+"]\n"
-              machines.each do |machinename|
-                #if we match :children, then we have an ansible config that's
-                #pointing to another group, not a specific machine
-                if /:children/.match(groupname)
+            end
+            file.write "["+groupname+"]\n"
+            machines.each do |machinename|
+              #if we match :children, then we have an ansible config that's
+              #pointing to another group, not a specific machine
+              if /:children/.match(groupname)
+                if not options[:quiet]
                   puts machinename
-                  file.write machinename+"\n"
-                else
+                end
+                file.write machinename+"\n"
+              else
+                if not options[:quiet]
                   puts outputs[machinename.to_sym]+"\n"
-                  file.write outputs[machinename.to_sym]+"\n"
                 end
+                file.write outputs[machinename.to_sym]+"\n"
               end
+            end
+            if not options[:quiet]
               puts "\n"
-              file.write "\n"
-            end    
-          end          
-        end
+            end
+            file.write "\n"
+          end    
+        end          
         0
       end # End Execute
       

data/lib/vagrant-flow/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module VagrantFlow
-    VERSION = "1.0.6"
+    VERSION = "1.0.7"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-flow
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Steve Morin
@@ -50,6 +50,7 @@ files:
 - NEVERWINTERDP
 - README.md
 - Rakefile
+- create_sample_ansible-inventory_input-file.rb
 - lib/vagrant-flow.rb
 - lib/vagrant-flow/command.rb
 - lib/vagrant-flow/plugin.rb