puppet-classroom-manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91bd91d0dc4b47cffaf1dcc62cb23f167e9ac4e5
+  data.tar.gz: 1f74d7f92c3b89f52528cbdf1771749d512508f9
+SHA512:
+  metadata.gz: c2a71798353538217e3e563360204406b0004ddb540969c80a2f56e0701afcec7506eeb8c18ce6cd50a819695289d4cd25ef161bad623f4949bf274c500c55c4
+  data.tar.gz: c2d572e1ac680bf66210f9e9b210bee4c372e66fff808c54f91c6058d73b45367e314b8f3b3c9cc40af4984f3404162a696ef2a122744dfda3062c19fa2f47bd

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,52 @@
+# Puppet Classroom Manager
+
+Usage : `classroom <action> [subject] [options]`
+
+Manage Puppet classroom VMs and updating courseware. This includes
+troubleshooting and maintenance tasks to be used as needed during
+the delivery and facilities for resetting the VM for use across
+multiple deliveries. This is pre-installed on the classroom VM and
+is only of use to trainers delivering Puppet Inc. classes.
+
+Available actions:
+
+* `classroom update`
+  This updates your VM to the latest released version. This includes all
+  cached packages, gems, modules, etc. and pre-installed courseware.
+
+  You should run this command before each delivery. It may take several
+  minutes to complete. When finished, it will run the validate task.
+
+* `classroom validate`
+  This runs built in serverspec tests to check the VM for consistency.
+  It is run automatically by the update task so you likely don't need
+  to run it yourself.
+
+* `classroom submit`
+  This task replaces the old `rake submit` tasks and uploads classroom
+  statistics to the EDU department for analysis.
+
+* `classroom sanitize`
+  Running this task will remove all traces of students in preparation
+  for using the same VM for the next delivery.
+
+* `classroom performance log <message>`
+  The VM periodically records performance metrics. These are included
+  in the information uploaded with the `submit` task. This task allows
+  you to annotate those logs with arbitrary information.
+
+* `classroom reset password | certificates | filesync`
+  This task resets the specified information. Using this to reset the
+  root password ensures that it is still displayed on the login console.
+  This can also regenerate all monolithic PE certificates or use the
+  so-called "nuclear" option to blow away and redeploy filesync.
+
+* `classroom restart <PE services>`
+  Gracefully restart PE services in the proper order. Run without a
+  service to see usage information.
+
+* `classroom troubleshoot`
+  Run through various troubleshooting checks and fixes.
+
+* `classroom page`
+  This will page on call classroom support in case of emergency.

data/bin/classroom

@@ -0,0 +1,115 @@
+#! /usr/bin/env ruby
+require 'optparse'
+require 'logger'
+
+require 'classroom'
+
+$logger = Logger.new(STDOUT)
+$logger.level = Logger::INFO
+$logger.formatter = proc do |severity, datetime, progname, msg|
+    "#{severity}: #{msg}\n"
+end
+
+config = {}
+optparse = OptionParser.new { |opts|
+    opts.banner = "Usage : classroom <action> [subject] [options]
+
+        Manage Puppet classroom VMs and updating courseware. This includes
+        troubleshooting and maintenance tasks to be used as needed during
+        the delivery and facilities for resetting the VM for use across
+        multiple deliveries. This is pre-installed on the classroom VM.
+
+        Type courseware help for full usage instructions.
+
+"
+
+    opts.on("-d", "--debug", "Display debugging messages") do
+        $logger.level = Logger::DEBUG
+    end
+
+    opts.on("-f", "--force", "When restarting services, force a hard restart.") do
+      config[:force] = true
+    end
+
+    opts.separator('')
+
+    opts.on("-v", "--version", "Print out the version") do
+        require 'courseware/version'
+        puts Courseware::VERSION
+        exit
+    end
+
+    opts.on("-h", "--help", "Displays this help") do
+      puts opts
+      puts
+      exit 1
+    end
+}
+optparse.parse!
+
+# hardcode for now. Decide if we need configurability later
+config[:basedir]  = '/opt/pltraining'
+config[:bindir]   = "#{config[:basedir]}/bin"
+config[:confdir]  = "#{config[:basedir]}/etc/puppet"
+config[:specdir]  = "#{config[:basedir]}/spec"
+config[:learndot] = 'https://learn.puppet.com/manage/instructor/dashboard.html'
+
+# grab the arguments after we've scraped the options out
+verb, *subject = ARGV.collect {|arg| arg.to_sym }
+
+classroom = Classroom.new(config)
+begin
+  case verb
+  when :update
+    classroom.update
+    classroom.validate
+
+  when :validate
+    classroom.validate
+    # serverspec tests on the master MV
+
+  when :submit
+    classroom.submit
+    # submit classroom presentation stats
+
+  when :sanitize
+    classroom.sanitize
+    # remove users, etc to start a new delivery
+
+  when :performance
+    classroom.performance subject
+    # reset certificates, environments, node groups, courseware, etc
+    # is this even a thing???
+
+  when :reset
+    classroom.reset subject
+    # reset master certificates
+    # reset VM password
+
+  when :restart
+    classroom.restart subject
+    # restart PE services
+
+  when :troubleshoot
+    classroom.troubleshoot
+    # run troubleshooting scripts
+
+  when :page
+    classroom.page
+
+  when :help
+    classroom.help
+
+  when :shell
+    classroom.debug
+
+  else
+    $logger.warn "Unknown verb: #{verb}"
+    classroom.help
+
+  end
+rescue RuntimeError => e
+  puts "Error: #{e.message}"
+  puts e.backtrace.join("\n\t") if config[:debug]
+  exit 1
+end

