vagrant-pe_build 0.12.0 → 0.13.0

data/lib/pe_build/plugin.rb

@@ -22,6 +22,11 @@ module PEBuild
       PEBuild::Config::PEBootstrap
     end
 
+    config(:pe_agent, :provisioner) do
+      require_relative 'config'
+      PEBuild::Config::PEAgent
+    end
+
     config(:pe_build) do
       require_relative 'config'
       PEBuild::Config::Global
@@ -32,6 +37,11 @@ module PEBuild
       PEBuild::Provisioner::PEBootstrap
     end
 
+    provisioner(:pe_agent) do
+      require_relative 'provisioner/pe_agent'
+      PEBuild::Provisioner::PEAgent
+    end
+
     command(:'pe-build') do
       require_relative 'command'
       PEBuild::Command::Base
@@ -92,6 +102,40 @@ module PEBuild
       PEBuild::Cap::RunInstall::Windows
     end
 
+    # Retrieve Facts
+    guest_capability('redhat', 'pebuild_facts') do
+      require_relative 'cap'
+      PEBuild::Cap::Facts::RedHat
+    end
+
+    guest_capability('debian', 'pebuild_facts') do
+      require_relative 'cap'
+      PEBuild::Cap::Facts::Debian
+    end
+
+    guest_capability('ubuntu', 'pebuild_facts') do
+      require_relative 'cap'
+      PEBuild::Cap::Facts::Ubuntu
+    end
+
+    guest_capability('suse', 'pebuild_facts') do
+      require_relative 'cap'
+      PEBuild::Cap::Facts::SUSE
+    end
+
+    [:solaris, :solaris11].each do |os|
+      guest_capability(os, 'pebuild_facts') do
+        require_relative 'cap'
+        PEBuild::Cap::Facts::Solaris
+      end
+    end
+
+    guest_capability('windows', 'pebuild_facts') do
+      require_relative 'cap'
+      PEBuild::Cap::Facts::Windows
+    end
+
+
     # internal action hooks
 
     action_hook('PE Build: initialize build dir') do |hook|

data/lib/pe_build/provisioner/pe_agent.rb

@@ -0,0 +1,262 @@
+require 'pe_build/util/pe_packaging'
+require 'pe_build/util/machine_comms'
+
+module PEBuild
+  module Provisioner
+    # Provision PE agents using simplified install
+    #
+    # @since 0.13.0
+    class PEAgent < Vagrant.plugin('2', :provisioner)
+      include ::PEBuild::Util::PEPackaging
+      include ::PEBuild::Util::MachineComms
+
+      attr_reader :facts
+      attr_reader :agent_version
+
+      def provision
+        provision_init!
+
+        # As of 2015.x, pe_repo doesn't support windows installation, so skip
+        # provisioning the repositories.
+        unless config.master_vm.nil? || provision_windows?
+          provision_pe_repo
+        end
+        provision_agent
+        provision_agent_cert if config.autosign
+      end
+
+      # This gets run during agent destruction and will remove the agent's
+      # certificate from the master, if requested.
+      def cleanup
+        unless config.master_vm.is_a?(::Vagrant::Machine)
+          vm_def = machine.env.active_machines.find {|vm| vm[0].to_s == config.master_vm.to_s}
+          if vm_def.nil?
+            config.master_vm.ui.warn I18n.t(
+              'pebuild.provisioner.pe_agent.skip_purge_no_master',
+              :master => config.master_vm.to_s
+            )
+            return
+          end
+          config.master_vm = machine.env.machine(*vm_def)
+        end
+
+        cleanup_agent_cert if config.autopurge
+      end
+
+      private
+
+      # Set data items that are only available at provision time
+      def provision_init!
+        @facts = machine.guest.capability(:pebuild_facts)
+        @agent_version = facts['puppetversion']
+
+        # Resolve the master_vm setting to a Vagrant machine reference.
+        unless config.master_vm.nil?
+          vm_def = machine.env.active_machines.find {|vm| vm[0].to_s == config.master_vm.to_s}
+
+          unless vm_def.nil?
+            config.master_vm = machine.env.machine(*vm_def)
+            config.master    ||= config.master_vm.config.vm.hostname.to_s
+          end
+        end
+      end
+
+      # A quick test to determine if we are provisioning a Windows agent
+      #
+      # This method requires {#provision_init!} to be called.
+      def provision_windows?
+        facts['os']['family'].downcase == 'windows'
+      end
+
+      def provision_agent
+        unless agent_version.nil?
+          machine.ui.info I18n.t(
+            'pebuild.provisioner.pe_agent.already_installed',
+            :version => agent_version
+          )
+          return
+        end
+
+        if provision_windows?
+          provision_windows_agent
+        else
+          provision_posix_agent
+        end
+
+        # Refresh agent facts post-installation.
+        @facts = machine.guest.capability(:pebuild_facts)
+      end
+
+      # Ensure a master VM is able to serve agent packages
+      #
+      # This method inspects the master VM and ensures it is configured to
+      # serve packages for the agent's architecture.
+      def provision_pe_repo
+        # This method will raise an error if commands can't be run on the
+        # master VM.
+        ensure_reachable(config.master_vm)
+
+        platform         = platform_tag(facts)
+        # Transform the platform_tag into a Puppet class name.
+        pe_repo_platform = platform.gsub('-', '_').gsub('.', '')
+        # TODO: Support PE 3.x
+        platform_repo    = "/opt/puppetlabs/server/data/packages/public/current/#{platform}"
+
+        # Print a message and return if the agent repositories exist on the
+        # master.
+        if config.master_vm.communicate.test("[ -e #{platform_repo} ]")
+          config.master_vm.ui.info I18n.t(
+            'pebuild.provisioner.pe_agent.pe_repo_present',
+            :vm_name      => config.master_vm.name,
+            :platform_tag => platform
+          )
+          return
+        end
+
+        config.master_vm.ui.info I18n.t(
+          'pebuild.provisioner.pe_agent.adding_pe_repo',
+          :vm_name      => config.master_vm.name,
+          :platform_tag => platform
+        )
+
+        shell_config = Vagrant.plugin('2').manager.provisioner_configs[:shell].new
+        shell_config.privileged = true
+        # TODO: Extend to configuring agent repos which are older than the
+        # master.
+        # TODO: Extend to PE 3.x masters.
+        shell_config.inline = <<-EOS
+/opt/puppetlabs/bin/puppet apply -e 'include pe_repo::platform::#{pe_repo_platform}'
+        EOS
+        shell_config.finalize!
+
+        shell_provisioner = Vagrant.plugin('2').manager.provisioners[:shell].new(config.master_vm, shell_config)
+        shell_provisioner.provision
+      end
+
+      # Execute a Vagrant shell provisioner to provision POSIX agents
+      #
+      # Performs a `curl | bash` installation.
+      def provision_posix_agent
+        shell_config = Vagrant.plugin('2').manager.provisioner_configs[:shell].new
+        shell_config.privileged = true
+        # Installation is split into to components running under set -e so that
+        # failures are detected. The curl command uses `sS` so that download
+        # progress is silenced, but error messages are still printed.
+        #
+        # TODO: Extend to allow passing agent install options.
+        # TODO: Extend to use `config.version` once {#provision_pe_repo}
+        # supports it.
+        shell_config.inline = <<-EOS
+set -e
+curl -ksS -tlsv1 https://#{config.master}:8140/packages/current/install.bash -o pe_frictionless_installer.sh
+bash pe_frictionless_installer.sh
+        EOS
+        shell_config.finalize!
+
+        machine.ui.info "Running: #{shell_config.inline}"
+
+        shell_provisioner = Vagrant.plugin('2').manager.provisioners[:shell].new(machine, shell_config)
+        shell_provisioner.provision
+      end
+
+      # Install a PE Agent on Windows
+      #
+      # Executes a `pe_bootstrap` provisioner running in agent mode.
+      def provision_windows_agent
+        pe_config = ::PEBuild::Config::PEBootstrap.new
+        pe_config.role    = :agent
+        # Windows won't reconize 'current' as a version number, so fall through
+        # to the global default by leaving it unset.
+        pe_config.version = config.version unless config.version == 'current'
+        pe_config.master  = config.master
+        pe_config.finalize!
+
+        machine.ui.info "Installing Windows agent with PE Bootstrap"
+
+        pe_provisioner = Vagrant.plugin('2').manager.provisioners[:pe_bootstrap].new(machine, pe_config)
+        pe_provisioner.configure(machine.config)
+        pe_provisioner.provision
+      end
+
+      def provision_agent_cert
+        # This method will raise an error if commands can't be run on the
+        # master VM.
+        ensure_reachable(config.master_vm)
+
+        agent_certname = facts['certname']
+
+        # Return if the cert has already been signed. The return code is
+        # inverted as `grep -q` will exit with 1 if the certificate is not
+        # found.
+        # TODO: Extend paths to PE 3.x masters.
+        if not config.master_vm.communicate.test("/opt/puppetlabs/bin/puppet cert list | grep -q -F #{agent_certname}", :sudo => true)
+          config.master_vm.ui.info I18n.t(
+            'pebuild.provisioner.pe_agent.no_csr_pending',
+            :certname => agent_certname,
+            :master   => config.master_vm.name.to_s
+          )
+          return
+        end
+
+        config.master_vm.ui.info I18n.t(
+          'pebuild.provisioner.pe_agent.signing_agent_cert',
+          :certname => agent_certname,
+          :master   => config.master_vm.name.to_s
+        )
+
+        shell_config = Vagrant.plugin('2').manager.provisioner_configs[:shell].new
+        shell_config.privileged = true
+        # TODO: Extend paths to PE 3.x masters.
+        shell_config.inline = <<-EOS
+/opt/puppetlabs/bin/puppet cert sign #{agent_certname}
+        EOS
+        shell_config.finalize!
+
+        shell_provisioner = Vagrant.plugin('2').manager.provisioners[:shell].new(config.master_vm, shell_config)
+        shell_provisioner.provision
+      end
+
+      def cleanup_agent_cert
+        # TODO: This isn't very flexible. But, the VM is destroyed at this
+        # point, so it's the best guess we have available.
+        agent_certname = machine.config.vm.hostname
+
+        unless is_reachable?(config.master_vm)
+          config.master_vm.ui.warn I18n.t(
+            'pebuild.provisioner.pe_agent.skip_purge_master_not_reachable',
+            :vm_name => config.master_vm.name.to_s
+          )
+          return
+        end
+
+        # TODO: Extend paths to PE 3.x masters.
+        if not config.master_vm.communicate.test("/opt/puppetlabs/bin/puppet cert list #{agent_certname}", :sudo => true)
+          config.master_vm.ui.info I18n.t(
+            'pebuild.provisioner.pe_agent.agent_purged',
+            :certname => agent_certname,
+            :master   => config.master_vm.name.to_s
+          )
+          return
+        end
+
+        config.master_vm.ui.info I18n.t(
+          'pebuild.provisioner.pe_agent.purging_agent',
+          :certname => agent_certname,
+          :master   => config.master_vm.name.to_s
+        )
+
+        shell_config = Vagrant.plugin('2').manager.provisioner_configs[:shell].new
+        shell_config.privileged = true
+        # TODO: Extend to PE 3.x masters.
+        shell_config.inline = <<-EOS
+/opt/puppetlabs/bin/puppet node purge #{agent_certname}
+        EOS
+        shell_config.finalize!
+
+        shell_provisioner = Vagrant.plugin('2').manager.provisioners[:shell].new(config.master_vm, shell_config)
+        shell_provisioner.provision
+      end
+
+    end
+  end
+end

data/lib/pe_build/release.rb

@@ -39,6 +39,6 @@ module PEBuild
     require 'pe_build/release/3_8'
     require 'pe_build/release/2015_2'
 
-    LATEST_VERSION = '2015.2.1'
+    LATEST_VERSION = '2015.2.2'
   end
 end

data/lib/pe_build/release/2015_2.rb

@@ -34,4 +34,5 @@ module PEBuild::Release
 
   @releases['2015.2.0'] = twentyfifteen_two_x
   @releases['2015.2.1'] = twentyfifteen_two_x
+  @releases['2015.2.2'] = twentyfifteen_two_x
 end

data/lib/pe_build/util/machine_comms.rb

@@ -0,0 +1,51 @@
+require 'vagrant/errors'
+
+module PEBuild
+  module Util
+    # Utilities related to Vagrant Machine communications
+    #
+    # This module provides general-purpose utility functions for communicating
+    # with Vagrant machines.
+    #
+    # @since 0.13.0
+    module MachineComms
+
+      # Determine if commands can be executed on a Vagrant machine
+      #
+      # @param machine [Vagrant::Machine] A Vagrant machine.
+      #
+      # @return [true] If the machine can accept communication.
+      # @return [false] If the machine cannot accept communication.
+      def is_reachable?(machine)
+        begin
+          machine.communicate.ready?
+        rescue Vagrant::Errors::VagrantError
+          # WinRM will raise an error if the VM isn't running instead of
+          # returning false (GH-6356).
+          false
+        end
+      end
+      module_function :is_reachable?
+
+      class MachineNotReachable < ::Vagrant::Errors::VagrantError
+        error_key(:machine_not_reachable, 'pebuild.errors')
+      end
+
+      # Raise an error if Vagrant commands cannot be executed on a machine
+      #
+      # This function raises an error if a given vagrant machine is not ready
+      # for communication.
+      #
+      # @param machine [Vagrant::Machine] A Vagrant machine.
+      #
+      # @return [void] If the machine can accept communication.
+      # @raise [MachineNotReachable] If the machine cannot accept
+      #   communication.
+      def ensure_reachable(machine)
+        raise MachineNotReachable, :vm_name => machine.name.to_s unless is_reachable?(machine)
+      end
+      module_function :ensure_reachable
+
+    end
+  end
+end

