simplygenius-atmos 0.11.3 → 0.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d15a018baaae4374130fb1128992a038334e7f15669f2444b76b4e235d1175
-  data.tar.gz: 6ef9631e9148dbee317857276ade4be8ce832dbe4321521a03f048067cd4b8b3
+  metadata.gz: 9ca7971744542f8e7e8b9892a57425edbef56c418b22617295f539a4e737a62d
+  data.tar.gz: 7a2e7501ec94b617eb0bb3c1d91a37b76884ca57ebc079d4a14e367b41827063
 SHA512:
-  metadata.gz: 7c08a8603f993acc6d7eae4e60fdda61620cfe57f8bb1317bb7cb8cf84ac2eefbe0b63b59629f45f168d548b694e9f94e4f034628de8f822ffc824114d6318d0
-  data.tar.gz: e926bfa00c22e54cafcabd80f0174eb0178bab25a1cbcfb8632aea1d5f607ba0300dbf59d082d462453a7b7923cb066deb9e49760c5ef65e37d68f16c03010d6
+  metadata.gz: 4fff280b4474c41e9329bc49ecfdd7ae215fbb2fd33b45161e94056126710bdca0d8461379029ed45ae23672724cce10cd61d7b79413190738d8b8a3121ad42d
+  data.tar.gz: 6d9801ed068c5c007d67e7f0c086134db4aa396a7e6b9c0a983cfa2ac3711ac7c4bd8eeb6092b82011362ed25d79a4bb9f7dfce243470ce928232a256f88efee

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.11.4 (11/27/2019)
+-------------------
+
+* add the ability to spawn a console for any service container [0d1764e](https://github.com/simplygenius/atmos/commit/0d1764e)
+* allow escaping atmos interpolations [3d8b59e](https://github.com/simplygenius/atmos/commit/3d8b59e)
+
+
 0.11.3 (11/12/2019)
 -------------------
 

data/lib/simplygenius/atmos/commands/container.rb

@@ -14,14 +14,14 @@ module SimplyGenius
           "Manages containers in the cloud provider"
         end
 
-        subcommand "push", "Only push a container image without activating it" do
+        option ["-c", "--cluster"],
+               "CLUSTER", "The cluster name\n",
+               required: true
 
-          option ["-c", "--cluster"],
-                 "CLUSTER", "The cluster name\n",
-                 required: true
+        option ["-r", "--role"],
+               "ROLE", "The role to assume when deploying\n"
 
-          option ["-r", "--role"],
-                 "ROLE", "The role to assume when deploying\n"
+        subcommand "push", "Only push a container image without activating it" do
 
           option ["-i", "--image"],
                  "IMAGE", "The local container image to deploy\nDefaults to service/task name"
@@ -54,15 +54,8 @@ module SimplyGenius
 
         subcommand "activate", "Activate a container that has already been pushed" do
 
-          option ["-c", "--cluster"],
-                 "CLUSTER", "The cluster name\n",
-                 required: true
-
-          option ["-r", "--role"],
-                 "ROLE", "The role to assume when deploying\n"
-
           option ["-v", "--revision"],
-                 "REVISION", "Use the given revision of the pushed image to activate\n"
+                 "REVISION", "Use the given revision of the pushed image\nto activate\n"
 
           option ["-l", "--list"],
                  :flag, "List the most recent pushed images\n"
@@ -122,13 +115,6 @@ module SimplyGenius
 
         subcommand "deploy", "Push and activate a container" do
 
-          option ["-c", "--cluster"],
-                 "CLUSTER", "The cluster name\n",
-                 required: true
-
-          option ["-r", "--role"],
-                 "ROLE", "The role to assume when deploying\n"
-
           option ["-i", "--image"],
                  "IMAGE", "The local container image to deploy\nDefaults to service/task name"
 
@@ -164,6 +150,44 @@ module SimplyGenius
           end
         end
 
+        subcommand "console", "Spawn a console and attach to it" do
+
+          option ["-p", "--persist"],
+                 :flag, "Leave the task running after disconnect\n"
+
+          parameter "NAME",
+                    "The name of the service (or task) to attach\nthe console to"
+
+          def execute
+            Atmos.config.provider.auth_manager.authenticate(ENV, role: role) do |auth_env|
+              ClimateControl.modify(auth_env) do
+                mgr = Atmos.config.provider.container_manager
+                remote_command = Array(Atmos.config['atmos.container.console.remote_command'])
+                remote_persist_command = Array(Atmos.config['atmos.container.console.remote_persist_command'])
+                log_pattern = Atmos.config['atmos.container.console.remote_log_pattern']
+                local_command = Atmos.config['atmos.container.console.local_command']
+
+                cmd = persist? ? remote_persist_command : remote_command
+                logger.debug "Running remote command: #{cmd.join(" ")}"
+                result = mgr.run_task(cluster, name, command: cmd, waiter_log_pattern: log_pattern)
+                logger.debug "Run task result: #{result}"
+                begin
+                  match = result[:log_match]
+                  local_command = local_command.collect {|c| match.names.each {|n| c = c.gsub("<#{n}>", match[n]) }; c }
+                  system(*local_command)
+                ensure
+                  if persist?
+                    logger.info "Console disconnected, you can reconnect with: #{local_command.join(" ")}"
+                  else
+                    logger.info "Console complete, stopping task"
+                    mgr.stop_task(cluster, result[:task_id])
+                  end
+                end
+              end
+            end
+          end
+        end
+
       end
 
     end

data/lib/simplygenius/atmos/commands/user.rb

@@ -14,7 +14,7 @@ module SimplyGenius
         subcommand "create", "Create a new user" do
 
           option ["-f", "--force"],
-                 :flag, "forces deletion/updates for pre-existing resources\n",
+                 :flag, "forces deletion/updates for pre-existing\nresources",
                  default: false
 
           option ["-l", "--login"],

data/lib/simplygenius/atmos/config.rb

@@ -121,8 +121,6 @@ module SimplyGenius
 
       private
 
-      INTERP_PATTERN = /(\#\{([^\}]+)\})/
-
       def config_merge(lhs, rhs, debug_state=[])
         result = nil
 

data/lib/simplygenius/atmos/providers/aws/container_manager.rb

@@ -1,6 +1,7 @@
 require_relative '../../../atmos'
 require 'aws-sdk-ecs'
 require 'aws-sdk-ecr'
+require 'aws-sdk-cloudwatchlogs'
 require 'open3'
 
 module SimplyGenius
@@ -159,7 +160,87 @@ module SimplyGenius
             return result
           end
 
-          private
+          def run_task(cluster, name, command:, waiter_log_pattern: nil, launch_type: "FARGATE")
+            result = {}
+
+            ecs = ::Aws::ECS::Client.new
+            resp = nil
+
+            task_opts = {
+                count: 1,
+                cluster: cluster,
+                task_definition: name,
+                launch_type: launch_type,
+                overrides: {container_overrides: [{name: name, command: command}]}
+            }
+
+            defn_arn = nil
+            resp = ecs.describe_services(cluster: cluster, services: [name])
+            if resp.services.size > 0
+              svc = resp.services.first
+              task_opts[:launch_type] = svc.launch_type
+              task_opts[:network_configuration] = svc.network_configuration.to_h
+              defn_arn = svc.task_definition
+              logger.info "Running service task as '#{task_opts[:launch_type]}'"
+            else
+              resp = ecs.list_task_definitions(family_prefix: name, sort: 'DESC')
+              defn_arn = resp.task_definition_arns.first
+              logger.info "Running task as '#{task_opts[:launch_type]}'"
+            end
+
+            resp = ecs.describe_task_definition(task_definition: defn_arn)
+            defn = resp.task_definition
+            raise "Invalid Launch type '#{launch_type}'" unless (defn.requires_compatibilities + defn.compatibilities).include?(launch_type)
+
+            log_config = defn.container_definitions.first.log_configuration
+            log_group = nil
+            log_stream_prefix = nil
+            if log_config && log_config.log_driver == "awslogs"
+              log_group = log_config.options["awslogs-group"]
+              log_stream_prefix = log_config.options["awslogs-stream-prefix"]
+            end
+            if waiter_log_pattern && log_group.nil?
+              logger.error "Cannot wait on a log unless task definition uses cloudwatch for logging"
+              waiter_log_pattern = nil
+            end
+
+            resp = ecs.run_task(**task_opts)
+            task_arn = result[:task_arn] = resp.tasks.first.task_arn
+            task_id = result[:task_id] = task_arn.split('/').last
+
+            logger.info "Waiting for task to start"
+            ecs.wait_until(:tasks_running, cluster: cluster, tasks: [task_id])
+
+            if waiter_log_pattern
+              cwl = ::Aws::CloudWatchLogs::Client.new
+
+              waiter_regexp = Regexp.new(waiter_log_pattern)
+              log_stream = "#{log_stream_prefix}/#{name}/#{task_id}"
+              logger.info "Task started, looking for log pattern in group=#{log_group} stream=#{log_stream}"
+              log_token = nil
+              10.times do
+                resp = cwl.get_log_events(log_group_name: log_group, log_stream_name: log_stream, start_from_head: true, next_token: log_token)
+                resp.events.each do |e|
+                  logger.debug("Task log #{e.timestamp}: #{e.message}")
+                  if e.message =~ waiter_regexp
+                    result[:log_match] = Regexp.last_match
+                    return result # return, not break due to doubly nested iterator
+                  end
+                end
+                log_token = resp.next_forward_token
+                sleep 1
+              end
+            end
+
+            return result
+          end
+
+          def stop_task(cluster, task)
+            ecs = ::Aws::ECS::Client.new
+            resp = ecs.stop_task(cluster: cluster, task: task)
+          end
+
+        private
 
           def run(*args, **opts)
             logger.debug("Running: #{args}")

data/lib/simplygenius/atmos/settings_hash.rb

@@ -12,7 +12,7 @@ module SimplyGenius
       disable_warnings
 
       PATH_PATTERN = /[\.\[\]]/
-      INTERP_PATTERN = /(\#\{([^\}]+)\})/
+      INTERP_PATTERN = /(\#?\#\{([^\}]+)\})/
 
       attr_accessor :_root_, :error_resolver, :enable_expansion
 
@@ -84,12 +84,16 @@ module SimplyGenius
         result.scan(INTERP_PATTERN).each do |substr, statement|
           # TODO: add an explicit check for cycles instead of relying on Stack error
           begin
-            # TODO: be consistent with dot notation between eval and
-            # notation_get.  eval ends up calling Hashie method_missing,
-            # which returns nil if a key doesn't exist, causing a nil
-            # exception for next item in chain, while notation_get returns
-            # nil gracefully for the entire chain (preferred)
-            val = eval(statement, binding, __FILE__)
+            if substr.start_with?('##')
+              val = substr[1..-1]
+            else
+              # TODO: be consistent with dot notation between eval and
+              # notation_get.  eval ends up calling Hashie method_missing,
+              # which returns nil if a key doesn't exist, causing a nil
+              # exception for next item in chain, while notation_get returns
+              # nil gracefully for the entire chain (preferred)
+              val = eval(statement, binding, __FILE__)
+            end
           rescue SystemStackError => e
             raise ConfigInterpolationError.new(format_error("Cycle in interpolated config", substr))
           rescue StandardError => e

data/lib/simplygenius/atmos/version.rb

@@ -1,5 +1,5 @@
 module SimplyGenius
   module Atmos
-    VERSION = "0.11.3"
+    VERSION = "0.11.4"
   end
 end

data/templates/new/config/atmos/runtime.yml

@@ -64,6 +64,51 @@ atmos:
       # a GUI notification
       force_inline: false
 
+  # Configure the container components accessible with 'atmos container ....'
+  container:
+    # Configuration for the console subcommand
+    # For this to work, your service container needs to have a recent (>= 2.4)
+    # tmate installed. For example in a debian container:
+    #
+    #      # Install locales package for tmate
+    #      RUN apt-get update -qq && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -q -y locales
+    #
+    #      # To set utf-8 locale for tmate
+    #      RUN sed -i -e 's/# \(en_US\.UTF-8 .*\)/\1/' /etc/locale.gen && \
+    #      dpkg-reconfigure --frontend=noninteractive locales && \
+    #      update-locale LANG=en_US.UTF-8
+    #      ENV LANG en_US.UTF-8
+    #
+    #      # Install tmate
+    #      RUN curl -Lo /tmp/tmate.tar.xz https://github.com/tmate-io/tmate/releases/download/2.4.0/tmate-2.4.0-static-linux-amd64.tar.xz && \
+    #      cd /tmp && \
+    #      tar xf /tmp/tmate.tar.xz && \
+    #      mv tmate-2.4.0-static-linux-amd64/tmate /usr/bin/tmate && \
+    #      rm -rf /tmp/tmate*
+    #
+    #      # tmate needs ssh keys
+    #      RUN ssh-keygen -f ~/.ssh/id_rsa -N '' -t rsa
+    #
+    console:
+      # The remote command to run when initiating a console (exits on disconnect)
+      remote_command:
+        - bash
+        - -c
+        - echo "set tmate-foreground-restart 0" > ~/.tmate.conf && tmate -F
+      # The remote command to run when initiating a console (persists on disconnect)
+      remote_persist_command:
+        - bash
+        - -c
+        - tmate -F
+      # The regexp to match against remote command output to extract any tokens
+      # needed for the client to connect.  The regexp named groups (?<...>) get
+      # substituted within the client command (<...>)
+      remote_log_pattern: "^ssh session: ssh (?<token>\\w+)@nyc1.tmate.io$"
+      # The local command to run when initiating a console
+      local_command:
+        - ssh
+        - <token>@nyc1.tmate.io
+
   # Configure terraform execution details
   terraform:
     # Disable module fetch from convenience plan/apply commands

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplygenius-atmos
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.11.4
 platform: ruby
 authors:
 - Matt Conway
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2019-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -416,6 +416,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudwatchlogs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement