ref_arch_setup 0.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8c6aca4691fde2196748ac621990f7b9c401ab0
-  data.tar.gz: be7e2c0c347e402d5482b68e0f26a74347b26144
+  metadata.gz: 867ecc198ad41daa38002f36364b3a9af7f561c6
+  data.tar.gz: f759732639ee8e271c2b0e062cd27ca8e2523ef0
 SHA512:
-  metadata.gz: 004016af7b7d615cd4c6f40b4ecea50f2b05fd65ba428516c05e2af52ded69a271de7aa9993220fcbf042d4f9dd6a69357a75723acd835977eda2449e0464679
-  data.tar.gz: daadb2ae7760654854e2e9b8fc4f0638d417bd3f0332c44cee99af3cf18f7775d5f0453fbe5cdad771130a01a84b492652238111d6e6d1e2353b0bc91d4b5cd5
+  metadata.gz: fc62ba4ba3beb0532c26cf0ad9b1ac577cb80cb157dc1d607c222b9069598b8730348f5bd2f5738f158cea6da57414c6e8f9caff41ea7fd2724f4095766c5875
+  data.tar.gz: 9bc508c713595af8e2174aed3f176ba565c8b1d5bfe2e615db7e6850218c60b418da099d8341b24406d4d544eaafbff95401ceca9f87e16cebae69271d039027

data/Boltdir/Puppetfile

@@ -0,0 +1,2 @@
+# Modules from the Puppet Forge
+mod "puppetlabs-facts", "0.2.0"

data/CONTRIBUTING.md

@@ -1,14 +1,35 @@
 # How To Contribute To RefArchSetup
 
 ## Getting Started
