cap-gce 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6eef30cfd574fe40156cd90133d646c233fa99c6
+  data.tar.gz: bb80ec04fb247ce1a4c0905d2c3db9699e208e9d
+SHA512:
+  metadata.gz: 3b7c36cb89fc86cd76a004d3776819050bf46e5b27896b7b6416b95ef059ca2f15eb8777d061d01fca9be846693d424c927f356ef96c69a9ae37853493cf1b20
+  data.tar.gz: d0443ab299a1dccd5a5c32ae6fe67ad8b6010655e27f89830192e0231946e08c506287eb2c2960b619f43952d79a7ea9434ae6d758d584f5673e2c59c1b27009

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 cap-gce.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dean Lin
+
+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,137 @@
+# Cap::Gce
+
+Cap-GCE is used to generate Capistrano namespaces and tasks from Google Cloud Compute Engine instance metadata, dynamically building the list of servers to be deployed to.
+
+This documentation assumes familiarity with Capistrano 3.x.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cap-gce'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cap-gce
+
+You also need to add the gem to your Capfile:
+
+```
+require "cap-gce/capistrano"
+```
+
+## Configuration
+
+Configurable options, shown here with defaults:
+
+```
+set :gce_config, 'config/gce.yml'
+set :gce_project_tag, 'Project'
+set :gce_roles_tag, 'Roles'
+set :gce_stages_tag, 'Stages'
+
+set :gce_project_id, nil
+set :gce_zone, %w[]
+set :gce_filter, '(status eq "RUNNING")'
+set :gce_fields, nil
+
+set :gce_scope, %w[https://www.googleapis.com/auth/compute]
+set :gce_secret_config, 'config/compute_engine_secret.json'
+set :gce_contact_point, nil # nat_ip, network_ip
+```
+
+### Secret Config
+:gce_secret_config is credential file of GCP, now it only accept Service account key json certificate.
+
+### Zones
+
+:gce_zone is an array of GCP zones and is required. Only list zones which you wish to query for instances
+
+### Misc settings
+
+* project_tag
+
+  Cap-GCE will look for a metadata with this name when searching for instances that belong to this project. The metadata name defaults to "Project".
+
+* stages_tag
+
+  Cap-GCE will look for a metadata with this name to determine which instances belong to a given stage. The metadata name defaults to "Stages".
+
+* roles_tag
+
+  Cap-GCE will look for a metadata with this name to determine which instances belong to a given role. The metadata name defaults to "Roles".
+
+## Usage
+
+## Utility tasks
+
+Cap-GCE adds a few utility tasks to Capistrano for displaying information about the instances that you will be deploying to. Note that unlike Capistrano 2.x, all tasks require a stage.
+
+### View instances
+
+This command will show you information all the instances your configuration matches for a given stage.
+
+```
+cap [stage] gce:status
+```
+
+Example:
+```
+$ cap production gce:status
+
+Num  Name                  ID                    Type      IP           Zone         Roles      Stage
+00   machine-learning-01   3805131608224908200   g1-small  10.138.0.2   us-west1-a   web,app    production
+00   machine-learning-02   3805131608224908300   g1-small  10.138.0.3   us-west1-a   web,app    production
+```
+
+### View server names
+
+This command will show you the server names of the instances matching the given stage:
+
+```
+cap [stage] gce:server_names
+```
+
+Example:
+```
+$ cap production gce:server_names
+machine-learning-01
+machine-learning-02
+```
+
+### View server instance IDs
+
+This command will show the instance IDs of the instances matching the given stage:
+```
+cap [stage] gce:instance_ids
+```
+
+Example:
+
+```
+$ cap production gce:instance_ids
+3805131608224908200
+3805131608224908300
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cap-gce. 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 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cap/gce"
+
+# 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(__FILE__)

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/cap-gce.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cap-gce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cap-gce'
+  spec.version       = CapGCE::VERSION
+  spec.authors       = ['Dean Lin']
+  spec.email         = ['iscreen@gmail.com']
+
+  spec.summary       = %q(Cap-GCE is used to generate Capistrano namespaces and tasks from Google Compute Engine instance metadatas, dynamically building the list of servers to be deployed to.)
+  spec.description   = %q(Cap-GCE is used to generate Capistrano namespaces and tasks from Google Compute Engine instance metadatas, dynamically building the list of servers to be deployed to.)
+  spec.homepage      = 'https://github.com/iscreen/cap-gce'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'https://github.com/iscreen/cap-gce'
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'google-api-client', '~> 0.11'
+  spec.add_dependency 'capistrano', '>= 3.0'
+  spec.add_dependency 'terminal-table'
+  spec.add_dependency 'colorize'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/cap-gce/capistrano.rb

@@ -0,0 +1,43 @@
+require 'google/apis/compute_v1'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'colorize'
+require 'terminal-table'
+require 'yaml'
+require_relative 'utils'
+require_relative 'gce-handler'
+require_relative 'status-table'
+
+# Load extra tasks
+load File.expand_path('../tasks/gce.rake', __FILE__)
+
+module Capistrano
+  module DSL
+    module Gce
+      def gce_handler
+        @gce_handler ||= CapGCE::GCEHandler.new
+      end
+
+      def gce_role(name, options = {})
+        gce_handler.get_servers_for_role(name).each do |server|
+          env.role(name, CapGCE::Utils.contact_point(server),
+                   options_with_instance_id(options, server))
+        end
+      end
+
+      def env
+        Configuration.env
+      end
+
+      private
+
+      def options_with_instance_id(options, server)
+        options.merge(instance_id: server.id)
+      end
+    end
+  end
+end
+
+extend Capistrano::DSL::Gce
+
+Capistrano::Configuration::Server.send(:include, CapGCE::Utils::Server)

data/lib/cap-gce/gce-handler.rb

@@ -0,0 +1,87 @@
+require 'google/apis/compute_v1'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+
+module CapGCE
+  class GCEHandler
+    include CapGCE::Utils
+
+    def initialize
+      load_config
+      @authorizer = fetch_authorizer
+      load_gce
+    end
+
+    def load_gce
+      compute = Google::Apis::ComputeV1::ComputeService.new
+      compute.authorization = @authorizer
+      configured_zones = get_zones(fetch(:gce_zone))
+      @gce = {}
+      configured_zones.each do |zone|
+        @gce[zone] = compute.list_instances(
+          fetch(:gce_project_id),
+          zone,
+          filter: fetch(:gce_filter)
+        )
+      end
+    end
+
+    def status_table
+      CapGCE::StatusTable.new(
+        defined_roles.map { |r| get_servers_for_role(r) }.flatten.uniq(&:id)
+      )
+    end
+
+    def server_names
+      puts defined_roles
+        .map { |r| get_servers_for_role(r) }
+        .flatten
+        .uniq(&:id)
+        .map(&:name)
+        .join("\n")
+    end
+
+    def instance_ids
+      puts defined_roles
+        .map { |r| get_servers_for_role(r) }
+        .flatten
+        .uniq(&:id)
+        .map(&:id)
+        .join("\n")
+    end
+
+    def defined_roles
+      roles(:all).flat_map(&:roles_array).uniq.sort
+    end
+
+    def stage
+      Capistrano::Configuration.env.fetch(:stage).to_s
+    end
+
+    def application
+      Capistrano::Configuration.env.fetch(:application).to_s
+    end
+
+    def tag(tag_name)
+      "tag:#{tag_name}"
+    end
+
+    def get_servers_for_role(role)
+      servers = []
+      @gce.each do |_, gce|
+        servers += gce.items.select do |i|
+          instance_has_tag?(i, roles_tag, role) &&
+            instance_has_tag?(i, stages_tag, stage) &&
+            instance_has_tag?(i, project_tag, application)
+        end
+      end
+      servers.sort_by(&:name)
+    end
+
+    private
+
+    def instance_has_tag?(instance, key, value)
+      (tag_value(instance, key) || '').split(',').map(&:strip).include?(value.to_s)
+    end
+  end
+end

data/lib/cap-gce/status-table.rb

@@ -0,0 +1,63 @@
+module CapGCE
+  class StatusTable
+    include CapGCE::Utils
+
+    def initialize(instances)
+      @instances = instances
+      output
+    end
+
+    def header_row
+      [
+        bold('Num'),
+        bold('Name'),
+        bold('ID'),
+        bold('Type'),
+        bold('IP'),
+        bold('Zone'),
+        bold('Roles'),
+        bold('Stages')
+      ]
+    end
+
+    def output
+      table = Terminal::Table.new(
+        style: {
+          border_x: '',
+          border_i: '',
+          border_y: ''
+        }
+      )
+      table.add_row header_row
+      @instances.each_with_index do |instance, index|
+        table.add_row instance_to_row(instance, index)
+      end
+      puts table.to_s
+    end
+
+    def instance_to_row(instance, index)
+      [
+        '%02d' % index,
+        green(instance.name || ''),
+        red(instance.id.to_s),
+        cyan(instance.machine_type.split('/').last),
+        bold(blue(CapGCE::Utils.contact_point(instance).join(','))),
+        magenta(instance.zone.split('/').last),
+        yellow(tag_value(instance, roles_tag)),
+        yellow(tag_value(instance, stages_tag))
+      ]
+    end
+
+    private
+
+    (String.colors + String.modes).each do |format|
+      define_method(format) do |string|
+        if $stdout.tty?
+          string.__send__(format)
+        else
+          string
+        end
+      end
+    end
+  end
+end

data/lib/cap-gce/tasks/gce.rake

@@ -0,0 +1,33 @@
+namespace :gce do
+  desc 'Show all information about GCE instances that match this project'
+  task :status do
+    gce_handler.status_table
+  end
+
+  desc 'Show GCE server names that match this project'
+  task :server_names do
+    gce_handler.server_names
+  end
+
+  desc 'Show GCE instance IDs that match this project'
+  task :instance_ids do
+    gce_handler.instance_ids
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :gce_config, 'config/gce.yml'
+    set :gce_project_tag, 'Project'
+    set :gce_roles_tag, 'Roles'
+    set :gce_stages_tag, 'Stages'
+
+    set :gce_project_id, nil
+    set :gce_zone, %w[]
+    set :gce_filter, '(status eq "RUNNING")'
+    set :gce_fields, nil
+    set :gce_scope, %w[https://www.googleapis.com/auth/compute]
+    set :gce_secret_config, 'config/compute_engine_secret.json'
+    set :gce_contact_point, nil # public_ip_address, private_ip_address
+  end
+end

data/lib/cap-gce/utils.rb

@@ -0,0 +1,92 @@
+module CapGCE
+  module Utils
+    module Server
+      def gce_tags
+        id = properties.fetch(:gce_instance_id)
+        gce_handler.get_server(id).tags
+      end
+    end
+
+    def project_tag
+      fetch(:gce_project_tag)
+    end
+
+    def roles_tag
+      fetch(:gce_roles_tag)
+    end
+
+    def stages_tag
+      fetch(:gce_stages_tag)
+    end
+
+    def tag_value(instance, key)
+      instance.metadata.items.find({}) { |t| t.key == key.to_s }.value
+    end
+
+    def self.contact_point_mapping
+      {
+        public_ip: :nat_ip,
+        private_ip: :network_ip
+      }
+    end
+
+    def self.contact_point(instance)
+      gce_interface = contact_point_mapping[fetch(:gce_contact_point)]
+      network_interfaces = all_network_interfaces(instance)
+      return network_interfaces[gce_interface] if gce_interface
+
+      !network_interfaces[:nat_ip].empty? && network_interfaces[:nat_ip] ||
+        !network_interfaces[:network_ip].empty? && network_interfaces[:network_ip]
+    end
+
+    def self.all_network_interfaces(instance)
+      {
+        network_ip: instance.network_interfaces.map(&:network_ip),
+        nat_ip: nat_ip(instance)
+      }
+    end
+
+    def self.nat_ip(instance)
+      instance.network_interfaces.map(&:access_configs).flatten.map(&:nat_ip) - [nil]
+    end
+
+    private
+
+    def load_config
+      secret_location = File.expand_path(fetch(:gce_secret_config), Dir.pwd)
+      unless secret_location && File.exist?(secret_location)
+        raise 'You must specify secret config file.'
+      end
+
+      config_location = File.expand_path(fetch(:gce_config), Dir.pwd)
+      return unless config_location && File.exist?(config_location)
+      config = YAML.load_file fetch(:gce_config)
+      return unless config
+
+      set :gce_project_tag, config['project_tag'] if config['project_tag']
+      set :gce_roles_tag, config['roles_tag'] if config['roles_tag']
+      set :gce_stages_tag, config['stages_tag'] if config['stages_tag']
+
+      set :gce_project_id, config['project_id'] if config['project_id']
+      set :gce_filter, config['filter'] if config['filter']
+      set :gce_zone, config['zones'] if config['zones']
+      set :gce_scope, config['scopes'] if config['scopes']
+    end
+
+    def fetch_authorizer
+      authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
+        json_key_io: File.open(fetch(:gce_secret_config)),
+        scope: fetch(:gce_scope)
+      )
+      authorizer.fetch_access_token!
+      authorizer
+    end
+
+    def get_zones(zones_array = nil)
+      if zones_array.nil? || zones_array.empty?
+        return raise 'You must specify at least one GCE zone.'
+      end
+      zones_array
+    end
+  end
+end

data/lib/cap-gce/version.rb

@@ -0,0 +1,3 @@
+module CapGCE
+  VERSION = '1.1.0'.freeze
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: cap-gce
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Dean Lin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  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: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Cap-GCE is used to generate Capistrano namespaces and tasks from Google
+  Compute Engine instance metadatas, dynamically building the list of servers to be
+  deployed to.
+email:
+- iscreen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cap-gce.gemspec
+- lib/cap-gce.rb
+- lib/cap-gce/capistrano.rb
+- lib/cap-gce/gce-handler.rb
+- lib/cap-gce/status-table.rb
+- lib/cap-gce/tasks/gce.rake
+- lib/cap-gce/utils.rb
+- lib/cap-gce/version.rb
+homepage: https://github.com/iscreen/cap-gce
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Cap-GCE is used to generate Capistrano namespaces and tasks from Google Compute
+  Engine instance metadatas, dynamically building the list of servers to be deployed
+  to.
+test_files: []