data/lib/classroom/help.rb

@@ -0,0 +1,59 @@
+class Classroom
+  HELP = <<-EOF
+
+Usage : classroom <action> [subject] [options]
+
+Manage Puppet classroom VMs and updating courseware. This includes
+troubleshooting and maintenance tasks to be used as needed during
+the delivery and facilities for resetting the VM for use across
+multiple deliveries. This is pre-installed on the classroom VM and
+is only of use to trainers delivering Puppet Inc. classes.
+
+Available actions:
+
+* classroom update:
+  This updates your VM to the latest released version. This includes all
+  cached packages, gems, modules, etc. and pre-installed courseware.
+
+  You should run this command before each delivery. It may take several
+  minutes to complete. When finished, it will run the validate task.
+
+* classroom validate
+  This runs built in serverspec tests to check the VM for consistency.
+  It is run automatically by the update task so you likely don't need
+  to run it yourself.
+
+* classroom submit
+  This task replaces the old `rake submit` tasks and uploads classroom
+  statistics to the EDU department for analysis.
+
+* classroom sanitize
+  Running this task will remove all traces of students in preparation
+  for using the same VM for the next delivery.
+
+* classroom performance log <message>
+  The VM periodically records performance metrics. These are included
+  in the information uploaded with the `submit` task. This task allows
+  you to annotate those logs with arbitrary information.
+
+* classroom reset password | certificates | filesync
+  This task resets the specified information. Using this to reset the
+  root password ensures that it is still displayed on the login console.
+  This can also regenerate all monolithic PE certificates or use the
+  so-called "nuclear" option to blow away and redeploy filesync.
+
+* classroom restart <PE services>
+  Gracefully restart PE services in the proper order. Run without a
+  service to see usage information.
+
+* classroom troubleshoot
+  Run through various troubleshooting checks and fixes.
+
+* classroom page
+  This will page on call classroom support in case of emergency.
+
+* classroom help
+  You're looking at it!
+
+EOF
+end

data/lib/classroom/page.rb

@@ -0,0 +1,41 @@
+class Classroom
+  def page
+    require 'json'
+    require 'rest-client'
+
+    begin
+      config = JSON.parse(File.read('/opt/pltraining/etc/classroom.json'))
+      pd_key = File.read('/opt/pltraining/etc/pagerduty.key')
+    rescue => e
+      puts "Cannot load configuration"
+      puts e.message
+      exit 1
+    end
+
+    puts "---------  You're about to page and possibly wake somone up.  ---------"
+    puts "Please check the Troubleshooting Guide for solutions to common problems."
+    puts
+    puts "https://github.com/puppetlabs/courseware/blob/master/TroubleshootingGuide.md"
+    puts
+    if confirm?("Have you done everything in the troubleshooting guide?") then
+      puts "Sending page. Make sure you've posted about the issue in HipChat."
+      config = load_metadata
+      page_message = "Instructor: #{config['name']}\n" +
+                     "Email: #{config['email']}\n" +
+                     "Course: #{config['course']}\n" +
+                     "ID: #{config['event_id']}"
+      page_data = {
+        "service_key" => pd_key,
+        "event_type"  => "trigger",
+        "description" => page_message
+      }
+      response = RestClient.post(
+        "https://events.pagerduty.com/generic/2010-04-15/create_event.json",
+        page_data.to_json,
+        :content_type => :json,
+        :accept => :json
+      )
+      puts response
+    end
+  end
+end

