cmdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9212599111d82e3f236f06fb05aaf87ec0932155
+  data.tar.gz: 87200c6133a80e8f2bd02f02697aa0d42c694622
+SHA512:
+  metadata.gz: 86b209d6f11b166e981cd7a0eeac50f10a78a8efa5ef4db7c973642c4eb26aa519741b7ffbdbb3e1e266f794e9429c19fb646bdddb749ae18cdd0429f4fc3fa6
+  data.tar.gz: 33d7b4855c49ece993167e1dbfd7da504a337fae128a60096d037fcaa51f8b0815658b2ac2ffb32d1875563464b16e1447a85316429dc0d08a0e0c760fbf48e0

data/.gitignore

@@ -0,0 +1,56 @@
+# simplecov/rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# for IntelliJ, RubyMine
+.idea
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+.rvmrc
+.ruby-gemset
+.ruby-version
+
+# For IntelliJ/RubyMine
+.idea/*

data/.rspec

@@ -0,0 +1,2 @@
+--require=spec_helper
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+- 2.1
+bundler_args: --without development
+before_install:
+- gem install --no-document -v '~> 1.10' bundler
+before_script:
+- bundle install
+script: 
+- bundle exec rake ci:spec
+- bundle exec rake ci:cucumber
+

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+### 2.6.0 (2016-03-01)
+
+Two new command line options are added to the shim
+`--consul-url` = The URL of the consul agent. Example: http://consul:8500
+`--consul-prefix` = The prefix to use when getting keys from consul. Example: shard403
+
+There are two ways of using the shim.
+
+1. Using to replace keys in legacy ruby apps:
+---------------------------------------------
+
+When using the shim to replace keys in configuration files, it is sufficient to specify
+the shard identifier (shard403, shard93, etc) as the prefix. Also prefix is optional so
+in dev environments if you don't have these shard identifier as prefixes, you don't have
+to specify it. When replacing keys in configuration files, the requested keys are loaded
+from consul on demand.
+
+Example:
+```
+bundle exec cmdb shim --consul-url=http://consul:8500 --consul-prefix=shard403 \
+  --dir=config -- rainbows -c config/rainbows.rb
+```
+
+2. Using to populate environment in modern apps:
+------------------------------------------------
+
+The --consul-prefix command line option can be specifed multiple times just like the
+envconsul tool allows and all keys under the specified prefix are loaded in the
+environment and the prefix itself is skipped.
+
+Example:
+```
+bundle exec cmdb shim --consul-url=http://consul:8500 --consul-prefix=shard403/common \
+  --consul-prefix=shard403/cwf_public_service --env -- rainbows -c config/rainbows.rb
+```
+
+### 2.5.0 (2015-07-16)
+
+So many changes! View the diffs for info.
+
+### 2.1.0
+
+Initial release. Contains the following features:
+ - API for querying a CMDB
+ - Command-line shim for rewriting config files
+ - Server restart feature to aid debugging

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'backticks'
+gem 'cucumber'
+gem 'rspec'
+
+group :development do
+  gem 'yard'
+  gem 'pry'
+  gem 'pry-byebug'
+end
+

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    cmdb (0.1.0)
+      diplomat (~> 0.15)
+      listen (~> 3.0)
+      trollop (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    backticks (0.4.0)
+    builder (3.2.2)
+    byebug (8.2.2)
+    coderay (1.1.1)
+    cucumber (2.3.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.4.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 3.2.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.4.0)
+      gherkin (~> 3.2.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.2.5)
+    diplomat (0.15.0)
+      faraday (~> 0.9)
+      json (~> 1.8)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.10)
+    gherkin (3.2.0)
+    json (1.8.3)
+    listen (3.0.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    method_source (0.8.2)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    multipart-post (2.0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+    trollop (2.1.2)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  backticks
+  bundler (~> 1.10)
+  cmdb!
+  cucumber
+  pry
+  pry-byebug
+  rake
+  rspec
+  yard
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,250 @@
+# CMDB
+
+[![TravisCI][travis_ci_img]](https://magnum.travis-ci.com/rightscale/cmdb)
+[travis_ci_img]: https://magnum.travis-ci.com/rightscale/cmdb.svg?token=ETyVMY7RGypDf6U8z6jc&branch=master
+
+CMDB is a Ruby interface for consuming data from one or more configuration management databases
+(CMDBs). It is intended to support multiple CM technologies, including:
+  - JSON/YAML files on a local disk
+  - consul
+  - (someday) etcd
+  - (someday) ZooKeeper
+
+The CMDB's command-line tool can also facilitate debugging by watching your application's files
+and sending SIGHUP (or the signal of your choice) to the app server if anything changes.
+
+Maintained by
+ - [RightScale Inc.](https://www.rightscale.com)
+
+## Why should I use this gem?
+
+By using a standardized API for querying inputs, your application is decoupled from the underlying
+configuration management database that our Operations team is using. Today we happen to use JSON
+files that live under /etc/rightscale, but tomorrow we might use a key/value store such as etcd or
+consul (possibly in combination with flat files). This gem will deal with all of that complexity
+and provide you with a simple interface for reading your app's configuration.
+
+The gem has two primary interfaces:
+- The `cmdb shim` command populates the environment with config data and/or rewrites hardcoded
+  config files, then spawns your application. It can also be told to watch the filesystem for changes and
+  send a signal e.g. `SIGHUP` to your application, bringing reload-on-edit functionality to any app.
+- The `CMDB::Interface` object provides a programmatic API for querying configuration. Its `#to_h`
+  method transforms the whole configuration into an environment-friendly hash if you prefer to seed the
+  environment yourself.
+
+The CMDB gem is friendly to 12-factor and "Rails-style" apps and can be used with or without the shim,
+depending on your application's needs. 
+
+# Getting Started
+
+## Create CMDB Data Files
+ 
+The shim looks in two locations to find data files. In order of precedence:
+1. `/var/lib/cmdb` -- typically used at deployment time
+2. `~/.cmdb` -- useful for developers when testing the app
+
+The base name (minus extension) of each file is important; it determines the top-level name of
+the keys in that file and it *must be unique* across all of the directories. For instance,
+`my_app.json` defines CMDB keys in the `my_app.*` hierarchy.
+
+Create a data file in one of these directories; for example, you might create `my_app.yml` with
+the following contents:
+
+    db:
+      hostname: db1.local
+    widgets:
+      flavors:
+        - vanilla
+        - chocolate
+
+## Invoke the CMDB Shim
+
+For non-Ruby applications, or for situations where CMDB values are required 
+outside of the context of interpreted code, use `cmdb shim` to run
+your application. The shim can do several things for you:
+
+1. Make CMDB values available to your app (in `ENV`, or by rewriting files)
+2. Change the user before invoking your app (e.g. drop privileges to `www-data`)
+3. Watch for filesystem changes and reload your app on demand
+
+### Populate the environment for a dotenv-compatible application
+
+If you have an app that uses 12-factor (dotenv) style configuration, the shim
+can populate the environment with CMDB values:
+
+    bundle exec cmdb shim --env
+
+    # Now your app can refer to ENV['DB_HOSTNAME'] or ENV['WIDGETS_FLAVORS]
+    # Note missing "my_app" prefix that would be present if you asked for these using their CMDB key names
+
+Note that the data type of CMDB inputs is preserved: lists remain lists, numbers remain numbers,
+and so forth. This works irrespective of the format of your configuration files, and also holds true
+for CMDB values that are serialized to the environment (as a JSON document, in the case of lists).
+
+### Rewriting configuration files with CMDB values
+
+If the `--dir` option is provided, the shim recursively scans your working 
+directory (`Dir.pwd`) for data files that contain replacement tokens; when a token is 
+found, it substitutes the corresponding CMDB key's value.
+
+Replacement tokens look like this: `<<name.of.my.key>>` and can appear anywhere in a file as a YAML
+or JSON _value_ (but never a key).
+
+Replacement tokens should appear inside string literals in your configuration files so they don't
+invalidate syntax or render the files unparsable by other tools.
+
+The shim performs replacement in-memory and saves all of the edits at once, making the rewrite 
+operation nearly atomic. If any keys are missing, then no files are changed on disk and the shim
+exits with a helpful error message.
+
+*NOTE:* the shim does not perform rewriting in development mode; the expectation is that your app's
+configuration files will already provide reasonable dev-mode defaults and that rewriting them
+is not necessary.
+
+Given `my_app.yml` and an application with two configuration files:
+
+    # config/database.yml
+    production:
+      host: <<my_app.db.hostname>
+      database: my_app_production
+
+    # config/widgets.json
+    {'widgetFlavors': '<<my_app.widgets.flavors>>'}
+
+I can run the following command in my application's root directory:
+
+    bundle exec cmdb shim --dir=config rackup
+
+This will rewrite the files under config, replacing my configuration files as 
+follows:
+
+    # config/database.yml
+    production:
+      host: db1.local
+      database: my_app_production
+
+    # config/widgets.json
+    {'widgetFlavors':['vanilla', 'chocolate']}
+
+### Drop Privileges
+
+If your app doesn't know how to safely switch to a non-privileged user, the shim
+can do this for you. Just add the `--user` flag when you invoke it:
+
+    bundle exec cmdb shim --user=www-data whoami
+
+### Reload the App When Code Changes
+
+You can pass the `--reload=key.name` option to `cmdb shim` in order to enable filesystem
+watching. The shim will signal your application server whenever files are created,
+updated or deleted, generally causing a graceful restart of the server process.
+
+Needless to say, your app server must support graceful restart upon receipt of
+a certain signal! The CMDB gem uses SIGHUP by default, but you can override this
+with --reload-signal=SIGWHATEVER.
+
+The parameter names a CMDB key (such as `key.name`) whose value determines whether filesystem
+watching is enabled. It *should* be a boolean, but *may* be nil or any "truthy" value such as a
+number or string. If the key is truthy, then the shim will perform filesystem-watching.
+
+## Query the CMDB Directly
+
+Ruby applications can access the CMDB as a Ruby proxy object:
+
+    # Ready to use; no bootstrapping required.
+    require 'cmdb'
+
+    cmdb = CMDB::Interface.new
+    cmdb.get('my_app.my_setting')
+    cmdb.get('my_app.some_other_setting')
+
+This allows you to read CMDB values from the directly from your code.
+
+# Data Model
+
+This library models all CMDBs as hierarchical key/value stores whose leaf nodes can be strings,
+numbers, or arrays of like-typed objects. This model is a "least common denominator" simplification
+of the data models of YML, JSON, ZooKeeper and etcd, allowing all of those technologies to be
+treated as interchangeable sources of configuration information.
+
+CMDB key names consist of a dot-separated string e.g. `my_app.category_of_settings.some_value`. The
+value of a CMDB key can be a string, boolean, number, nil, or a list of any of those types.
+
+CMDB keys *cannot* contain maps/hashes, nor can lists contain differently-typed data.
+
+## Disk-Based Data Sources
+
+When the CMDB interface is initialized, it searches two directories for YAML files:
+ - /var/lib/cmdb
+ - ~/.cmdb
+
+YAML files in these directories are assumed to contain CMDB values and loaded into memory in the
+order they are encountered. The hierarchy of the YAML keys is flattened in order to derive
+dot-separated key names. Consider the following YAML file:
+
+    # beverages.yml
+    coffee:
+      - latte
+      - cappucino
+      - mocha
+      - macchiato
+    tea:
+      - chai
+      - herbal
+      - black
+    to_go: true
+
+This defines three CMDB values: `beverages.coffee` (a list of four items), `beverages.tea`
+(a list of three items), and `beverages.to_go` (a boolean).
+
+### Key Namespaces
+
+The name of a CMDB file is important; it defines a namespace for all of the variables contained
+inside. No two files may share a name; therefore, no two CMDB keys can have the same name.
+Likewise, all keys with a given prefix are guaranteed to come from the same source.
+
+### Overlapping Namespaces
+
+Because CMDB files can come from several directories, it's possible for two same-named data files
+to define values in the same namespace. In this case, the behavior of RightService varies depending
+on the value of RACK_ENV or RAILS_ENV:
+
+  - unset, development or test: CMDB chooses the highest-precedence file and ignores the others
+    after printing a warning. Files in `/etc` win over files in `$HOME`, which win over
+    files in the working directory.
+     
+  - any other environment: CMDB fails with an error message that describes the problem and
+    the locations of the overlapping files.
+   
+### Ambiguous Key Names
+
+Consider a file that defines the following variables:
+
+    # confusing.yml
+    this:
+      is:
+        ambiguous
+      was:
+        very: ambiguous
+        extremely: confusing
+
+At first glance, ths file defines two CMDB keys:
+  - `confusing.this.is` (a string)
+  - `confusing.this.was` (a map)
+
+However, an equally valid interpretation would be:
+  - `confusing.this.is`
+  - `confusing.this.was.very`
+  - `confusing.this.was.extremely`
+
+Because CMDB keys cannot contain maps, the first interpretation is wrong. The second
+interpretation is valid according to the data model, but results in a situation where the type
+of the keys could change if the structure of the YML file changes.
+
+For this reason, any YAML file that defines an "ambiguous" key name will cause an error at
+initialization time. To avoid ambiguous key names, think of your YAML file as a tree and remember
+that _leaf nodes must define data_ and _internal nodes must define structure_.
+
+## Network Data Sources
+
+TODO: add support for etcd or similar

data/Rakefile

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+require 'cucumber/rake/task'
+desc "Run functional tests"
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--color --format pretty}
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec, :cucumber]

data/TODO.md

@@ -0,0 +1,3 @@
+Actually respect --quiet
+
+Remove reset/late_initialize garbage.

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cmdb"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cmdb.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'cmdb'
+  spec.version       = '0.1.0'
+  spec.authors       = ['RightScale']
+  spec.email         = ['rubygems@rightscale.com']
+
+  spec.summary       = %q{Command-line tool for configuration manegement databases}
+  spec.description   = %q{Reads CMDB variables from files, Consul, and elsewhere.}
+  spec.homepage      = 'https://github.com/rightscale/cmdb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = Gem::Requirement.new("~> 2.0")
+
+  spec.add_dependency 'listen', '~> 3.0'
+  spec.add_dependency 'diplomat', '~> 0.15'
+  spec.add_dependency 'trollop', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+end

data/fixtures/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra', '~> 1.3'
+gem 'rack', '~> 1.0'

data/fixtures/Gemfile.lock

@@ -0,0 +1,19 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    daemons (1.1.9)
+    rack (1.6.0)
+    rack-protection (1.5.1)
+      rack
+    sinatra (1.3.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack (~> 1.0)
+  sinatra (~> 1.3)

data/fixtures/app/widgets.rb

@@ -0,0 +1,4 @@
+get '/widgets' do
+  headers 'Content-Type' => 'application/json; charset=utf-8'
+  [200, '[]']
+end

data/fixtures/config.ru

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'sinatra'
+
+Signal.trap('HUP') do
+  puts 'I got a SIGHUP'
+end
+
+Signal.trap('USR2') do
+  puts 'I got a SIGUSR2'
+end
+
+app_dir = File.expand_path('../app', __FILE__)
+
+Dir.glob(File.join(app_dir, '**', '*')).each do |f|
+  require f
+end
+
+set :environment, :development
+set :run, false
+set :raise_errors, true
+
+if ENV['DIE_DIE_DIE']
+  puts "I am dying as requested by ENV['DIE_DIE_DIE']"
+  exit(42)
+else
+  puts "I am up and running"
+  run Sinatra::Application
+end

data/lib/cmdb.rb

@@ -0,0 +1,2 @@
+module CMDB
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: cmdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RightScale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: diplomat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Reads CMDB variables from files, Consul, and elsewhere.
+email:
+- rubygems@rightscale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- cmdb.gemspec
+- fixtures/Gemfile
+- fixtures/Gemfile.lock
+- fixtures/app/widgets.rb
+- fixtures/config.ru
+- lib/cmdb.rb
+homepage: https://github.com/rightscale/cmdb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Command-line tool for configuration manegement databases
+test_files: []
+has_rdoc: