ecs-rails-console 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89bf0d51f3784badf31b3b907df33c184653dff3e03b4907bde2a80f9558c750
+  data.tar.gz: 53630b5f467b6fd0d0f2c596fa636a710ab6384affd78e713bb970ce197fb177
+SHA512:
+  metadata.gz: 365b37aeb0780b5f724e4f702650af90d7698793e8fb4edb9e02f2a41560058a7f3dd72b86c21f6c9f40e861cc2a2ef97e8aa075f4a003a823e8d619ff0c80ae
+  data.tar.gz: 84a2fd356d3553979c7dbd833ec2a1b9b249cc80547ca30800e0b22119a7615461d660c96c19e4f5c11df6394e11278b6d227b6707371abefbd427d5f30b07ee

data/bin/ecs_rails_console

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'ecs_rails_console'
+
+$LOAD_PATH.push File.expand_path('../lib', __dir__)
+
+options = {
+  environment: 'production',
+  command: 'bin/rails console'
+}
+
+opts = OptionParser.new do |option|
+  option.banner = 'Usage: ecs_rails_console [options]'
+
+  option.on('-g', '--generate-config', 'Generate config file') do
+    template = File.expand_path('../config/ecs_rails_console.yml', __dir__)
+    config_file = 'config/ecs_rails_console.yml'
+
+    if File.exist?(config_file)
+      puts 'Configuration file already exists and will be kept untouched.'
+    else
+      FileUtils.mkdir_p(File.dirname(config_file))
+      FileUtils.cp(template, "#{Dir.pwd}/#{config_file}")
+      puts "File generated: #{config_file}"
+    end
+    exit
+  end
+
+  option.on('-h', '--help', 'Display this help') do
+    puts option
+    exit
+  end
+
+  option.on('-eENVIRONMENT', '--environment=ENVIRONMENT', 'Rails environment') do |environment|
+    options[:environment] = environment
+  end
+
+  option.on('-v', '--version', 'Display version') do
+    require 'ecs_rails_console/version'
+    puts EcsRailsConsole::VERSION
+    exit
+  end
+end
+
+begin
+  opts.parse!
+rescue OptionParser::InvalidOption => e
+  puts e
+  puts
+  puts opts
+  exit
+end
+
+options[:command] = ARGV.join(' ') unless ARGV.empty?
+
+begin
+  EcsRailsConsole::Cli.run!(options)
+rescue Gem::LoadError
+  puts 'ecs_rails_console is not in your Gemfile.'
+  exit 1
+end

data/lib/ecs_rails_console.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EcsRailsConsole
+end
+
+require "ecs_rails_console/core"
+require "ecs_rails_console/cli"

data/lib/ecs_rails_console/cli.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yaml"
+
+module EcsRailsConsole
+  CONFIG_FILE = "#{Dir.pwd}/config/ecs_rails_console.yml"
+  SSH_OPTIONS = '-tq -oStrictHostKeyChecking=no'
+
+  class Cli < Core
+    def self.run!(options)
+      new(options).run!
+    end
+
+    def initialize(options)
+      super()
+      @environment = options[:environment]
+      @command = options[:command]
+    end
+
+    def run!
+      puts "Cluster name: #{cluster_name}"
+
+      task_description = run_task
+
+      public_ip = get_public_ip(task_description)
+
+      puts "it is running on: #{public_ip}"
+
+      system("ssh #{SSH_OPTIONS} #{ssh_user}@#{public_ip} 'cd /app ; #{command}'")
+    rescue Aws::ECS::Errors::ExpiredTokenException
+      puts "\nHey, it seems your token expired. Authenticate on AWS give another try."
+    end
+
+    private
+
+    attr_reader :environment, :command
+
+    def aws_credentials
+      config.slice(
+        "profile",
+        "access_key_id",
+        "secret_access_key",
+        "region"
+      ).transform_keys(&:to_sym)
+    end
+
+    def config
+      @config ||= YAML.load_file(CONFIG_FILE)[environment] || {}
+    end
+
+    def ssh_user
+      config[:ssh_user] || 'root'
+    end
+  end
+end

