capistrano-gcp-autoscaling 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec2ae2059e98aee5d438dbba5b5752ac15af4dbbf34708e18d386462e2b9fbea
+  data.tar.gz: c5432d74d75e77c3d1124f1f2c8fc71d791d2c89e64413b5202ed8aea9aa3867
+SHA512:
+  metadata.gz: 73c358b3b10b3ebfd84f6390c6a35554f2aa1d5d73d6bc7bb6cd4f58b8e1d1bd2814938f05ad1545c39dc02b80f7765520910898be68c9e73a44ae3fabb77e9d
+  data.tar.gz: 73c64322f6dafed4248b32b8ef3e4a46a9ca2ef6676d0192e5bd9ea144befeb1635dc3fabb1317e9530517e44686672226f3c5a0b1b1d200ad755774709e49c0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  Include:
+    - "**/*.rb"
+    - Gemfile
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Max: 120
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-gcp-autoscaling.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    capistrano-gcp-autoscaling (0.1.0)
+      capistrano (~> 3.0)
+      google-api-client (~> 0.8)
+      googleauth (>= 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    airbrussh (1.3.1)
+      sshkit (>= 1.6.1, != 1.7.0)
+    ast (2.4.0)
+    capistrano (3.11.0)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.1.5)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    google-api-client (0.28.4)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (>= 0.5, < 0.10.0)
+      httpclient (>= 2.8.1, < 3.0)
+      mime-types (~> 3.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+      signet (~> 0.10)
+    googleauth (0.8.0)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.7)
+    httpclient (2.8.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    jwt (2.1.0)
+    memoist (0.16.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    net-scp (2.0.0)
+      net-ssh (>= 2.6.5, < 6.0.0)
+    net-ssh (5.2.0)
+    os (1.0.0)
+    parallel (1.15.0)
+    parser (2.6.2.0)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    signet (0.11.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    sshkit (1.18.2)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    uber (0.1.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  capistrano-gcp-autoscaling!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.66)
+  rubocop-rspec (~> 1.32)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aleksei Vorobyov
+
+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,66 @@
+# Capistrano::Gcp::Autoscaling
+
+We were inspired by https://github.com/lserman/capistrano-elbas.
+The gem helps deploy code to the all instances of the provided instance group.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-gcp-autoscaling'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-gcp-autoscaling
+    
+Add this line to Capfile
+
+```ruby
+require 'capistrano/gcp/autoscaling'
+```
+
+## Configuration
+
+The gem uses a service account to get an access to GCP.
+Read the documentation (https://cloud.google.com/iam/docs/creating-managing-service-accounts) if you don't know how to create it.
+
+```ruby
+set :gcp_project_id, nil
+set :gcp_region, nil
+set :gcp_filter, '(status eq "RUNNING")'
+set :gcp_scope, 'https://www.googleapis.com/auth/compute'
+set :gcp_private_key, ENV['GCP_PRIVATE_KEY']
+set :gcp_client_email, ENV['GCP_CLIENT_EMAIL']
+```
+
+## Usage
+
+To provide an instance group, go to deploy/<stage>.rb and instead of server write the next line:
+
+```ruby
+instance_group_manager 'my-instance-group-manager1', user: 'apps', roles: %i(app web db)
+
+instance_group_manager 'my-instance-group-manager2' do |_instance, index|
+  index.zero? ? { user: 'apps', roles: %i(app web db) } : { user: 'apps', roles: %i(app web) }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/a3.vorobyov/capistrano-gcp-autoscaling.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'capistrano/gcp/autoscaling'
+
+# 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/capistrano-gcp-autoscaling.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/gcp/autoscaling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-gcp-autoscaling'
+  spec.version       = Capistrano::Gcp::Autoscaling::VERSION
+  spec.authors       = ['Aleksei Vorobyov']
+  spec.email         = ['effypad@gmail.com']
+
+  spec.summary       = 'Capistrano plugin for deploying to GCP instance groups'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/a3vorobyov/capistrano-gcp-autoscaling'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.66'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.32'
+
+  spec.add_dependency 'capistrano', '~> 3.0'
+  spec.add_dependency 'google-api-client', '~> 0.8'
+  spec.add_dependency 'googleauth', '>= 0.6'
+end

data/lib/capistrano/gcp/autoscaling.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'googleauth'
+require 'google/apis/compute_v1'
+require 'capistrano/gcp/autoscaling/core/compute_service'
+require 'capistrano/gcp/autoscaling/core/instance'
+require 'capistrano/gcp/autoscaling/core/instance_group_manager'
+
+load File.expand_path('tasks/autoscaling.rake', __dir__)
+
+def compute_service
+  @compute_service ||= Capistrano::Gcp::Autoscaling::Core::ComputeService.new(
+    gcp_project_id: fetch(:gcp_project_id),
+    gcp_private_key: fetch(:gcp_private_key),
+    gcp_client_email: fetch(:gcp_client_email),
+    gcp_scope: fetch(:gcp_scope)
+  ).instance
+end
+
+def instance_group_manager(group_manager_name, properties = {})
+  instance_group_manager = Capistrano::Gcp::Autoscaling::Core::InstanceGroupManager.new(
+    compute_service,
+    gcp_project_id: fetch(:gcp_project_id),
+    gcp_region: fetch(:gcp_region),
+    gcp_filter: fetch(:gcp_filter),
+    group_manager_name: group_manager_name
+  )
+
+  instance_group_manager.instances.each_with_index do |instance, index|
+    server instance.network_ip, block_given? ? yield(instance, index) : properties
+  end
+end

data/lib/capistrano/gcp/autoscaling/core/compute_service.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Gcp
+    module Autoscaling
+      module Core
+        class ComputeService
+          def initialize(options = {})
+            @options = options
+          end
+
+          def instance
+            @instance ||= Google::Apis::ComputeV1::ComputeService.new.tap do |instance|
+              ensure_env_variables_set!
+              ensure_authorization_set!(instance)
+            end
+          end
+
+          private
+
+          attr_reader :options
+
+          def ensure_env_variables_set!
+            ENV[Google::Auth::CredentialsLoader::PRIVATE_KEY_VAR] = options.fetch(:gcp_private_key)
+            ENV[Google::Auth::CredentialsLoader::CLIENT_EMAIL_VAR] = options.fetch(:gcp_client_email)
+          end
+
+          def ensure_authorization_set!(instance)
+            instance.authorization = Google::Auth::ServiceAccountCredentials.make_creds(
+              scope: options.fetch(:gcp_scope)
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/gcp/autoscaling/core/instance.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Gcp
+    module Autoscaling
+      module Core
+        class Instance
+          INSTANCE_PATTERN = %r{/instances/[\w-]+}.freeze
+          ZONE_PATTERN = %r{/zones/[\w-]+}.freeze
+          SEPARATOR = '/'.freeze
+
+          def initialize(compute_service, managed_instance, options = {})
+            @compute_service = compute_service
+            @managed_instance = managed_instance
+            @options = options
+          end
+
+          def network_ip
+            instance.network_interfaces.first.network_ip
+          end
+
+          private
+
+          attr_reader :compute_service, :managed_instance, :options
+
+          def instance
+            compute_service.get_instance(options.fetch(:gcp_project_id), instance_zone, instance_name)
+          end
+
+          def instance_zone
+            parse_managed_instance(ZONE_PATTERN)
+          end
+
+          def instance_name
+            parse_managed_instance(INSTANCE_PATTERN)
+          end
+
+          def parse_managed_instance(pattern, separator = SEPARATOR)
+            managed_instance.instance.scan(pattern).last.split(separator).last
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/gcp/autoscaling/core/instance_group_manager.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Gcp
+    module Autoscaling
+      module Core
+        class InstanceGroupManager
+          def initialize(compute_service, options = {})
+            @compute_service = compute_service
+            @options = options
+          end
+
+          def instances
+            group_manager.managed_instances.map(&method(:instance_for))
+          end
+
+          private
+
+          attr_reader :compute_service, :options
+
+          def instance_for(managed_instance)
+            Capistrano::Gcp::Autoscaling::Core::Instance.new(
+              compute_service,
+              managed_instance,
+              gcp_project_id: options.fetch(:gcp_project_id)
+            )
+          end
+
+          def group_manager
+            compute_service.list_region_instance_group_manager_managed_instances(
+              options.fetch(:gcp_project_id),
+              options.fetch(:gcp_region),
+              options.fetch(:group_manager_name),
+              filter: options.fetch(:gcp_filter)
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/gcp/autoscaling/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Gcp
+    module Autoscaling
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/lib/capistrano/gcp/tasks/autoscaling.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :load do
+  task :defaults do
+    set :gcp_project_id, nil
+    set :gcp_region, nil
+    set :gcp_filter, '(status eq "RUNNING")'
+    set :gcp_scope, 'https://www.googleapis.com/auth/compute'
+    set :gcp_private_key, ENV['GCP_PRIVATE_KEY']
+    set :gcp_client_email, ENV['GCP_CLIENT_EMAIL']
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-gcp-autoscaling
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksei Vorobyov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.66'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.66'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+- !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: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Capistrano plugin for deploying to GCP instance groups
+email:
+- effypad@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-gcp-autoscaling.gemspec
+- lib/capistrano/gcp/autoscaling.rb
+- lib/capistrano/gcp/autoscaling/core/compute_service.rb
+- lib/capistrano/gcp/autoscaling/core/instance.rb
+- lib/capistrano/gcp/autoscaling/core/instance_group_manager.rb
+- lib/capistrano/gcp/autoscaling/version.rb
+- lib/capistrano/gcp/tasks/autoscaling.rake
+homepage: https://github.com/a3vorobyov/capistrano-gcp-autoscaling
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin for deploying to GCP instance groups
+test_files: []