capistrano-ami 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 043c077f7f5158a6b23387193bd1aa8b08e30dac
+  data.tar.gz: a6885baffe755f2f07fab43687761caeba3e85f1
+SHA512:
+  metadata.gz: 4e9fa6380478338c62226202d2b1fab04de59fab8e37a95929b9d2b20bcb68328a0b667dc4e2037e304d3534d9d3fc77de7ebf1464e8cf2ae6e763bcfc5d525d
+  data.tar.gz: 4691961e3babee0d332c3bf295354c13d4f011013be7e7668d85a04733c9fe95d86845a6ff679d38615c0232f300831ec8a5ea259adbb4df455ae8420de0d8f1

data/.gitignore

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

data/.reek

@@ -0,0 +1,12 @@
+IrresponsibleModule:
+  enabled: false
+  exclude: []
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 2
+UncommunicativeVariableName:
+  enabled: true
+  accept:
+  - a
+  - b

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Style/FileName:
+  Enabled: true
+  Exclude:
+    - lib/capistrano-ami.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/MethodLength:
+  Enabled: true
+  Max: 15
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+  Exclude:
+    - capistrano-ami.gemspec

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at watassbass@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 wata_mac
+
+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,94 @@
+# Capistrano AMI
+
+[![build status](https://circleci.com/gh/wata727/capistrano-ami.svg?style=shield&circle-token=490e040fc0a638ff54e85f9f0ac71c0330bcafa6)](https://circleci.com/gh/wata727/capistrano-ami)
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE.txt)
+
+This plugin that create AMI (Amazon Machine Image) and manage generations tasks into capistrano script. `capistrano-ami` tasks are able to run when deploy target servers exists in AWS (http://aws.amazon.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-ami'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-ami
+
+## Usage
+Load `capistrano-ami` into your capistrano configuration file `Capfile`:
+```ruby
+require 'capistrano/ami'
+```
+And set config values in deploy script `config/deploy.rb`:
+```ruby
+set :aws_region, 'ap-northeast-1'  # deploy servers region name
+set :base_ami_name, 'web-role'     # name: "#{base_ami_name}_#{instance_id}_#{deploy_timestamp}" default is capistrano-ami
+set :keep_amis, 3                  # keeps number of AMIs. default is 5
+```
+If you do not specify, `base_ami_name` and `keep_amis` uses default value.
+
+### Credentials
+
+`capistrano-ami` supports various credential providers. As of the following priority:
+
+- Specified shared credentials
+- Key values
+- Environment values
+- Default shared credentials
+- IAM role
+
+#### Key values
+
+You can set credentials in deploy script `config/deploy.rb`:
+```ruby
+set :aws_access_key_id, 'YOUR_AWS_ACCESS_KEY'
+set :aws_secret_access_key, 'YOUR_AWS_SECRET_KEY'
+```
+
+#### Environment values
+
+`capistrano-ami` looks `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, `AWS_REGION` environemt values.
+```
+$ export AWS_ACCESS_KEY_ID=YOUR_AWS_ACCESS_KEY
+$ export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_KEY
+```
+
+If you do not want to fix region in deploy script. use `AWS_REGION` environment values and other credential providers.
+
+#### Shared credentials
+
+Shared credentials are credentials file in local machine. default location is `~/.aws/credentials`. [More infomation](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs).
+If you want to use `default`, do not specify key values in delopy script. But if you want to use other profile, you should specify following:
+
+```ruby
+set :aws_credentials_profile_name, 'profile_name'
+```
+
+#### IAM role
+
+IAM role is most secure credential provider. If you can, should use this. [More infomation](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html).
+This provider used in no credentials configuration. Because you should not specify key values.
+
+## Versions
+
+We check working this plugin following platform versions.
+
+- Ruby 
+    - 2.3.0
+- Capistrano 
+    - 3.5.0
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wata727/capistrano-ami. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'capistrano/ami'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

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

data/capistrano-ami.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/ami/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-ami'
+  spec.version       = Capistrano::Ami::VERSION
+  spec.authors       = ['wata727']
+  spec.email         = ['watassbass@gmail.com']
+
+  spec.summary       = 'create AMI (Amazon Machine Image) and manage generations after deployment by capistrano3'
+  spec.description   = "After deployed, create the instance's AMI and delete old AMI versions. If you spefied 'keep_amis', it's keep number of AMIs."
+  spec.homepage      = 'https://github.com/wata727/capistrano-ami'
+  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.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.0'
+
+  spec.add_dependency 'aws-sdk', '~> 2'
+  spec.add_dependency 'capistrano', '~> 3'
+end

data/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  ruby:
+    version: 2.3.0
+
+dependencies:
+  pre:
+    - gem install bundler --pre

data/lib/capistrano/ami.rb

@@ -0,0 +1,52 @@
+require 'date'
+require 'aws-sdk'
+require 'capistrano/ami/credentials'
+require 'capistrano/ami/instance'
+require 'capistrano/ami/version'
+
+module Capistrano
+  module Ami
+    extend Capistrano::Ami::Instance
+
+    def self.create(instance_id, base_name)
+      image = instance(instance_id).create_image(
+        name: ami_name(instance_id, base_name),
+        no_reboot: true,
+        description: 'created by capistrano-ami'
+      )
+      image.create_tags(tags: [{ key: 'created_by', value: 'capistrano-ami' }])
+      image.create_tags(tags: [{ key: 'base_instance_id', value: instance_id }])
+      client.wait_until(:image_available, image_ids: [image.id])
+      image
+    end
+
+    def self.old_amis(instance_id, keep_amis)
+      images = ec2_resource.images(
+        owners: ['self'],
+        filters: [{
+          name: 'tag:created_by',
+          values: ['capistrano-ami']
+        }, {
+          name: 'tag:base_instance_id',
+          values: [instance_id]
+        }]
+      )
+      images = images.sort { |a, b| b.creation_date <=> a.creation_date }
+      Array(images[keep_amis, images.length])
+    end
+
+    def self.delete_snapshot(block_device_mappings)
+      block_device_mappings.each do |device|
+        client.delete_snapshot(snapshot_id: device[:ebs][:snapshot_id])
+      end
+    end
+
+    def self.ami_name(instance_id, base_name)
+      base_name + '_' + instance_id + '_' + Time.now.to_i.to_s
+    end
+
+    private_class_method :ami_name
+  end
+end
+
+load File.expand_path('../tasks/ami.rake', __FILE__)

data/lib/capistrano/ami/credentials.rb

@@ -0,0 +1,13 @@
+module Capistrano
+  module Ami
+    module Credentials
+      def credentials(profile_name)
+        @credentials ||= ::Aws::SharedCredentials.new(profile_name: profile_name) if profile_name
+        @credentials ||= ::Aws::Credentials.new(
+          fetch(:aws_access_key_id, ENV['AWS_ACCESS_KEY_ID']),
+          fetch(:aws_secret_access_key, ENV['AWS_SECRET_ACCESS_KEY'])
+        )
+      end
+    end
+  end
+end

data/lib/capistrano/ami/instance.rb

@@ -0,0 +1,25 @@
+module Capistrano
+  module Ami
+    module Instance
+      include Capistrano::Ami::Credentials
+
+      def client
+        @client ||= ::Aws::EC2::Client.new(
+          region: fetch(:aws_region, ENV['AWS_REGION']),
+          credentials: credentials(fetch(:aws_credentials_profile_name))
+        ) if credentials(fetch(:aws_credentials_profile_name)).set?
+        @client ||= ::Aws::EC2::Client.new(region: fetch(:aws_region, ENV['AWS_REGION']))
+      end
+
+      def ec2_resource
+        @ec2_resource ||= ::Aws::EC2::Resource.new(client: client)
+      end
+
+      def instance(instance_id)
+        @instance ||= ec2_resource.instances(instance_ids: [instance_id]).first
+      end
+
+      module_function :credentials
+    end
+  end
+end

data/lib/capistrano/ami/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Ami
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/capistrano/tasks/ami.rake

@@ -0,0 +1,26 @@
+namespace :ami do
+  task :create do
+    on roles(:all) do
+      instance_id = capture 'curl -s http://169.254.169.254/latest/meta-data/instance-id'
+      info "[capistrano-ami] [#{instance_id}] Createing AMI..."
+      ami = Capistrano::Ami.create(instance_id, fetch(:base_ami_name, 'capistrano-ami'))
+      info "[capistrano-ami] [#{instance_id}] Created AMI (#{ami.id})"
+    end
+  end
+
+  task :delete_old_amis do
+    on roles(:all) do
+      instance_id = capture 'curl -s http://169.254.169.254/latest/meta-data/instance-id'
+      info "[capistrano-ami] [#{instance_id}] Deleting old AMIs...."
+      Capistrano::Ami.old_amis(instance_id, fetch(:keep_amis, 5)).each do |ami|
+        ami.deregister
+        Capistrano::Ami.delete_snapshot(ami.block_device_mappings)
+        info "[capistrano-ami] [#{instance_id}] Deleted AMI (#{ami.id})"
+      end
+      info "[capistrano-ami] [#{instance_id}] Finished deleting AMIs"
+    end
+  end
+end
+
+after 'deploy', 'ami:create'
+after 'ami:create', 'ami:delete_old_amis'

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-ami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wata727
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: After deployed, create the instance's AMI and delete old AMI versions.
+  If you spefied 'keep_amis', it's keep number of AMIs.
+email:
+- watassbass@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".reek"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-ami.gemspec
+- circle.yml
+- lib/capistrano-ami.rb
+- lib/capistrano/ami.rb
+- lib/capistrano/ami/credentials.rb
+- lib/capistrano/ami/instance.rb
+- lib/capistrano/ami/version.rb
+- lib/capistrano/tasks/ami.rake
+homepage: https://github.com/wata727/capistrano-ami
+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.5.1
+signing_key: 
+specification_version: 4
+summary: create AMI (Amazon Machine Image) and manage generations after deployment
+  by capistrano3
+test_files: []