data/lib/classroom/performance.rb

@@ -0,0 +1,41 @@
+class Classroom
+  def performance(subject)
+    if subject.empty?
+      puts "This will take performance related snapshots, which will be uploaded for"
+      puts "engineering analysis. You may also record performance notes into the log."
+      puts
+      puts "Usage: classroom performance [ log <message>  | snapshot ]"
+      puts
+      puts "  * log: Record a message into classroom log and take a snapshot."
+      puts "  * snapshot: Save snapshot of classroom statistics."
+      puts
+      exit 1
+    end
+
+    case subject.shift
+    when 'log'
+      message = subject.empty? ? "Misc performance issue noted." : subject.join(' ')
+      $logger.warn message
+      record_snapshot
+
+    when 'snapshot'
+      $logger.debug "Scheduled performance snapshot"
+      record_snapshot
+
+    else
+      raise "No such action"
+    end
+
+    def record_snapshot
+      $logger.debug "-------------------------------- top -bn1 ----------------------------------\n#{`top -bn1`}"
+      $logger.debug "-------------------------------- vmstat ------------------------------------\n#{`vmstat`}"
+      $logger.debug "-------------------------------- netstat -a --------------------------------\n#{`netstat -a`}"
+      $logger.debug "-------------------------------- iostat ------------------------------------\n#{`iostat`}"
+      $logger.debug "-------------------------------- mpstat -P ALL -----------------------------\n#{`mpstat -P ALL`}"
+
+      FileUtils.mkdir_p '/var/log/puppetlabs/classroom-traffic'
+      `tcpdump -G 15 -W 1 -w /var/log/puppetlabs/classroom-traffic/#{Time.now.to_i}.pcap -i any > /dev/null 2>&1 &`
+    end
+
+  end
+end

data/lib/classroom/reset.rb

