sf-hiera-aws 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 443deac718f30bc09618c7d35f400447cee08790
+  data.tar.gz: 8b68ef269097ba57cfb8cc8e2ba2aed0dfa45174
+SHA512:
+  metadata.gz: 3dc41f57aea0f60f7ad7f9c8f9e7c77efa993c4296df1660e8be1eff46633685ca68020f34ecedfb80874599a877af54d340ac07099c5abd9a03943a546fe678
+  data.tar.gz: e6610c0c32a4e7dcb2c8421a38fb9b748d4a9651215c0d324f644460a174f83e8ed925c924cd8229cc08763c530a20264b3b39189a26dc12656a7ddc4081bbc4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sf-hiera-aws.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jon Topper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# sf-hiera-aws
+
+## About
+
+This is a Hiera backend to provide access to the EC2 API for a small number of resource types. Its purpose is to prevent it from ever being necessary to copy and paste EC2, RDS and ElastiCache addresses from the AWS console into Puppet configs anywhere.
+
+## Usage and Setup
+
+To add this backend to hiera, edit `/etc/puppet/hiera.yaml`:
+
+```
+:backends:
+  - yaml
+  - sf_hiera_aws
+```
+
+This plugin will attempt to use a machine's IAM role to perform AWS lookups - this is the recommended method of operation. 
+
+Absent an IAM role, the plugin will fall back to looking up credentials in the environment. Use `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_REGION` variables.
+
+The IAM role will need the following permissions:
+
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+            {
+                "Action": [
+                    "ec2:DescribeInstances",
+                    "rds:DescribeDBInstances",
+                    "elasticache:DescribeCacheClusters"
+                ],
+                "Effect": "Allow",
+                "Resource": [
+                    "*"
+                ]
+            }
+    ]
+}
+```
+
+## Configuration
+
+The plugin expects to find a configuration file under `/etc/puppet/sf_hiera_aws.yaml`, defining how we look up named keys.  The keys at the top level of this file determine the names of the hiera keys the plugin will provide; the configuration determines how these are looked up.
+
+### Example - EC2 nodes by tag
+
+```
+aws_am_search_nodes:
+  type: :ec2_instance
+  filters:
+    - name:   tag:aws:autoscaling:groupName
+      values: [ "%{::sf_location}-%{::sf_environment}-search" ]
+  return:
+    - :instance_id
+    - :private_ip_address
+    - :private_dns_name
+```
+
+The value of `return` here is also the default, and so can be omitted. You can use any of the methods listed at http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Instance.html to obtain other details from the Instance object.
+
+
+### Example - RDS instance by name
+
+```
+aws_am_bullseye_rds:
+  type:                   :rds_db_instance
+  db_instance_identifier: "%{::sf_location}-%{::sf_environment}-db"
+```
+
+Calls to `:rds_db_instance` type keys return the instance identifier, endpoint address and endpoint port.
+
+### Example - ElastiCache cluster by name
+
+```
+aws_am_bullseye_redis:
+  type:             :elasticache_cache_cluster
+  cache_cluster_id: "%{::sf_location}-%{::sf_environment}-redis"
+```
+
+Calls to `:elasticache_cache_cluster` type keys return a list of cache nodes, their IDs and endpoint address/ports.
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/hiera/backend/sf_hiera_aws_backend.rb

@@ -0,0 +1,167 @@
+class Hiera
+
+    module Backend
+
+        class Sf_hiera_aws_backend
+
+            public
+
+            def initialize
+                require 'aws-sdk-resources'
+                Hiera.debug('Hiera AWS SDK backend started')
+            end
+
+            def lookup (key, scope, order_override, resolution_type)
+
+                config = recursive_interpolate_config(aws_config, scope)
+
+                Hiera.debug("Looking up '#{key} in AWS SDK backend")
+
+                if ! config.key? key
+                    return nil
+                end
+
+                Hiera.debug("Config: #{config[key].inspect}")
+                type = config[key]['type']
+
+                if self.methods.include? "type_#{type}".to_sym
+
+                    begin
+                        answer = self.send("type_#{type}".to_sym, config[key])
+                        Hiera.debug( answer )
+                        return answer
+                    rescue Aws::Errors::MissingRegionError, Aws::Errors::MissingCredentialsError
+                        Hiera.warn("No IAM role or ENV based AWS config - skipping")
+                        return nil
+                    end
+
+                end
+
+                Hiera.debug("Type of AWS SDK lookup '#{type}' invalid")
+                return nil
+
+            end
+
+            def aws_config
+
+                require 'yaml'
+
+                default_config_path = "/etc/puppet/sf_hiera_aws.yaml"
+
+                if ! Config[:aws_sdk].nil?
+                    config_file = Config[:aws_sdk][:config_file] || default_config_path
+                else
+                    config_file = default_config_path
+                end
+
+                if File.exist?(config_file)
+                    config = YAML::load_file(config_file)
+                else
+                    Hiera.warn("No config file #{config_file} found")
+                    config = {}
+                end
+
+                config
+
+            end
+
+            def recursive_interpolate_config(h,scope)
+                case h
+                when Hash
+                    Hash[
+                    h.map do |k, v|
+                        [ Backend.parse_answer(k, scope), recursive_interpolate_config(v,scope) ]
+                    end
+                    ]
+                when Enumerable
+                    h.map { |v| recursive_interpolate_config(v,scope) }
+                when String
+                    Backend.parse_answer(h,scope)
+                else
+                    h
+                end
+            end
+
+            def type_ec2_instance(options)
+
+                options = {
+                    'return'  => [
+                        :instance_id,
+                        :private_ip_address,
+                        :private_dns_name,
+                    ]
+                }.merge(options)
+
+                ec2 = Aws::EC2::Resource.new()
+
+                if options.key? 'filters'
+                    instances = ec2.instances( filters: options['filters'] ) || []
+                else
+                    instances = ec2.instances() || []
+                end
+
+                instances.collect do |i|
+                    Hash[ options['return'].map { |f|
+                        [f.to_s, i.methods.include?(f) ? i.send(f) : nil ]
+                    } ]
+                end
+
+            end
+
+            def type_rds_db_instance(options)
+
+                rds = Aws::RDS::Client.new()
+
+                if options.key? 'db_instance_identifier'
+                    instances = rds.describe_db_instances(
+                        db_instance_identifier: options['db_instance_identifier']
+                    ).db_instances
+                else
+                    instances = rds.describe_db_instances.db_instances
+                end
+
+                instances.collect do |i|
+                    {
+                        'db_instance_identifier' => i.db_instance_identifier,
+                        'endpoint_address'       => i.endpoint.address,
+                        'endpoint_port'          => i.endpoint.port,
+                    }
+                end
+
+            end
+
+            def type_elasticache_cache_cluster(options)
+
+                elasticache = Aws::ElastiCache::Client.new()
+
+                if options.key? 'cache_cluster_id'
+                    clusters = elasticache.describe_cache_clusters(
+                        cache_cluster_id: options['cache_cluster_id'],
+                        show_cache_node_info: true,
+                    ).cache_clusters
+                else
+                    clusters = elasticache.describe_cache_clusters(
+                        show_cache_node_info: true
+                    ).cache_clusters
+                end
+
+                clusters.collect do |i|
+                    {
+                        'cache_cluster_id' => i.cache_cluster_id,
+                        'cache_nodes'      => i.cache_nodes.collect do |n|
+                            {
+                                'cache_node_id'    => n.cache_node_id,
+                                'endpoint_address' => n.endpoint.address,
+                                'endpoint_port'    => n.endpoint.port,
+                            }
+                        end
+                    }
+                end
+            end
+
+        end
+
+    end
+
+end
+

data/sf-hiera-aws.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "sf-hiera-aws"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jon Topper"]
+  spec.email         = ["jon@scalefactory.com"]
+
+  spec.summary       = %q{Hiera backend for querying AWS resources}
+  spec.homepage      = "https://github.com/scalefactory/sf-hiera-aws"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "aws-sdk-resources", ">=2.1.18"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sf-hiera-aws
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Topper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.18
+description: 
+email:
+- jon@scalefactory.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/hiera/backend/sf_hiera_aws_backend.rb
+- sf-hiera-aws.gemspec
+homepage: https://github.com/scalefactory/sf-hiera-aws
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Hiera backend for querying AWS resources
+test_files: []