puppet-runner 0.0.21 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 255f8a295029af51ad19f6b7eaedaed8d84c23443e113a71d377e2ec619e4cef
-  data.tar.gz: 21d692bf0b338f1f4e53e74a675131843e1206cdc0dc7c19c08268cc7ac77eeb
+  metadata.gz: c99b584c8b2e9bb6b81e8d8d2f1f9d28c693450fce0bef5fde9e54438a3cde5e
+  data.tar.gz: cc2d7f9e9aa0fa5469e8b4972f21cb8a82327260fa313dd103dcaff9c2884add
 SHA512:
-  metadata.gz: 04c85a270ffedc2ff99e77c264dbb807b22cba02d0b87cd42359323d1793b440d9d145722beb26e3129ed1c62bf2154f7a5153d3c46fcd48e8c7327e25144261
-  data.tar.gz: ebb4ab20384b64d3420721fe031a0edad4e230eeeafc22719790ab842b496e2abef9ee32218a0a18635942bb201f6638d09efb92ef85bf19c4dcf218a9f1944c
+  metadata.gz: 327eafe7227662b5d00ddcc2d34d0fa72c8d3f44f69c01f92139293651ea707f9b9d2565ab69ed7642be49ff34c2908807f66dbebf1fdcf480cdba047735f5a6
+  data.tar.gz: a6d3c97286d790c3336e123dd53a55672b2c1afcf42805d016ed76fed4b13ef935c5d7b4bced1d3916eb228254cbc38598cba1e36ce715d19d783ef72b776d56

data/README.md

@@ -8,7 +8,7 @@ Executable gem that composes hiera configuration and facts and execute puppet ap
 
 ## Usage
 
-*  puppet-runner (prepare|all) [-c CONFIG_DIR] [-t TEMPLATES] [-d DESTINATION_DIR] [-f FACTS_DEST] [-s SERVERNAME] [-r PUPPETFILE_CONFIG] [-o PUPPETFILE_OUTPUT_PATH] [-e EYAML_KEY_PATH]
+*  puppet-runner (prepare|all) [-c CONFIG_DIR] [-t TEMPLATES] [-d DESTINATION_DIR] [-f FACTS_DEST] [-s SERVERNAME] [-r PUPPETFILE_CONFIG] [-o PUPPETFILE_OUTPUT_PATH] [-e EYAML_KEY_PATH] [-x CUSTOM_FACTS_DIR]
 *  puppet-runner start [-p PUPPET_APPLY]
 *  puppet-runner -h | --help
 
@@ -416,11 +416,16 @@ Path to output Puppetfile.
 *  -d DESTINATION_DIR --dest_dir DESTINATION_DIR   Directory for result hiera config.
 *  -t TEMPLATES --templates TEMPLATES              Directory containing templates and defaults folder with functionality templates and default facts
 *  -f FACTS_DEST --facts_dest_dir FACTS_DEST       Destination directory to store result facts
+*  -x CUSTOM_FACTS_DIR --custom_facts_dir CUSTOM_FACTS_DIR                   Directory containing yaml files with custom facts that will be merged with ones from <hostname>_facts.yaml, custom facts can overwrite them 
 *  -r PUPPETFILE_CONFIG --puppetfile_config puppetfile_config                Puppetfile composition config file
 *  -o PUPPETFILE_OUTPUT_PATH --puppetfile_output_path PUPPETFILE_OUTPUT_PATH Result Puppetfile path
 *  -e EYAML_KEY_PATH --eyaml_key_pair EYAML_KEY_PATH                         Path to eyaml encryption key pair
 *  -p PUPPET_APPLY --puppet_apply PUPPET_APPLY                               Custom puppet apply command to run
 *    -k --keep-facts                                                        Flag to keep the encrypted facts file in /tmp for analysis
+*  -n --dry-run                                                              Flag to indicate puppet should run in dry run mode (--noop), this also sets the verbose flag to true
+*  -v --verbose                                                              Flag to indicate that all output from puppet apply should be displayed instead of just stdout
+Commands:
+
 
 Commands:
 

