ref_arch_setup 0.0.1 → 0.5.0

data/lib/ref_arch_setup/version.rb

@@ -2,6 +2,6 @@ module RefArchSetup
   # Module for holding version info
   module Version
     # Version number
-    STRING = "0.0.1".freeze
+    STRING = "0.5.0".freeze
   end
 end

data/modules/ref_arch_setup/tasks/download_pe_tarball.json

@@ -0,0 +1,13 @@
+{
+  "description": "A task to download the specified PE tarball",
+  "parameters": {
+    "url": {
+      "description": "The URL for the specified tarball",
+      "type": "Pattern['https?://.*\.(tar|tar\.gz)$']"
+    },
+    "destination": {
+      "description": "The folder where the tarball should be saved",
+      "type": "Optional[String[1]]"
+    }
+  }
+}

data/modules/ref_arch_setup/tasks/download_pe_tarball.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# Download PE Tarball:
+# This is a script-based task as the target node may not have Ruby installed.
+# Provide the URL and optionally an existing destination directory (the default is /tmp/ref_arch_setup).
+# Run the task as per the following examples:
+#
+# Localhost with default destination -
+# bolt task run ref_arch_setup::download_pe_tarball url=http://test.net/test.gz --modulepath ./modules --nodes localhost
+#
+# Remote node as root user with specified destination -
+# bolt task run ref_arch_setup::download_pe_tarball url=http://test.net/test.gz destination=/tmp/ras --modulepath ./modules --nodes tjsss144r6ouvhc --user root
+
+URL=$PT_url
+DESTINATION=${PT_destination:-/tmp/ref_arch_setup}
+FILENAME=$(basename $PT_url)
+DESTINATION_PATH=$DESTINATION/$FILENAME
+
+echo URL: $URL
+echo Destination: $DESTINATION
+echo Filename: $FILENAME
+echo
+
+# check for the directory; attempt to create if it doesn't exist
+if [ -d "$DESTINATION" ]; then
+  echo "Destination directory exists; proceeding"
+else
+  echo "Destination directory does not exist; attempting to create"
+  mkdir -p $DESTINATION
+fi
+
+# check for the directory again; proceed if it exists, otherwise exit
+if [ -d "$DESTINATION" ]; then
+  echo Downloading $URL to $DESTINATION_PATH
+
+  # download and check for failure
+  if curl -f -L -o $DESTINATION_PATH $URL ; then
+    echo "Download complete"
+    exit 0
+  else
+    echo "Download failed; exiting"
+    exit 1
+  fi
+
+else
+  echo "Destination directory does not exist and could not be created; exiting"
+  exit 1
+fi

data/modules/ref_arch_setup/tasks/generate_pe_conf.json

@@ -0,0 +1,10 @@
+{
+  "description": "Generates a PE.conf file at ./tmp/pe.conf",
+
+  "parameters": {
+    "console_password": {
+      "description": "The initial console password for the puppet admin user",
+      "type": "String[1]"
+    }
+  }
+}

data/modules/ref_arch_setup/tasks/generate_pe_conf.rb

@@ -0,0 +1,128 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+require "fileutils"
+
+# rubocop:disable Style/FormatStringToken
+pe_conf = <<~PE_CONF
+  #----------------------------------------------------------------------------
+  # 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": "#{ENV['PT_console_password']}"
+
+
+  #--------------------------------------------------------------------------
+  # 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"
+  }
+PE_CONF
+# rubocop:enable Style/FormatStringToken
+
+FileUtils.mkdir_p "/tmp/ref_arch_setup" unless Dir.exist? "/tmp/ref_arch_setup"
+File.open("/tmp/ref_arch_setup/pe.conf", "w") { |f| f.write(pe_conf) }

data/modules/ref_arch_setup/tasks/install_pe.json

@@ -0,0 +1,14 @@
+{
+  "description": "Installs PE master on a node",
+
+  "parameters": {
+    "pe_tarball_path": {
+      "description": "The file path to the PE tarball that was downloaded and copied to the master",
+      "type": "String[1]"
+    },
+    "pe_conf_path": {
+      "description": "The file path to the pe.conf file that was copied to the master",
+      "type": "String[1]"
+    }
+  }
+}

data/modules/ref_arch_setup/tasks/install_pe.sh

