sf-hiera-aws 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d39910445613c2d49ecf0e13dc57e122129a5788
-  data.tar.gz: e0589b22593c40fac6f61d4d6b93aea0655be822
+  metadata.gz: f7c460e98b3363eeec6460d644ebefc2361e7eb4
+  data.tar.gz: 53d713bbe89e34005bb8a3f4ddb7a844abcb4d3c
 SHA512:
-  metadata.gz: e6eafb08e724871a9512882215aed82678e15019d01dcb3dbba11daa1eb91967e8046be08e1fd913e78a0c49927c7b9fe975ada1e4b14a24ef2d0b4c60f9d0e5
-  data.tar.gz: 7358df8a4ceef3d6385f1728bfe5c5a30c655feebb809f13589a93947eb8acf279084d068a11223232197f9e4431546e0e2a45994ee8ff1f39698fbad82f6ef4
+  metadata.gz: 29aac28022286ccc023aee65d89ed05bbd5ff5354c2e182046d604777bb70316b9c02e45092ac65189ffa103d6177079d09607c75873c43ad874cfdeb09232bd
+  data.tar.gz: f4dcc37e4ed641e7720053bb710737d92d4f75e766801818af032718719848142fb11ffaaf8271605393ce269b6997acbb28a97efaaff6260998a697a183cf47

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# sf-hiera-aws changelog
+
+## 0.0.7 (2 June 2016)
+
+ * Add support for ElastiCache Replication Groups
+
 ## 0.0.6 (22 March 2016)
 
  * Correct bad filter logic

data/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing
+
+## Unit Tests
+
+You can run the unit tests with `bundle exec rake test:unit`
+
+The tests live under `spec/` as per the rspec convention, with one spec file
+per lookup type.  We use a combination of dependency injection and the mocking
+features of the AWS SDK to test the logic inside the hiera back-end.
+
+
+## Testing For Real
+
+With unit tests in place, you'll want to test against some real infrastructure
+at some point too.  The easiest way to do this is using the Hiera CLI tool.
+
+Check out this backend onto your test box. Alongside it, you'll create three
+config files.
+
+```
+hiera.yaml  scope.yaml  sf-hiera-aws  sf_hiera_aws.yaml
+```
+
+`hiera.yaml` should look like:
+
+```
+---
+:backends:
+  - sf_hiera_aws
+
+:logger: console
+
+:aws_sdk:
+    :config_file: sf_hiera_aws.yaml
+```
+
+`scope.yaml` should contain any variables you interpolate in the other config
+files.  For example:
+
+```
+---
+"::sf_environment": test
+"::sf_location": euwest1
+```
+
+`sf_hiera_aws.yaml` should be your config for this back-end, as documented
+in the README for this project.
+
+To ensure we load the checked out version of this plugin rather than any
+installed copy, we set the RUBYLIB environment variable to point at the
+project `lib/` folder.
+
+To look up a test key, do the following:
+
+```
+$ RUBYLIB=sf-hiera-aws/lib hiera -c ./hiera.yaml -y ./scope.yaml --debug <key>
+```
+
+

data/README.md

@@ -52,6 +52,8 @@ aws_am_search_nodes:
   filters:
     - name:   tag:aws:autoscaling:groupName
       values: [ "%{::sf_location}-%{::sf_environment}-search" ]
+    - name: instance-state-name
+      values: [ 'running' ]
   return:
     - :instance_id
     - :private_ip_address
@@ -60,6 +62,8 @@ aws_am_search_nodes:
 
 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.  Calls to this key will return a list of hashes, each containing `instace_id`, `private_ip_address` and `private_dns_name` keys.
 
