container_broker 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 021bb9a1ca3d028ae71c5640840335415923572f5427f4ae2ab0905cadd35fe4
-  data.tar.gz: e8af975eb58b008668e654fa0e1d0ca4b7ea70e9832ca788ed4842d021fe6f8d
+  metadata.gz: c1d863ef7a79cf23d92d509e16473a5fb717afbb4327adf8a7c60ff0ac5483f6
+  data.tar.gz: 4afbefff24adf873548bfd36542d38ade60f6b8031f8a7de2274cc1820d9efbd
 SHA512:
-  metadata.gz: 963ddbcc97ebc45676eab092818f8f3e23d20be0e24f45aec26fb3c5f49db3ef7fe9342f6bc0488b7827b6d99bdb8bbba586f446a7cf25ba6b5613bc0f9fa35d
-  data.tar.gz: c59b5198d1b4fdc532ac1ea93cafd947ea04b35573f752b9c8ce6277c9a40a76fa1903ac774d98afc13693e846558056ef8d2ac0a771c9b3c26edb9a36675d36
+  metadata.gz: 72276623eadee051da7078c9a203b1c5eb2ac4e82d826e1545deba5e8fba6273e6cd820b65507e76a2e34e4054701b5c893ddf9528c47079f5b790d6980973cf
+  data.tar.gz: 5222da3fcf97e5fb7bb962c337e21e661cd3c6922f1eeb560e6d4e40d1c90ef3b6878dc2ca2f9d14c4a02bb6fae5bdc81a64f49b597dc47e51857f56015c7e30

data/README.md

@@ -1,5 +1,16 @@
 # Container Broker
 
+## Key Features
+- Run any Docker based task
+- A Node only needs Docker HTTP API
+- Separate Tasks by execution type
+- Easily get Task logs
+- Automatically retry jobs
+- Enqueue tasks if no slots available
+- Distribute load between Nodes
+- If a node dies, tasks are automatically moved to another healthy Node (Failover)
+- Support external volume mounts
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/app/controllers/tasks_controller.rb

@@ -66,14 +66,7 @@ class TasksController < ApplicationController
       :execution_type,
       storage_mounts: {},
       tags: {}
-    ).tap do |permitted_params|
-      # TODO: Remove after migrate encoder
-      if params.key?(:ingest_storage_mount) || params[:task].key?(:ingest_storage_mount)
-        permitted_params[:storage_mounts] = {
-          "ingest-nfs" => params[:ingest_storage_mount] || params.dig(:task, :ingest_storage_mount)
-        }
-      end
-    end
+    )
   end
 
   def set_request_id

data/app/jobs/add_task_tags_job.rb

@@ -6,7 +6,7 @@ class AddTaskTagsJob < ContainerBrokerBaseJob
   queue_as :default
 
   def perform(task:)
-    task.tags.keys.each do |tag_name|
+    task.tags.each_key do |tag_name|
       TaskTag.find_or_create_by(name: tag_name.to_s)
     end
   end

data/app/jobs/run_task_job.rb

@@ -6,9 +6,6 @@ class RunTaskJob < ContainerBrokerBaseJob
   queue_as :default
 
   def perform(task:, slot:)
-    # TODO: remove after successful deploy
-    task.update!(storage_mounts: { "ingest-nfs" => task.attributes["ingest_storage_mount"] }) if task.attributes["ingest_storage_mount"] && task.storage_mounts.blank?
-
     Rails.logger.debug("Performing RunTaskJob for #{task} #{slot}")
 
     raise "Invalid task status - #{task}" unless task.starting?

data/app/models/mongoid_serializable_model.rb

@@ -2,6 +2,7 @@
 
 class MongoidSerializableModel
   attr_reader :model
+
   include GlobalID::Identification
 
   def initialize(model)

data/app/models/node.rb

@@ -83,10 +83,8 @@ class Node
     "Node #{name} #{uuid} #{runner_provider} (#{status}#{last_success})"
   end
 
-  def run_with_lock_no_wait
-    LockManager.new(type: self.class.to_s, id: id, wait: false, expire: 5.minutes).lock do
-      yield
-    end
+  def run_with_lock_no_wait(&block)
+    LockManager.new(type: self.class.to_s, id: id, wait: false, expire: 5.minutes).lock(&block)
   end
 
   private

data/app/models/task.rb

@@ -19,7 +19,6 @@ class Task
   field :created_at, type: DateTime
   field :started_at, type: DateTime
   field :finished_at, type: DateTime
-  field :progress, type: String
   field :try_count, type: Integer, default: 0
   field :persist_logs, type: Boolean, default: false
   field :tags, type: Hash, default: {}

data/app/serializers/status_panel_task_serializer.rb

@@ -2,7 +2,7 @@
 
 class StatusPanelTaskSerializer < ActiveModel::Serializer
   attributes :uuid, :name, :image, :cmd, :status, :exit_code, :error, :try_count, :created_at,
-             :started_at, :finished_at, :progress, :seconds_running, :tags, :runner_id,
+             :started_at, :finished_at, :seconds_running, :tags, :runner_id,
              :storage_mounts, :slot, :execution_type
 
   def slot

data/app/serializers/task_serializer.rb