@@ -0,0 +1,132 @@
+#!/usr/bin/env bash
+
+# Install PE:
+# First, copy the PE installer tarball and pe_conf file to the node
+# Then, execute the task as per the following example:
+# bolt task --modulepath modules run 'ref_arch_setup::install_pe pe_tarball_path=puppet-enterprise-2018.1.1-el-7-x86_64.tar.gz pe_conf_path=pe.conf' --nodes bdjshmr8bx75q2a.delivery.puppetlabs.net
+
+execute_command() {
+    cmd=$1
+    echo "Executing: $cmd"
+    eval $cmd
+    cmd_exit_code=$?
+
+    # if number of args is 1, check for exit code = 0, otherwise check for exit code = value of second arg
+    if [ $# -eq 1 ]
+    then
+        expected_exit_code=0
+    else
+        expected_exit_code=$2
+    fi
+    if [ $cmd_exit_code -ne $expected_exit_code ]
+    then
+        echo "Command '$1' failed - expected_exit_code: $expected_exit_code, actual_exit_code: $cmd_exit_code"
+        exit 1
+    fi
+}
+
+# Sometimes it takes more than one run ...
+
+execute_puppet_until_idempotent() {
+  puppet_command="puppet agent -t"
+
+  # The following could be converted into parameters with defaults ...
+
+  maximum_number_of_puppet_runs=8
+  sleep_seconds_when_puppet_run_in_progress=16
+  retry_when_success_with_failures=false
+
+  for run in $(seq 1 $maximum_number_of_puppet_runs); do
+    echo "Executing: '$puppet_command'"
+
+    # To both capture and output command output ...
+    exec 5>&1
+    puppet_command_output=$($puppet_command | tee /dev/fd/5; exit "${PIPESTATUS[0]}")
+    puppet_exit_code=$?
+
+    if echo "$puppet_command_output" | grep -q "Run of Puppet configuration client already in progress"; then
+      puppet_run_in_progress=true
+    else
+      puppet_run_in_progress=false
+    fi
+
+    # 0: The run succeeded with no changes or failures; the system was already in the desired state
+    if [ $puppet_exit_code -eq 0 ]; then
+      break
+    fi
+
+    # 1: The run failed, or wasn't attempted due to another run already in progress.
+    if [ $puppet_exit_code -eq 1 ]; then
+      if [ "$puppet_run_in_progress" = true ]; then
+        echo "Sleeping $sleep_seconds_when_puppet_run_in_progress seconds while waiting for another run already in progress"
+        sleep $sleep_seconds_when_puppet_run_in_progress
+        continue
+      else
+        echo "ERROR: '$puppet_command' failed with exit code: $puppet_exit_code"
+        exit 1
+      fi
+    fi
+
+    # 2: The run succeeded, and some resources were changed.
+    if [ $puppet_exit_code -eq 2 ]; then
+      continue
+    fi
+
+    # 4: The run succeeded, and some resources failed.
+    if [ $puppet_exit_code -eq 4 ]; then
+      if [ "$retry_when_success_with_failures" = true ]; then
+        continue
+      else
+        echo "ERROR: '$puppet_command' failed with exit code: $puppet_exit_code"
+        exit 1
+      fi
+    fi
+
+    # 6: The run succeeded, and included both changes and failures.
+    if [ $puppet_exit_code -eq 6 ]; then
+      if [ "$retry_when_success_with_failures" = true ] ; then
+        continue
+      else
+        echo "ERROR: '$puppet_command' failed with exit code: $puppet_exit_code"
+        exit 1
+      fi
+    fi
+  done
+}
+
+#check that pe.conf is present
+if [ ! -f $PT_pe_conf_path ]; then
+  echo "ERROR: Specified pe.conf file not found: $PT_pe_conf_path"
+  exit 1
+fi
+
+#check that pe tarball is present
+if [ ! -f $PT_pe_tarball_path ]; then
+  echo "ERROR: Specified pe tarball not found: $PT_pe_tarball_path"
+  exit 1
+fi
+
+# Install tar using existing package manager if it is not already installed
+if [ "" == "`which tar`" ]
+then
+    echo "Tar Not Found"
+    if [ -n "`which apt-get`" ]
+    then
+        execute_command "apt-get -y install tar"
+    elif [ -n "`which yum`" ]
+    then
+        execute_command "yum -y install tar"
+    else
+        echo "OS does not have apt-get or yum package manager"
+        exit 1
+    fi
+fi
+
+execute_command "tar -xvf $PT_pe_tarball_path -C /tmp/ref_arch_setup"
+
+# Using -* so we don't have to know the specific version, or parse it from the install path
+execute_command "sh /tmp/ref_arch_setup/puppet-enterprise-*/puppet-enterprise-installer -c $PT_pe_conf_path"
+
+# Must run puppet agent twice, see https://puppet.com/docs/pe/2017.3/installing/installing_pe.html#text-mode-installation-options-for-monolithic-installations
+execute_puppet_until_idempotent
+exit 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ref_arch_setup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bolt
@@ -16,14 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: beaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: beaker-vmpooler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   This gem provides methods for for setting up /
                                   Puppet Enterprise reference architectures
@@ -34,14 +76,25 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- Boltdir/Puppetfile
 - CONTRIBUTING.md
 - MAINTAINERS
 - README.md
 - bin/ref_arch_setup
+- fixtures/pe.conf
+- fixtures/puppet-enterprise-2019.0-rc1-7-gd82666f-el-7-x86_64.tar
 - lib/ref_arch_setup.rb
+- lib/ref_arch_setup/bolt_helper.rb
 - lib/ref_arch_setup/cli.rb
+- lib/ref_arch_setup/download_helper.rb
 - lib/ref_arch_setup/install.rb
 - lib/ref_arch_setup/version.rb
+- modules/ref_arch_setup/tasks/download_pe_tarball.json
+- modules/ref_arch_setup/tasks/download_pe_tarball.sh
+- modules/ref_arch_setup/tasks/generate_pe_conf.json
+- modules/ref_arch_setup/tasks/generate_pe_conf.rb
+- modules/ref_arch_setup/tasks/install_pe.json
+- modules/ref_arch_setup/tasks/install_pe.sh
 homepage: https://github.com/puppetlabs/ref_arch_setup
 licenses:
 - Apache2
@@ -54,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -62,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Tool for setting up reference architectures