ref_arch_setup 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8c6aca4691fde2196748ac621990f7b9c401ab0
+  data.tar.gz: be7e2c0c347e402d5482b68e0f26a74347b26144
+SHA512:
+  metadata.gz: 004016af7b7d615cd4c6f40b4ecea50f2b05fd65ba428516c05e2af52ded69a271de7aa9993220fcbf042d4f9dd6a69357a75723acd835977eda2449e0464679
+  data.tar.gz: daadb2ae7760654854e2e9b8fc4f0638d417bd3f0332c44cee99af3cf18f7775d5f0453fbe5cdad771130a01a84b492652238111d6e6d1e2353b0bc91d4b5cd5

data/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# 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.
+  * 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
+* Create a topic branch from your local copy of the repository. 
+  * Please title the branch after the ticket you intend to address, ie `SLV-111`.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in the proper format.
+
+````
+    (SLV-111) Make the example in CONTRIBUTING imperative and concrete
+
+    Without this patch applied the example commit message in the CONTRIBUTING
+    document is not a concrete example.  This is a problem because the
+    contributor is left to imagine what the commit message should look like
+    based on a description rather than an example.  This patch fixes the
+    problem by making the example concrete and imperative.
+
+    The first line is a real life imperative statement with a ticket number
+    from our issue tracker.  The body describes the behavior without the patch,
+    why this is a problem, and how the patch fixes the problem when applied.
+````
+
+* During the time that you are working on your patch the master branch may have changed - you'll want to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) on top of the master branch before you submit your PR.  
+A successful rebase ensures that your PR will cleanly merge.
+
+### Testing
+
+* Submitted PR's will be tested in a series of spec and acceptance level tests - the results of these tests will be evaluated by an SLV team member, as test results are currently not accessible by the public. Testing failures that require code changes will be communicated in the PR discussion.
+* Make sure you have added [RSpec](http://rspec.info/) tests that exercise your new code.
+
+### Documentation
+
+* Make sure that you have added documentation using [Yard](http://yardoc.org/) as necessary for any new code introduced.
+* More user friendly documentation will be required for PRs unless exempted. Documentation lives in the [docs/ folder](docs).
+
+## Making Trivial Changes
+
+### Maintenance
+
+For changes of a trivial nature, it is not always necessary to create a new ticket in Jira. In this case, it is appropriate to start the first line of a commit with `(MAINT)` instead of a ticket/issue number. 
+
+````
+    (MAINT) Fix whitespace 
+
+    - remove additional spaces that appear at EOL
+````
+
+## Submitting Changes
+
+* Push your changes to a topic branch of the repository.
+* Submit a pull request to [ref_arch_setup](https://github.com/puppetlabs/ref_arch_setup)
+* Update your [Jira](https://tickets.puppetlabs.com) ticket
+  * Update the status to "Ready for Merge".
+  * Include a link to the pull request in the ticket.
+
+## Building And Publishing The Gem
+
+### RubyGems.org
+* Create a [rubygems.org](rubygems.org) account if you don't already have one.
+* Use your email and password when pushing the gem. The credentials will be stored in ~/.gem/credentials.
+
+### Bundler Release Tasks
+
+RefArchSetup includes the [Bundler release rake tasks](https://bundler.io/v1.12/guides/creating_gem.html#releasing-the-gem) via [gem_of](https://github.com/puppetlabs/gem_of) which simplifies the build and release process.
+The following tasks are included:
+````
+rake gem:build                  # Build ref_arch_setup-0.0.1.gem into the pkg directory
+rake gem:clean                  # Remove any temporary products
+rake gem:clobber                # Remove any generated files
+rake gem:install                # Build and install ref_arch_setup-0.0.1.gem into system gems
+rake gem:install:local          # Build and install ref_arch_setup-0.0.1.gem into system gems without network access
+rake gem:release[remote]        # Create tag v0.0.1 and build and push ref_arch_setup-0.0.1.gem to rubygems.org
+````
+
+To publish the gem to RubyGems.org, use the `release` task:
+
+````
+    $ rake gem:release
+````
+
+This will create a new tag for the release, push it to GitHub, build the gem, and push it to RubyGems.org.
+
+### Version Bump For Gem Release
+
+* Update the `version.rb` file with the upcoming gem version number to prepare for the next gem release.  
+* Commit the update with `(GEM)` instead of a ticket/issue number.
+
+````
+     (GEM) Update version for ref_arch_setup 1.11.1
+````
+* Submit a pull request for the version update to [ref_arch_setup](https://github.com/puppetlabs/ref_arch_setup)
+
+# Additional Resources
+
+* [Puppet community guidelines](https://docs.puppet.com/community/community_guidelines.html)
+* [Bug tracker (Jira)](http://tickets.puppetlabs.com)
+* [SLV Jira Project](https://tickets.puppetlabs.com/projects/SLV/)
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+

data/MAINTAINERS

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "file_format": "This MAINTAINERS file format is described at https://github.com/puppetlabs/maintainers",
+  "issues": "https://tickets.puppetlabs.com/projects/SLV/",
+  "internal_list": "https://groups.google.com/a/puppet.com/forum/?hl=en#!forum/silver-team",
+  "people": [
+    {
+      "github": "RandellP",
+      "email": "team-system-level-validation@puppet.com",
+      "name": "Randell Pelak"
+    }
+  ]
+}

data/README.md

@@ -0,0 +1,30 @@
+# RefArchSetup
+
+## Overview
+
+RefArchSetup is a gem designed to help install the various puppet reference architectures
+
+# Installation
+
+    $ gem install ref_arch_setup
+
+# Usage
+
+    TBD
+
+# License
+
+See [LICENSE](LICENSE) file.
+
+# Support & Issues
+
+Please log tickets and issues in the 
+[SLV project](https://tickets.puppetlabs.com/projects/SLV/).
+
+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

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+STDOUT.sync
+
+require "rubygems" unless defined?(Gem)
+require "ref_arch_setup"
+require "optparse"
+
+available_commands = [
+  "install"
+]
+
+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]
+
+  Available Commands:
+
+    install               - Install a bootstrapped mono PE on target_host
+
+  Available Options:
+
+BANNER
+  opt.on("-h", "--help", "Prints this help") do
+    puts opt
+    exit
+  end
+  opt.on("-v", "--version", "Show currently running version of ref_arch_setup") do
+    puts RefArchSetup::Version::STRING
+    exit 0
+  end
+end
+
+subcommands = {
+  "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
+    end
+  end
+}
+
+global.order!(ARGV)
+command_string = ARGV[0]
+
+if command_string.nil?
+  puts global.help
+  exit 0
+end
+
+unless available_commands.include?(command_string)
+  puts "# ERROR, #{cmd} 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)

data/lib/ref_arch_setup.rb

@@ -0,0 +1,8 @@
+# General namespace for RAS
+module RefArchSetup
+  %w[cli version install].each do |lib|
+    require "ref_arch_setup/#{lib}"
+  end
+  # location of modules shipped with RAS (Ref Arch Setup)
+  RAS_MODULE_PATH = File.dirname(__FILE__) + "/../modules"
+end

data/lib/ref_arch_setup/cli.rb

@@ -0,0 +1,89 @@
+require "optparse"
+
+module RefArchSetup
+  # Implements the command line subcommands
+  #
+  # @author Randell Pelak
+  # @attr [hash] options Options from the command line
+  class CLI
+    # Initialize class
+    #
+    # @author Randell Pelak
+    #
+    # @param [Hash] options The options from the command line
+    # @option options [String] something not yet defined
+    #
+    # @return [void]
+    def initialize(options)
+      @options = options
+    end
+
+    # Check values of options to see if they are really an option
+    #
+    # optparse will gobble up the next option if no value is given
+    # This checks option values for things that start with --
+    # and then assumes the user forgot to provide a value
+    # This is okay as long as we don't need to support values with --
+    #
+    # @author Randell Pelak
+    #
+    # @raise [OptionParser::MissingArgument] Thrown if an option is missing and argument
+    #
+    # @example check_for_missing_value
+    #
+    # @return [void]
+    def check_for_missing_value
+      @options.each do |key, value|
+        raise OptionParser::MissingArgument, key if value =~ /^--/
+      end
+    end
+
+    # Checks for an option that is required by the sub command
+    #
+    # @author Randell Pelak
+    #
+    # @param [string] option the name of the option
+    # @param [string] subcommand the name of the subcommand
+    #
+    # @example check_option("target_host", "install")
+    #
+    # @raise [OptionParser::MissingOption] Thrown if option is missing
+    #
+    # @return [void]
+    def check_option(option, subcommand)
+      return unless @options[option].nil? || @options[option].empty?
+      option.tr!("_", "-")
+      raise OptionParser::MissingOption, \
+            "option --#{option} is required for the #{subcommand} subcommand"
+    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"])
+      return success
+    end
+  end
+end
+
+# from optparse
+class OptionParser
+  # Adds an exception for missing a required option
+  #
+  # OptionParser doesn't handle required options, only required arguments to the options
+  # And even that it doesn't do all that well.
+  # This creates a missing argument exception for use by this CLI class
+  #
+  # @author Randell Pelak
+  class MissingOption < ParseError
+    const_set(:Reason, "missing option".freeze)
+  end
+end

data/lib/ref_arch_setup/install.rb

@@ -0,0 +1,44 @@
+# General namespace for RAS
+module RefArchSetup
+  # Installation helper
+  #
+  # @author Randell Pelak
+  #
+  # @attr [string] target_master Host to install on
+  class Install
+    # Initialize class
+    #
+    # @author Randell Pelak
+    #
+    # @param [string] target_master Host to install on
+    #
+    # @return [void]
+    def initialize(target_master)
+      @target_master = target_master
+    end
+
+    # Runs the initial bootstrapping install
+    #
+    # @author Randell Pelak
+    #
+    # @param [string] pe_conf_path Path to pe.conf
+    # @param [string] pe_tarball_path Path to pe tarball
+    # @param [string] target_master Host to install on
+    #
+    # @return [true,false] Based on exit status of the bolt task
+    def bootstrap_mono(pe_conf_path, pe_tarball_path, target_master = @target_master)
+      env_vars = "PE_CONF_PATH=#{pe_conf_path};"
+      env_vars << "PE_TARBALL_PATH=#{pe_tarball_path};"
+      env_vars << "PE_TARGET_MASTER=#{target_master};"
+      command = env_vars.to_s + "bolt task run bogus::foo "
+      command << "--modulepath #{RAS_MODULE_PATH} --nodes #{target_master}"
+      puts "Running: #{command}"
+      output = `#{command}`
+      success = $?.success? # rubocop:disable Style/SpecialGlobalVars
+      puts "ERROR: bolt command failed!" unless success
+      puts "Exit status was: #{$?.exitstatus}" # rubocop:disable Style/SpecialGlobalVars
+      puts "Output was: #{output}"
+      return success
+    end
+  end
+end

data/lib/ref_arch_setup/version.rb

@@ -0,0 +1,7 @@
+module RefArchSetup
+  # Module for holding version info
+  module Version
+    # Version number
+    STRING = "0.0.1".freeze
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: ref_arch_setup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Puppet, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bolt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: |-
+  This gem provides methods for for setting up /
+                                  Puppet Enterprise reference architectures
+email:
+- team-system-level-validation@puppet.com
+executables:
+- ref_arch_setup
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- MAINTAINERS
+- README.md
+- bin/ref_arch_setup
+- lib/ref_arch_setup.rb
+- lib/ref_arch_setup/cli.rb
+- lib/ref_arch_setup/install.rb
+- lib/ref_arch_setup/version.rb
+homepage: https://github.com/puppetlabs/ref_arch_setup
+licenses:
+- Apache2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Tool for setting up reference architectures
+test_files: []