@@ -2,6 +2,6 @@
 
 class TaskSerializer < ActiveModel::Serializer
   attributes :uuid, :status, :exit_code, :error, :try_count,
-             :created_at, :started_at, :finished_at, :progress, :seconds_running,
+             :created_at, :started_at, :finished_at, :seconds_running,
              :execution_type
 end

data/app/services/friendly_name_nodes.rb

@@ -3,7 +3,7 @@
 class FriendlyNameNodes
   def perform
     Node.order(runner_provider: :desc, hostname: :asc, id: :asc).each_with_index do |node, index|
-      node.update(name: "n#{format("%02d%s", (index + 1), node.runner_provider.first)}")
+      node.update(name: format("n%<sequence>02d%<provider>s", sequence: (index + 1), provider: node.runner_provider.first))
       FriendlyNameSlots.new(node: node).perform
     end
   end

data/app/services/kubernetes_client.rb

@@ -2,7 +2,9 @@
 
 class KubernetesClient
   class PodNotFoundError < StandardError; end
+
   class NetworkError < StandardError; end
+
   class LogsNotFoundError < StandardError; end
 
   LOG_UNAVAILABLE_HTTP_ERROR = 400
@@ -20,7 +22,7 @@ class KubernetesClient
   end
 
   # rubocop:disable Metrics/ParameterLists
-  def create_pod(pod_name:, image:, cmd:, internal_mounts: [], external_mounts: [], node_selector:)
+  def create_pod(pod_name:, image:, cmd:, node_selector:, internal_mounts: [], external_mounts: [])
     handle_exception do
       pod = Kubeclient::Resource.new(
         metadata: {

data/app/services/lock_manager.rb

@@ -2,6 +2,7 @@
 
 class LockManager
   attr_reader :expire, :wait, :locked, :key
+
   KEY_PREFIX = "lockmanager"
 
   def initialize(type:, id:, expire:, wait: true)
@@ -13,7 +14,7 @@ class LockManager
   def lock
     if lock!
       begin
-        yield(self)
+        yield(self) if block_given?
       ensure
         unlock!
       end

data/app/services/reschedule_tasks_for_missing_runners.rb

@@ -11,7 +11,7 @@ class RescheduleTasksForMissingRunners
   def perform
     tasks_without_runner.each do |runner_id|
       task = started_tasks_group_by_runner_id[runner_id]
-      message = "Task retryied because runner #{runner_id} is missing (#{task} #{task&.slot})"
+      message = "Task retried because runner is missing"
       Rails.logger.debug(message)
 
       report_event(message: message, task: task, runner_id: runner_id)
@@ -36,18 +36,18 @@ class RescheduleTasksForMissingRunners
         runner: slot&.node&.runner_provider,
         runner_id: runner_id,
         slot: {
-          id: slot&.id,
+          uuid: slot&.uuid,
           name: slot&.name,
           status: slot&.status,
           runner_id: slot&.runner_id
         },
         node: {
-          id: node&.id,
+          uuid: node&.uuid,
           name: node&.name,
           status: node&.status
         },
         task: {
-          id: task.id,
+          uuid: task.uuid,
           name: task.name,
           status: task.status
         }

data/app/services/runners/kubernetes/create_execution_info.rb

@@ -16,9 +16,9 @@ module Runners
         Runners::ExecutionInfo.new(
           id: pod&.metadata&.name,
           status: status,
-          exit_code: container_status&.state&.terminated&.exitCode,
+          exit_code: exit_code,
           started_at: started_at,
-          finished_at: container_status&.state&.terminated&.finishedAt,
+          finished_at: finished_at,
           error: error_message,
           schedule_pending: schedule_pending?
         )
@@ -54,6 +54,14 @@ module Runners
         container_status&.state&.terminated&.exitCode&.zero?
       end
 
+      def exit_code
+        container_status&.state&.terminated&.exitCode
+      end
+
+      def finished_at
+        container_status&.state&.terminated&.finishedAt
+      end
+
       def reason_is_error?
         waiting? && ERROR_REASONS.include?(reason[:reason])
       end

data/config/initializers/docker_config.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-::Docker.logger = Logger.new(STDOUT)
+::Docker.logger = Logger.new($stdout)

data/lib/constants.rb

@@ -2,7 +2,7 @@
 
 module Constants
   class ExecutionType
-    FORMAT = /\A([a-z0-9])+(\-[a-z0-9]+)*\z/.freeze
+    FORMAT = /\A([a-z0-9])+(-[a-z0-9]+)*\z/.freeze
     INVALID_FORMAT_MESSAGE = "only allows lowercase letters, numbers and hyphen symbol"
   end
 

data/lib/container_broker.rb

@@ -12,7 +12,6 @@ require "current_thread_request_id"
 require "config"
 require "docker-api"
 require "active_model_serializers"
-require "config"
 require "idempotent-request"
 require "kubeclient"
 require "mongoid/uuid"
@@ -22,7 +21,6 @@ require "sentry-raven"
 require "sidekiq"
 require "sidekiq-failures"
 require "sidekiq-scheduler"
-require "docker-api"
 require "measures"
 
 module ContainerBroker

data/lib/container_broker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContainerBroker
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: container_broker
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Douglas Lise
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -583,7 +583,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: ContainerBroker