elevage 0.1.0 → 0.1.2

data/lib/elevage/platform.rb

@@ -5,6 +5,8 @@ require 'English'
 
 module Elevage
   # Platform class
+  #
+  # This represents the overall description of the platform
   class Platform
     attr_accessor :name, :description
     attr_accessor :environments
@@ -17,6 +19,9 @@ module Elevage
     attr_accessor :compute
 
     # rubocop:disable MethodLength
+
+    # Create a new platform object
+    # @return [Elevage::Platform]
     def initialize
       fail unless platform_files_exists?
       platform = YAML.load_file(YML_PLATFORM).fetch('platform')
@@ -34,6 +39,9 @@ module Elevage
     # rubocop:enable MethodLength
 
     # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity, AmbiguousOperator
+
+    # Determine whether the platform definition is considered correct
+    # return [Boolean]
     def healthy?
       health = ''
       # Array of string checked for empty values
@@ -60,7 +68,7 @@ module Elevage
         health += MSG[:invalid_destfolder] if v['destfolder'].nil?
         health += MSG[:invalid_appendenv] unless v['appendenv'] == true || v['appendenv'] == false
         health += MSG[:invalid_appenddomain] unless v['appenddomain'] == true || v['appenddomain'] == false
-        health += MSG[:empty_datastores] unless v['datastores'].all?
+        health += MSG[:empty_datastores] if v['datastore'].nil?
         health += MSG[:invalid_domain] if v['domain'].nil?
         v['dnsips'].each { |ip| health += MSG[:invalid_ip] unless Resolv::IPv4::Regex.match(ip) }
       end
@@ -85,8 +93,8 @@ module Elevage
 
     private
 
-    # Private: confirms existence of the standard platform definition files
-    # Returns true if all standard files present
+    # Confirm existence of the standard platform definition files
+    # @return [Boolean] True if all standard files present
     def platform_files_exists?
       fail(IOError, ERR[:no_platform_file]) unless File.file?(YML_PLATFORM)
       fail(IOError, ERR[:no_vcenter_file]) unless File.file?(YML_VCENTER)

data/lib/elevage/provisioner.rb

@@ -5,7 +5,10 @@ require_relative 'platform'
 require_relative 'provisionerrunqueue'
 
 module Elevage
-  # Provisioner class
+  # rubocop:disable ClassLength
+
+  # Provisioner is responsible for the actual execution of the commands to
+  # create the requested virtual machine.
   class Provisioner
     attr_accessor :name
     attr_accessor :component
@@ -13,7 +16,14 @@ module Elevage
     attr_accessor :environment
     attr_accessor :vcenter
 
-    # Set us up to build the specified instance of component
+    # Create the Provisioner object for the requested virtual machine
+    # @param [String] name Name of the node to create
+    # @param [String] component Name of the platform component node is part of
+    # @param [String] instance Number representing which instance of
+    # `component` this node is
+    # @param [String] environment Name of the environnment we're provisioning to
+    # @param [String] options Thor `options` hash
+    # @return [Elevage::Provisioner]
     def initialize(name, component, instance, environment, options)
       @name = name
       @component = component
@@ -23,6 +33,8 @@ module Elevage
       @vcenter = @environment.vcenter
     end
 
+    # Stringify the Provisioner
+    # @return [String]
     def to_s
       puts "Name: #{@name}"
       puts "Instance: #{@instance}"
@@ -32,8 +44,9 @@ module Elevage
       puts @environment.to_yaml
     end
 
-    # Public: Build the node
-    # rubocop:disable MethodLength, LineLength, GlobalVars, CyclomaticComplexity
+    # rubocop:disable MethodLength, CyclomaticComplexity
+
+    # Build the the virtual machine
     def build
       knife_cmd = generate_knife_cmd
 
@@ -60,12 +73,18 @@ module Elevage
         # err_thread = Thread.new do
         Thread.new do
           while (line = stderr.gets)
-            sem.synchronize { logfile.puts line }
+            sem.synchronize do
+              logfile.puts line
+              logfile.sync
+            end
           end
         end
         out_thread = Thread.new do
           while (line = stdout.gets)
-            sem.synchronize { logfile.puts line }
+            sem.synchronize do
+              logfile.puts line
+              logfile.sync
+            end
           end
         end
         out_thread.join
@@ -80,22 +99,41 @@ module Elevage
       # exit status is a failure, and the details will be in the logfile
       status.exitstatus == 0 ? true : false
     end
-    # rubocop:enable MethodLength, LineLength, GlobalVars, CyclomaticComplexity
+    # rubocop:enable MethodLength, CyclomaticComplexity
 
     private
 