@@ -0,0 +1,121 @@
+class Classroom
+  def reset(subject)
+    if subject.size != 1
+      puts <<-EOF
+Usage: classroom reset <password | certificates | filesync>
+
+This tool will reset or regenerate:
+  * root's login password and update the /etc/issue screen
+  * delete and redeploy all FileSync caches
+  * *all* ssl certificates in the PE stack. (warning: destructive!)
+
+EOF
+      exit 1
+    end
+
+    case subject.first
+    when :password
+      reset_password
+    when :certificates
+      reset_certificates
+    when :filesync
+      reset_filesync
+    else
+      raise "Unknown action."
+    end
+  end
+
+  def reset_password
+    print "Enter new root password: "
+    password = gets.chomp
+
+    %x(echo "root:#{password}"|chpasswd)
+
+    File.open('/var/local/password','w') do |f|
+      f.puts password
+    end
+
+    %x(/etc/rc.local 2>/dev/null)
+  end
+
+  def reset_certificates
+    require "fileutils"
+
+    # Automate the process of regenerating certificates on a monolithic master
+    # https://docs.puppet.com/pe/latest/trouble_regenerate_certs_monolithic.html
+    #
+    timestamp     = Time.now.to_i
+    certname      = `puppet master --configprint certname`.strip
+    ssldir        = '/etc/puppetlabs/puppet/ssl'
+    puppetdbcerts = '/etc/puppetlabs/puppetdb/ssl'
+    consolecerts  = '/opt/puppetlabs/server/data/console-services/certs'
+    pgsqlcerts    = '/opt/puppetlabs/server/data/postgresql/9.4/data/certs'
+    orchcerts     = '/etc/puppetlabs/orchestration-services/ssl'
+
+    ["puppet", "puppetdb", "console-services", "postgresql", "orchestration"].each do |path|
+      FileUtils.mkdir_p("/root/certificates.bak/#{path}")
+    end
+    FileUtils.cp_r("#{ssldir}",        "/root/certificates.bak/puppet/#{timestamp}")
+    FileUtils.cp_r("#{puppetdbcerts}", "/root/certificates.bak/puppetdb/#{timestamp}")
+    FileUtils.cp_r("#{consolecerts}",  "/root/certificates.bak/console-services/#{timestamp}")
+    FileUtils.cp_r("#{pgsqlcerts}",    "/root/certificates.bak/postgresql/#{timestamp}")
+    FileUtils.cp_r("#{orchcerts}",     "/root/certificates.bak/orchestration/#{timestamp}")
+
+    puts "Certificates backed up to ~/certificates.bak"
+
+    puts
+    puts
+    puts "#####################################################################"
+    puts
+    puts "      If you regenerate the Puppet CA to start fresh, then"
+    puts "ALL client certificates will be invalidated and must be regenerated!"
+    puts
+    puts "        -- This should only be done as a last resort --"
+    puts
+    puts "#####################################################################"
+    puts
+    if confirm?('Would you like to regenerate the CA?', false)
+      FileUtils.rm_rf("#{ssldir}/*")
+      system("puppet cert list -a")
+    end
+
+    FileUtils.rm_f("/opt/puppetlabs/puppet/cache/client_data/catalog/#{certname}.json")
+    system("puppet cert clean #{certname}")
+    system("puppet infrastructure configure --no-recover")
+    system("puppet agent -t")
+
+    puts "All done. If you regenerated the CA, then regenerate all client certificates now."
+  end
+
+  def reset_filesync
+    puts
+    puts
+    puts "################################################################################"
+    puts
+    puts "This script will completely delete and redeploy all environments without backup!"
+    puts "            The operation may take up to five minutes to complete."
+    puts
+    puts "################################################################################"
+    puts
+    bailout?
+
+    system("systemctl stop pe-puppetserver")
+
+    # filesync cache
+    FileUtils.rm_rf("/opt/puppetlabs/server/data/puppetserver/filesync")
+
+    # r10k cache
+    FileUtils.rm_rf("/opt/puppetlabs/server/data/code-manager/git")
+
+    # code manager worker thread caches
+    FileUtils.rm_rf("/opt/puppetlabs/server/data/code-manager/worker-caches")
+    FileUtils.rm_rf("/opt/puppetlabs/server/data/code-manager/cache")
+
+    # possibly stale environment codebases
+    FileUtils.rm_rf("/etc/puppetlabs/code/*")
+    FileUtils.rm_rf("/etc/puppetlabs/code-staging/environments")
+
+    system("systemctl start pe-puppetserver")
+    system("puppet code deploy --all --wait")
+  end
+end

data/lib/classroom/restart.rb

@@ -0,0 +1,91 @@
+class Classroom
+  def restart(subject)
+    if subject.empty?
+      puts <<-EOF
+This tool simply helps restart the PE services in the right order.
+It will send a HUP signal to Puppetserver by default which is much
+faster than a full restart.
+
+You can also restart Docker containers in classes that use them.
+
+If you do need the full restart, please pass the -f option.
+
+Service names:
+    * puppetserver
+    * console
+    * puppetdb
+    * orchestration
+    * mcollective
+    * containers
+    * all (restart all PE services in the proper order)
+
+Examples:
+    * classroom restart puppetdb puppetserver
+    * classroom restart puppetserver console -f
+    * classroom restart all -f
+
+EOF
+      exit 1
+    end
+
+    # normalize to lowercase strings so we can pattern match
+    subject.map! { |x| x.to_s.downcase }
+
+    if subject.include? 'all'
+      puts "Restarting all PE stack services. This may take a few minutes..."
+      subject.concat ['puppetdb', 'puppetserver', 'orchestrator', 'console', 'mcollective', 'puppet']
+      subject.uniq!
+    else
+      puts "Restarting selected PE components."
+    end
+
+    if subject.grep(/puppetdb|pdb/).any?
+      restart_service('pe-postgresql.service')
+      restart_service('pe-puppetdb.service')
+    end
+
+    if subject.grep(/puppetserver|server/).any?
+      if @config[:force]
+        restart_service('pe-puppetserver.service')
+      else
+        reload_service('pe-puppetserver.service', 'puppet-server')
+      end
+    end
+
+    if subject.grep(/orch|pxp/).any?
+      restart_service('pe-orchestration-services.service')
+      restart_service('pxp-agent.service')
+    end
+
+    if subject.grep(/console/).any?
+      restart_service('pe-console-services.service')
+      restart_service('pe-nginx.service')
+    end
+
+    if subject.grep(/mco/).any?
+      restart_service('pe-activemq.service')
+      restart_service('mcollective.service')
+    end
+
+    if subject.include? 'puppet'
+      restart_service('puppet.service')
+    end
+
+    if subject.include? 'containers'
+      `systemctl list-units`.each_line do |line|
+          restart_service($1) if line =~ /^(docker-\S+)/
+      end
+    end
+
+  end
+
+  def restart_service(service)
+    puts "- Restarting #{service}..."
+    system("systemctl restart #{service}")
+  end
+
+  def reload_service(service, pattern)
+    puts "> Reloading #{service}..."
+    system("kill -HUP `pgrep -f #{pattern}`")
+  end
+end