data/lib/pe_build/util/pe_packaging.rb

@@ -0,0 +1,57 @@
+module PEBuild
+  module Util
+    # Utilities related to PE Packages
+    #
+    # This module provides general-purpose utility functions for working with
+    # PE packages.
+    #
+    # @since 0.13.0
+    module PEPackaging
+
+      # Determine package tag from Facts
+      #
+      # The `platform_tag` is a `os-version-archtecture` value that is used in
+      # many PE package filenames and repostiory names.
+      #
+      # @param facts [Hash] A hash of facts which includes `architecture`
+      #   and `os` values.
+      #
+      # @return [String] A string representing the platform tag.
+      def platform_tag(facts)
+        case facts['os']['family'].downcase
+        when 'redhat'
+          # TODO: Fedora might be in here.
+          os      = 'el'
+          version = facts['os']['release']['major']
+          arch    = facts['architecture']
+        when 'windows'
+          os      = 'windows'
+          version = nil
+          arch    = (facts['architecture'] == 'x64' ? 'x86_64' : 'i386')
+        when 'debian'
+          case os = facts['os']['name'].downcase
+          when 'debian'
+            version = facts['os']['release']['major']
+          when 'ubuntu'
+            version = facts['os']['release']['full']
+          end
+          # TODO: Add "unknown debian" error.
+          arch = (facts['architecture'] == 'x86_64' ? 'amd64' : 'i386')
+        when 'solaris'
+          os      = 'solaris'
+          version = facts['os']['release']['major']
+          arch    = (facts['architecture'].match(/^i\d+/) ? 'i386' : 'sparc')
+        when 'suse'
+          os      = 'sles'
+          version = facts['os']['release']['major']
+          arch    = facts['architecture']
+        end
+        # TODO: Add "unknown os" error.
+
+        [os, version, arch].join('-').downcase
+      end
+      module_function :platform_tag
+
+    end
+  end
+end