-    # Private: Determine which datastore to use for this specific
-    # provisioning.
+    # rubocop:disable LineLength
+
+    # Private
+    #
+    # Determine which datastore to use for this specific provisioning.
+    # @return [String] Name of datastore
     def select_datastore
-      if @options['dry-run']
-        @vcenter['datastores'][0]
-      else
-        @vcenter['datastores'][rand(@vcenter['datastores'].count)]
-      end
+      knife_cmd = 'knife vsphere datastore maxfree --vsinsecure'
+
+      # Authentication and host
+      knife_cmd << " --vsuser #{@options[:vsuser]}"
+      knife_cmd << " --vspass #{@options[:vspass]}"
+      knife_cmd << " --vshost #{@vcenter['host']}"
+
+      # vSphere destination information (where the clone will end up)
+      knife_cmd << " --vsdc '#{@vcenter['datacenter']}'"
+
+      # datastore prefix
+      knife_cmd << " --regex #{@vcenter['datastore']}"
+
+      # get result and clean up
+      @options['dry-run'] ? @vcenter['datastore'] : `#{knife_cmd}`.to_s.gsub!("\n", '')
     end
+    # rubocop:enable LineLength
 
-    # Private: Build the knife command that will do the provisioning.
     # rubocop:disable MethodLength, LineLength
+
+    # Private
+    #
+    # Build the knife command that will do the provisioning.
+    # @return [String] knife command line string
     def generate_knife_cmd
       knife_cmd = 'knife vsphere vm clone --vsinsecure --start'
 
@@ -110,7 +148,9 @@ module Elevage
 
       # vSphere destination information (where the clone will end up)
       knife_cmd << " --vsdc '#{@vcenter['datacenter']}'"
-      knife_cmd << " --dest-folder '#{@vcenter['destfolder']}'"
+      knife_cmd << " --dest-folder '#{@vcenter['destfolder']}"
+      knife_cmd << "/#{@component['tier']}" if @vcenter['appendtier']
+      knife_cmd << '\''
       knife_cmd << " --resource-pool '#{@vcenter['resourcepool']}'"
       knife_cmd << " --datastore '#{select_datastore}'"
 
@@ -143,7 +183,6 @@ module Elevage
 
       # What the node should be identified as in Chef
       nodename = String.new(@name)
-      nodename << '.' << @environment.name if @vcenter['appendenv']
       nodename << @vcenter['domain'] if @vcenter['appenddomain']
       knife_cmd << " --node-name '#{nodename}'"
 
@@ -153,17 +192,18 @@ module Elevage
       # Assign the Chef environment
       knife_cmd << " --environment '#{@environment.name}'"
 
-      # What version of chef-client are we bootstrapping (not sure this is necessary)
+      # What version of chef-client are we bootstrapping (not sure
+      # this is necessary)
       knife_cmd << " --bootstrap-version #{@options['bootstrap-version']}"
 
       # Finally, the name of the VM as seen by vSphere.
-      # Whereas nodename will optionally append the domain name, VM names should *always* have the domain name
-      # appended. The only optional bit is including the chef environment in the name.
+      # Whereas nodename will optionally append the domain name, VM names
+      # should *always* have the domain name appended.
       vmname = String.new(@name)
-      vmname << '.' << @environment.name if @vcenter['appendenv']
       vmname << @vcenter['domain']
       knife_cmd << " #{vmname}"
     end
     # rubocop:enable MethodLength, LineLength
   end
+  # rubocop:enable ClassLength
 end

data/lib/elevage/provisionerrunqueue.rb

@@ -1,7 +1,9 @@
 require_relative 'constants'
 
 module Elevage
-  # ProvisionerRunQueue class
+  # ProvisionerRunQueue
+  #
+  # Manage multiple queued and running `Elevage::Provisioner` objects/threads
   class ProvisionerRunQueue
     attr_reader :running_tasks
     attr_accessor :provisioners
@@ -9,7 +11,8 @@ module Elevage
     attr_accessor :busy_wait_timeout
     attr_accessor :build_status_interval
 
-    # Public: Initialize the object
+    # Create a new run queue
+    # @return [Elevage::ProvisionerRunQueue]
     def initialize
       @running_tasks = 0 # We start out with nothing running
       @max_concurrent = BUILD_CONCURRENT_DEFAULT
@@ -19,8 +22,9 @@ module Elevage
       @children = {}
     end
 
-    # Public: run() - Process the queue
     # rubocop:disable MethodLength
+
+    # Process the queue
     def run
       puts "#{Time.now} [#{$$}]: Provisioning started."
       @provisioners.each do |provisioner|
@@ -38,8 +42,10 @@ module Elevage
     end
     # rubocop:enable MethodLength
 
-    # Public: Display a string representation
     # rubocop:disable MethodLength
+
+    # Display a string representation
+    # @return [String]
     def to_s
       puts "Running Tasks: #{@running_tasks}"
       puts "Max Concurrency: #{@max_concurrent}"
@@ -57,9 +63,13 @@ module Elevage
 
     private
 
-    # rubocop:disable LineLength, GlobalVars
-    # Private: provision_task is the method that should execute in the child
+    # rubocop:disable LineLength
+
+    # Private
+    #
+    # provision_task is the method that should execute in the child
     # process, and contain all the logic for the child process.
+    # @param [Elevage::Provisioner] task a Provisioner from the queue
     def provision_task(task: nil)
       start_time = Time.now
       print "#{Time.now} [#{$$}]: #{task.name} Provisioning...\n"
@@ -67,15 +77,20 @@ module Elevage
       run_time = Time.now - start_time
       print "#{Time.now} [#{$$}]: #{task.name} #{status} in #{run_time.round(2)} seconds.\n"
     end
-    # rubocop:enable LineLength, GlobalVars
+    # rubocop:enable LineLength
+
+    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity
 
-    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, GlobalVars
-    # Private: Wait for child tasks to return
+    # Private
+    #
+    # Wait for child tasks to return
     # Since our trap for SIGCHLD will clean up the @running_tasks count and
     # the children hash, here we can just keep checking until @running_tasks
     # is 0.
     # If we've been waiting at least a minute, print out a notice of what
     # we're still waiting for.
+    # @param [String] state Disposition; whether we are still `:running` or
+    # are trying to `:collect` still-running tasks
     def wait_for_tasks(state: :running)
       i = interval = @build_status_interval / @busy_wait_timeout
 
@@ -109,6 +124,6 @@ module Elevage
         sleep @busy_wait_timeout
       end
     end
-    # rubocop:enable MethodLength, LineLength, CyclomaticComplexity, GlobalVars
+    # rubocop:enable MethodLength, LineLength, CyclomaticComplexity
   end
 end

data/lib/elevage/templates/vcenter.yml.tt

@@ -13,7 +13,7 @@ vcenter:
   # resourcepool  vcenter resource pool for the provisioned vms
   # appendenv     if true the destfolder path will be appended with the environment name
   # appenddomain  if true the domain will be pre-pended with environment name
-  # datastores    array list of available datastores. Elevage will attempt to evenly distribute
+  # datastore     prefix of desired datastorecluster.  knife vsphere datastorecluster maxfree will determine
   # domain        domain for fqdn of host
   # dnsips        ips of dns servers
   #
@@ -31,11 +31,8 @@ vcenter:
   #        resourcepool: 'App-Web Linux/Corporate'
   #        appendenv: true
   #        appenddomain: true
-  #        datastores:
-  #          - NonProd_Cor_25
-  #          - NonProd_Cor_26
-  #          - NonProd_Cor_38
-  #          - NonProd_Cor_39
+  #        appendtier: false
+  #        datastore: 'NonProd_Cor_PlaSer'
   #
   #        domain: dev.corp.local
   #        dnsips:
@@ -46,9 +43,7 @@ vcenter:
   #        <<: *vcenter
   #
   #        datacenter: 'WCDC Prod'
-  #        datastores:
-  #          - Prod_Cor_03
-  #          - Prod_Cor_04
+  #        datastore: 'Prod_Cor_PlaSer'
   #
   #        domain: corp.local
   #        dnsips:
@@ -66,12 +61,12 @@ vcenter:
     resourcepool:
     appendenv: false
     appenddomain: false
-    datastores:
-      -
+    appendtier: false
+    datastore:
 
     domain:
     dnsips:
       -
 
   prod:
-    <<: *default
+    <<: *default

data/lib/elevage/version.rb

@@ -1,4 +1,4 @@
 # simple gem version number tracking
 module Elevage
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

data/lib/elevage.rb

@@ -17,13 +17,17 @@ module Elevage
     map '-v' => :version
 
     desc 'version', DESC_VERSION
+    # Display the version
     def version
       puts VERSION
     end
 
     desc 'list ITEM', DESC_LIST
     method_option :nodes, aliases: '-n', desc: DESC_LIST_NODES
+
     # rubocop:disable LineLength
+
+    # Process the `list` command
     def list(item)
       # errors handled in class methods
       if LIST_CMDS.include?(item)
@@ -34,6 +38,7 @@ module Elevage
         puts options[:nodes] ? environment.list_nodes : environment
       end
     end
+
     # rubocop:enable LineLength
 
     # subcommand in Thor called as registered class