data/lib/classroom/sanitize.rb

@@ -0,0 +1,76 @@
+class Classroom
+  def sanitize
+    require 'yaml'
+    require 'fileutils'
+    require 'puppetclassify'
+
+    puts 'Sanitizing your VM for your next delivery...'
+
+    certname     = `puppet master --configprint certname`.strip
+    master       = `puppet agent --configprint server`.strip
+    classifier   = "http://#{master}:4433/classifier-api"
+    known_groups = [ 'All Nodes', 'Agent-specified environment', 'Production environment', /PE / ]
+    known_users  = [ 'admin"=', 'api_user', 'deployer' ]
+    auth_info    = {
+      'ca_certificate_path' => `puppet master --configprint localcacert`.strip,
+      'certificate_path'    => `puppet master --configprint hostcert`.strip,
+      'private_key_path'    => `puppet master --configprint hostprivkey`.strip,
+    }
+
+    group_pattern  = Regexp.union(known_groups)
+    puppetclassify = PuppetClassify.new(classifier, auth_info)
+    puppetclassify.groups.get_groups.each do |group|
+      next if group['name'].match(group_pattern)
+      puppetclassify.groups.delete_group(group['id'])
+      print '.'
+    end
+    puts
+
+    # depends on pltraining/rbac module
+    users = YAML.load(`puppet resource rbac_user --to_yaml`)
+    users['rbac_user'].each do |user, data|
+      next if known_users.include? user
+      puts "puppet resource rbac_user #{user} ensure=absent"
+      system("puppet resource rbac_user #{user} ensure=absent")
+      print '.'
+    end
+    puts
+
+    `puppet cert list --all --machine-readable`.each_line do |line|
+      next unless line.start_with? '+'
+      name = line.gsub('"', '').split[1]
+      next if name.start_with? 'pe-internal'
+      next if name == certname
+
+      system("puppet node deactivate #{name}")
+      system("puppet cert clean #{name}")
+      print '.'
+    end
+    puts
+
+    Dir.glob('/home/*').each do |path|
+      next if ['/home/training', '/home/showoff'].include? path
+      system("userdel #{File.basename(path)}")
+      FileUtils.rm_rf path
+      print '.'
+    end
+    puts
+
+    Dir.glob('/etc/puppetlabs/code-staging/environments/*').each do |path|
+      next if File.basename(path) == 'production'
+      FileUtils.rm_rf path
+      print '.'
+    end
+    puts
+
+    Dir.glob('/etc/puppetlabs/code/environments/*').each do |path|
+      next if File.basename(path) == 'production'
+      FileUtils.rm_rf path
+      print '.'
+    end
+    puts
+
+    FileUtils.rm_rf('/var/repositories/*')
+  end
+
+end

data/lib/classroom/submit.rb

