capistrano-nomad 0.6.5 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659b43a201195b9cefc001ff096e0edc07967303695f19466e612061028f81d7
-  data.tar.gz: 236271b31a3cae45ba09828afb8cc27854eee2ce2329166dfde818683610c193
+  metadata.gz: eac8deb55e886ac97912499380a208f03ef15f7f952123afda2d6f8910e30df0
+  data.tar.gz: 730715ed63a01273775a7dccc403993866d73cb562de7cf70d0c22cf2754b493
 SHA512:
-  metadata.gz: bce586af52de2b0d1d679bb7dcbb7b1d8ccf9fb23bfa8296ff9fb2cff379deb8a35071b75164e7750918f7c1d52364340beb40877fbacd41cbd70bb758af1e40
-  data.tar.gz: ace5161204cdc20b739a462971ba9a2d18d194205ecc4ef2beb68e7820da0e4a02e9b711317babd5e76bf368892b358b9c8f2abdcd82dcca92303faa79bcc77a
+  metadata.gz: 933da9e873b7d6ed030983f0a441a157a4b2bac6c8803076a6dbeebb2bf3afeb922e57d5d3f5ba1b437f9da371386c9a09676d4e3f8dc32e68e3bfa86e5ae4b8
+  data.tar.gz: a87d69e22c6df4fcb9189a43279e399e27d9a625d1a86d728626fba63327daeed6a924113f019ed639d2782fae6db47367fbcd2568337faeafe9410ed3176b9f

data/Gemfile.lock

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

data/README.md

@@ -48,24 +48,38 @@ end)
 
 # Make helpers available to all template .erb files
 nomad_template_helpers do
-  def restart_stanza
+  def restart_stanza(interval = "1m")
     <<-EOF
-
+      restart {
+        interval = "#{interval}"
+        attempts = 3
+        mode = "delay"
+      }
     EOF
   end
 end
 
-# Docker image types
+# Use hosted Docker image
+nomad_docker_image_type :postgres,
+  alias: "postgres:5.0.0"
+
+# Use Docker image that will be built locally relative to project and push
 nomad_docker_image_type :backend,
   path: "local/path/backend",
   alias: ->(image_type:) { "gcr.io/axsuul/#{image_type}" },
   target: "release",
   build_args: { foo: "bar" }
+
+# Use Docker image that will be built locally from an absolute path and push
 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"
+
+# Use Docker image that will be built remotely on server
+nomad_docker_image_type :restic,
+  path: "containers/restic",
+  alias: "my-project/restic:local",
+  strategy: :remote_build
 
 # Jobs
 nomad_job :backend, docker_image_types: [:backend], var_files: [:rails]
@@ -80,20 +94,20 @@ nomad_namespace :analytics do
 end
 ```
 
-Deploy all with
+Deploy all jobs
 
 ```shell
 cap production nomad:all:deploy
 ```
 
-Deploy jobs individually with
+Deploy individual jobs
 
 ```shell
 cap production nomad:app:deploy
 cap production nomad:analytics:grafana:deploy
 ```
 
-Manage jobs with
+Manage jobs
 
 ```shell
 cap production nomad:app:stop
@@ -102,7 +116,7 @@ cap production nomad:analytics:grafana:restart
 cap production nomad:postgres:status
 ```
 
-Open console with
+Open console
 
 ```shell
 cap production nomad:app:console
@@ -110,7 +124,7 @@ cap production nomad:app:console TASK=custom-task-name
 cap production nomad:analytics:grafana:console
 ```
 
-Show logs with
+Display logs
 
 ```shell
 cap production nomad:app:logs

data/capistrano-nomad.gemspec

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

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

@@ -5,3 +5,7 @@ end
 def capistrano_nomad_deep_symbolize_hash_keys(hash)
   JSON.parse(JSON[hash], symbolize_names: true)
 end
+
+def capistrano_nomad_run_remotely(&block)
+  on(roles(:manager), &block)
+end

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

@@ -21,7 +21,7 @@ end
 def capistrano_nomad_read_docker_image_types_manifest
   manifest = {}
 
-  on(roles(:manager)) do |_host|
+  capistrano_nomad_run_remotely do
     # Ensure file exists
     execute("mkdir -p #{shared_path}")
     execute("touch #{capistrano_nomad_docker_image_types_manifest_path}")
@@ -37,7 +37,7 @@ def capistrano_nomad_read_docker_image_types_manifest
 end
 
 def capistrano_nomad_update_docker_image_types_manifest(image_type, properties = {})
