aws-metadata-export 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e728df97757e47eaa097b8a1a4e12ca5914ca82
+  data.tar.gz: b678d0e51b9eda94d9a0bcb18b971e5f1906437e
+SHA512:
+  metadata.gz: 119c72aca171fd59fa6f7a6bbf5b6cda4a2804191f0b86e3c519c4d85094769274a8d1f5db1f561691df408b27f4e37508fd70625ccb4f40225bc34e2d61d6b5
+  data.tar.gz: 8f52522e8931dec63653548c8e6fd3a708b5a60bad1902ee1e97555845a7973ba4b2017da89eec3b0690756ccf10f3c3f31ebab3aa8b2007f66725b38f85844f

data/History.md

@@ -0,0 +1,5 @@
+# Changelog for aws-metadata-export
+
+## 0.1.0
+
+* initial version

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 James FitzGibbon
+
+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/Manifest.txt

@@ -0,0 +1,9 @@
+History.md
+LICENSE
+Manifest.txt
+README.md
+aws-metadata-export.gemspec
+bin/aws-metadata-export
+lib/aws-metadata-export.rb
+lib/aws/metadata_export.rb
+lib/aws/metadata_export/version.rb

data/README.md

@@ -0,0 +1,81 @@
+# aws-metadata-export
+
+* home :: https://github.com/jf647/aws-metadata-export
+* license :: [MIT](http://opensource.org/licenses/MIT)
+* gem version :: [![Gem Version](https://badge.fury.io/rb/aws-metadata-export.png)](http://badge.fury.io/rb/aws-metadata-export)
+* build status :: [![Circle CI](https://circleci.com/gh/jf647/aws-metadata-export.svg?style=svg)](https://circleci.com/gh/jf647/aws-metadata-export)
+
+## DESCRIPTION
+
+Exports AWS EC2 Instance metadata and tags to files
+
+## OVERVIEW
+
+aws-metadata-export is a utility to dump AWS EC2 instance metadata and tags
+to files.  This makes it easier to predicate behaviour of userdata scripts
+on the value of tags.  For example, in a userdata script:
+
+    aws-metadata-export
+    instance_id=$(cat /var/run/aws_metadata_export/instance_id)
+    foo_tag_value=$(cat /var/run/aws_metadata_export/tags/foo)
+    if [ -f /var/run/aws_metadata_export/tags/bar ]
+    then
+      echo 'tag bar is set'
+    fi
+
+The following instance data files are written:
+
+* instance_id
+* local_ipv4
+* region
+* az
+
+Tags are written to the a 'tags' directory.  Each file is the name of a
+tag and the contents of that file is the value of the tag.
+
+## INSTALLATION
+
+    gem install aws-metadata-export
+
+This would typically be done in your AMI preparation process, but can be
+done in your userdata if the instance has a path to rubygems.org.
+
+## IAM INSTANCE PERMISSIONS
+
+Tags are not exported through EC2 instance data, so the EC2 API must be
+used to fetch them.  As such, the IAM permission `ec2:DescribeInstances`
+must be available via an IAM instance profile and role.
+
+## ENVIRONMENT VARIABLES
+
+Two environment variables can be used to vary behavior of the utility.
+
+* AWS_METADATA_EXPORT_DIR if set changes the output directory from `/var/run/aws_metadata_export` to something else
+* AWS_METADATA_EXPORT_UMASK if set changes the umask used to create the directory and write the files from the default of 00077 to something else
+
+## AUTHOR
+
+James FitzGibbon - james@nadt.net
+
+## LICENSE
+
+Copyright (c) 2015 James FitzGibbon
+
+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/aws-metadata-export.gemspec

@@ -0,0 +1,76 @@
+# -*- encoding: utf-8 -*-
+# stub: aws-metadata-export 0.1.0.20150624082252 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "aws-metadata-export"
+  s.version = "0.1.0.20150624082252"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["James FitzGibbon"]
+  s.date = "2015-06-24"
+  s.description = "Exports AWS EC2 Instance metadata and tags to files"
+  s.email = ["james@nadt.net"]
+  s.executables = ["aws-metadata-export"]
+  s.extra_rdoc_files = ["History.md", "Manifest.txt", "README.md"]
+  s.files = ["History.md", "LICENSE", "Manifest.txt", "README.md", "aws-metadata-export.gemspec", "bin/aws-metadata-export", "lib/aws-metadata-export.rb", "lib/aws/metadata_export.rb", "lib/aws/metadata_export/version.rb"]
+  s.homepage = "https://github.com/jf647/aws-metadata-export"
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--main", "README.md"]
+  s.rubygems_version = "2.4.4"
+  s.summary = "Exports AWS EC2 Instance metadata and tags to files"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<aws-sdk>, ["~> 2.0"])
+      s.add_runtime_dependency(%q<ec2-metadata>, ["~> 0.2"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<hoe>, ["~> 3.13"])
+      s.add_development_dependency(%q<hoe-gemspec>, ["~> 1.0"])
+      s.add_development_dependency(%q<rake>, ["~> 10.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_development_dependency(%q<guard>, ["~> 2.12"])
+      s.add_development_dependency(%q<guard-rspec>, ["~> 4.2"])
+      s.add_development_dependency(%q<guard-rubocop>, ["~> 1.2"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.9"])
+      s.add_development_dependency(%q<simplecov-console>, ["~> 0.2"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8"])
+      s.add_development_dependency(%q<rspec_junit_formatter>, ["~> 0.2"])
+      s.add_development_dependency(%q<fakefs>, ["~> 0.6"])
+    else
+      s.add_dependency(%q<aws-sdk>, ["~> 2.0"])
+      s.add_dependency(%q<ec2-metadata>, ["~> 0.2"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<hoe>, ["~> 3.13"])
+      s.add_dependency(%q<hoe-gemspec>, ["~> 1.0"])
+      s.add_dependency(%q<rake>, ["~> 10.3"])
+      s.add_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_dependency(%q<guard>, ["~> 2.12"])
+      s.add_dependency(%q<guard-rspec>, ["~> 4.2"])
+      s.add_dependency(%q<guard-rubocop>, ["~> 1.2"])
+      s.add_dependency(%q<simplecov>, ["~> 0.9"])
+      s.add_dependency(%q<simplecov-console>, ["~> 0.2"])
+      s.add_dependency(%q<yard>, ["~> 0.8"])
+      s.add_dependency(%q<rspec_junit_formatter>, ["~> 0.2"])
+      s.add_dependency(%q<fakefs>, ["~> 0.6"])
+    end
+  else
+    s.add_dependency(%q<aws-sdk>, ["~> 2.0"])
+    s.add_dependency(%q<ec2-metadata>, ["~> 0.2"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<hoe>, ["~> 3.13"])
+    s.add_dependency(%q<hoe-gemspec>, ["~> 1.0"])
+    s.add_dependency(%q<rake>, ["~> 10.3"])
+    s.add_dependency(%q<rspec>, ["~> 3.1"])
+    s.add_dependency(%q<guard>, ["~> 2.12"])
+    s.add_dependency(%q<guard-rspec>, ["~> 4.2"])
+    s.add_dependency(%q<guard-rubocop>, ["~> 1.2"])
+    s.add_dependency(%q<simplecov>, ["~> 0.9"])
+    s.add_dependency(%q<simplecov-console>, ["~> 0.2"])
+    s.add_dependency(%q<yard>, ["~> 0.8"])
+    s.add_dependency(%q<rspec_junit_formatter>, ["~> 0.2"])
+    s.add_dependency(%q<fakefs>, ["~> 0.6"])
+  end
+end

data/bin/aws-metadata-export

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'aws-metadata-export'
+
+Aws::MetadataExport.new.export

data/lib/aws-metadata-export.rb

@@ -0,0 +1 @@
+require 'aws/metadata_export'

data/lib/aws/metadata_export.rb

@@ -0,0 +1,89 @@
+require 'aws-sdk'
+require 'ec2_metadata'
+require 'fileutils'
+
+module Aws
+  class MetadataExport
+    def export
+      set_umask
+      write_metadata
+      write_tags
+    end
+
+    private
+
+    def set_umask
+      if ENV.key?('AWS_METADATA_EXPORT_UMASK')
+        File.umask ENV['AWS_METADATA_EXPORT_UMASK'].to_i(8)
+      else
+        File.umask 00077
+      end
+    end
+
+    def write_metadata
+      %w(instance_id local_ipv4 az region).each do |meta|
+        metafile = File.join(output_dir, meta)
+        File.open(metafile, 'w') do |fh|
+          fh.write send meta.to_sym
+        end
+      end
+    end
+
+    def write_tags
+      tags.each do |tag|
+        tagfile = File.join(tags_dir, tag['key'])
+        File.open(tagfile, 'w') do |fh|
+          fh.write tag['value']
+        end
+      end
+    end
+
+    # :nocov:
+    def aws_client
+      @aws_client ||= Aws::EC2::Client.new(region: region)
+    end
+    # :nocov:
+
+    def output_dir
+      @output_dir ||= begin
+        dir = ENV['AWS_METADATA_EXPORT_DIR'] || File.join(
+          %w(/ var run aws_metadata_export)
+        )
+        FileUtils.mkpath(dir)
+        dir
+      end
+    end
+
+    def tags_dir
+      @tags_dir ||= begin
+        dir = File.join(output_dir, 'tags')
+        FileUtils.mkpath(dir)
+        dir
+      end
+    end
+
+    def az
+      @az ||= Ec2Metadata['placement']['availability_zone']
+    end
+
+    def instance_id
+      @instance_id ||= Ec2Metadata['instance_id']
+    end
+
+    def local_ipv4
+      @local_ipv4 ||= Ec2Metadata['local_ipv4']
+    end
+
+    def region
+      @region ||= az.chop
+    end
+
+    # :nocov:
+    def tags
+      @tags ||= Aws::EC2::Resource
+                .new(client: aws_client)
+                .instance(instance_id).tags
+    end
+    # :nocov:
+  end
+end

data/lib/aws/metadata_export/version.rb

@@ -0,0 +1,5 @@
+module Aws
+  class MetadataExport
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,269 @@
+--- !ruby/object:Gem::Specification
+name: aws-metadata-export
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James FitzGibbon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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: ec2-metadata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Exports AWS EC2 Instance metadata and tags to files
+email:
+- james@nadt.net
+executables:
+- aws-metadata-export
+extensions: []
+extra_rdoc_files:
+- History.md
+- Manifest.txt
+- README.md
+files:
+- History.md
+- LICENSE
+- Manifest.txt
+- README.md
+- aws-metadata-export.gemspec
+- bin/aws-metadata-export
+- lib/aws-metadata-export.rb
+- lib/aws/metadata_export.rb
+- lib/aws/metadata_export/version.rb
+homepage: https://github.com/jf647/aws-metadata-export
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Exports AWS EC2 Instance metadata and tags to files
+test_files: []