@@ -0,0 +1,72 @@
+class Classroom
+  def submit
+    require 'fileutils'
+    require 'aws-sdk'
+
+    if puppetlabs_instructor?
+      puts "Please go to your learn dashboard and ensure that attendance is accurate"
+      puts "and then close this class delivery to mark it as complete."
+      puts " -- #{@config[:learndot]}"
+      puts
+    end
+
+    presentation = showoff_working_directory()
+
+    data = JSON.parse(File.read("#{presentation}/stats/metadata.json")) rescue {}
+    event_id = data['event_id'] || Time.now.to_i
+    course   = data['course']   || 'none'
+    email    = data['email']    || 'none'
+
+    begin
+      # depends on root's credentials as managed by bootstrap
+      s3 = Aws::S3::Resource.new(region:'us-west-2')
+
+      # record the module versions in use
+      system("puppet module list > /var/log/puppetlabs/classroom-modules")
+
+      filename = "classroom-perflogs-#{course}-#{email}-#{event_id}.tar.gz"
+      system("tar -cf /var/cache/#{filename} /var/log/puppetlabs/")
+      obj = s3.bucket(PERF_BUCKET).object(filename)
+      obj.upload_file("/var/cache/#{filename}")
+      FileUtils.rm(filename)
+
+      filename = "classroom-stats-#{course}-#{email}-#{event_id}.tar.gz"
+      system("tar -cf /var/cache/#{filename} #{presentation}/stats/")
+      obj = s3.bucket(STATS_BUCKET).object(filename)
+      obj.upload_file("/var/cache/#{filename}")
+      FileUtils.rm(filename)
+
+    rescue LoadError, StandardError => e
+      LOGGER.warn "S3 upload failed. No network?"
+      LOGGER.warn e.message
+      LOGGER.debug e.backtrace
+    end
+
+    # clean up for next delivery
+    system("puppet resource service showoff-courseware ensure=stopped")
+    FileUtils.rm_rf("#{presentation}/stats")
+    FileUtils.rm_f("#{presentation}/courseware.yaml")
+    FileUtils.rm_f("#{presentation}/_files/share/nearby_events.html")
+    system("puppet resource service showoff-courseware ensure=running")
+
+  end
+
+  def puppetlabs_instructor?
+    # TODO: how do?
+    false
+  end
+
+  def showoff_working_directory
+    # get the path of the currently configured showoff presentation
+    data = {}
+    path = '/usr/lib/systemd/system/showoff-courseware.service'
+    File.read(path).each_line do |line|
+      setting = line.split('=')
+      next unless setting.size == 2
+
+      data[setting.first] = setting.last
+    end
+    data['WorkingDirectory']
+  end
+
+end

data/lib/classroom/troubleshoot.rb

