capistrano-nomad 0.6.3 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f13cb3a6f203bc88f1bad802dea89660937818fe4568824fb0f2aa9ed789fab
-  data.tar.gz: '09f27219c86a2fe67e2d47a660cabdef3844517954feba31141d4c38fb20d6a5'
+  metadata.gz: 659b43a201195b9cefc001ff096e0edc07967303695f19466e612061028f81d7
+  data.tar.gz: 236271b31a3cae45ba09828afb8cc27854eee2ce2329166dfde818683610c193
 SHA512:
-  metadata.gz: 3cd44e5fb4c6cbd3db75cc22f67ef116d0ece07965c1e20387cebee287bf28de7b09ee9d8cd5d9b0cff29a1bb0ae0a5d16d0deb451cdeb731ddcdd32fbfa0a57
-  data.tar.gz: 9759e600f1bc654c9093b5e72606de756bf220271a11ee6a0b8fc770b78f78e638f4557ba6054e57326f4cd5ef4ee05de6183a66f1e0351fc9129bd5bbcf4177
+  metadata.gz: bce586af52de2b0d1d679bb7dcbb7b1d8ccf9fb23bfa8296ff9fb2cff379deb8a35071b75164e7750918f7c1d52364340beb40877fbacd41cbd70bb758af1e40
+  data.tar.gz: ace5161204cdc20b739a462971ba9a2d18d194205ecc4ef2beb68e7820da0e4a02e9b711317babd5e76bf368892b358b9c8f2abdcd82dcca92303faa79bcc77a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-nomad (0.6.3)
+    capistrano-nomad (0.6.5)
       activesupport (<= 7.0.8)
       byebug
       capistrano (~> 3.0)

data/README.md

@@ -37,8 +37,8 @@ Within `deploy.rb`
 set :nomad_jobs_path, "nomad/jobs"
 set :nomad_var_files_path, "nomad/vars"
 
