ecs_helper 0.0.34 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a88fdb1673cb2abe2e271e6004fd278b0c5d92bf630ab70fcf7a94c5e0730ce
-  data.tar.gz: '0278428fd13fc8bc2dcca2b054041787f85c06b1adb94523b09db83a8c160bfe'
+  metadata.gz: 0d05f26ad2e1cfadd91160c700ecd339e3484fadf00e547d666c589eb74017cd
+  data.tar.gz: 3e69e86b2c95f659ca2638d874c13ab11130fda06fe31c95e66247fa662ea861
 SHA512:
-  metadata.gz: 52bb0aba871028e742a3ff98323d807f136ce19c2c55d3451ed429b31f32cc64d13b6e88bf4c0b8aa3cbfb61ea41a36b4014ae11a3bbae54ea4af5a223d069a3
-  data.tar.gz: be2a51106a033db704cc57f44539670616e55e12ba6a3f1a62ae1220708d296e6c3e671687889a559c75841788cdb543aaaffce07d432524a5e89e6988534846
+  metadata.gz: bacf9314c83c7d19ddbdfd1571f467b4fcbebfdb4888c83fc4127cfd9eb9009262115e3828d98acb8711e58d364442c42975ed6566926c65d040f845521e3fcd
+  data.tar.gz: 98d256e205ba4ee2170edea30685f5e1b7bafa4d3627d488ff3e3d1dba036bc6fd6283e9e9e37599521223d225da7fcd77bf98305b0528fff2390d1f1e20ea97

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecs_helper (0.0.34)
+    ecs_helper (0.0.36)
       aws-sdk-ecr (~> 1.42, >= 1.42)
       aws-sdk-ecrpublic (~> 1.3, >= 1.3)
       aws-sdk-ecs (~> 1.80, >= 1.80)
@@ -17,26 +17,26 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     awesome_print (1.9.2)
-    aws-eventstream (1.2.0)
-    aws-partitions (1.516.0)
-    aws-sdk-core (3.121.1)
-      aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.239.0)
-      aws-sigv4 (~> 1.1)
-      jmespath (~> 1.0)
-    aws-sdk-ecr (1.47.0)
-      aws-sdk-core (~> 3, >= 3.120.0)
+    aws-eventstream (1.3.0)
+    aws-partitions (1.920.0)
+    aws-sdk-core (3.193.0)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.8)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-ecr (1.70.0)
+      aws-sdk-core (~> 3, >= 3.193.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ecrpublic (1.6.0)
-      aws-sdk-core (~> 3, >= 3.120.0)
+    aws-sdk-ecrpublic (1.27.0)
+      aws-sdk-core (~> 3, >= 3.193.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ecs (1.86.0)
-      aws-sdk-core (~> 3, >= 3.120.0)
+    aws-sdk-ecs (1.146.0)
+      aws-sdk-core (~> 3, >= 3.193.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-ssm (1.0.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sigv4 (1.4.0)
+    aws-sigv4 (1.8.0)
       aws-eventstream (~> 1, >= 1.0.2)
     bump (0.10.0)
     byebug (11.1.3)
@@ -46,8 +46,8 @@ GEM
     crack (0.4.5)
       rexml
     hashdiff (1.0.1)
-    jmespath (1.4.0)
-    json (2.6.0)
+    jmespath (1.6.2)
+    json (2.7.2)
     method_source (1.0.0)
     minitest (5.14.4)
     minitest-power_assert (0.3.1)
@@ -97,6 +97,7 @@ GEM
 
 PLATFORMS
   aarch64-linux
+  arm64-darwin-22
   x86_64-darwin-18
   x86_64-linux
 

data/README.md

@@ -0,0 +1,95 @@
+# ECS Helper - A tool for managing the deployment process of an application in Amazon Elastic Container Service (ECS)
+
+## Introduction
+
+ECS Helper is a command-line tool written in Ruby that allows you to control the deployment process of your application
+in Amazon Elastic Container Service. The tool provides various commands for building and pushing images, deploying your
+application, exporting images, logging in to Amazon Elastic Container Registry (ECR), running commands, exporting
+environment variables, and more. To use it an ECS Cluster with a service running there and have task_definitons is
+required. Docker images are stored in the ECR Elastic Container Registry.
+
+## Installation
+
+### Ruby Gem
+
+To use ECS Helper, you need to install the ecs_helper gem. You can install it using the following command:
+
+```bash
+gem install ecs_helper
+```
+
+You can use the ecs_helper command followed by the desired command and arguments to control your application deployment
+process.
+
+### Docker Image
+
+Alternatively, you can use the Docker image `partos/ecs_toolbox`. This image contains the ecs_helper gem and the AWS CLI
+tool. You can use the image to run the ecs_helper command in a container.
+
+## The available commands are:
+
+- **build_and_push**: builds and pushes the Docker image to Amazon Elastic Container Registry (ECR).
+- **deploy**: deploys the Docker image to Amazon Elastic Container Service (ECS).
+- **export_images**: exports Docker images to a file.
+- **ecr_login**: logs in to Amazon Elastic Container Registry (ECR).
+- **run_command**: runs a command in a container.
+- **export_env_secrets**: exports environment variables to a file.
+- **exec**: executes a command in a running container.
+- **check_exec**: checks if the command in the running container was executed successfully.
+
+You can select the desired command by passing the argument to the ecs_helper command. For example, to build and push an
+image with the tag api, you can use the following command:
+
+```bash
+ecs_helper build_and_push --image=api
+```
+
+## Using in GitLab CI
+
+ECS Helper can also be used in GitLab CI by using a pre-built Docker image. Here's an example of how to use ECS Helper
+in a GitLab CI pipeline:
+
+```yaml
+stages:
+  - build
+  - deploy
+
+
+variables:
+  DOCKER_DRIVER: overlay2
+  DOCKER_TLS_CERTDIR: ''
+  DOCKER_IMAGE: docker:20.10.6
+  PROJECT: test_project
+  TOOLBOX_IMAGE: partos/ecs_toolbox:0.0.34
+  AWS_REGION: us-east-1
+  AWS_DEFAULT_REGION: us-east-1
+  APPLICATION: app
+
+.ci_deploy: &ci_deploy
+
+only:
+  - master
+  - staging
+
+build_app:
+  <<: *ci_deploy
+  stage: build
+  image: $TOOLBOX_IMAGE
+  script:
+    - mkdir -p ./apps/api/dist/apps && cp -r ./dist/apps/api ./apps/api/dist/apps
+    - ecs_helper build_and_push --image=api --cache -d ./apps/api
+
+deploy_app:
+  <<: *ci_deploy
+  stage: deploy
+  image: $TOOLBOX_IMAGE
+  variables:
+  APPLICATION: app
+  script:
+    - ecs_helper deploy --timeout 600
+```
+
+In this example, ECS Helper is used to build and push the api Docker image in the build_app job, and to deploy the
+application in the deploy_app job.
+
+When a new version of an application is deployed, a new task definition revision is created in the target service.

data/lib/ecs_helper/client.rb

@@ -40,10 +40,6 @@ class ECSHelper::Client
     ecs.register_task_definition(params).task_definition
   end
 
-  def deregister_task_definition(params = {})
-    ecs.deregister_task_definition(params).task_definition
-  end
-
   def update_service(params = {})
     ecs.update_service(params)
   end

data/lib/ecs_helper/command/base.rb

@@ -62,4 +62,3 @@ class ECSHelper::Command::Base
     value.start_with?('=') ? value[1..-1] : value
   end
 end
-

data/lib/ecs_helper/command/build_and_push.rb

@@ -11,9 +11,12 @@ class ECSHelper::Command::BuildAndPush < ECSHelper::Command::Base
               'Set image name, will be used to detect ecr repo where to push image, for example web/nginx/toolbox (required)') do |c|
         options[:image] = processEqual(c)
       end
-      opts.on('-d VALUE', '--directory VALUE', "Set directory for dockerfile and context, default = './'") do |c|
+      opts.on('-d VALUE', '--directory VALUE', "Set directory for build context, default = './'") do |c|
         options[:directory] = processEqual(c)
       end
+      opts.on('-f VALUE', '--file VALUE', "Set path for Dockerfile, default = './Dockerfile'") do |c|
+        options[:file] = processEqual(c)
+      end
       opts.on('-p VALUE', '--project VALUE',
               "Set project name, if not specified will look at ENV['PROJECT'], will be used to detect cluster") do |p|
         options[:project] = processEqual(p)
@@ -33,17 +36,17 @@ class ECSHelper::Command::BuildAndPush < ECSHelper::Command::Base
   end
 
   def run
-    log("Command", type)
-    log("Options", options)
-    log("Repository", repository)
-    log("Auth Private", auth_private)
-    should_cache? && log("Pull", pull)
-    log("Build", build)
-    log("Push", push)
+    log('Command', type)
+    log('Options', options)
+    log('Repository', repository)
+    log('Auth Private', auth_private)
+    should_cache? && log('Pull', pull)
+    log('Build', build)
+    log('Push', push)
   end
 
   def auth_private
-    auth_cmd = Terrapin::CommandLine.new('aws ecr get-login --no-include-email | sh')
+    auth_cmd = helper.auth_private_cmd
     auth_cmd.run
   end
 
@@ -63,7 +66,8 @@ class ECSHelper::Command::BuildAndPush < ECSHelper::Command::Base
     build_args = options[:build_args].map { |a| "--build-arg=#{a}" }
     cache_command = should_cache? ? ["--cache-from #{latest_tag}"] : []
     tags_command = ["--tag #{latest_tag} --tag #{version_tag}"]
-    command = (build_command + build_args + cache_command + tags_command).join(' ')
+    file_command = ["--file #{file}"]
+    command = (build_command + file_command + build_args + cache_command + tags_command).join(' ')
     build_cmd = Terrapin::CommandLine.new(command)
 
     console "Building with two tags: #{latest_tag} & #{version_tag}"
@@ -85,6 +89,10 @@ class ECSHelper::Command::BuildAndPush < ECSHelper::Command::Base
     options[:directory] || './'
   end
 
+  def file
+    options[:file] || './Dockerfile'
+  end
+
   def latest_tag
     "#{repository}:latest"
   end

data/lib/ecs_helper/command/deploy.rb

@@ -34,14 +34,13 @@ class ECSHelper::Command::Deploy < ECSHelper::Command::Base
     log("Service task definition", service_task_definition.task_definition_arn)
     log("Containers", task_definition_helper.pretty_container_definitions)
     log("New task definition", new_task_definition.task_definition_arn)
-    update_service(new_task_definition.task_definition_arn, service_task_definition.task_definition_arn) && log("Update service", "Service task definition was updated")
+    update_service(new_task_definition.task_definition_arn) && log("Update service", "Service task definition was updated")
     log("Waiting for deployment...")
     wait_for_deployment && log("Success", "Application was succesfully deployed", :cyan)
   end
 
-  def update_service(task_definition_arn, old_task_definition_arn)
+  def update_service(task_definition_arn)
     helper.update_service(cluster_arn, service_arn, task_definition_arn)
-    helper.client.deregister_task_definition(task_definition: old_task_definition_arn)
   end
 
   def wait_for_deployment(time = 0)

data/lib/ecs_helper/command/ecr_login.rb

@@ -20,7 +20,7 @@ class ECSHelper::Command::ECRLogin < ECSHelper::Command::Base
   end
 
   def auth_private
-    auth_cmd = Terrapin::CommandLine.new("aws ecr get-login --no-include-email | sh")
+    auth_cmd = helper.auth_private_cmd
     auth_cmd.run
   end
 end

data/lib/ecs_helper/common_helper.rb

@@ -1,5 +1,6 @@
 BRANCH_TO_ENV_MAPPING = {
   master: 'production',
+  main: 'production',
   qa: 'qa',
   uat: 'uat',
   staging: 'staging',
@@ -14,13 +15,13 @@ class ECSHelper::CommonHelper
   end
 
   def branch
-    @branch ||= ENV["CI_COMMIT_BRANCH"] || `git rev-parse --abbrev-ref HEAD`.strip
+    @branch ||= ENV['CI_COMMIT_BRANCH'] || `git rev-parse --abbrev-ref HEAD`.strip
   end
 
   def version
     @version ||=
       begin
-        if deployable_branch? && use_image_tag_env_prefix?
+        if use_image_tag_env_prefix?
           "#{environment}-#{commit_sha}"
         else
           commit_sha
@@ -29,15 +30,27 @@ class ECSHelper::CommonHelper
   end
 
   def environment
-    @env ||= helper.options[:environment] || ENV["ENVIRONMENT"] || env_from_branch || raise(StandardError.new("Environment not detected"))
+    @env ||= helper.options[:environment] || ENV['ENVIRONMENT'] || env_from_branch || raise(StandardError, 'Environment not detected')
   end
 
   def project
-    ENV["PROJECT"]
+    ENV['PROJECT']
   end
 
   def application
-    ENV["APPLICATION"]
+    ENV['APPLICATION']
+  end
+
+  def region
+    @region ||= ENV['AWS_REGION']
+  end
+
+  def account_id
+    @account_id ||= ENV['AWS_ACCOUNT_ID'] || `aws sts get-caller-identity --query "Account" --output text`.strip
+  end
+
+  def auth_private_cmd
+    @auth_private_cmd ||= Terrapin::CommandLine.new("docker login -u AWS -p $(aws ecr get-login-password --region=#{region}) #{account_id}.dkr.ecr.#{region}.amazonaws.com")
   end
 
   private
@@ -51,7 +64,7 @@ class ECSHelper::CommonHelper
   end
 
   def commit_sha
-    ENV["CI_COMMIT_SHA"] || `git rev-parse HEAD`.strip
+    ENV['CI_COMMIT_SHA'] || `git rev-parse HEAD`.strip
   end
 
   def use_image_tag_env_prefix?

data/lib/ecs_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ECSHelper
-  VERSION = '0.0.34'
+  VERSION = '0.0.36'
 end

data/lib/ecs_helper.rb

@@ -17,7 +17,7 @@ class ECSHelper
   autoload :Command, 'ecs_helper/command'
 
   def_delegators :client, :task_definitions, :clusters, :services, :tasks, :repositories, :repositories, :task_definition, :run_task
-  def_delegators :common_helper, :version, :branch, :environment, :project, :application
+  def_delegators :common_helper, :version, :branch, :environment, :project, :application, :region, :account_id, :auth_private_cmd
   def_delegators :cluster_helper, :current_cluster, :clusters
   def_delegators :service_helper, :current_service, :services, :update_service
   def_delegators :command, :run, :options, :type

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.36
 platform: ruby
 authors:
 - Artem Petrov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -338,6 +338,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Makefile
+- README.md
 - Rakefile
 - bin/console
 - bin/ecs_helper
@@ -370,7 +371,7 @@ homepage: https://github.com/artempartos/ecs_helper
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -385,9 +386,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
-signing_key:
+rubygems_version: 3.5.9
+signing_key: 
 specification_version: 4
 summary: ECSHelper
 test_files: []