flapjack_configurator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd6924183c859202d58b0a39d5bd4ef0a90cfbb5
+  data.tar.gz: f65b30f3d4ecf257a2e964dfa3c27f51d5fde57e
+SHA512:
+  metadata.gz: 05f44c8e5a7c11334478166df466478e905d1a9cacf1346026232834bf2c0251b04b03c3ba4cb965d3e87d3816b104c3df09579d79ee879f8206615c04031f07
+  data.tar.gz: 02d11b88c7a9d5b03dd73ed44940e48b80cf2ceb30e30b24b4cd5d57944b03280a79efaeec0716cb38c8000ca3dc97e228e9f95bc0e044e9f42da449c8f823bd

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/*
+coverage/*

data/.rubocop.yml

@@ -0,0 +1,47 @@
+# Disable requirement of "encoding" headers on files
+Encoding:
+  Enabled: false
+
+# Increase line length, we're not on VT220s anymore
+LineLength:
+  Max: 180
+
+# Increase allowed lines in a method.  Short methods are good, but 10 lines
+#   is a bit too low.
+MethodLength:
+  Max: 40
+
+# Favor explicit over implicit code: don't complain of "redundant returns"
+RedundantReturn:
+  Enabled: false
+
+# Don't complain about if/unless modifiers.  The merit of this is debatable
+#   and it will likely require building of over-length lines.
+IfUnlessModifier:
+  Enabled: false
+
+# Raise allowed CyclomaticComplexity to 10.
+CyclomaticComplexity:
+  Max: 10
+
+# Raise allowed parameter count to 8, 5 is a bit low.
+ParameterLists:
+  Max: 8
+
+# 123_456 doesn't add value IMO.
+NumericLiterals:
+  Enabled: false
+
+# Turn up Assignment Branch Condition size
+# This baby's gonna be complicated \m/
+AbcSize:
+  Max: 40
+
+# Disable the english library substitution cop: What is the value here?
+SpecialGlobalVars:
+  Enabled: false
+
+# Turn up the class length
+# The contact class is big, and isn't easily pared down.
+ClassLength:
+  Max: 250

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM debian:jessie
+MAINTAINER Tom Noonan II <thomas.noonan@corvisa.com>
+
+RUN apt-get update && apt-get install -y ruby bundler git
+
+COPY ./ /gem_build
+RUN cd /gem_build; rm -r pkg; bundle install && rake install
+
+RUN useradd -m flapjackconf
+USER flapjackconf
+ENTRYPOINT ["/usr/local/bin/flapjack_configurator"]

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,139 @@
+Flapjack Configurator
+=====================
+
+This gem provides a idempotent, file based fonfigurator for [Flapjack](http://flapjack.io)
+
+Configuration
+-------------
+
+The general config form is:
+
+```yaml
+# Example/Demo Flapjack setup file
+
+baseline_options:
+  notification_media:
+    # Baseline Pagerduty creds
+    # Pagerduty setup takes the domain, a API token to poll for acks, and a service key unique to the Pagerduty service
+    # Define the (common) domain id and API token here
+    # Currently only one PD instance is supported to keep the config handling easy. (/lazy)
+    pagerduty:
+      subdomain: foocorp
+      token: PagerDutyAPIToken
+
+# Contacts!
+contacts:
+  TestUser:
+    # Details is a direct map to the Flapjack API arguments (except notification related fields)
+    # http://flapjack.io/docs/1.0/jsonapi/#create-contacts
+    details:
+      first_name: Test
+      last_name: User
+      # Email is required but is only used here for documentation
+      email: test.user@example.com
+      timezone: MST7MDT
+
+    notification_media:
+      defaults:
+        # Re-notify every 30 minutes
+        interval: 1800
+        rollup_threshold: 3
+
+      # Only one of each is allowed in Flapjack 1.x :(
+      pagerduty:
+        service_key: PagerDutyServiceKey
+
+      email:
+        address: test.user@example.com
+
+      jabber:
+        address: room@conf.hipchat.com
+
+    notification_rules:
+      default:
+        warning_media:
+          - jabber
+          - email
+        critical_media:
+          - pagerduty
+          - jabber
+          - email
+
+    # Entities: A list of entities to associate with the contact
+    # Priority ordering is:
+    #  1: Exact entities
+    #  2: Blacklist entities
+    #  3: Blacklist regex
+    #  4: Entities regex
+    #
+    # If entities/default is true the contact will be associated with all entities which would otherwise not be associated with any contact.
+    entities:
+      default: false
+      exact:
+        - foo-app-1
+      regex:
+        - "datagen-[0-9]+"
+    entities_blacklist:
+      exact:
+        - datagen-2
+      regex:
+        - "datagen-[78]"
+```
+
+Most (but not all) of the options are passed through directly to the API (This is logged at debug level).
+notification_media and notification_rules are merged down with the per contact rule with the highest precidence, contact defaults, and then baseline_options.
+The key must be present in the contact to merge to prevent partial settings from being built off defaults.
+Complete configs at the baseline_option level with automatic inheritance is not currently supported.
+
+Use
+===
+
+WARNING: Passwords/API tokens will be logged at debug log level!
+
+Command Line
+------------
+
+```
+$ flapjack_configurator -h
+Usage: flapjack_configurator [options]
+
+Specific options:
+    -u, --apiurl URL                 Flapjack API URL
+    -v, --verbosity [level]          Set Verbosity, level corresponds to Ruby logger levels (0: debug, 3: error)
+    -f, --files file1,file2,file3    List of YAML config files to load, increasing precidence
+    -h, --help                       Show this message
+        --version                    Show version
+```
+
+Files is a comma-separated list of yaml files which are merged together to form the configuration.
+API URL should be of the form "http://${hostname}:${port}"
+
+Gem
+---
+
+```
+require 'flapjack_configurator'
+
+FlapjackConfigurator.configure_flapjack(config, api_base_url, logger)
+```
+
+### configure_flapjack method:
+
+- Arguments:
+  - config (Hash): Configuration hash to apply
+  - api_base_url (String)(Default: http://127.0.0.1:3081): Flapjack API URL string to connect to
+  - logger (Logger)(Default: Logger.new(STDOUT)): Logger class to log to
+  - enable_all_entity (Boolean)(Default: true): Add the ALL magic entity if it doesn't exist
+- Return value: Boolean: true if changes were applied, false otherwise
+
+Testing
+=======
+
+The Rubocop and Rspec coverage are part of the default rake task.
+Tests spin up a Flapjack container in Docker and interact with its API, no mocks are used.
+As such a running Docker daemon is required for tests.
+
+Authors
+=======
+
+- Tom Noonan <thomas.noonan@corvisa.com>

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+
+# https://github.com/bbatsov/rubocop#rake-integration
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  task default: :rubocop
+rescue LoadError
+  puts 'WARNING: Rubocop unavailable'
+end
+
+# https://www.relishapp.com/rspec/rspec-core/docs/command-line/rake-task
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  puts 'WARNING: Rspec unavailable'
+end

data/bin/flapjack_configurator

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require 'flapjack_configurator'
+require 'optparse'
+require 'ostruct'
+require 'logger'
+require 'yaml'
+require 'deep_merge'
+
+# Parse the command line arguments
+def parse_arguments(args, logger)
+  options = OpenStruct.new
+  options.api_url = 'http://127.0.0.1:3081'
+  logger.level = Logger::INFO
+  options.files = []
+
+  parser = OptionParser.new do |opts|
+    opts.banner = 'Usage: flapjack_configurator [options]'
+
+    opts.separator ''
+    opts.separator 'Specific options:'
+
+    opts.on('-u', '--apiurl URL', String, 'Flapjack API URL') do |url|
+      options.api_url = url
+      logger.debug("API URL set to #{url}")
+    end
+
+    opts.on('-v', '--verbosity [level]', Integer, 'Set Verbosity, level corresponds to Ruby logger levels (0: debug, 3: error)') do |level|
+      if level
+        logger.level = level
+      else
+        logger.level -= 1 if logger.level > 0
+      end
+      logger.debug('Log level set to #{logger.level}')
+    end
+
+    opts.on('-f', '--files file1,file2,file3', Array, 'List of YAML config files to load, increasing precidence') do |files|
+      options.files += files
+    end
+
+    opts.on_tail('-h', '--help', 'Show this message') do
+      puts opts
+      exit
+    end
+
+    opts.on_tail('--version', 'Show version') do
+      puts "Flapjack Configurator #{Gem.loaded_specs['flapjack_configurator'].version}"
+      exit
+    end
+  end
+
+  parser.parse!(args)
+
+  if options.files.length < 1
+    logger.fatal('Option --files is required')
+    exit
+  end
+
+  return options
+end
+
+# Load and merge the configs
+def load_config(file_list, logger)
+  config = {}
+  file_list.each do |file_name|
+    logger.debug("Loading config file #{file_name}")
+    config.deep_merge!(YAML.load_file(file_name))
+  end
+
+  return config
+end
+
+def main
+  logger = Logger.new(STDOUT)
+  options = parse_arguments(ARGV, logger)
+  config = load_config(options.files, logger)
+
+  logger.info('Nothing to do') unless FlapjackConfigurator.configure_flapjack(config, options.api_url, logger)
+end
+
+# The __FILE__ $0 trick doesn't work when loaded through the gem wrapper
+main

data/example.yml

@@ -0,0 +1,121 @@
+# Example/Demo Flapjack setup file
+
+baseline_options:
+  notification_media:
+    # Baseline Pagerduty creds
+    # Pagerduty setup takes the domain, a API token to poll for acks, and a service key unique to the Pagerduty service
+    # Define the (common) domain id and API token here
+    # Currently only one PD instance is supported to keep the config handling easy. (/lazy)
+    pagerduty:
+      subdomain: foocorp
+      token: PagerDutyAPIToken
+
+# Contacts!
+contacts:
+  TestUser:
+    # Details is a direct map to the Flapjack API arguments (except notification related fields)
+    # http://flapjack.io/docs/1.0/jsonapi/#create-contacts
+    details:
+      first_name: Test
+      last_name: User
+      # Email is required but is only used here for documentation
+      email: test.user@example.com
+      timezone: MST7MDT
+
+    notification_media:
+      defaults:
+        # Re-notify every 30 minutes
+        interval: 1800
+        rollup_threshold: 3
+
+      # Only one of each is allowed in Flapjack 1.x :(
+      pagerduty:
+        service_key: PagerDutyServiceKey
+
+      email: 
+        address: test.user@example.com
+
+      jabber: 
+        address: room@conf.hipchat.com
+
+    notification_rules:
+      default:
+        warning_media:
+          - jabber
+          - email
+        critical_media:
+          - pagerduty
+          - jabber
+          - email
+   
+    # Entities: An exact list of entities
+    # Priority ordering is:
+    #  1: Exact entities
+    #  2: Blacklist entities
+    #  3: Blacklist regex
+    #  4: Entities regex  
+    entities:
+      exact:
+        - foo-app-1
+      regex:
+        - "datagen-[0-9]+"
+    entities_blacklist:
+      exact:
+        - datagen-2
+      regex:
+        - "datagen-[78]"
+
+  DefaultUser:
+    details:
+      first_name: Default
+      last_name: User
+      email: default.user@example.com
+      timezone: MST7MDT
+
+    notification_media:
+      defaults:
+        # Re-notify every 30 minutes
+        interval: 1800
+        rollup_threshold: 3
+
+      # Only one of each is allowed in Flapjack 1.x :(
+      email:
+        address: test.user@example.com
+
+    notification_rules:
+      default:
+        warning_media:
+          - email
+        critical_media:
+          - email
+
+    entities:
+      default: true 
+
+  Beard:
+    details:
+      first_name: Beard
+      last_name: User
+      email: beard.user@example.com
+      timezone: CST6CDT
+
+    notification_media:
+      defaults:
+        # Re-notify every 30 minutes
+        interval: 1800
+        rollup_threshold: 3
+
+      # Only one of each is allowed in Flapjack 1.x :(
+      email:
+        address: beard.user@example.com
+
+    notification_rules:
+      default:
+        warning_media:
+          - email
+        critical_media:
+          - email
+
+    entities:
+      exact:
+        - ALL

data/flapjack_configurator.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flapjack_configurator/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Tom Noonan II']
+  gem.email         = 'thomas.noonan@corvisa.com'
+  gem.description   = 'FlapjackConfigurator loads a user specified config from YAML files and loads them idempotently into Flapjack via the Flapjack API'
+  gem.summary       = 'Flapjack configuration tool'
+  gem.homepage      = 'https://github.com/CVTJNII/FlapjackConfigurator'
+  gem.license       = 'Apache License, Version 2'
+
+  gem.files         = `git ls-files`.split($\) - ['Gemfile.lock']
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'flapjack_configurator'
+  gem.require_paths = ['lib']
+  gem.version       = FlapjackConfigurator::VERSION
+
+  gem.add_dependency 'flapjack-diner', '~>1.4'
+  gem.add_dependency 'ruby_deep_clone', '~>0.6'
+  gem.add_dependency 'deep_merge', '~>1.0'
+
+  gem.add_development_dependency 'bundler', '~> 1.7'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'docker-api'
+  gem.add_development_dependency 'simplecov'
+end