-  on(roles(:manager)) do |_host|
+  capistrano_nomad_run_remotely do
     # Read and update manifest
     manifest = capistrano_nomad_read_docker_image_types_manifest
     manifest[image_type] = (manifest[image_type] || {}).merge(properties.stringify_keys)
@@ -90,12 +90,7 @@ def capistrano_nomad_build_docker_image_for_type(image_type)
     args << "--build-arg #{key}=#{value}"
   end
 
-  run_locally do
-    # If any of these files exist then we're in the middle of rebase so we should interrupt
-    if ["rebase-merge", "rebase-apply"].any? { |f| File.exist?("#{capistrano_nomad_git.dir.path}/.git/#{f}") }
-      raise StandardError, "Still in the middle of git rebase, interrupting docker image build"
-    end
-
+  docker_build_command = lambda do |path|
     image_alias_args = args.dup
 
     [capistrano_nomad_build_docker_image_alias(image_type)]
@@ -104,7 +99,30 @@ def capistrano_nomad_build_docker_image_for_type(image_type)
         image_alias_args << "--tag #{tag}"
       end
 
-    execute("docker build #{image_alias_args.join(' ')} #{capistrano_nomad_root.join(attributes[:path])}")
+    "docker build #{image_alias_args.join(' ')} #{path}"
+  end
+
+  case attributes[:strategy]
+
+  # We need to build Docker container locally
+  when :local_build, :local_push
+    run_locally do
+      # If any of these files exist then we're in the middle of rebase so we should interrupt
+      if ["rebase-merge", "rebase-apply"].any? { |f| File.exist?("#{capistrano_nomad_git.dir.path}/.git/#{f}") }
+        raise StandardError, "Still in the middle of git rebase, interrupting docker image build"
+      end
+
+      execute(docker_build_command.call(capistrano_nomad_root.join(attributes[:path])))
+    end
+
+  # We need to build Docker container remotely
+  when :remote_build, :remote_push
+    remote_path = Pathname.new(release_path).join(attributes[:path])
+    capistrano_nomad_upload(local_path: attributes[:path], remote_path: remote_path)
+
+    capistrano_nomad_run_remotely do
+      execute(docker_build_command.call(remote_path))
+    end
   end
 end
 
