ref_arch_setup 0.0.1 → 0.5.0

data/fixtures/pe.conf

@@ -0,0 +1,119 @@
+#----------------------------------------------------------------------------
+# Puppet Enterprise installer configuration file
+# https://docs.puppet.com/pe/latest/install_pe_conf_param.html
+#
+# Format: Hocon
+# https://docs.puppet.com/pe/latest/config_hocon.html
+#----------------------------------------------------------------------------
+{
+  #--------------------------------------------------------------------------
+  # ⚠️  REQUIRED FOR INSTALLATION ⚠️
+  #
+  # The password to log into the Puppet Enterprise console.
+  #
+  # After installation, you may set the console_admin_password to an empty
+  # string to avoid storing a password in plain text.
+  #--------------------------------------------------------------------------
+  "console_admin_password": "puppetlabs"
+
+
+  #--------------------------------------------------------------------------
+  # PE Component assignments.
+  #
+  # If you're performing a monolithic install (recommended), there is no need
+  # to change the default settings, and you do not need to set the
+  # puppetdb_host and console_host parameters.
+  #
+  # When performing a split install, do not use the %{::trusted.certname} fact.
+  # Instead set the FQDN for all three PE component nodes.
+  # For more information, refer to:
+  # https://docs.puppet.com/pe/latest/install_text_mode_split.html
+  #
+  # Overview of PE Components:
+  # https://docs.puppet.com/pe/latest/pe_architecture_overview.html
+  #-------------------------------------------------------------------------
+
+  # Puppet Enterprise Master
+  "puppet_enterprise::puppet_master_host": "%{::trusted.certname}"
+
+  # Puppet Enterprise Console
+  #"puppet_enterprise::console_host": ""
+
+  # PuppetDB
+  #"puppet_enterprise::puppetdb_host": ""
+
+  # Hostname of database node if pe-postgres is being run on its own node
+  #"puppet_enterprise::database_host": ""
+
+  #--------------------------------------------------------------------------
+  # DATABASE CONFIGURATION
+  #
+  # Puppet Enterprise uses PostgreSQL as a database backend.
+  # PE can install and manage a new one (recommended), or you can use an
+  # existing instance.
+  #
+  # For details on using an existing PostgreSQL database, visit:
+  # https://docs.puppet.com/pe/latest/install_system_requirements.html
+  #
+  # UPGRADE NOTE:
+  # If you’re upgrading and have previously used non-default database names and
+  # users, you must uncomment and change these parameters to match what you
+  # have used.
+  #--------------------------------------------------------------------------
+
+  #"puppet_enterprise::activity_database_name": "pe-activity"
+  #"puppet_enterprise::activity_service_migration_db_user": "pe-activity"
+  #"puppet_enterprise::activity_service_regular_db_user": "pe-activity"
+  #"puppet_enterprise::classifier_database_name": "pe-classifier"
+  #"puppet_enterprise::classifier_service_migration_db_user": "pe-classifier"
+  #"puppet_enterprise::classifier_service_regular_db_user": "pe-classifier"
+  #"puppet_enterprise::orchestrator_database_name": "pe-orchestrator"
+  #"puppet_enterprise::orchestrator_service_migration_db_user": "pe-orchestrator"
+  #"puppet_enterprise::orchestrator_service_regular_db_user": "pe-orchestrator"
+  #"puppet_enterprise::rbac_database_name": "pe-rbac"
+  #"puppet_enterprise::rbac_service_migration_db_user": "pe-rbac"
+  #"puppet_enterprise::rbac_service_regular_db_user": "pe-rbac"
+  #"puppet_enterprise::puppetdb_database_name": "pe-puppetdb"
+  #"puppet_enterprise::puppetdb_database_user": "pe-puppetdb"
+
+
+  # EXTERNAL POSTGRES OPTIONS ONLY
+  # If you're using an existing PostgreSQL instance that was not set up by
+  # Puppet Enterprise, set the following parameters:
+
+  #"puppet_enterprise::database_ssl": false
+  #"puppet_enterprise::database_cert_auth": false
+  #"puppet_enterprise::activity_database_password": "PASSWORD"
+  #"puppet_enterprise::classifier_database_password": "PASSWORD"
+  #"puppet_enterprise::orchestrator_database_password": "PASSWORD"
+  #"puppet_enterprise::rbac_database_password": "PASSWORD"
+  #"puppet_enterprise::puppetdb_database_password": "PASSWORD"
+
+
+  #--------------------------------------------------------------------------
+  # ADVANCED AND CUSTOM PARAMETERS
+  #
+  # You can use the following parameters as needed, or add your own parameters
+  # to this section.
+  #
+  # For a complete list of parameters and what they do, visit:
+  # https://docs.puppet.com/pe/latest/install_pe_conf_param.html
+  #--------------------------------------------------------------------------
+
+  # DNS altnames to be added to the SSL certificate generated for the Puppet
+  # master node. Only used at install time.
+  #"pe_install::puppet_master_dnsaltnames": ["puppet"]
+
+  #Enabling this configures code manager, all three below values should be enabled and populated at the same time.
+  #"puppet_enterprise::profile::master::code_manager_auto_configure": true
+
+  #The ssh url to your existing control repo.
+  #"puppet_enterprise::profile::master::r10k_remote": "git@your.git.server.com:puppet/control.git"
+
+  #The private key to your puppetmaster for establishing key-based ssh authentication to your vcs.
+  #"puppet_enterprise::profile::master::r10k_private_key": "/etc/puppetlabs/puppetserver/ssh/id-control_repo.rsa"
+
+  #test key that does nothing
+  "ref_arch::name": "basic"
+}
+ 