-# Accessible in all .erb files
-set :nomad_erb_vars, (lambda do
+# Make variables available to all template .erb files
+set :nomad_template_vars, (lambda do
   {
     env_name: fetch(:stage).to_sym,
     domain: fetch(:domain),
@@ -46,6 +46,15 @@ set :nomad_erb_vars, (lambda do
   }
 end)
 
+# Make helpers available to all template .erb files
+nomad_template_helpers do
+  def restart_stanza
+    <<-EOF
+
+    EOF
+  end
+end
+
 # Docker image types
 nomad_docker_image_type :backend,
   path: "local/path/backend",
@@ -55,10 +64,13 @@ nomad_docker_image_type :backend,
 nomad_docker_image_type :redis,
   path: "/absolute/path/redis",
   alias: "gcr.io/axsuul/redis"
+nomad_docker_image_type :postgres,
+  alias_digest: "postgres:5.0.0"
 
 # Jobs
-nomad_job :frontend
 nomad_job :backend, docker_image_types: [:backend], var_files: [:rails]
+nomad_job :frontend
+nomad_job :postgres, docker_image_types: [:postgres]
 nomad_job :redis, docker_image_types: [:redis]
 nomad_job :"traefik-default", template: :traefik, erb_vars: { role: :default }
 nomad_job :"traefik-secondary", template: :traefik, erb_vars: { role: :secondary }
@@ -74,14 +86,22 @@ Deploy all with
 cap production nomad:all:deploy
 ```
 
-Deploy individually with
+Deploy jobs individually with
 
 ```shell
 cap production nomad:app:deploy
-cap production nomad:redis:purge
 cap production nomad:analytics:grafana:deploy
 ```
 
+Manage jobs with
+
+```shell
+cap production nomad:app:stop
+cap production nomad:redis:purge
+cap production nomad:analytics:grafana:restart
+cap production nomad:postgres:status
+```
+
 Open console with
 
 ```shell
@@ -90,6 +110,21 @@ cap production nomad:app:console TASK=custom-task-name
 cap production nomad:analytics:grafana:console
 ```
 
+Show logs with
+
+```shell
+cap production nomad:app:logs
+cap production nomad:app:stdout
+cap production nomad:app:stderr
+cap production nomad:analytics:grafana:follow
+```
+
+Create missing and delete unused namespaces
+
+```shell
+cap production nomad:all:modify_namespaces
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/capistrano-nomad.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "capistrano-nomad"
-  spec.version = "0.6.3"
+  spec.version = "0.6.5"
   spec.authors = ["James Hu"]
 
   spec.summary = "Capistrano plugin for deploying and managing Nomad jobs"

data/lib/capistrano/nomad/helpers/docker.rb

@@ -70,6 +70,9 @@ def capistrano_nomad_build_docker_image_for_type(image_type)
 
   return unless attributes
 
+  # No need to build if there's no path
+  return unless attributes[:path]
+
   args = [
     # Ensure images are built for x86_64 which is production env otherwise it will default to local development env
     # which can be arm64 (Apple Silicon)
@@ -106,26 +109,30 @@ def capistrano_nomad_build_docker_image_for_type(image_type)
 end
 
 def capistrano_nomad_push_docker_image_for_type(image_type, is_manifest_updated: true)
-  # Allows end user to add hooks
-  invoke("nomad:docker_images:push")
+  attributes = fetch(:nomad_docker_image_types)[image_type]
+  alias_digest = attributes&.dig(:alias_digest)
 
   run_locally do
-    interaction_handler = CapistranoNomadDockerPushImageInteractionHandler.new
-    image_alias = capistrano_nomad_build_docker_image_alias(image_type)
+    # Don't push Docker image if alias digest is already passed in
+    unless alias_digest
+      interaction_handler = CapistranoNomadDockerPushImageInteractionHandler.new
+      image_alias = capistrano_nomad_build_docker_image_alias(image_type)
+
+      # We should not proceed if image cannot be pushed
+      unless execute("docker push #{image_alias}", interaction_handler: interaction_handler)
+        raise StandardError, "Docker image push unsuccessful!"
+      end
 
-    # We should not proceed if image cannot be pushed
-    unless execute("docker push #{image_alias}", interaction_handler: interaction_handler)
-      raise StandardError, "Docker image push unsuccessful!"
-    end
+      return unless is_manifest_updated
 
-    return unless is_manifest_updated
+      # Has the @sha256:xxxx appended so we have the ability to also target by digest
+      alias_digest = "#{image_alias}@#{interaction_handler.last_digest}"
+    end
 
     # Update image type manifest
     capistrano_nomad_update_docker_image_types_manifest(image_type,
       alias: image_alias,
-
-      # Has the @sha256:xxxx appended so we have the ability to also target by digest
-      alias_digest: "#{image_alias}@#{interaction_handler.last_digest}",
+      alias_digest: alias_digest,
     )
   end
 end

data/lib/capistrano/nomad/helpers/dsl.rb

@@ -50,12 +50,12 @@ def nomad_job(name, attributes = {})
 
       desc "Run #{description_name} job"
       task :run do
-        capistrano_nomad_run_jobs([name], namespace: namespace)
+        capistrano_nomad_run_jobs([name], namespace: namespace, is_detached: false)
       end
 
       desc "Purge and run #{description_name} job again"
       task :rerun do
-        capistrano_nomad_rerun_jobs([name], namespace: namespace)
+        capistrano_nomad_rerun_jobs([name], namespace: namespace, is_detached: false)
       end
 
       desc "Upload and plan #{description_name} job"
@@ -65,22 +65,17 @@ def nomad_job(name, attributes = {})
 
       desc "Upload and run #{description_name} job"
       task :upload_run do
-        capistrano_nomad_upload_run_jobs([name], namespace: namespace)
+        capistrano_nomad_upload_run_jobs([name], namespace: namespace, is_detached: false)
       end
 
       desc "Upload and re-run #{description_name} job"
       task :upload_rerun do
-        capistrano_nomad_upload_rerun_jobs([name], namespace: namespace)
+        capistrano_nomad_upload_rerun_jobs([name], namespace: namespace, is_detached: false)
       end
 
       desc "Deploy #{description_name} job"
       task :deploy do
-        capistrano_nomad_deploy_jobs([name], namespace: namespace)
-      end
-
-      desc "Restart #{description_name} job"
-      task :restart do
-        capistrano_nomad_restart_jobs([name], namespace: namespace)
+        capistrano_nomad_deploy_jobs([name], namespace: namespace, is_detached: false)
       end
 
       desc "Stop #{description_name} job"
@@ -88,6 +83,11 @@ def nomad_job(name, attributes = {})
         capistrano_nomad_stop_jobs([name], namespace: namespace)
       end
 
+      desc "Restart #{description_name} job"
+      task :restart do
+        capistrano_nomad_restart_jobs([name], namespace: namespace)
+      end
+
       desc "Purge #{description_name} job"
       task :purge do
         capistrano_nomad_purge_jobs([name], namespace: namespace, is_detached: false)
@@ -98,9 +98,32 @@ def nomad_job(name, attributes = {})
         capistrano_nomad_display_job_status(name, namespace: namespace)
       end
 
-      desc "Open console to #{description_name} job. Specify task by passing TASK environment variable"
+      desc "Open console to #{description_name} job. Specify task with TASK, command with CMD"
       task :console do
-        capistrano_nomad_exec_within_job(name, "/bin/bash", namespace: namespace, task: ENV["TASK"].presence)
+        command = ENV["CMD"].presence || "/bin/bash"
+
+        capistrano_nomad_exec_within_job(name, command, namespace: namespace, task: ENV["TASK"])
+      end
+
+      desc "Display stdout and stderr of #{description_name} job. Specify task with TASK"
+      task :logs do
+        capistrano_nomad_tail_job_logs(name, namespace: namespace, stdout: true)
+        capistrano_nomad_tail_job_logs(name, namespace: namespace, stderr: true)
+      end
+
+      desc "Display stdout of #{description_name} job. Specify task with TASK"
+      task :stdout do
+        capistrano_nomad_tail_job_logs(name, namespace: namespace, stdout: true)
+      end
+
+      desc "Display stderr of #{description_name} job. Specify task with TASK"
+      task :stderr do
+        capistrano_nomad_tail_job_logs(name, namespace: namespace, stderr: true)
+      end
+
+      desc "Follow logs of #{description_name} job. Specify task with TASK"
+      task :follow do
+        capistrano_nomad_display_job_logs(name, namespace: namespace, f: true)
       end
     end
   end
@@ -116,3 +139,7 @@ def nomad_job(name, attributes = {})
     end
   end
 end
+
+def nomad_template_helpers(&block)
+  CapistranoNomadErbNamespace.class_eval(&block)
+end

data/lib/capistrano/nomad/helpers/nomad.rb

@@ -10,16 +10,6 @@ class CapistranoNomadErbNamespace
     end
   end
 
-  # Use default value passed in unless `nomad_job_task_cpu_resource` is set
-  def build_nomad_job_task_cpu_resource(default:)
-    nomad_job_task_cpu_resource == "null" ? default : nomad_job_task_cpu_resource
-  end
-
-  # Use default value passed in unless `nomad_job_task_memory_resource` is set
-  def build_nomad_job_task_memory_resource(default:)
-    nomad_job_task_memory_resource == "null" ? default : nomad_job_task_memory_resource
-  end
-
   # rubocop:disable Style/MissingRespondToMissing
   def method_missing(name, *args)
     instance_variable = "@#{name}"
@@ -116,32 +106,59 @@ end
 def capistrano_nomad_capture_nomad_command(*args)
   output = nil
 
-  on(roles(:manager)) do |host|
+  on(roles(:manager)) do |_host|
     output = capistrano_nomad_run_nomad_command(:capture, *args)
   end
 
   output
 end
 
-def capistrano_nomad_exec_within_job(name, command, namespace: nil, task: nil)
-  on(roles(:manager)) do
-    task = name unless task
+def capistrano_nomad_find_job_task_details(name, namespace: nil, task: nil)
+  task = task.presence || name
 
-    # Find alloc id that contains task
-    output = capistrano_nomad_capture_nomad_command(
-      :job,
-      :allocs,
-      { namespace: namespace, t: "'{{range .}}{{ .ID }},{{ .TaskGroup }}|{{end}}'" },
-      name,
-    )
-    alloc_id = output.split("|").map { |s| s.split(",") }.find { |_, t| t == task.to_s }&.first
+  # Find alloc id that contains task
+  allocs_output = capistrano_nomad_capture_nomad_command(
+    :job,
+    :allocs,
+    { namespace: namespace, t: "'{{range .}}{{ .ID }},{{ .TaskGroup }}|{{end}}'" },
+    name,
+  )
+  alloc_id = allocs_output.split("|").map { |s| s.split(",") }.find { |_, t| t == task.to_s }&.first
+
+  # Can't continue if we can't choose an alloc id
+  return unless alloc_id
+
+  tasks_output = capistrano_nomad_capture_nomad_command(
+    :alloc,
+    :status,
+    { namespace: namespace, t: "'{{range $key, $value := .TaskStates}}{{ $key }},{{ .State }}|{{end}}'" },
+    alloc_id,
+  )
+  tasks_by_score = tasks_output.split("|").each_with_object({}) do |task_output, hash|
+    task, state = task_output.split(",")
+
+    score = 0
+    score += 5 if state == "running"
+    score += 5 unless task.match?(/connect-proxy/)
 
-    if alloc_id
+    hash[task] = score
+  end
+  task = tasks_by_score.max_by { |_, v| v }.first
+
+  {
+    alloc_id: alloc_id,
+    name: task,
+  }
+end
+
+def capistrano_nomad_exec_within_job(name, command, namespace: nil, task: nil)
+  on(roles(:manager)) do
+    if (task_details = capistrano_nomad_find_job_task_details(name, namespace: namespace, task: task))
       capistrano_nomad_execute_nomad_command(
         :alloc,
         :exec,
-        { namespace: namespace, task: task },
-        alloc_id,
+        { namespace: namespace, task: task_details[:name] },
+        task_details[:alloc_id],
         command,
       )
     else
@@ -175,7 +192,7 @@ def capistrano_nomad_upload_file(local_path:, remote_path:, erb_vars: {})
   }
 
   # Add global ERB vars
-  final_erb_vars.merge!(fetch(:nomad_erb_vars) || {})
+  final_erb_vars.merge!(fetch(:nomad_template_vars) || {})
 
   # Add job-specific ERB vars
   final_erb_vars.merge!(erb_vars)
@@ -269,11 +286,11 @@ def capistrano_nomad_plan_jobs(names, *args)
   end
 end
 
-def capistrano_nomad_run_jobs(names, namespace: nil)
+def capistrano_nomad_run_jobs(names, namespace: nil, is_detached: true)
   names.each do |name|
     run_options = {
       namespace: namespace,
-      detach: true,
+      detach: is_detached,
 
       # Don't reset counts since they may have been scaled
       preserve_counts: true,
@@ -292,44 +309,52 @@ def capistrano_nomad_run_jobs(names, namespace: nil)
 end
 
 # Remove job and run again
-def capistrano_nomad_rerun_jobs(names)
+def capistrano_nomad_rerun_jobs(names, **options)
+  general_options = options.slice!(:is_detached)
+
   names.each do |name|
     # Wait for jobs to be purged before running again
-    capistrano_nomad_purge_jobs([name], is_detached: false)
+    capistrano_nomad_purge_jobs([name], **general_options.merge(is_detached: false))
 
-    capistrano_nomad_run_jobs([name])
+    capistrano_nomad_run_jobs([name], **general_options.merge(options))
   end
 end
 
-def capistrano_nomad_upload_plan_jobs(names, *args)
-  capistrano_nomad_upload_jobs(names, *args)
-  capistrano_nomad_plan_jobs(names, *args)
+def capistrano_nomad_upload_plan_jobs(names, **options)
+  capistrano_nomad_upload_jobs(names, **options)
+  capistrano_nomad_plan_jobs(names, **options)
 end
 
-def capistrano_nomad_upload_run_jobs(names, *args)
-  capistrano_nomad_upload_jobs(names, *args)
-  capistrano_nomad_run_jobs(names, *args)
+def capistrano_nomad_upload_run_jobs(names, **options)
+  general_options = options.slice!(:is_detached)
+
+  capistrano_nomad_upload_jobs(names, **general_options)
+  capistrano_nomad_run_jobs(names, **general_options.merge(options))
 end
 
-def capistrano_nomad_upload_rerun_jobs(names, *args)
-  capistrano_nomad_upload_jobs(names, *args)
-  capistrano_nomad_rerun_jobs(names, *args)
+def capistrano_nomad_upload_rerun_jobs(names, **options)
+  general_options = options.slice!(:is_detached)
+
+  capistrano_nomad_upload_jobs(names, **general_options)
+  capistrano_nomad_rerun_jobs(names, **general_options.merge(options))
 end
 
-def capistrano_nomad_deploy_jobs(names, *args)
-  capistrano_nomad_assemble_jobs_docker_images(names, *args)
-  capistrano_nomad_upload_run_jobs(names, *args)
+def capistrano_nomad_deploy_jobs(names, **options)
+  general_options = options.slice!(:is_detached)
+
+  capistrano_nomad_assemble_jobs_docker_images(names, **general_options)
+  capistrano_nomad_upload_run_jobs(names, **general_options.merge(options))
 end
 
-def capistrano_nomad_stop_jobs(names, namespace: nil)
+def capistrano_nomad_stop_jobs(names, **options)
   names.each do |name|
-    capistrano_nomad_execute_nomad_command(:job, :stop, { namespace: namespace }, name)
+    capistrano_nomad_execute_nomad_command(:job, :stop, options, name)
   end
 end
 
-def capistrano_nomad_restart_jobs(names, namespace: nil)
+def capistrano_nomad_restart_jobs(names, **options)
   names.each do |name|
-    capistrano_nomad_execute_nomad_command(:job, :restart, { namespace: namespace }, name)
+    capistrano_nomad_execute_nomad_command(:job, :restart, options, name)
   end
 end
 
@@ -339,6 +364,29 @@ def capistrano_nomad_purge_jobs(names, namespace: nil, is_detached: true)
   end
 end
 
-def capistrano_nomad_display_job_status(name, *args)
-  capistrano_nomad_execute_nomad_command(:status, *args, name)
+def capistrano_nomad_display_job_status(name, **options)
+  capistrano_nomad_execute_nomad_command(:status, options, name)
+end
+
+def capistrano_nomad_display_job_logs(name, namespace: nil, **options)
+  if (task_details = capistrano_nomad_find_job_task_details(name, namespace: namespace, task: ENV["TASK"]))
+    capistrano_nomad_execute_nomad_command(
+      :alloc,
+      :logs,
+      options.merge(namespace: namespace, task: task_details[:name]),
+      task_details[:alloc_id],
+    )
+  else
+    # If task can't be determined choose a random allocation
+    capistrano_nomad_execute_nomad_command(
+      :alloc,
+      :logs,
+      options.merge(namespace: namespace, job: true),
+      name,
+    )
+  end
+end
+
+def capistrano_nomad_tail_job_logs(*args, **options)
+  capistrano_nomad_display_job_logs(*args, **options.merge(tail: true, n: 50))
 end

data/lib/capistrano/nomad/tasks/nomad.rake

@@ -53,6 +53,25 @@ namespace :nomad do
         capistrano_nomad_purge_jobs(names, namespace: namespace)
       end
     end
+
+    desc "Create missing and remove unused namespaces"
+    task :modify_namespaces do
+      output = capistrano_nomad_capture_nomad_command(:namespace, :list, t: "'{{range .}}{{ .Name }}|{{end}}'")
+      current_namespaces = output.split("|").compact.map(&:to_sym)
+      desired_namespaces = fetch(:nomad_jobs).keys
+      missing_namespaces = desired_namespaces - current_namespaces
+      unused_namespaces = current_namespaces - desired_namespaces
+
+      # Remove unused namespaces
+      unused_namespaces.each do |namespace|
+        capistrano_nomad_execute_nomad_command(:namespace, :delete, namespace)
+      end
+
+      # Create missing namespaces
+      missing_namespaces.each do |namespace|
+        capistrano_nomad_execute_nomad_command(:namespace, :apply, namespace)
+      end
+    end
   end
 
   namespace :docker_images do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-nomad
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.5
 platform: ruby
 authors:
 - James Hu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-31 00:00:00.000000000 Z
+date: 2023-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport