ecs_helper 0.0.33 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 871394ee1f21e808a91e123a5affccb713a0e7f44fcbb1d308bcc849eb97e992
-  data.tar.gz: bd42356f7c7984047d85e41810fd12a9aa5a0ef95e63fdab370c38ff20278117
+  metadata.gz: 4b8c83b0859617581d45d79cb3a8ca067858266427fa3f1024f85aadb12640f5
+  data.tar.gz: 1a0416def41b5089f63b2a7beb98d61ec22e30e04c570da57025752a291ad7d0
 SHA512:
-  metadata.gz: 709ccc270f6143206e63d4f55b2ea68b556f8929407e0a44cf9bfd626595b39973a76ade7376072371bb17b965ee56e8340650fc44f22467c15fe4dbd28512c8
-  data.tar.gz: d7a5f1635642a612a3abe7c3c85887a91475c37fbe3f2bb2d15e8b793d39f7dff29018a55b85e12db43ca5a31ad36fcb3fdd539909bdc0ddce84a95c22eaa7d9
+  metadata.gz: 9682932c0088f66054ced4231eab331a8bc244a783db1e98958116dd6cebea145ea5fd24695e78d0b34a3f607831b6a42f6729e224252268d275b12199788282
+  data.tar.gz: cb72b81d624af0d0cfa68d4b8ea30d73fc1818aaef39117ab6bd470395b1e1fddc5257a38d3192d2da8f97d755ba034061c105c451f7f85e8ac517e5e17c3e17

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecs_helper (0.0.33)
+    ecs_helper (0.0.35)
       aws-sdk-ecr (~> 1.42, >= 1.42)
       aws-sdk-ecrpublic (~> 1.3, >= 1.3)
       aws-sdk-ecs (~> 1.80, >= 1.80)
@@ -18,7 +18,7 @@ GEM
     ast (2.4.2)
     awesome_print (1.9.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.515.0)
+    aws-partitions (1.516.0)
     aws-sdk-core (3.121.1)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
@@ -97,6 +97,7 @@ GEM
 
 PLATFORMS
   aarch64-linux
+  arm64-darwin-22
   x86_64-darwin-18
   x86_64-linux
 
@@ -117,4 +118,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.27
+   2.4.12

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

@@ -24,7 +24,6 @@ class ECSHelper::Command::BuildAndPush < ECSHelper::Command::Base
       end
       opts.on('-c', '--cache', 'Cache image before build, default false') { options[:cache] = true }
       opts.on('--build-arg=VALUE', 'Pass --build-arg to the build command') { |o| options[:build_args] << o }
-      opts.on('-e', '--env-prefix', 'Add environment name as a prefix to the version tag, default false') { options[:env_prefix] = true }
     end
     [parser, options]
   end
@@ -34,17 +33,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
 
@@ -91,11 +90,7 @@ class ECSHelper::Command::BuildAndPush < ECSHelper::Command::Base
   end
 
   def version_tag
-    if options[:env_prefix]
-      "#{repository}:#{helper.environment}-#{helper.version}"
-    else
-      "#{repository}:#{helper.version}"
-    end
+    "#{repository}:#{helper.version}"
   end
 
   def project

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)
@@ -70,10 +69,10 @@ class ECSHelper::Command::Deploy < ECSHelper::Command::Base
   end
 
   def timeout
-    options[:timeout] || DEFAULT_TIMEOUT
+    (options[:timeout] || DEFAULT_TIMEOUT).to_i
   end
 
   def service
     helper.client.describe_service(cluster_arn, service_arn)
   end
-end
+end

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/command/run_command.rb

@@ -124,7 +124,7 @@ class ECSHelper::Command::RunCommand < ECSHelper::Command::Base
   end
 
   def timeout
-    options[:timeout] || DEFAULT_TIMEOUT
+    (options[:timeout] || DEFAULT_TIMEOUT).to_i
   end
 
   def service
@@ -142,4 +142,4 @@ class ECSHelper::Command::RunCommand < ECSHelper::Command::Base
   def container_name
     options[:container_name]
   end
-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',
@@ -8,27 +9,66 @@ BRANCH_TO_ENV_MAPPING = {
 
 class ECSHelper::CommonHelper
   attr_accessor :helper, :branch, :version, :env
+
   def initialize(helper)
     @helper = helper
   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 ||= ENV["CI_COMMIT_SHA"] || `git rev-parse HEAD`.strip
+    @version ||=
+      begin
+        if use_image_tag_env_prefix?
+          "#{environment}-#{commit_sha}"
+        else
+          commit_sha
+        end
+      end
   end
 
   def environment
-    @env ||= helper.options[:environment] || ENV["ENVIRONMENT"] || BRANCH_TO_ENV_MAPPING[branch.to_sym] || 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
-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
+
+  def env_from_branch
+    BRANCH_TO_ENV_MAPPING[branch.to_sym]
+  end
+
+  def deployable_branch?
+    !env_from_branch.nil?
+  end
+
+  def commit_sha
+    ENV['CI_COMMIT_SHA'] || `git rev-parse HEAD`.strip
+  end
+
+  def use_image_tag_env_prefix?
+    !ENV['USE_IMAGE_TAG_ENV_PREFIX'].nil?
+  end
+
+end

data/lib/ecs_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ECSHelper
-  VERSION = '0.0.33'
+  VERSION = '0.0.35'
 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.33
+  version: 0.0.35
 platform: ruby
 authors:
 - Artem Petrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2023-04-17 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
@@ -385,8 +386,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: ECSHelper