@@ -112,9 +130,11 @@ def capistrano_nomad_push_docker_image_for_type(image_type, is_manifest_updated:
   attributes = fetch(:nomad_docker_image_types)[image_type]
   alias_digest = attributes&.dig(:alias_digest)
 
+  return false unless [:local_push, :remote_push].include?(attributes[:strategy])
+
   run_locally do
-    # Don't push Docker image if alias digest is already passed in
-    unless alias_digest
+    # Only push Docker image if it was built from path
+    if attributes[:path]
       interaction_handler = CapistranoNomadDockerPushImageInteractionHandler.new
       image_alias = capistrano_nomad_build_docker_image_alias(image_type)
 

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

@@ -1,6 +1,16 @@
+require "active_support/core_ext/hash"
+
 def nomad_docker_image_type(image_type, attributes = {})
   docker_image_types = fetch(:nomad_docker_image_types) || {}
-  docker_image_types[image_type] = attributes
+  docker_image_types[image_type] = attributes.reverse_merge(
+    # By default build and push Docker image locally
+    strategy: :local_push,
+  )
+
+  raise ArgumentError, "passing in alias_digest is not allowed!" if attributes[:alias_digest]
+
+  # If Docker image doesn't get pushed, this will still be populated
+  docker_image_types[image_type][:alias_digest] = attributes[:alias]
 
   set(:nomad_docker_image_types, docker_image_types)
 end

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

@@ -96,7 +96,7 @@ def capistrano_nomad_run_nomad_command(kind, *args)
 end
 
 def capistrano_nomad_execute_nomad_command(*args)
-  on(roles(:manager)) do |host|
+  capistrano_nomad_run_remotely do |host|
     run_interactively(host) do
       capistrano_nomad_run_nomad_command(:execute, *args)
     end
@@ -106,7 +106,7 @@ end
 def capistrano_nomad_capture_nomad_command(*args)
   output = nil
 
-  on(roles(:manager)) do |_host|
+  capistrano_nomad_run_remotely do
     output = capistrano_nomad_run_nomad_command(:capture, *args)
   end
 
@@ -152,7 +152,7 @@ def capistrano_nomad_find_job_task_details(name, namespace: nil, task: nil)
 end
 
 def capistrano_nomad_exec_within_job(name, command, namespace: nil, task: nil)
-  on(roles(:manager)) do
+  capistrano_nomad_run_remotely do
     if (task_details = capistrano_nomad_find_job_task_details(name, namespace: namespace, task: task))
       capistrano_nomad_execute_nomad_command(
         :alloc,
@@ -174,40 +174,52 @@ def capistrano_nomad_exec_within_job(name, command, namespace: nil, task: nil)
   end
 end
 
-def capistrano_nomad_upload_file(local_path:, remote_path:, erb_vars: {})
-  docker_image_types = fetch(:nomad_docker_image_types)
-  docker_image_types_manifest = capistrano_nomad_read_docker_image_types_manifest
+def capistrano_nomad_upload(local_path:, remote_path:, erb_vars: {})
+  # If directory upload everything within the directory
+  if File.directory?(local_path)
+    Dir.glob("#{local_path}/*").each do |path|
+      capistrano_nomad_upload(local_path: path, remote_path: "#{remote_path}/#{File.basename(path)}")
+    end
 
-  # Merge manifest into image types
-  docker_image_types_manifest.each do |manifest_image_type, manifest_attributes|
-    docker_image_types[manifest_image_type]&.merge!(manifest_attributes) || {}
-  end
+  # If file, attempt to always parse it as ERB
+  else
+    docker_image_types = fetch(:nomad_docker_image_types)
+    docker_image_types_manifest = capistrano_nomad_read_docker_image_types_manifest
 
-  # Parse manifest files using ERB
-  erb = ERB.new(File.open(local_path).read, trim_mode: "-")
+    # Merge manifest into image types
+    docker_image_types_manifest.each do |manifest_image_type, manifest_attributes|
+      docker_image_types[manifest_image_type]&.merge!(manifest_attributes) || {}
+    end
 
-  final_erb_vars = {
-    git_commit_id: fetch(:current_revision) || capistrano_nomad_git_commit_id,
-    docker_image_types: docker_image_types,
-  }
+    # Parse manifest files using ERB
+    erb = ERB.new(File.open(local_path).read, trim_mode: "-")
+
+    final_erb_vars = {
+      git_commit_id: fetch(:current_revision) || capistrano_nomad_git_commit_id,
+      docker_image_types: docker_image_types,
+    }
 
-  # Add global ERB vars
-  final_erb_vars.merge!(fetch(:nomad_template_vars) || {})
+    # Add global ERB vars
+    final_erb_vars.merge!(fetch(:nomad_template_vars) || {})
 
-  # Add job-specific ERB vars
-  final_erb_vars.merge!(erb_vars)
+    # Add job-specific ERB vars
+    final_erb_vars.merge!(erb_vars)
 
-  # We use a custom namespace class so that we can include helper methods into the namespace to make them available for
-  # template to access
-  namespace = CapistranoNomadErbNamespace.new(
-    context: self,
-    vars: final_erb_vars,
-  )
-  erb_io = StringIO.new(erb.result(namespace.instance_eval { binding }))
+    # We use a custom namespace class so that we can include helper methods into the namespace to make them available
+    # for template to access
+    namespace = CapistranoNomadErbNamespace.new(
+      context: self,
+      vars: final_erb_vars,
+    )
 
-  on(roles(:manager)) do
-    execute(:mkdir, "-p", File.dirname(remote_path))
-    upload!(erb_io, remote_path)
+    string_io = StringIO.new(erb.result(namespace.instance_eval { binding }))
+
+    capistrano_nomad_run_remotely do
+      # Ensure parent directory exists
+      execute(:mkdir, "-p", File.dirname(remote_path))
+
+      upload!(string_io, remote_path)
+    end
   end
 end
 
@@ -253,7 +265,7 @@ def capistrano_nomad_upload_jobs(names, *args)
   uniq_var_files = names.map { |n| capistrano_nomad_fetch_job_var_files(n, *args) }.flatten.uniq
 
   uniq_var_files.each do |var_file|
-    capistrano_nomad_upload_file(
+    capistrano_nomad_upload(
       local_path: capistrano_nomad_build_local_var_file_path(var_file, *args),
       remote_path: capistrano_nomad_build_release_var_file_path(var_file, *args),
     )
@@ -269,7 +281,7 @@ def capistrano_nomad_upload_jobs(names, *args)
       # Can set a custom template instead
       file_basename = nomad_job_options[:template] || name
 
-      capistrano_nomad_upload_file(
+      capistrano_nomad_upload(
         local_path: capistrano_nomad_build_local_job_path(file_basename, *args),
         remote_path: capistrano_nomad_build_release_job_path(name, *args),
         erb_vars: erb_vars,

metadata

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