data/lib/ref_arch_setup.rb

@@ -1,8 +1,14 @@
 # General namespace for RAS
 module RefArchSetup
-  %w[cli version install].each do |lib|
+  %w[cli bolt_helper download_helper version install].each do |lib|
     require "ref_arch_setup/#{lib}"
   end
+  # the location of ref_arch_setup
+  RAS_PATH = File.dirname(__FILE__) + "/..".freeze
   # location of modules shipped with RAS (Ref Arch Setup)
-  RAS_MODULE_PATH = File.dirname(__FILE__) + "/../modules"
+  RAS_MODULE_PATH = "#{RAS_PATH}/modules".freeze
+  # location of fixtures shipped with RAS (Ref Arch Setup)
+  RAS_FIXTURES_PATH = "#{RAS_PATH}/fixtures".freeze
+  # location of modules downloaded from the Puppet Forge
+  FORGE_MODULE_PATH = "#{RAS_PATH}/Boltdir/modules".freeze
 end

data/lib/ref_arch_setup/bolt_helper.rb

@@ -0,0 +1,263 @@
+# General namespace for RAS
+module RefArchSetup
+  # Bolt helper methods
+  class BoltHelper
+    # the user RAS will provide to the bolt --run-as option
+    BOLT_RUN_AS_USER = "root".freeze
+
+    # the default options to specify when running bolt commands
+    BOLT_DEFAULT_OPTIONS = { "run-as" => BOLT_RUN_AS_USER }.freeze
+
+    @bolt_options = BOLT_DEFAULT_OPTIONS
+
+    # custom exception class for bolt command errors
+    class BoltCommandError < StandardError
+      attr_reader :output
+      def initialize(message, output)
+        @output = output
+        super(message)
+      end
+    end
+
+    # Initializes the bolt options to the default
+    #
+    # @author Bill Claytor
+    #
+    def self.init
+      @bolt_options = BOLT_DEFAULT_OPTIONS
+    end
+
+    # Merges the specified bolt options with the default options
+    # or optionally overwriting the default options
+    #
+    # @author Bill Claytor
+    #
+    # @param [hash] options_hash The user-specified bolt options hash
+    # @param [boolean] overwrite The flag indicating whether the default options
+    #   should be overwritten
+    #
+    def self.bolt_options(options_hash, overwrite = false)
+      @bolt_options = if overwrite
+                        options_hash
+                      else
+                        @bolt_options.merge(options_hash)
+                      end
+    end
+
+    # Merges the default bolt options with the specified options
+    #
+    # @author Bill Claytor
+    #
+    # @param [hash] options_hash The user-specified bolt options hash
+    #
+    def self.bolt_options=(options_hash)
+      bolt_options(options_hash)
+    end
+
+    # Gets the bolt options as a string
+    #
+    # @author Sam Woods
+    # @return [string] the string value for bolt options
+    def self.bolt_options_string
+      bolt_options_string = ""
+      @bolt_options.each do |key, value|
+        bolt_options_string << " --#{key} #{value}"
+      end
+      bolt_options_string
+    end
+
+    # Creates a dir on the target_host
+    # Doesn't fail if dir is already there
+    # Uses -p to create parent dirs if needed
+    #
+    # @author Randell Pelak
+    #
+    # @param [string] dir Directory to create
+    # @param [string] nodes Hosts to make dir on
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [true,false] Based on the output returned from the bolt command
+    def self.make_dir(dir, nodes)
+      error_message = "ERROR: Failed to make dir #{dir} on all nodes"
+      cmd = "mkdir -p #{dir}"
+      output = run_cmd_with_bolt(cmd, nodes, error_message)
+      success = output.nil? ? false : true
+      return success
+    end
+
+    # Run the specified command
+    #
+    # @author Bill Claytor
+    #
+    # @param command [string] The command to run
+    # @param error_message [string] The error to raise if the command is not successful
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [string] The output returned from the command
+    def self.run_command(command, error_message = "ERROR: command failed!")
+      puts "Running: #{command}"
+      output = `#{command}`
+      puts "Output was: #{output}"
+
+      success = $?.success? # rubocop:disable Style/SpecialGlobalVars
+      puts "Exit status was: #{$?.exitstatus}" # rubocop:disable Style/SpecialGlobalVars
+      puts
+
+      # raise error_message unless success
+      raise BoltCommandError.new(error_message, output) if output.nil?
+      raise BoltCommandError.new(error_message, output) unless success
+
+      return output
+    end
+
+    # Run a command with bolt on given nodes
+    #
+    # @author Randell Pelak
+    #
+    # @param [string] cmd Command to run on the specified nodes
+    # @param [string] nodes Nodes on which the command should be run
+    # @param [string] error_message The message that should be used if an error is raised
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [string] The output returned from the bolt command
+    def self.run_cmd_with_bolt(cmd, nodes, error_message = "ERROR: bolt command failed!")
+      command = "bolt command run '#{cmd}'"
+      command << " --nodes #{nodes}"
+      command << bolt_options_string
+
+      output = run_command(command, error_message)
+      return output
+    end
+
+    # Run a task with bolt on given nodes
+    #
+    # @author Sam Woods
+    #
+    # @param task [string] Task to run on nodes
+    # @param params [hash] task parameters to send to bolt
+    # @param nodes [string] Host or space delimited hosts to run task on
+    # @param modulepath [string] The modulepath to use when running bolt
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [string] The output returned from the bolt command
+    def self.run_task_with_bolt(task, params, nodes, modulepath = RAS_MODULE_PATH)
+      params_str = ""
+      params_str = params_to_string(params) unless params.nil?
+      command = "bolt task run #{task} #{params_str}"
+      command << " --modulepath #{modulepath} --nodes #{nodes}"
+      command << bolt_options_string
+
+      output = run_command(command, "ERROR: bolt task failed!")
+      return output
+    end
+
+    # Run a plan with bolt on given nodes
+    #
+    # @author Sam Woods
+    #
+    # @param plan [string] Plan to run on nodes
+    # @param params [hash] Plan parameters to send to bolt
+    # @param nodes [string] Host or space delimited hosts to run plan on
+    # @param modulepath [string] The modulepath to use when running bolt
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [string] The output returned from the bolt command
+    def self.run_plan_with_bolt(plan, params, nodes, modulepath = RAS_MODULE_PATH)
+      params_str = ""
+      params_str = params_to_string(params) unless params.nil?
+      command = "bolt plan run #{plan} #{params_str}"
+      command << " --modulepath #{modulepath} --nodes #{nodes}"
+      command << bolt_options_string
+
+      output = run_command(command, "ERROR: bolt plan failed!")
+      return output
+    end
+
+    # Run a task from the forge with bolt on given nodes
+    #
+    # @author Bill Claytor
+    #
+    # @param task [string] Task to run on nodes
+    # @param params [hash] Task parameters to send to bolt
+    # @param nodes [string] Host or space delimited hosts to run task on
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [string] The output returned from the bolt command
+    def self.run_forge_task_with_bolt(task, params, nodes)
+      install_forge_modules
+      output = run_task_with_bolt(task, params, nodes, FORGE_MODULE_PATH)
+      return output
+    end
+
+    # Run a plan from the forge with bolt on given nodes
+    #
+    # @author Bill Claytor
+    #
+    # @param plan [string] Plan to run on nodes
+    # @param params [hash] Plan parameters to send to bolt
+    # @param nodes [string] Host or space delimited hosts to run plan on
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [string] The output returned from the bolt command
+    def self.run_forge_plan_with_bolt(plan, params, nodes)
+      install_forge_modules
+      output = run_plan_with_bolt(plan, params, nodes, FORGE_MODULE_PATH)
+      return output
+    end
+
+    # Convert params to string for bolt
+    # format is space separated list of name=value
+    #
+    # @author Randell Pelak
+    #
+    # @param params [Array] params to convert
+    #
+    # @return [String] stringified params
+    def self.params_to_string(params)
+      str = params.map { |k, v| "#{k}=#{v}" }.join(" ")
+      return str
+    end
+
+    # Upload a file to given nodes
+    #
+    # @author Randell Pelak
+    #
+    # @param [string] source File to upload
+    # @param [string] destination Path to upload to
+    # @param [string] nodes Host to put files on
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [output] The output returned from the bolt command
+    def self.upload_file(source, destination, nodes)
+      command = "bolt file upload #{source} #{destination}"
+      command << " --nodes #{nodes}"
+      command << bolt_options_string
+
+      error_message = "ERROR: failed to upload file #{source} to #{destination} on #{nodes}"
+      output = run_command(command, error_message)
+      return output
+    end
+
+    # Install modules from the forge via Puppetfile
+    # The modules are defined in Boltdir/Puppetfile
+    #
+    # @author Bill Claytor
+    #
+    # @raise [BoltCommandError] If the bolt command is not successful or the output is nil
+    #
+    # @return [string] The output returned from the bolt command
+    def self.install_forge_modules
+      command = "cd #{RAS_PATH} && bolt puppetfile install --modulepath #{FORGE_MODULE_PATH}"
+      output = run_command(command, "ERROR: bolt puppetfile install failed!")
+      return output
+    end
+  end
+end