@@ -0,0 +1,178 @@
+class Classroom
+  def troubleshoot
+    master   = `puppet agent --configprint server`.strip
+    codedir  = `puppet master --configprint codedir`.strip
+    filesync = '/etc/puppetlabs/puppetserver/conf.d/file-sync.conf'
+    release  = File.read('/etc/puppetlabs-release').to_f rescue 0
+    legacy   = release < 7.0
+
+    if File.exist? filesync
+      # why isn't there a configprint setting for this?
+      staging = `hocon -f #{filesync} get file-sync.repos.puppet-code.staging-dir`.strip
+      puts "Running checks for Code Manager configurations:"
+    else
+      staging = codedir
+      puts "Running checks for configurations without Code Manager:"
+    end
+
+    print "Cleaning any stray .git directories in: #{codedir}..."
+    sleep 1
+    system("find #{codedir} -name .git -type d -print -exec rm -rf {} \\;")
+    check_success
+
+    print "Validating permissions on: #{codedir}..."
+    sleep 1
+    system("find #{codedir} '!' -user pe-puppet -print -exec chown pe-puppet:pe-puppet {} \\;")
+    check_success
+
+    if codedir != staging
+      puts "Validating permissions on: #{staging}..."
+      sleep 1
+      system("find #{staging} '!' -user pe-puppet -print -exec chown pe-puppet:pe-puppet {} \\;")
+      check_success
+    end
+
+    # only check legacy systems that rely on manual installs
+    if legacy
+      if File.exist? '/home/training/courseware'
+        print "Sanitizing uploaded courseware..."
+        sleep 1
+        FileUtils.rm_f '/home/training/courseware/stats/viewstats.json'
+        FileUtils.rm_f '/home/training/courseware/stats/forms.json'
+        check_success
+      else
+        check_success(false)
+        puts "\tYou don't seem to have uploaded the courseware from your host system"
+      end
+    end
+
+    print "Checking Forge connection..."
+    if system("ping -c1 -W2 forge.puppet.com >/dev/null 2>&1")
+      if legacy
+        puts "Ensuring the latest version of pltraining/classroom in #{staging}..."
+        system("puppet module upgrade pltraining/classroom --modulepath #{staging}")
+        check_success
+      else
+        check_success(true)
+      end
+    else
+      if `awk '$1 == "server" {print $2}' /etc/ntp.conf` != master
+        check_success(false)
+        puts "\tCould not reach the Forge. You should classify your master as $offline => true"
+      else
+        puts "\tYou appear to be in offline mode."
+      end
+    end
+
+    if codedir != staging
+      print "Ensuring you have a valid deploy token..."
+      if File.exist? '/root/.puppetlabs/token'
+        token  = `puppet access show`
+        api    = 'https://#{master}:4433/rbac-api/v1/users/current'
+        status = `curl -k --write-out "%{http_code}" --silent --output /dev/null #{api} -H "X-Authentication:#{token}"`.strip
+        if status != "200"
+          print "\nRegenerating invalid token..."
+          FileUtils.rm_f('/root/.puppetlabs/token')
+          check_success
+        end
+      end
+
+      unless File.exist? '/root/.puppetlabs/token'
+        print "\nGenerating new token."
+        system('puppet plugin download > /dev/null')
+        system('puppet resource rbac_user deployer ensure=present display_name=deployer email=deployer@puppetlabs.vm password=puppetlabs roles=4 > /dev/null')
+        system('echo "puppetlabs" | HOME=/root /opt/puppetlabs/bin/puppet-access login deployer --lifetime 14d > /dev/null')
+        check_success
+      else
+        check_success(true)
+      end
+
+      puts
+      puts "If you're having trouble with Code Manager or FileSync, deleting all deployed"
+      puts "code and destroying all caches can sometimes help you get going again."
+      puts
+      if confirm?('Would you like to nuke it all and start over?', false)
+        reset([:filesync])
+      end
+    end
+
+    print "Validating SSL certificates..."
+    if valid_certificates
+      check_success(true)
+    else
+      puts
+      puts "It looks like there is an inconsistency with your master's SSL certificates."
+      puts "Regenerating certificates may take up to five minutes."
+      puts
+      if confirm?('Would you like to try regenerating certificates?', false)
+        reset([:certificates])
+      end
+    end
+
+    puts
+    puts 'Done checking. Fix any errors noted above and try again.'
+    puts 'If still having troubles, try some of the following steps.'
+    puts 'Note that both tail and journalctl have a "-f" follow mode.'
+    puts
+    puts 'Log files:'
+    puts '  * tail /var/log/puppetlabs/puppetserver/puppetserver.log'
+    puts '  * tail /var/log/puppetlabs/console-services/console-services.log'
+    puts '  * tail any other interesting log files in /var/log/puppetlabs'
+    puts 'System logs:'
+    puts '  * journalctl -eu pe-puppetserver'
+    puts '  * journalctl -eu pe-console-services'
+    puts '  * systemctl list-units | egrep "pe-|puppet"'
+    puts 'Edu tools:'
+    puts '  * tail /var/log/puppetfactory'
+    puts '  * journalctl -eu abalone'
+    puts '  * journalctl -eu puppetfactory'
+    puts '  * journalctl -eu showoff-courseware'
+    puts '  * reset_ssl_certificates.sh'
+    puts '  * restart_classroom_services.rb'
+    puts '  * dependency_nuke.rb'
+    puts
+    puts 'Have you searched the Troubleshooting Guide for your issue?'
+    puts "If you're still stuck, page the on-call support with 'classroom page'"
+  end
+
+  def valid_certificates
+    certname      = `puppet master --configprint certname`.strip
+    ssldir        = '/etc/puppetlabs/puppet/ssl'
+    puppetdbcerts = '/etc/puppetlabs/puppetdb/ssl'
+    consolecerts  = '/opt/puppetlabs/server/data/console-services/certs'
+    pgsqlcerts    = '/opt/puppetlabs/server/data/postgresql/9.4/data/certs'
+    orchcerts     = '/etc/puppetlabs/orchestration-services/ssl'
+
+    cert = same_file("#{ssldir}/certs/#{certname}.pem", [
+                                                          "#{puppetdbcerts}/#{certname}.cert.pem",
+                                                          "#{pgsqlcerts}/_local.cert.pem",
+                                                          "#{consolecerts}/#{certname}.cert.pem",
+                                                          "#{orchcerts}/#{certname}.cert.pem",
+                                                        ])
+    public_key = same_file("#{ssldir}/public_keys/#{certname}.pem", [
+                                                          "#{puppetdbcerts}/#{certname}.public_key.pem",
+                                                          "#{consolecerts}/#{certname}.public_key.pem",
+                                                          "#{orchcerts}/#{certname}.public_key.pem",
+                                                        ])
+    private_key = same_file("#{ssldir}/private_keys/#{certname}.pem", [
+                                                          "#{puppetdbcerts}/#{certname}.private_key.pem",
+                                                          "#{pgsqlcerts}/_local.private_key.pem",
+                                                          "#{consolecerts}/#{certname}.private_key.pem",
+                                                          "#{orchcerts}/#{certname}.private_key.pem",
+                                                        ])
+
+    return (cert and public_key and private_key)
+  end
+
+  def same_file(filename, list)
+    require 'digest'
+    list  = Array(list) # coerce if needed
+    left  = Digest::MD5.hexdigest(File.read(filename))
+
+    list.each do |path|
+      return false unless (left == Digest::MD5.hexdigest(File.read(path)))
+    end
+
+    return true
+  end
+end