data/bin/puppet-runner

@@ -27,8 +27,8 @@ doc = <<DOCOPT
 Adaptavist puppet runner
 
 Usage:
-  puppet-runner (prepare|all) [-c CONFIG_DIR] [-t TEMPLATES] [-d DESTINATION_DIR] [-f FACTS_DEST] [-s SERVERNAME] [-p PUPPET_APPLY] [-r PUPPETFILE_CONFIG] [-o PUPPETFILE_OUTPUT_PATH] [-e EYAML_KEY_PATH] [-k]
-  puppet-runner start [-p PUPPET_APPLY]
+  puppet-runner (prepare|all) [-c CONFIG_DIR] [-t TEMPLATES] [-d DESTINATION_DIR] [-f FACTS_DEST] [-s SERVERNAME] [-p PUPPET_APPLY] [-r PUPPETFILE_CONFIG] [-o PUPPETFILE_OUTPUT_PATH] [-e EYAML_KEY_PATH] [-m MODULE_PATH] [-x CUSTOM_FACTS_DIR] [-k] [-n] [-v]
+  puppet-runner start [-p PUPPET_APPLY] [-m MODULE_PATH] [-n] [-v]
   puppet-runner -h | --help
 
 Options:
@@ -38,11 +38,15 @@ Options:
   -d DESTINATION_DIR --dest_dir DESTINATION_DIR                             Directory for result hiera config.
   -t TEMPLATES --templates TEMPLATES                                        Directory containing templates and defaults folder with functionality templates and default facts
   -f FACTS_DEST --facts_dest_dir FACTS_DEST                                 Destination directory to store result facts
+  -x CUSTOM_FACTS_DIR --custom_facts_dir CUSTOM_FACTS_DIR                   Directory containing yaml files with custom facts that will be merged with ones from <hostname>_facts.yaml, custom facts can overwrite them 
+  -m MODULE_PATH --module_path MODULE_PATH                                  Path to find puppet modules, can be colon (:) delimited
   -p PUPPET_APPLY --puppet_apply PUPPET_APPLY                               Custom puppet apply command to run
   -r PUPPETFILE_CONFIG --puppetfile_config puppetfile_config                Puppetfile composition config file
   -o PUPPETFILE_OUTPUT_PATH --puppetfile_output_path PUPPETFILE_OUTPUT_PATH Result Puppetfile path
   -e EYAML_KEY_PATH --eyaml_key_path EYAML_KEY_PATH                         Path to eyaml encryption key pair
   -k --keep-facts                                                           Flag to keep the encrypted facts file in /tmp for analysis
+  -n --dry-run                                                              Flag to indicate puppet should run in dry run mode (--noop), this also sets the verbose flag to true
+  -v --verbose                                                              Flag to indicate that all output from puppet apply should be displayed instead of just stdout
 Commands:
   all           Runs the following commands prepare, start 
   start         Runs puppet apply 
@@ -149,6 +153,7 @@ if options['all'] || options['prepare']
     input_dir = options["--config_dir"] || options["-c"] 
     dest_dir = options["--dest_dir"] || options["-d"]
     facts_dest_dir = options["--facts_dest_dir"] || options["-f"]
+    custom_facts_dir = options["--custom_facts_dir"] || options["-x"] || nil
     templates = options["--templates"] || options["-t"]
     puppetfile_config_path = options["--puppetfile_config"] || options["-r"]
     puppetfile_output_path = options["--puppetfile_output_path"] || options["-o"]
@@ -156,6 +161,7 @@ if options['all'] || options['prepare']
     hostname = options["--servername"] || options["-s"] || Facter.value("hostname")
     puts "Hostname #{hostname}"
     keep_facts = true if options["-k"] or options["--keep-facts"]
+    
 
     config_file_path = path_join_glob(input_dir, hostname+".yaml")
     templates_dir = path_join_glob(templates, "templates")