data/lib/ecs_rails_console/core.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require "aws-sdk-ecs"
+require "aws-sdk-ec2"
+
+module EcsRailsConsole
+  class Core
+    private
+
+    def ecs_client
+      @ecs_client ||= Aws::ECS::Client.new(aws_credentials)
+    end
+
+    def ec2_client
+      @ec2_client ||= Aws::EC2::Client.new(aws_credentials)
+    end
+
+    def vpc_id
+      @vpc_id ||= begin
+        id = ec2_client.describe_vpcs(
+          {
+            filters: [{
+              name: "tag:aws:cloudformation:stack-name",
+              values: ["#{cluster_name}InfraStack"]
+            }]
+          }
+        )[:vpcs].map(&:vpc_id).first
+        abort "Could not find VPC" if id.empty?
+
+        id
+      end
+    end
+
+    def subnet_ids(vpc_id)
+      @subnet_ids ||= begin
+        ids = ec2_client.describe_subnets(
+          {
+            filters: [
+              {name: "vpc-id", values: [vpc_id]},
+              {name: "tag:aws-cdk:subnet-type", values: ["Public"]}
+            ]
+          }
+        )[:subnets].map(&:subnet_id)
+        abort "Could not find subnets" if ids.empty?
+
+        ids
+      end
+    end
+
+    def console_security_group_ids(vpc_id)
+      @console_security_group_ids ||= begin
+        ids = ec2_client.describe_security_groups(
+          filters: [
+            {name: "vpc-id", values: [vpc_id]},
+            {name: "group-name",
+             values: config["security_groups"]}
+          ]
+        )[:security_groups].map(&:group_id)
+        abort "Could not find security groups" if ids.empty?
+
+        ids
+      end
+    end
+
+    def task_definition
+      @task_definition ||= begin
+        task_definition_name_regex = %r{.*/(#{config['task_definition']}):\d+}
+        task_definitions = ecs_client.list_task_definitions(status: "ACTIVE")
+        definition_arn = task_definitions[:task_definition_arns].detect do |arn|
+          arn.match(task_definition_name_regex)
+        end
+        abort "Could not find console task definition" if definition_arn.empty?
+
+        definition_arn.match(task_definition_name_regex).captures.first
+      end
+    end
+
+    def run_task
+      task = ecs_client.run_task(
+        {
+          cluster: cluster_name,
+          launch_type: "FARGATE",
+          task_definition: task_definition,
+          network_configuration: {
+            awsvpc_configuration: {
+              subnets: subnet_ids(vpc_id),
+              security_groups: console_security_group_ids(vpc_id),
+              assign_public_ip: "ENABLED"
+            }
+          }
+        }
+      )[:tasks].first
+
+      task_id = task[:task_arn].match(%r{.*/(\w+)$}).captures.first
+
+      ecs_client
+        .wait_until(:tasks_running, {cluster: cluster_name, tasks: [task_id]})[:tasks]
+        .first
+    end
+
+    def get_public_ip(task_description)
+      network_interface_id =
+        task_description[:attachments]
+          .first[:details]
+          .detect { |detail| detail[:name] == "networkInterfaceId" }[:value]
+
+      ec2_client.describe_network_interfaces(
+        network_interface_ids: [
+          network_interface_id
+        ]
+      )[:network_interfaces].first[:association][:public_ip]
+    end
+
+    def cluster_name
+      @cluster_name ||= config["cluster_name"]
+    end
+  end
+end

data/lib/ecs_rails_console/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EcsRailsConsole
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ecs-rails-console
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Eduardo Ramos
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.227'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.227'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ecs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Provide a way to run Rails Console in a container running on AWS ECS
+  Fargate.
+email:
+- ramos.eduardo87@gmail.com
+executables:
+- ecs_rails_console
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/ecs_rails_console
+- lib/ecs_rails_console.rb
+- lib/ecs_rails_console/cli.rb
+- lib/ecs_rails_console/core.rb
+- lib/ecs_rails_console/version.rb
+homepage: http://rubygems.org/gems/ecs-rails-console
+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.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Run Rails Console in AWS ECS
+test_files: []