data/lib/classroom/validate.rb

@@ -0,0 +1,17 @@
+class Classroom
+  def validate
+    require 'rake'
+    require 'rspec/core/rake_task'
+
+    puts "Validating configuration..."
+    Dir.chdir(@config[:specdir]) do
+      RSpec::Core::RakeTask.new(:spec) do |t|
+        t.rspec_opts = "-I #{@config[:specdir]}"
+        t.pattern    = 'localhost/*_spec.rb'
+      end
+
+      Rake::Task[:spec].invoke
+    end
+
+  end
+end

data/lib/classroom/version.rb

@@ -0,0 +1,3 @@
+class Classroom
+  VERSION = '0.0.1'
+end

data/lib/classroom.rb

@@ -0,0 +1,54 @@
+class Classroom
+  require 'classroom/performance'
+  require 'classroom/reset'
+  require 'classroom/restart'
+  require 'classroom/sanitize'
+  require 'classroom/submit'
+  require 'classroom/troubleshoot'
+  require 'classroom/validate'
+  require 'classroom/version'
+
+  def initialize(config)
+    @config = config
+  end
+
+  def update
+    puts "Updating system and courseware..."
+    system("#{@config[:bindir]}/puppet agent -t --confdir #{@config[:confdir]}")
+  end
+
+  def confirm?(message = 'Continue?', default = true)
+    if default
+      print "#{message} [Y/n]: "
+      return [ 'y', 'yes', '' ].include? STDIN.gets.strip.downcase
+    else
+      print "#{message} [y/N]: "
+      return [ 'y', 'yes' ].include? STDIN.gets.strip.downcase
+    end
+  end
+
+  def bailout?(message = 'Continue?')
+    raise "User cancelled" unless confirm?(message)
+  end
+
+  def check_success(status=nil)
+    status = status.nil? ? ($? == 0) : status
+
+    if status
+      printf("\[\033[32m  OK  \033[0m]\n")
+    else
+      printf("[\033[31m FAIL \033[0m]\n")
+    end
+  end
+
+  def help
+    require 'classroom/help'
+    puts Classroom::HELP
+  end
+
+  def debug
+    require 'pry'
+    binding.pry
+  end
+
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: puppet-classroom-manager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Ford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puppetclassify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hocon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Manage Puppet classroom VMs and updating courseware. This includes
+      troubleshooting and maintenance tasks to be used as needed during
+      the delivery and facilities for resetting the VM for use across
+      multiple deliveries. This is pre-installed on the classroom VM.
+
+      If you are not teaching Puppet Inc. classes, this is not for you.
+email: education@puppetlabs.com
+executables:
+- classroom
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- bin/classroom
+- lib/classroom/help.rb
+- lib/classroom/page.rb
+- lib/classroom/performance.rb
+- lib/classroom/reset.rb
+- lib/classroom/restart.rb
+- lib/classroom/sanitize.rb
+- lib/classroom/submit.rb
+- lib/classroom/troubleshoot.rb
+- lib/classroom/validate.rb
+- lib/classroom/version.rb
+- lib/classroom.rb
+homepage: http://github.com/puppetlabs/puppet-classroom-manager
+licenses:
+- Apache-2.0
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Manage Puppet classroom VMs and updating courseware.
+test_files: []