mina-infinum 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8b7cc4a4b5015428a7103241d34ec9ce0e672ed95b555f0a04d24b65640de89
-  data.tar.gz: 6e9499a465eef1bd140a269351899fb08ca12ebc67def5e478c9cb4c50a535ab
+  metadata.gz: 7515a358a97fb531c9234b5af9f66d38b21ca179baa2630a6c0cdab7594bc81d
+  data.tar.gz: 0d1c15c942585a620cae300808ae5c509dbc8329fd68a17a67913e27203e3ab0
 SHA512:
-  metadata.gz: b57397003d8fc8ed3f682c686bcf64ac41df029f62ec7fe65c061198f17b084bbc38ea7e3d3f1ff508f95ea76de4acbd60c3e30fd02056afeb1bb5dea387d4e7
-  data.tar.gz: e864d2dbebfb3ef831ffc2f1c03d07074865e515a31ff16dbbf7192fcec9b84d73fac0ea659ca5c81eae31c93606791644f1d6c751341a325017f034192d76d7
+  metadata.gz: d636c8821a835dc329c263ebe7da0cafc1689aa4b4c41829988e243979c76f1867fedea43b1d2fdad509e11ff2bd96ed0e60a27645b217b47591056c29c386b0
+  data.tar.gz: 28ce51888667a163a17dd3274643f9071d1cc88fa2981f593454cb92a2940996665deb17d9512e6cdcfa0c3f319af8003e778e2632faae3306927bd89ab4c725

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [v2.1.0](https://github.com/infinum/mina-infinum/tree/v-2.1.0) (2025-05-29)
+[Full Changelog](https://github.com/infinum/mina-infinum/compare/v2.0.0...v2.1.0)
+
+### Enhancements
+
+- Add ECS tasks [\#5](https://github.com/infinum/mina-infinum/pull/5)
+
 ## [v2.0.0](https://github.com/infinum/mina-infinum/tree/v-2.0.0) (2021-12-03)
 [Full Changelog](https://github.com/infinum/mina-infinum/compare/v1.9.0...v2.0.0)
 

data/README.md

@@ -1,6 +1,11 @@
 # Mina::Infinum
 
 For `mina 0.3.0` please take a look at [v0.3.0 branch](https://github.com/infinum/mina-infinum/tree/v0.3.0)
+
+## ECS
+
+For ECS-related setup, see [this README](lib/mina/infinum/ecs/README.md).
+
 ## Plugins
 
 * [mina](https://github.com/mina-deploy/mina), '> 1.0'

data/lib/mina/infinum/ecs/README.md

@@ -0,0 +1,72 @@
+# ECS tasks
+
+This module contains common tasks for accessing ECS containers and Rails applications on them.
+
+Tasks are split in several namespaces:
+- `aws`: AWS-related commands (profile creation, SSO login)
+- `db`: interaction with DBs (forwarding remote DB port to local machine)
+- `ecs`: interaction with ECS containers (e.g. running commands)
+- `rails`: interaction with Rails apps on ECS containers (e.g. opening the console)
+
+To find available tasks, run `bundle exec mina --tasks`.<br />
+To read detailed task descriptions, run `bundle exec mina --describe/-D`.
+
+## Setup
+
+To get started, copy the following into `config/deploy.rb` and adjust variables:
+
+```ruby
+require 'mina/infinum/ecs'
+
+set :aws_profile, 'profile_name'
+set :aws_source_profile, 'source_profile_name'
+set :aws_region, 'region'
+set :aws_role_arn, 'role_arn'
+# set :aws_login_profile, 'login_profile_name' (uses :aws_source_profile by default)
+
+set :service, 'service_name'
+# set :db_local_port, 4242 (default: 9999)
+
+# set :shell, 'zsh' (default: 'bash')
+
+task :staging do
+  set :rails_env, 'staging'
+  set :aws_jump_server_id, 'i-ec2_instance_id'
+  set :db_host, 'production_db_host'
+  # set :db_port, 3306 (default: 5432)
+  set :cluster, 'production_cluster_name'
+end
+
+task :production do
+  set :rails_env, 'production'
+  set :aws_jump_server_id, 'i-ec2_instance_id'
+  set :db_host, 'production_db_host'
+  # set :db_port, 3306 (default: 5432)
+  set :cluster, 'production_cluster_name'
+end
+```
+
+## Debug mode
+
+To see debug output, append `debug=true` to command, e.g.: `bundle exec mina staging db:proxy debug=true`:
+```
+$ bundle exec mina staging db:proxy debug=true
+
+2025-05-27 09:32:14,455 - MainThread - awscli.clidriver - DEBUG - CLI version: aws-cli/2.2.6 Python/3.8.8 Darwin/24.5.0 exe/x86_64
+2025-05-27 09:32:14,455 - MainThread - awscli.clidriver - DEBUG - Arguments entered to CLI: ['configure', 'list-profiles', '--debug']
+# and so on...
+```
+
+## Verbose mode
+
+To see commands before they run, append `verbose=true`, e.g.: `bundle exec mina staging db:proxy verbose=true`:
+```
+$ bundle exec mina staging db:proxy verbose=true
+
+  $ aws configure list-profiles
+  $ aws ssm start-session --target aws_jump_server_id --document-name AWS-StartPortForwardingSessionToRemoteHost --parameters host="db_host",portNumber="5432",localPortNumber="9999" --profile aws_profile
+
+Starting session with SessionId: botocore-session-12345
+Port 9999 opened for sessionId botocore-session-12345.
+Waiting for connections...
+```

data/lib/mina/infinum/ecs/aws.rb

@@ -0,0 +1,93 @@
+require 'English'
+
+set :debug, false
+
+namespace :aws do
+  task :ensure_cli_version do
+    version = run_cmd "aws --version #{'--debug' if debug?}"
+
+    error! 'AWS CLI version 2 is required' unless version.start_with?('aws-cli/2')
+
+    puts "AWS CLI v2 is intalled. Version: #{version}" if debug?
+  end
+
+  desc <<~TXT
+    Log in to AWS
+
+    Retrieves an SSO access token from AWS. Prerequisite for any task
+    which requires authentication (for example, ecs:connect).
+
+    Logs in with profile :aws_login_profile if defined, otherwise uses
+    :aws_source_profile.
+  TXT
+  task login: [:ensure_cli_version] do
+    ensure!(:aws_source_profile)
+
+    login_profile = fetch(:aws_login_profile, fetch(:aws_source_profile))
+
+    run_cmd "aws sso login --profile #{login_profile}", exec: true
+  end
+
+  desc <<~TXT
+    Open AWS console in the browser
+
+    The console is opened in region :aws_region.
+  TXT
+  task console: ['profile:check'] do
+    ensure!(:aws_region)
+
+    region = fetch(:aws_region)
+
+    run_cmd "open https://#{region}.console.aws.amazon.com/console/home?region=#{region}", exec: true
+  end
+
+  namespace :profile do
+    task :check do
+      ensure!(:aws_profile)
+
+      unless profile_exists?(fetch(:aws_profile))
+        error! "Please create AWS profile '#{fetch(:aws_profile)}' first (use task aws:profile:create)"
+      end
+    end
+
+    desc <<~TXT
+      Create AWS profile
+
+      Creates profile :aws_profile on local machine. Prerequisite for
+      any task which uses AWS resources (for example, ecs:connect).
+
+      The profile is set up with parameters:
+      - source_profile -> :aws_source_profile
+      - region -> :aws_region
+      - role_arn -> :aws_role_arn
+    TXT
+    task create: [:ensure_cli_version] do
+      ensure!(:aws_profile)
+      ensure!(:aws_source_profile)
+      ensure!(:aws_region)
+      ensure!(:aws_role_arn)
+
+      unless profile_exists?(fetch(:aws_source_profile))
+        error! "Please create AWS source profile first - #{fetch(:aws_source_profile)}"
+      end
+
+      if profile_exists?(fetch(:aws_profile)) && !fetch(:force)
+        puts "Profile '#{fetch(:aws_profile)}' already exists, add 'force=true' to overwrite it"
+      else
+        puts "Creating profile '#{fetch(:aws_profile)}'..."
+        run_cmd "aws configure set source_profile #{fetch(:aws_source_profile)} --profile #{fetch(:aws_profile)} #{'--debug' if debug?}"
+        run_cmd "aws configure set region #{fetch(:aws_region)} --profile #{fetch(:aws_profile)} #{'--debug' if debug?}"
+        run_cmd "aws configure set role_arn #{fetch(:aws_role_arn)} --profile #{fetch(:aws_profile)} #{'--debug' if debug?}"
+        puts 'Done'
+      end
+    end
+  end
+end
+
+def profile_exists?(profile)
+  profiles = run_cmd "aws configure list-profiles #{'--debug' if debug?}"
+
+  error! 'Cannot list AWS profiles' unless $CHILD_STATUS.success?
+
+  profiles.split("\n").include?(profile)
+end

data/lib/mina/infinum/ecs/db.rb

@@ -0,0 +1,33 @@
+require 'mina/infinum/ecs/aws'
+
+namespace :db do
+  desc <<~TXT
+    Forward remote DB port to local port through an SSM session
+
+    Connects to the AWS resource :aws_jump_server_id through an SSM session
+    and forwards port :db_port (default: 5432) on host :db_host to local
+    port :db_local_port (default: 9999). Uses profile :aws_profile.
+
+    You can override local port in config/deploy.rb, or inline:
+    $ mina db:proxy db_local_port=4242
+  TXT
+  task proxy: ['aws:profile:check'] do
+    ensure!(:aws_jump_server_id)
+    ensure!(:db_host)
+
+    profile = fetch(:aws_profile)
+    jump_server_id = fetch(:aws_jump_server_id)
+    host = fetch(:db_host)
+    remote_port = fetch(:db_port, 5432)
+    local_port = fetch(:db_local_port, 9999)
+
+    run_cmd squish(<<~CMD), exec: true
+      aws ssm start-session
+        --target #{jump_server_id}
+        --document-name AWS-StartPortForwardingSessionToRemoteHost
+        --parameters host="#{host}",portNumber="#{remote_port}",localPortNumber="#{local_port}"
+        --profile #{profile}
+        #{'--debug' if debug?}
+    CMD
+  end
+end

data/lib/mina/infinum/ecs/ecs.rb

@@ -0,0 +1,60 @@
+require 'json'
+require 'mina/infinum/ecs/aws'
+
+namespace :ecs do
+  desc <<~TXT
+    Execute a command on ECS container
+
+    Executes command :command in interactive mode on container in active
+    task on cluster :cluster for service :service. Uses profile :aws_profile.
+
+    Command is provided as a rake task argument:
+    $ mina "ecs:exec[command]"
+  TXT
+  task :exec, [:command] => ['aws:profile:check'] do |_, args|
+    ensure!(:cluster)
+    ensure!(:service)
+
+    command = args.fetch(:command) { error! 'Command is a required argument' }
+
+    task_arn = find_task_arn
+
+    run_cmd squish(<<~CMD), exec: true
+      aws ecs execute-command
+        --task #{task_arn}
+        --command \"#{command}\"
+        --cluster #{fetch(:cluster)}
+        --profile #{fetch(:aws_profile)}
+        --interactive
+        #{'--debug' if debug?}
+    CMD
+  end
+
+  desc <<~TXT
+    Connect to the ECS container
+
+    Uses ecs:exec task to start a shell on the container.
+
+    The shell is defined with :shell (default: 'bash').
+  TXT
+  task :connect do
+    invoke 'ecs:exec', fetch(:shell, 'bash')
+  end
+end
+
+def find_task_arn
+  output = run_cmd squish(<<~CMD)
+    aws ecs list-tasks
+      --output json
+      --cluster #{fetch(:cluster)}
+      --service #{fetch(:service)}
+      --profile #{fetch(:aws_profile)}
+      #{'--debug' if debug?}
+  CMD
+
+  unless $CHILD_STATUS.success?
+    error! "Cannot list ECS tasks... do you need to log in (use task aws:login)? For more info, add debug=true to command"
+  end
+
+  JSON.parse(output).dig('taskArns', 0) || error!('There are no task definitions')
+end

data/lib/mina/infinum/ecs/rails.rb

@@ -0,0 +1,42 @@
+require 'mina/infinum/ecs/ecs'
+
+desc 'Execute a rails command'
+desc <<~TXT
+  Execute a Rails command
+
+  Uses ecs:exec task to execute a Rails command on the container.
+
+  Command is provided as a rake task argument:
+  $ mina "rails[command]"
+  and is executed on the container as:
+  $ bundle exec rails [command]
+TXT
+task :rails, [:command] do |_, args|
+  ensure!(:rails_env)
+
+  command = args.fetch(:command) { error! 'Command is a required argument' }
+
+  invoke 'ecs:exec', "bundle exec rails #{command}"
+end
+
+namespace :rails do
+  desc <<~TXT
+    Open rails console
+
+    Runs "bundle exec rails console" on the ECS container.
+  TXT
+  task :console do
+    invoke 'rails', 'console'
+  end
+
+  desc <<~TXT
+    Tail application log
+
+    Log is tailed from `log` folder for environment :rails_env.
+  TXT
+  task :log do
+    ensure!(:rails_env)
+
+    invoke 'ecs:exec', "tail -f log/#{fetch(:rails_env)}.log"
+  end
+end

data/lib/mina/infinum/ecs.rb

@@ -0,0 +1,27 @@
+require 'mina/default'
+require 'mina/infinum/ecs/rails'
+require 'mina/infinum/ecs/db'
+
+# INFO: hides default Mina tasks when running "mina --tasks"
+Rake::Task['run'].clear_comments
+Rake::Task['ssh'].clear_comments
+Rake::Task['ssh_keyscan_domain'].clear_comments
+Rake::Task['ssh_keyscan_repo'].clear_comments
+
+def squish(command)
+  command.gsub(/[[:space:]]+/, ' ').strip
+end
+
+def run_cmd(cmd, exec: false)
+  print_command(cmd) if fetch(:verbose)
+
+  if exec
+    Kernel.exec cmd
+  else
+    Kernel.` cmd
+  end
+end
+
+def debug?
+  fetch(:debug, false)
+end

data/lib/mina/infinum/version.rb

@@ -1,5 +1,5 @@
 module Mina
   module Infinum
-    VERSION = '2.0.0'.freeze
+    VERSION = '2.1.0'.freeze
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mina-infinum
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Stjepan Hadjic
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +140,12 @@ files:
 - bin/console
 - bin/setup
 - lib/mina/infinum.rb
+- lib/mina/infinum/ecs.rb
+- lib/mina/infinum/ecs/README.md
+- lib/mina/infinum/ecs/aws.rb
+- lib/mina/infinum/ecs/db.rb
+- lib/mina/infinum/ecs/ecs.rb
+- lib/mina/infinum/ecs/rails.rb
 - lib/mina/infinum/helpers.rb
 - lib/mina/infinum/tasks.rb
 - lib/mina/infinum/version.rb
@@ -150,7 +155,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -165,8 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Collection of mina plugins we use in infinum
 test_files: []