+Note that by default all EC2 instances will be returned, including stopped instances. To return only the running instances, add a filter as shown in this example.
+
 ### Example - EC2 nodes by tag, single item list
 
 ```
@@ -99,3 +103,21 @@ Calls to `:elasticache_cache_cluster` type keys return a list of cache nodes, th
 Pass a `return` key with value `:hostname` to have a list of hostnames of keys of all cache nodes matching the cache_cluster_id returned.
 Pass a `return` key with value `:hostname_and_port` to have a list of `"<hostname>:<port>"` strings returned.
 
+### Example - ElastiCache replication group by name
+
+```
+aws_app_redis:
+  type: :elasticache_replication_group
+  replication_group_id: "%{::sf_location}-%{::sf_environment}-redis"
+```
+
+Calls to `:elasticache_replication_group` return a list of replication groups, their primary endpoints and node group members.
+Pass a `return` key with value `:primary_endpoint` to have the hostname for the primary end point of the node group returned.
+Pass a `return` key with value `:primary_endpoint_and_port` to have the hostname and port returned as a colon-separated string.
+Pass a `return` key with value `:read_endpoints` to return an array of read endpoint hostnames, if a `replication_group_id` is specified. Returns `nil` if `replication_group_id` is unspecified.
+Pass a `return` key with value `:read_endpoints_with_ports` to return an array of read endpoint hostnames and ports as colon delimted strongs. Returns `nil` if `replication_group_id` is unspecified.
+
+## Notes
+
+* The order in which items are returned, for example EC2 nodes matching a tag, is undefined. If you are using an array of items in a configuration file template, for example, you are advised to sort the array in the template. This eliminates the likelihood of unnecessary configuration file changes, and the consequential unnecessary restart of dependent services.
+* By default, all EC2 instances are returned, including those in a non-running state. To return only running instances, add a filter on `name: instance-state-name` and `values: ['running']` as per the example above.

data/lib/hiera/backend/sf_hiera_aws_backend.rb

@@ -303,6 +303,84 @@ class Hiera
                 end
 
             end
+
+            def type_elasticache_replication_group(options)
+                elasticache = get_elasticache_client
+
+                if options.key? 'replication_group_id'
+                    replgroups = elasticache.describe_replication_groups(
+                        replication_group_id: options['replication_group_id'],
+                    ).replication_groups
+                else
+                    replgroups = elasticache.describe_replication_groups.replication_groups
+                end
+
+                if !options.key? 'return'
+
+                    return replgroups.collect do |rg|
+                        {
+                            'replication_group_id' => rg.replication_group_id,
+                            'primary_endpoint_address' => rg.node_groups[0].primary_endpoint.address,
+                            'primary_endpoint_port' => rg.node_groups[0].primary_endpoint.port,
+                            'node_group_members' => rg.node_groups[0].node_group_members.collect do |ngm| 
+                                {
+                                    'cache_node_id' => ngm.cache_node_id,
+                                    'cache_cluster_id' => ngm.cache_cluster_id,
+                                    'read_endpoint_address' => ngm.read_endpoint.address,
+                                    'read_endpoint_port' => ngm.read_endpoint.port,
+                                    'current_role' => ngm.current_role,
+                                }
+                            end
+                        }
+                    end
+
+                end
+
+                if options['return'] == :read_endpoints
+
+                    if options.key? 'replication_group_id'
+                        return replgroups[0].node_groups[0].node_group_members.map { |ngm| ngm.read_endpoint.address }
+                    else
+                        Hiera.warn('Requested to return array of read endpoints for replication group, but no replication_group_id specified')
+                        return nil
+                    end
+
+                end
+
+                if options['return'] == :read_endpoints_and_ports
+
+                    if options.key? 'replication_group_id'
+                        return replgroups[0].node_groups[0].node_group_members.map { |ngm| "#{ngm.read_endpoint.address}:#{ngm.read_endpoint.port}" }
+                    else
+                        Hiera.warn('Requested to return array of read endpoints and ports for replication group, but no replication_group_id specified')
+                        return nil
+                    end
+
+                end
+
+                if options['return'] == :primary_endpoint
+
+                    primary_endpoints = []
+
+                    replgroups.each do |rg|
+                        primary_endpoints.push(rg.node_groups[0].primary_endpoint.address)
+                    end
+
+                    return primary_endpoints
+
+                elsif options['return'] == :primary_endpoint_and_port
+
+                    primary_endpoints = []
+
+                    replgroups.each do |rg|
+                        primary_endpoints.push( [ rg.node_groups[0].primary_endpoint.address, rg.node_groups[0].primary_endpoint.port ].join(':') )
+                    end
+
+                    return primary_endpoints
+
+               end
+
+            end
         end
     end
 end

data/sf-hiera-aws.gemspec

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
     spec.name          = 'sf-hiera-aws'
-    spec.version       = '0.0.6'
-    spec.authors       = ['Jon Topper']
-    spec.email         = ['jon@scalefactory.com']
+    spec.version       = '0.0.7'
+    spec.authors       = ['Jon Topper','Mike Griffiths']
+    spec.email         = ['jon@scalefactory.com','mike@scalefactory.com']
 
     spec.summary       = 'Hiera backend for querying AWS resources'
     spec.homepage      = 'https://github.com/scalefactory/sf-hiera-aws'

metadata

@@ -1,67 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: sf-hiera-aws
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jon Topper
+- Mike Griffiths
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-06-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.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.6
 description: 
 email:
 - jon@scalefactory.com
+- mike@scalefactory.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
+- .gitignore
+- .rubocop.yml
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -78,17 +81,17 @@ 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
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Hiera backend for querying AWS resources