data/lib/ref_arch_setup/cli.rb

@@ -14,8 +14,9 @@ module RefArchSetup
     # @option options [String] something not yet defined
     #
     # @return [void]
-    def initialize(options)
+    def initialize(options, bolt_options)
       @options = options
+      @bolt_options = bolt_options
     end
 
     # Check values of options to see if they are really an option
@@ -57,20 +58,88 @@ module RefArchSetup
             "option --#{option} is required for the #{subcommand} subcommand"
     end
 
+    # Wrapper around commands
+    #
+    # @author Randell Pelak
+    #
+    # @param [string] command the name of the command to run
+    # @param [string] subcommand the name of the subcommand to run
+    #
+    # @return [boolean] success of install
+    def run(command, subcommand = nil)
+      check_for_missing_value
+      BoltHelper.bolt_options = @bolt_options
+
+      comm = command
+      unless subcommand.nil?
+        str = subcommand.tr("-", "_")
+        comm += "_" + str
+      end
+      success = send(comm)
+      return success
+    end
+
     # Installs a bootstrap version of mono on the target host using the provided tarball and pe.conf
     #
     # @author Randell Pelak
     #
     # @return [boolean] success of install
     def install
-      check_for_missing_value
-      check_option("target_host", "install")
-      check_option("pe_tarball_path", "install")
-      check_option("pe_conf_path", "install")
-      install_obj = RefArchSetup::Install.new(@options["target_host"])
-      success = install_obj.bootstrap_mono(@options["pe_conf_path"], @options["pe_tarball_path"])
+      puts "Running install command"
+      success = true
+      success = install_generate_pe_conf unless @options.key?("pe_conf")
+      # TODO: Pass pe.conf object along so we don't have to read/validate it in each subcommand
+      success = install_bootstrap if success
+      success = install_pe_infra_agent_install if success
+      success = install_configure if success
+      return success
+    end
+
+    # Generates a pe.conf for use doing the install
+    #
+    # @author Randell Pelak
+    #
+    # @return [boolean] success of generating the pe.conf file
+    def install_generate_pe_conf
+      puts "Running generate-pe-conf subcommand of install command"
+      # check_option("console_password", "install") # password hardcoded in base file for now
+      return true
+    end
+
+    # Installs a bootstrap version of PE on the target host using the provided tarball and pe.conf
+    #
+    # @author Randell Pelak
+    #
+    # @return [boolean] success of install
+    def install_bootstrap
+      puts "Running bootstrap subcommand of install command"
+      # none of these will be required in the future...  but are for now
+      check_option("primary_master", "install")
+      install_obj = RefArchSetup::Install.new(@options["primary_master"])
+      success = install_obj.bootstrap(@options["pe_conf"], @options["pe_tarball"],
+                                      @options["pe_version"])
       return success
     end
+
+    # Installs an agent on infrastructure nodes
+    #
+    # @author Randell Pelak
+    #
+    # @return [boolean] success of agent install
+    def install_pe_infra_agent_install
+      puts "Running pe-infra-agent-install subcommand of install command"
+      return true
+    end
+
+    # Configures infrastructure nodes and do initial perf tuning
+    #
+    # @author Randell Pelak
+    #
+    # @return [boolean] success of all the things
+    def install_configure
+      puts "Running configure subcommand of install command"
+      return true
+    end
   end
 end