openvox 9.0.0.pre.rc1-universal-darwin

data/examples/enc/regexp_nodes/regexp_nodes.rb

@@ -0,0 +1,270 @@
+#!/usr/bin/env ruby
+
+# = Synopsis
+# This is an external node classifier script, after
+# https://docs.openvoxproject.org/openvox/latest/lang_write_functions_in_puppet.html
+#
+# = Usage
+# regexp_nodes.rb <host>
+#
+# = Description
+# This classifier implements filesystem autoloading: It looks through classes,
+# parameters, and environment subdirectories, looping through each file it
+# finds.  Each file's contents are a regexp-per-line which, if they match the
+# hostname passed to the program as ARGV[0], sets a class, parameter value
+# or environment named the same thing as the file itself. At the end, the
+# resultant data structure is returned back to the OpenVox server process as
+# yaml.
+#
+# = Caveats
+# Since the files are read in directory order, multiple matches for a given
+# hostname in the parameters/ and environment/ subdirectories will return the
+# last-read value.  (Multiple classes/ matches don't cause a problem; the
+# class is either incuded or it isn't)
+#
+# Unmatched hostnames in any of the environment/ files will cause 'production'
+# to be emitted; be aware of the complexity surrounding the interaction between
+# ENC and environments as discussed in https://projects.puppetlabs.com/issues/3910
+#
+# = Examples
+# Based on the example files in the classes/ and parameters/ subdirectories
+# in the distribution, classes/database will set the 'database' class for
+# hosts matching %r{db\d{2}} (that is, 'db' followed by two digits) or with
+# 'mysql' anywhere in the hostname.  Similarly, hosts beginning with 'www' or
+# 'web' or the hostname 'leterel' (my workstation) will be assigned the
+# 'webserver' class.
+#
+# Under parameters/ there is one subdirectory 'service' which
+# sets the a parameter called 'service' to the value 'prod' for production
+# hosts (whose hostnames always end with a three-digit code), 'qa' for
+# anything that starts with 'qa-' 'qa2-' or 'qa3-', and 'sandbox' for any
+# development machines whose hostnames start with 'dev-'.
+#
+# In the environment/ subdirectory, any hosts matching '^dev-' and a single
+# production host which serves as 'canary in the coal mine' will be put into
+# the development environment
+#
+# = Author
+# Eric Sorenson <eric@explosive.net>
+
+# we need yaml or there's not much point in going on
+require 'yaml'
+
+# Sets are like arrays but automatically de-duplicate elements
+require 'set'
+
+# set up some syslog logging
+require 'syslog'
+Syslog.open('extnodes', Syslog::LOG_PID | Syslog::LOG_NDELAY, Syslog::LOG_DAEMON)
+# change this to LOG_UPTO(Sysslog::LOG_DEBUG) if you want to see everything
+# but remember your syslog.conf needs to match this or messages will be filtered
+Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_INFO)
+
+# Helper method to log to syslog; we log at level debug if no level is specified
+# since those are the most frequent calls to this method
+def log(message,level=:debug)
+  Syslog.send(level,message)
+end
+
+
+# set our workingdir to be the directory we're executed from, regardless
+# of parent's cwd, symlinks, etc. via handy Pathname.realpath method
+require 'pathname'
+p = Pathname.new(File.dirname(__FILE__))
+WORKINGDIR = "#{p.realpath}"
+
+# This class holds all the methods for creating and accessing the properties
+# of an external node. There are really only two public methods: initialize
+# and a special version of to_yaml
+
+class ExternalNode
+  # Make these instance variables get/set-able with eponymous methods
+  attr_accessor :classes, :parameters, :environment, :hostname
+
+  # initialize takes three arguments:
+  # hostname:: usually passed in via ARGV[0] but it could be anything
+  # classdir:: directory under WORKINGDIR to look for files named after
+  # classes
+  # parameterdir:: directory under WORKINGDIR to look for directories to set
+  # parameters
+  def initialize(hostname, classdir = 'classes/', parameterdir = 'parameters/', environmentdir = 'environment/')
+    # instance variables that contain the lists of classes and parameters
+    @classes = Set.new
+    @parameters = Hash.new("unknown")  # sets a default value of "unknown"
+    @environment = "production"
+
+    self.parse_argv(hostname)
+    self.match_classes("#{WORKINGDIR}/#{classdir}")
+    self.match_parameters("#{WORKINGDIR}/#{parameterdir}")
+    self.match_environment("#{WORKINGDIR}/#{environmentdir}")
+  end
+
+  # private method called by initialize which sanity-checks our hostname.
+  # good candidate for overriding in a subclass if you need different checks
+  def parse_argv(hostname)
+    if hostname =~ /^([-\w]+?)\.([-\w\.]+)/  # non-greedy up to the first . is hostname
+      @hostname = $1
+    elsif hostname =~ /^([-\w]+)$/     # sometimes puppet's @name is just a name
+      @hostname = hostname
+      log("got shortname for [#{hostname}]")
+    else
+      log("didn't receive parsable hostname, got: [#{hostname}]",:err)
+      exit(1)
+    end
+  end
+
+  # to_yaml massages a copy of the object and outputs clean yaml so we don't
+  # feed weird things back to puppet []<
+  def to_yaml
+    classes = self.classes.to_a
+    if self.parameters.empty? # otherwise to_yaml prints "parameters: {}"
+      parameters = nil
+    else
+      parameters = self.parameters
+    end
+    ({ 'classes' => classes, 'parameters' => parameters, 'environment' => environment}).to_yaml
+  end
+
+  # Private method that expects an absolute path to a file and a string to
+  # match - it returns true if the string was matched by any of the lines in
+  # the file
+  def matched_in_patternfile?(filepath, matchthis)
+
+    patternlist = []
+
+    begin
+      File.open(filepath).each do |l|
+        l.chomp!
+
+        next if l =~ /^$/
+        next if l =~ /^#/
+
+        if l =~ /^\s*(\S+)/
+          m = Regexp.last_match
+          log("found a non-comment line, transforming [#{l}] into [#{m[1]}]")
+          l.gsub!(l,m[1])
+        else
+          next l
+        end
+
+        pattern = %r{#{l}}
+        patternlist <<  pattern
+        log("appending [#{pattern}] to patternlist for [#{filepath}]")
+      end
+    rescue StandardError
+      log("Problem reading #{filepath}: #{$!}",:err)
+      exit(1)
+    end
+
+    log("list of patterns for #{filepath}: #{patternlist}")
+
+    if matchthis =~ Regexp.union(patternlist)
+      log("matched #{$~} in #{matchthis}, returning true")
+      return true
+
+    else  # hostname didn't match anything in patternlist
+      log("#{matchthis} unmatched, returning false")
+      return nil
+    end
+
+  end # def
+
+  # private method - takes a path to look for files, iterates through all
+  # readable, regular files it finds, and matches this instance's @hostname
+  # against each line; if any match, the class will be set for this node.
+  def match_classes(fullpath)
+    Dir.foreach(fullpath) do |patternfile|
+      filepath = "#{fullpath}/#{patternfile}"
+      next unless File.file?(filepath) and
+        File.readable?(filepath)
+        next if patternfile =~ /^\./
+      log("Attempting to match [#{@hostname}] in [#{filepath}]")
+      if matched_in_patternfile?(filepath,@hostname)
+        @classes << patternfile.to_s
+        log("Appended #{patternfile} to classes instance variable")
+      end
+    end
+  end
+
+  # match_environment is similar to match_classes but it overwrites
+  # any previously set value (usually just the default, 'production')
+  # with a match
+  def match_environment(fullpath)
+    Dir.foreach(fullpath) do |patternfile|
+      filepath = "#{fullpath}/#{patternfile}"
+      next unless File.file?(filepath) and
+        File.readable?(filepath)
+        next if patternfile =~ /^\./
+      log("Attempting to match [#{@hostname}] in [#{filepath}]")
+      if matched_in_patternfile?(filepath,@hostname)
+        @environment = patternfile.to_s
+        log("Wrote #{patternfile} to environment instance variable")
+      end
+    end
+  end
+
+
+  # Parameters are handled slightly differently; we make another level of
+  # directories to get the parameter name, then use the names of the files
+  # contained in there for the values of those parameters.
+  #
+  # ex: cat ./parameters/service/production
+  # ^prodweb
+  # would set parameters["service"] = "production" for prodweb001
+  def match_parameters(fullpath)
+    Dir.foreach(fullpath) do |parametername|
+
+      filepath = "#{fullpath}/#{parametername}"
+      next if File.basename(filepath) =~ /^\./   # skip over dotfiles
+
+      next unless File.directory?(filepath) and
+        File.readable?(filepath)        # skip over non-directories
+
+      log("Considering contents of #{filepath}")
+
+      Dir.foreach("#{filepath}") do |patternfile|
+        secondlevel = "#{filepath}/#{patternfile}"
+        log("Found parameters patternfile at #{secondlevel}")
+        next unless File.file?(secondlevel) and
+          File.readable?(secondlevel)
+        log("Attempting to match [#{@hostname}] in [#{secondlevel}]")
+        if matched_in_patternfile?(secondlevel, @hostname)
+          @parameters[ parametername.to_s ] = patternfile.to_s
+          log("Set @parameters[#{parametername}] = #{patternfile}")
+        end
+      end
+    end
+  end
+
+end
+
+# Logic for local hacks that don't fit neatly into the autoloading model can
+# happen as we initialize a subclass
+class MyExternalNode < ExternalNode
+
+  def initialize(hostname, classdir = 'classes/', parameterdir = 'parameters/')
+
+    super
+
+    # Set "hostclass" parameter based on hostname,
+    # stripped of leading environment prefix and numeric suffix
+    if @hostname =~ /^(\w*?)-?(\D+)(\d{2,3})$/
+      match = Regexp.last_match
+
+      hostclass = match[2]
+      log("matched hostclass #{hostclass}")
+      @parameters[ "hostclass" ] = hostclass
+    else
+      log("couldn't figure out class from #{@hostname}",:warning)
+
+    end
+  end
+
+end
+
+
+# Here we begin actual execution by calling methods defined above
+
+mynode = MyExternalNode.new(ARGV[0])
+
+puts mynode.to_yaml

data/examples/hiera/README.md

@@ -0,0 +1,102 @@
+A working demo of Hiera with YAML backend.
+======================================================
+
+This demo consists of:
+
+- A **NTP** module that has defaults for *pool.ntp.org* servers
+- A **YAML** data source in the *data/* directory where users can override data in yaml files
+- A **Users** module that has a few manifests that simply notify that they are being included
+- In Hiera data files a key called **classes** that decides what to include on a node
+
+Below various usage scenarios can be tested using this module.
+
+The examples below assume you:
+- Have the openvox-agent already installed
+- You have this repository cloned from github
+- Are running these commands from within the *examples/hiera* directory as cwd.
+
+Module from forge with module defaults
+--------------------------------------
+
+- Comment out lines 6-8 of [data/common.yaml](data/common.yaml#L6-8) to avoid overrides used further in the example
+- Run a `puppet apply` to create a */tmp/ntp.conf* file containing the two *pool.ntp.org* addresses
+- The *users::common* class should also be present in your catalog
+
+```shell
+$ sed -i '6,8 s/^/#/' data/common.yaml
+$ puppet apply site.pp --hiera_config=hiera.yaml --modulepath=modules
+Notice: Compiled catalog for node.corp.com in environment production in 0.04 seconds
+Notice: Adding users::common
+Notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+Notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/ensure: defined content as '{sha256}949c7247dbe0870258c921418cc8b270afcc57e1aa6f9d9933f306009ede60d0'
+Notice: Applied catalog in 0.02 seconds
+$ cat /tmp/ntp.conf
+server 1.pool.ntp.org
+server 2.pool.ntp.org
+```
+
+Site wide override data in _data::common_
+-----------------------------------------
+
+- Remove the comments on lines 6-8 of [data/common.yaml](data/common.yaml#L6-8)
+- Run a `puppet apply` to update */tmp/ntp.conf* to contain the two *ntp.example.com* addresses
+- The *users::common* class should also be present in your catalog
+
+```shell
+$ sed -i '6,8 s/^#//' data/common.yaml
+$ puppet apply site.pp --hiera_config=hiera.yaml --modulepath=modules
+Notice: Compiled catalog for node.corp.com in environment production in 0.04 seconds
+Notice: Adding users::common
+Notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+Notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{sha256}949c7247dbe0870258c921418cc8b270afcc57e1aa6f9d9933f306009ede60d0' to '{sha256}28ced955a8ed9efd7514b2364fe378ba645ab947f26e8c0b4d84e8368f1257a0'
+Notice: Applied catalog in 0.02 seconds
+$ cat /tmp/ntp.conf
+server ntp1.example.com
+server ntp2.example.com
+```
+
+Fact driven overrides for location=dc1
+--------------------------------------
+
+- Override the location fact to `dc1` to demonstrate *data/dc1.yaml* overrides the *ntp::config::ntpservers* values in *data/common.yaml*
+- `dc1` nodes will
+  - have the *users::common* and *users::dc1* in their catalogs
+  - */tmp/ntp.conf* will contain the two *ntp.dc1.example.com* addresses
+- Show that the nodes in `dc2` would use the site-wide defaults
+
+```shell
+$ FACTER_location=dc1 puppet apply site.pp --hiera_config=hiera.yaml --modulepath=modules
+Notice: Compiled catalog for node.corp.com in environment production in 0.04 seconds
+Notice: Adding users::dc1
+Notice: /Stage[main]/Users::Dc1/Notify[Adding users::dc1]/message: defined 'message' as 'Adding users::dc1'
+Notice: Adding users::common
+Notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+Notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{sha256}28ced955a8ed9efd7514b2364fe378ba645ab947f26e8c0b4d84e8368f1257a0' to '{sha256}39227f1cf8d09623d2e66b6622af2e8db01ab26f77a5a2e6d6e058d0977f369b'
+Notice: Applied catalog in 0.02 seconds
+$ cat /tmp/ntp.conf
+server ntp1.dc1.example.com
+server ntp2.dc1.example.com
+```
+
+Now simulate a machine in `dc2`, because there is no data for `dc2` it uses the site wide defaults and
+does not include the *users::dc1* class anymore
+
+```shell
+$ FACTER_location=dc2 puppet apply site.pp --hiera_config=hiera.yaml --modulepath=modules
+Notice: Compiled catalog for node.corp.com in environment production in 0.04 seconds
+Notice: Adding users::common
+Notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+Notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{sha256}39227f1cf8d09623d2e66b6622af2e8db01ab26f77a5a2e6d6e058d0977f369b' to '{sha256}28ced955a8ed9efd7514b2364fe378ba645ab947f26e8c0b4d84e8368f1257a0'
+Notice: Applied catalog in 0.02 seconds
+$ cat /tmp/ntp.conf
+server ntp1.example.com
+server ntp2.example.com
+```
+
+You could create override data in the following places for a machine in *location=dc2*, they will be searched in this order and the first one with data will match.
+
+- file data/dc2.yaml
+- file data/<environment>.yaml
+- file data/common.yaml
+
+In this example due to the presence of *common.yaml* that declares *ntpservers* the classes will never be searched, it will have precedence.

data/examples/hiera/data/common.yaml

@@ -0,0 +1,12 @@
+---
+classes:
+  - users::common
+  - ntp::config
+
+ntp::config::ntpservers:
+  - 'ntp1.example.com'
+  - 'ntp2.example.com'
+
+lookup_options:
+  classes:
+    merge: unique

data/examples/hiera/data/dc1.yaml

@@ -0,0 +1,6 @@
+---
+ntp::config::ntpservers:
+  - 'ntp1.dc1.example.com'
+  - 'ntp2.dc1.example.com'
+classes:
+  - users::dc1

data/examples/hiera/hiera.yaml

@@ -0,0 +1,15 @@
+---
+version: 5
+defaults:
+  datadir: data
+  data_hash: yaml_data
+
+hierarchy:
+  - name: 'Per Location'
+    path: "%{facts.location}.yaml"
+
+  - name: 'Per Environment'
+    path: "%{facts.environment}.yaml"
+
+  - name: 'Common Data'
+    path: 'common.yaml'

data/examples/hiera/modules/ntp/data/common.yaml

@@ -0,0 +1,4 @@
+---
+ntp::config::ntpservers:
+  - '1.pool.ntp.org'
+  - '2.pool.ntp.org'

data/examples/hiera/modules/ntp/hiera.yaml

@@ -0,0 +1,9 @@
+---
+version: 5
+defaults:
+  datadir: data
+  data_hash: yaml_data
+
+hierarchy:
+  - name: 'Common Data'
+    path: 'common.yaml'

data/examples/hiera/modules/ntp/manifests/config.pp

@@ -0,0 +1,18 @@
+# @summary Manage /tmp/ntp.conf file
+#
+# Given an array of ntpservers, manage the /tmp/ntp.conf file
+#
+# @example
+#   include ntp::config
+#
+# @param ntpservers
+#   An array of ntpserver(s) that should be present in the conf file
+class ntp::config(
+  Array[String[1], 1] $ntpservers = undef,
+) {
+
+  file { '/tmp/ntp.conf':
+    content => epp('ntp/ntp.conf.epp')
+  }
+
+}

data/examples/hiera/modules/ntp/templates/ntp.conf.epp

@@ -0,0 +1,3 @@
+<% $ntp::config::ntpservers.each |$server| { -%>
+server <%= $server %>
+<% } -%>

data/examples/hiera/modules/users/manifests/common.pp

@@ -0,0 +1,9 @@
+# @summary Notify to demonstrate users::common in catalog
+#
+# A common Class that all examples should include
+#
+# @example
+#   include users::common
+class users::common {
+  notify { 'Adding users::common': }
+}

data/examples/hiera/modules/users/manifests/dc1.pp

@@ -0,0 +1,9 @@
+# @summary Notify to demonstrate users::dc1 in catalog
+#
+# A Class that should be present in dc1 node(s) catalog
+#
+# @example
+#   include users::dc1
+class users::dc1 {
+  notify { 'Adding users::dc1': }
+}

data/examples/hiera/site.pp

@@ -0,0 +1,3 @@
+node default {
+  include lookup('classes')
+}

data/examples/nagios/check_puppet.rb

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'sys/proctable'
+include Sys
+
+class CheckPuppet
+
+  VERSION = '0.1'
+  script_name = File.basename($0)
+
+  # default options
+  OPTIONS = {
+    :statefile => "/opt/puppetlabs/puppet/cache/state/state.yaml",
+    :process   => "puppet",
+    :interval  => 30,
+  }
+
+  OptionParser.new do |o|
+    o.set_summary_indent('  ')
+    o.banner =    "Usage: #{script_name} [OPTIONS]"
+    o.define_head "The check_puppet Nagios plug-in checks that specified OpenVox process is running and the state file is no older than specified interval."
+      o.separator   ""
+      o.separator   "Mandatory arguments to long options are mandatory for short options too."
+
+
+        o.on(
+          "-s", "--statefile=statefile", String, "The state file",
+
+    "Default: #{OPTIONS[:statefile]}") { |op| OPTIONS[:statefile] = op }
+
+      o.on(
+        "-p", "--process=processname", String, "The process to check",
+
+    "Default: #{OPTIONS[:process]}")   { |op| OPTIONS[:process] = op }
+
+      o.on(
+        "-i", "--interval=value", Integer,
+
+    "Default: #{OPTIONS[:interval]} minutes")  { |op| OPTIONS[:interval] = op }
+
+    o.separator ""
+    o.on_tail("-h", "--help", "Show this help message.") do
+      puts o
+      exit
+    end
+
+    o.parse!(ARGV)
+  end
+
+  def check_proc
+
+    unless ProcTable.ps.find { |p| p.name == OPTIONS[:process]}
+      @proc = 2
+    else
+      @proc = 0
+    end
+
+  end
+
+  def check_state
+
+    # Set variables
+    curt = Time.now
+    intv = OPTIONS[:interval] * 60
+
+    # Check file time
+    begin
+      @modt = File.mtime("#{OPTIONS[:statefile]}")
+    rescue
+      @file = 3
+    end
+
+    diff = (curt - @modt).to_i
+
+    if diff > intv
+      @file = 2
+    else
+      @file = 0
+    end
+
+  end
+
+  def output_status
+
+    case @file
+    when 0
+      state = "state file status okay updated on " + @modt.strftime("%m/%d/%Y at %H:%M:%S")
+    when 2
+      state = "state fille is not up to date and is older than #{OPTIONS[:interval]} minutes"
+    when 3
+      state = "state file status unknown"
+    end
+
+    case @proc
+    when 0
+      process = "process #{OPTIONS[:process]} is running"
+    when 2
+      process = "process #{OPTIONS[:process]} is not running"
+    end
+
+    case
+    when (@proc == 2 or @file == 2)
+      status = "CRITICAL"
+      exitcode = 2
+    when (@proc == 0 and @file == 0)
+      status = "OK"
+      exitcode = 0
+    else
+      status = "UNKNOWN"
+      exitcode = 3
+    end
+
+    puts "PUPPET #{status}: #{process}, #{state}"
+    exit(exitcode)
+  end
+end
+
+cp = CheckPuppet.new
+cp.check_proc
+cp.check_state
+cp.output_status
+

data/ext/README.md

@@ -0,0 +1,13 @@
+# `ext/` directory details 
+This directory contains files used internally when packaging [openvox](https://github.com/OpenVoxProject/openvox) and [openvox-agent](https://github.com/OpenVoxProject/openvox-agent)
+What follows is a more detailed description of each directory/file:
+* `debian/` - init scripts for puppet (used for Debian-based platforms that do not support systemd)
+* `hiera/hiera.yaml` - installed to `$codedir/environments/production`as a default Hiera configuration file
+* `osx/puppet.plist` - puppet launchd plist for macOS
+* `redhat/` -  init scripts for puppet (used for EL-based platforms that do not support systemd)
+* `solaris/smf/` - service manifests for Solaris 11
+* `suse/client.init` - init script for puppet (used for SUSE-based platforms that do not support systemd) 
+* `systemd/puppet.service` - systemd unit file for puppet
+* `windows/` - the puppet daemon for Windows, and other useful `.bat` helper wrappers
+* `build_defaults.yaml` - information pertaining to the legacy build automation
+* `project_data.yaml` - information used when packaging the openvox gem

data/ext/build_defaults.yaml

@@ -0,0 +1,18 @@
+---
+packager: 'puppetlabs'
+
+# These are the build targets used by the packaging repo. Uncomment to allow use.
+#final_mocks: 'pl-el-5-i386 pl-el-6-i386 pl-el-7-x86_64'
+#cows: 'base-lucid-i386.cow base-precise-i386.cow base-squeeze-i386.cow base-trusty-i386.cow base-wheezy-i386.cow'
+pbuild_conf: '/etc/pbuilderrc'
+
+build_gem: TRUE
+build_dmg: FALSE
+sign_tar: FALSE
+yum_host: 'yum.puppetlabs.com'
+yum_repo_path: '/opt/repository/yum/'
+apt_signing_server: 'apt.puppetlabs.com'
+apt_repo_url: 'http://apt.puppetlabs.com'
+apt_repo_path: '/opt/repository/incoming'
+tar_host: 'downloads.puppetlabs.com'
+nonfinal_gem_path: '/opt/repository-nightlies/downloads/gems/puppet8-nightly'

data/ext/debian/puppet.default

@@ -0,0 +1,4 @@
+# Defaults for puppet - sourced by /etc/init.d/puppet
+
+# Startup options
+DAEMON_OPTS=""