@@ -349,8 +355,19 @@ if options['all'] || options['prepare']
           end
         end
 
+        # merge custom facts if parameter provided
+        custom_facts_all = {}
+        if (custom_facts_dir)
+          Dir.glob("#{custom_facts_dir}/*.yaml").sort.each do |custom_facts_file|
+            custom_facts_from_file = YAML.load_file(custom_facts_file) || {}
+            custom_facts_all.merge!(custom_facts_from_file)
+          end
+        end
+        # merge, prefer custom facts
+        merged_all_facts = YAML.load(output_result_default_facts).merge!(custom_facts_all)
+
         # write the temp encrypted facts file
-        output_file.write(output_result_default_facts)
+        output_file.write(merged_all_facts.to_yaml)
 
         # now that the merged final facts are present look for any global transformations to apply 
         # global transformations are currently either booleans that need to be expressed directly in 
@@ -437,7 +454,6 @@ if options['all'] || options['prepare']
               end
             }
         end
-
         output_file.write(decrypted.join)
       end
 
@@ -492,10 +508,33 @@ end
 # start puppet
 if (options['start'] || options['all']) && !stop_apply
     require 'puppet'
-    modulefile_definition = Gem::Version.new(Puppet.version) > Gem::Version.new('4.0.0') ? '--modulepath /etc/puppet/modules' : ''
-    puppet_command = "sudo su -c 'source /usr/local/rvm/scripts/rvm; puppet apply /etc/puppet/manifests/site.pp --confdir=/etc/puppet  --verbose --detailed-exitcodes #{modulefile_definition}'"
+
+    #  set dry run option if the flag has been set
+    if options["-n"] or options["--dry-run"]
+      dry_run = '--noop'
+      verbose_output = true
+    else
+      dry_run = ''
+    end
+
+    # if the user has specified a module path pass it to puppet
+    if options["--module_path"]
+      modulefile_definition = "--modulepath #{options['--module_path']}"
+    elsif options["-m"]
+      modulefile_definition = "--modulepath #{options['-m']}"
+    # if no modulepath has been set default to /etc/puppet/modules for puppet 4 and above and blank for older versions 
+    else
+      modulefile_definition = Gem::Version.new(Puppet.version) > Gem::Version.new('4.0.0') ? '--modulepath /etc/puppet/modules' : ''
+    end
+
+    # construct defaut puppet apply command
+    puppet_command = "sudo su -c 'source /usr/local/rvm/scripts/rvm; puppet apply #{dry_run} /etc/puppet/manifests/site.pp --confdir=/etc/puppet  --verbose --detailed-exitcodes #{modulefile_definition}'"
+    
+    # if a custom puppet apply command has been set use if, otherwise use the default generated above
     to_execute = options["--puppet_apply"] || options["-p"] || puppet_command
     debug "Running #{to_execute}"
+    
+    # execute puppet apply and capture return code
     `#{to_execute}`
     exit_code = $?.exitstatus
 
@@ -514,7 +553,11 @@ if (options['start'] || options['all']) && !stop_apply
       warning "Unable to locate Facts file, please urgently locate and remove this as it holds unencrypted values"
     end
 
-    if exit_code != 2
+    # if we see a bad exit code report it, for refrerence good codes are:
+    # 0: The run succeeded with no changes or failures; the system was already in the desired state.
+    # 2: The run succeeded, and some resources were changed.
+    if exit_code != 2 and exit_code != 0
       raise "execute_puppet exit status: #{exit_code}"
     end
 end
+

data/puppet-runner.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "puppet-runner"
-  spec.version       = "0.0.21"
+  spec.version       = "0.0.25"
   spec.authors       = ["Martin Brehovsky", "Matthew Hope"]
   spec.email         = ["mbrehovsky@adaptavist.com"]
   spec.summary       = %q{Preprocessor for hiera config}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-runner
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.25
 platform: ruby
 authors:
 - Martin Brehovsky
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Preprocessor for hiera config