-
-* Create a [Jira](http://tickets.puppetlabs.com) account.
 * Make sure you have a [GitHub](https://github.com) account.
-* Submit a ticket for your issue, assuming one does not already exist.
+* Clone the [ref_arch_setup](https://github.com/puppetlabs/ref_arch_setup) repository on GitHub. 
+    * RefArchSetup uses [gem_of](https://github.com/puppetlabs/gem_of) for some development gem dependencies and rake tasks.
+    * Clone the repository and include the `gem_of` submodule:
+      ```
+      $ ~/> git clone --recurse-submodules https://github.com/puppetlabs/ref_arch_setup.git
+      ```
+    * If you've already cloned the repository you'll need to initialize and update the `gem_of` submodule:
+      ```
+      git submodule init
+      git submodule update
+      ```
+      
+* Navigate to the ref_arch_setup directory:
+  ```
+  $ ~/> cd ref_arch_setup
+  ```
+* Install the required gems:
+  ```
+  $ ~/ref_arch_setup> bundle install 
+  ```
+
+## Filing Tickets With Jira
+
+* Create a [Jira](http://tickets.puppetlabs.com) account if you don't already have one.
+* Submit a ticket for your issue, assuming one does not already exist:
+  * File a ticket in the [SLV project](https://tickets.puppetlabs.com/projects/SLV/).
   * Clearly describe the issue including steps to reproduce when it is a bug.
-  * File a ticket in the [SLV project](https://tickets.puppetlabs.com/projects/SLV/)
-* Clone the [ref_arch_setup](https://github.com/puppetlabs/ref_arch_setup) repository on GitHub.
-
+  
 ## Making Changes
 
 ### GitHub

data/README.md

@@ -1,23 +1,188 @@
 # RefArchSetup
 
 ## Overview
+RefArchSetup is a Ruby gem designed to help install the various Puppet Reference Architectures. 
+It currently supports the Standard Reference Architecture.
 
-RefArchSetup is a gem designed to help install the various puppet reference architectures
+# Prerequisites
+## Ruby
+RefArchSetup uses [Puppet Bolt](https://puppet.com/products/puppet-bolt) as a gem which requires a minimum Ruby version of 2.3.
+
+## Root Access
+RefArchSetup executes Bolt commands as the root user using the `--run-as root` option to ensure a successful PE installation. 
+See the [Bolt Options](#bolt-options) section for more information.
+
+## Supported Platforms
+RefArchSetup supports the following platforms:
+
+| OS                                                  | Arch   |
+|:----                                                |:----   |
+| EL (RHEL, CentOS, Scientific Linux, Oracle Linux) 6 | x86_64 |
+| EL (RHEL, CentOS, Scientific Linux, Oracle Linux) 7 | x86_64 |
+| SLES 12                                             | x86_64 |
+| Ubuntu 16.04                                        | amd64  |
+| Ubuntu 18.04                                        | amd64  |
+
+## Supported PE Versions
+RefArchSetup supports PE versions greater than 2018.1.0.
+
+## Supported Reference Architectures
+RefArchSetup currently supports the Standard Architecture.
 
 # Installation
+RefArchSetup can be installed via [RubyGems](https://rubygems.org/gems/ref_arch_setup) or by building the gem locally. 
 
+## Install via RubyGems
+The easiest way to install RefArchSetup is via [RubyGems](https://rubygems.org/gems/ref_arch_setup):
+```
     $ gem install ref_arch_setup
+```
+
+## Build the gem locally
+To build the gem locally:
+* Clone the RefArchSetup repository and install the dependencies by following the steps in the [Getting Started](CONTRIBUTING.md) section in [CONTRIBUTING.md](CONTRIBUTING.md).
+* From your local copy of the repository, build the gem using the provided rake task:
+```
+    $ ~/ref_arch_setup> bundle exec rake gem:build
+```
+* The gem will be built to the pkg directory; install the gem by either specifying the path to the RAS gem provided in the output from the previous step:
+```
+    $ ~/ref_arch_setup> gem install pkg/ref_arch_setup-0.0.x
+```
+or navigate to the pkg directory first, in which case specifying the version is not required:
+```
+    $ ~/ref_arch_setup> cd pkg && gem install ref_arch_setup
+```
 
 # Usage
+## Help
+RefArchSetup provides help on the command line. Run the `ref_arch_setup` command with the ` -h` option to display the available commands and options:
+```
+    $ ref_arch_setup -h
+    Usage: ref_arch_setup <command> [subcommand] [options]
+  
+    Available Commands:
+  
+      install                         - Install a bootstrapped PE on target host
+      install generate-pe-conf        - Generates a pe.conf for the install
+      install bootstrap               - Installs a bare PE on the target host
+      install pe-infra-agent-install  - Installs agents on all PE
+                                        infrastructure nodes
+      install configure               - Configures PE infrastructure nodes to
+                                        reference architecture settings
+  
+    Available Options:
+  
+      -h, --help                       Prints this help
+      -v, --version                    Show current version of ref_arch_setup
+      
+```
 
-    TBD
+Run the `ref_arch_setup install` sub-command with the ` -h` option to display the available sub-commands and options:
+```
+    $ ref_arch_setup install -h
+    Usage: ref_arch_setup install [options]
 
-# License
+    Runs the install subcommands in the following order:
+      generate-pe-conf (unless --pe-conf is provided)
+      bootstrap
+      pe-infra-agent-install (noop for "Standard" ref arch)
+      configure
+
+    Available Options:
+      Either --console-password or --pe-conf required
+        --user <username>               SSH username for bolt ssh to target host
+        --password <password>           SSH password for bolt ssh to target host
+        --private-key <path>            Path to SSH private key file for bolt
+                                        ssh to target host
+        --sudo-password <password>      Root user password for privilege escalation
+        --console-password <password>   Password for the PE console
+        --primary-master <hostname>     Hostname of primary master
+        --pe-tarball <path|URL>         Path or URL to PE tarball
+        --pe-version <version>          PE version to get tarball for
+        --pe-conf <path>                Path to pe.conf file
+```
+
+## Install
+Install PE on the desired primary master using the install command. For example:
+```
+    $ ref_arch_setup install --primary-master=localhost --pe-version=latest --pe-conf=/path/to/pe.conf
+```
+### Subcommands
+RefArchSetup is currently in development and as such not all subcommands are currently available. 
+Currently only the `bootstrap` subcommand is implemented; other subcommands run in a noop mode.
+
+#### generate-pe-conf
+This subcommand has not been implemented.
+
+#### bootstrap
+This subcommand runs the bootstrap portion of the install which includes the following steps:
+* Download the PE tarball or verify a local tarball if specified
+* Extract the tarball
+* Run the PE installer
+* Run the Puppet agent until no changes are reported
+
+#### pe-infra-agent-install
+This subcommand has not been implemented.
+
+#### configure
+This subcommand has not been implemented.
+
+### Options
+
+#### --primary-master
+RefArchSetup can perform the PE installation with a local or remote primary master.
+
+##### Specifying a local primary master
+To perform the PE installation on the same host where RefArchSetup is run, specify `--primary-master=localhost`.
 
+##### Specifying a remote primary master
+To perform the PE installation on a remote host, specify `--primary-master=my.remote.master`.
+If a remote host is specified it must be accessible to Bolt; see the [Bolt Options](#bolt-options) section for more information.
+
+#### --pe-tarball
+Specifying a PE tarball is optional, but if the option is specified it will override the `--pe-version` option.
+
+##### Specifying a tarball URL
+To install PE using a tarball URL, specify `--pe-tarball=https://my.host.tarball.tar.gz`.
+
+##### Specifying a tarball path
+To install PE using a tarball on a local or remote filesystem, specify `--pe-tarball=/path/to/tarball.tar.gz`.
+
+#### --pe-version
+RefArchSetup can install a specific version of PE or the latest version. 
+See the [Puppet Enterprise Version History](https://puppet.com/misc/version-history) for a comprehensive list of PE versions.
+
+##### Install a specific version
+To install a specific version of PE, specify the version number: `--pe-version=2018.1.4`.
+
+##### Install the latest version 
+To install the latest version, specify `--pe-version=latest`.
+
+#### --pe-conf
+PE installation requires a valid pe.conf file. At a minimum the "console_admin_password" option must be specified.
+RefArchSetup provides a default [pe.conf](fixtures/pe.conf) file. Specify the path to the pe.conf file: `--pe-conf=/path/to/pe.conf`
+
+## Bolt Options
+
+### --sudo-password
+RefArchSetup executes Bolt commands as the root user using the `--run-as` option. 
+If RefArchSetup is run as a user other than root the sudo password must be specified: `--sudo-password=mysudopassword`
+
+### --user
+To execute Bolt commands via ssh with a user other than the user running RefArchSetup, specify `--user=my.ssh.user`. 
+Bolt can authenticate using a password or a private key file.
+
+### --password
+To authenticate using a password, specify `--password=mypassword`.
+
+### --private-key
+To authenticate using a private key, specify `--private-key=/path/to/my_key.rsa`.
+
+# License
 See [LICENSE](LICENSE) file.
 
 # Support & Issues
-
 Please log tickets and issues in the 
 [SLV project](https://tickets.puppetlabs.com/projects/SLV/).
 
@@ -25,6 +190,5 @@ For additional information on filing tickets, please check out our
 [CONTRIBUTOR doc](CONTRIBUTING.md).
 
 # Maintainers
-
 For information on project maintainers, please check out our
 [MAINTAINERS doc](MAINTAINERS.md).

data/bin/ref_arch_setup

@@ -5,20 +5,27 @@ require "rubygems" unless defined?(Gem)
 require "ref_arch_setup"
 require "optparse"
 
-available_commands = [
-  "install"
-]
+available_commands = %w[install]
 
-options = {}
+available_subcommands = %w[generate-pe-conf bootstrap pe-infra-agent-install configure]
+
+@options      = {}
+@bolt_options = {}
 # options["some_option"] = "some value"  #to set a default value
 
 global = OptionParser.new do |opt|
   opt.banner = <<-BANNER
-  Usage: ref_arch_setup [options] <subcommand> [options]
+  Usage: ref_arch_setup <command> [subcommand] [options]
 
   Available Commands:
 
-    install               - Install a bootstrapped mono PE on target_host
+    install                         - Install a bootstrapped PE on target host
+    install generate-pe-conf        - Generates a pe.conf for the install
+    install bootstrap               - Installs a bare PE on the target host
+    install pe-infra-agent-install  - Installs agents on all PE
+                                      infrastructure nodes
+    install configure               - Configures PE infrastructure nodes to
+                                      reference architecture settings
 
   Available Options:
 
@@ -27,29 +34,161 @@ BANNER
     puts opt
     exit
   end
-  opt.on("-v", "--version", "Show currently running version of ref_arch_setup") do
+  opt.on("-v", "--version", "Show current version of ref_arch_setup") do
     puts RefArchSetup::Version::STRING
     exit 0
   end
 end
 
-subcommands = {
+def install_bolt_opts(opt)
+  opt.on("--user <username>", "SSH username for bolt ssh to target host") do |value|
+    @bolt_options["user"] = value
+  end
+  opt.on("--password <password>", "SSH password for bolt ssh to target host") do |value|
+    @bolt_options["password"] = value
+  end
+  opt.on("--private-key <path>", "Path to SSH private key file for bolt", \
+         "ssh to target host") do |value|
+    @bolt_options["private-key"] = value
+  end
+  opt.on("--sudo-password <password>", "Root user password for privilege escalation") do |value|
+    @bolt_options["sudo-password"] = value
+  end
+end
+
+def install_generate_opts(opt)
+  opt.on("--primary-master <hostname>", "Hostname of primary master") do |value|
+    @options["primary_master"] = value
+  end
+  opt.on("--pe-version <version>", "PE version for base pe.conf file") do |value|
+    @options["pe_version"] = value
+  end
+end
+
+def install_bootstrap(opt)
+  # TODO: remove primary master once we implement getting the host from the pe.conf
+  opt.on("--primary-master <hostname>", "Hostname of primary master") do |value|
+    @options["primary_master"] = value
+  end
+  opt.on("--pe-tarball <path|URL>", "Path or URL to PE tarball") do |value|
+    @options["pe_tarball"] = value
+  end
+  opt.on("--pe-version <version>", "PE version to get tarball for") do |value|
+    @options["pe_version"] = value
+  end
+  opt.on("--pe-conf <path>", "Path to pe.conf file") do |value|
+    @options["pe_conf"] = value
+  end
+end
+
+def install_pe_infra_agent_install(opt)
+  opt.on("--pe-conf <path>", "Path to pe.conf file") do |value|
+    @options["pe_conf"] = value
+  end
+end
+
+def install_configure(opt)
+  opt.on("--pe-conf <path>", "Path to pe.conf file") do |value|
+    @options["pe_conf"] = value
+  end
+end
+
+def install_opts(opt)
+  install_bolt_opts(opt)
+  # This one is here because it is required for generate-pe-conf but not necessarily install
+  opt.on("--console-password <password>", "Password for the PE console") do |value|
+    @options["console_password"] = value
+  end
+  install_generate_opts(opt)
+  install_bootstrap(opt)
+  install_pe_infra_agent_install(opt)
+  install_configure(opt)
+end
+
+commands = {
   "install" => OptionParser.new do |opt|
-    opt.banner = "Usage: ref_arch_setup install [options]"
-    opt.on("--target-host value", "Host to install PE on") do |value|
-      options["target_host"] = value
-    end
-    opt.on("--pe-tarball-path value", "Path to PE tarball") do |value|
-      options["pe_tarball_path"] = value
-    end
-    opt.on("--pe-conf-path value", "Path to pe.conf file") do |value|
-      options["pe_conf_path"] = value
+    opt.set_summary_width(35)
+    opt.banner = <<-BANNER
+    Usage: ref_arch_setup install [options]
+
+    Runs the install subcommands in the following order:
+      generate-pe-conf (unless --pe-conf is provided)
+      bootstrap
+      pe-infra-agent-install (noop for "Standard" ref arch)
+      configure
+
+    Available Options:
+      Either --console-password or --pe-conf required
+    BANNER
+    install_opts(opt)
+  end
+}
+
+subcommands = {
+  "generate-pe-conf" => OptionParser.new do |opt|
+    opt.set_summary_width(35)
+    opt.banner = <<-BANNER
+    Usage: ref_arch_setup install generate-pe-conf [options]
+
+    Generates a pe.conf file for the install.
+    Uses localhost for primary master by default.
+    Uses latest production release for version by default.
+    Places the file in /tmp/ref_arch_setup/pe.conf
+
+    Available Options:
+    BANNER
+    # This one is here because it is required for generate-pe-conf but not necessarily install
+    opt.on("--console-password <password>", "REQUIRED: Password for the PE console") do |value|
+      @options["console_password"] = value
     end
+    install_generate_opts(opt)
+    install_bolt_opts(opt)
+  end,
+  "bootstrap" => OptionParser.new do |opt|
+    opt.set_summary_width(35)
+    opt.banner = <<-BANNER
+    Usage: ref_arch_setup install bootstrap [options]
+
+    Does a bootstrap install of PE on the primary master
+    Uses pe.conf from /tmp/ref_arch_setup/pe.conf by default.
+
+    Available Options:
+    BANNER
+    install_bootstrap(opt)
+    install_bolt_opts(opt)
+  end,
+  "pe-infra-agent-install" => OptionParser.new do |opt|
+    opt.set_summary_width(35)
+    opt.banner = <<-BANNER
+    Usage: ref_arch_setup install pe-infra-agent-install [options]
+
+    Installs puppet agents on all PE infrastructure nodes other than
+    the primary master
+    Uses pe.conf from the primary master by default.
+
+    Available Options:
+    BANNER
+    install_pe_infra_agent_install(opt)
+    install_bolt_opts(opt)
+  end,
+  "configure" => OptionParser.new do |opt|
+    opt.set_summary_width(35)
+    opt.banner = <<-BANNER
+    Usage: ref_arch_setup install configure [options]
+
+    Configures all PE infrastructure nodes, including initial performance tuning
+    Uses pe.conf from from the primary master by default.
+
+    Available Options:
+    BANNER
+    install_configure(opt)
+    install_bolt_opts(opt)
   end
 }
 
 global.order!(ARGV)
 command_string = ARGV[0]
+subcommand_string = ARGV[1]
 
 if command_string.nil?
   puts global.help
@@ -57,13 +196,23 @@ if command_string.nil?
 end
 
 unless available_commands.include?(command_string)
-  puts "# ERROR, #{cmd} is not an available command"
+  puts "# ERROR, #{command_string} is not an available command"
   puts
   puts global.help
   exit 1
 end
 
-subcommands[command_string].parse!
-
-cli = RefArchSetup::CLI.new(options)
-cli.send(command_string)
+cli = RefArchSetup::CLI.new(@options, @bolt_options)
+if subcommand_string !~ /^[a-zA-Z]/
+  commands[command_string].parse!
+  exit cli.run(command_string)
+else
+  unless available_subcommands.include?(subcommand_string)
+    puts "# ERROR, #{subcommand_string} is not an available subcommand of #{command_string}"
+    puts
+    puts global.help
+    exit 1
+  end
+  subcommands[subcommand_string].parse!
+  exit cli.run(command_string, subcommand_string)
+end