capistrano-nomad 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d227d6f15f433cd6410884afc5572cf9c7e115a7365e00e244d3b95ca320f148
-  data.tar.gz: a0cdd0e131319cd0f1a17a926afe70619d24550018de9731c96a610b075300c2
+  metadata.gz: '02685bbf3f2ad3d0bc5dbc45b33f31622ddbe9a465671381645bd665266cf4aa'
+  data.tar.gz: 6f386d0642e4cd00f66e5dc0ddefdb3815d537d254525e130717251d7407a56d
 SHA512:
-  metadata.gz: fd4aec6aecd6698d4ed23d4e1a2c3d3e8ded18467c1a4d8daee191e29304e2f91f85ca7d604681dba4ec6cb885308f0fb6985fb4e9d952e459fc7859a3b3917a
-  data.tar.gz: 6009d60f5bd99e35fdb2961f6b9d860ea9db40ac844cebacf87b21ae58381eeefd35022fb58c7a6b88fa74da7e3acff3ee26a0f9a71a92e1b61495102bf53a21
+  metadata.gz: 5c7a4c7173a08c5ef7bc7207a5e3500864a1f85171a4a324342bf0ed6bdfda3b7bce2ba3db147440476db96513f1ab0b9af7458c59fee7bd8c4f6996686acc69
+  data.tar.gz: f6d8b9affa00bea01d56a6ef3c067d80a6596c7881b8f4893c4b16e17fd5f2d0030128dfa0f0de4dce6cd908e29013ca088d61a26df5897fe97bebf6aa215d7d

data/Gemfile.lock

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

data/README.md

@@ -37,6 +37,9 @@ Within `deploy.rb`
 set :nomad_jobs_path, "nomad/jobs"
 set :nomad_var_files_path, "nomad/vars"
 
+# Determines base URL to use when opening job in web UI 
+set :nomad_ui_url, "http://localhost:4646"
+
 # Make variables available to all template .erb files
 set :nomad_template_vars, (lambda do
   {
@@ -61,7 +64,7 @@ end
 
 # Use hosted Docker image
 nomad_docker_image_type :postgres,
-  alias_digest: "postgres:5.0.0"
+  alias: "postgres:5.0.0"
 
 # Use Docker image that will be built locally relative to project and push
 nomad_docker_image_type :backend,
@@ -92,6 +95,10 @@ nomad_job :"traefik-secondary", template: :traefik, erb_vars: { role: :secondary
 nomad_namespace :analytics do
   nomad_job :grafana
 end
+
+nomad_namespace :maintenance, path: "maintenance-stuff" do
+  nomad_job :garbage_collection
+end
 ```
 
 Deploy all jobs
@@ -133,6 +140,12 @@ cap production nomad:app:stderr
 cap production nomad:analytics:grafana:follow
 ```
 
+Open job in web UI
+
+```shell
+cap production nomad:app:ui
+```
+
 Create missing and delete unused namespaces
 
 ```shell

data/capistrano-nomad.gemspec

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

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

@@ -23,8 +23,8 @@ def capistrano_nomad_read_docker_image_types_manifest
 
   capistrano_nomad_run_remotely do
     # Ensure file exists
-    execute("mkdir -p #{shared_path}")
-    execute("touch #{capistrano_nomad_docker_image_types_manifest_path}")
+    execute("mkdir", "-p", shared_path)
+    execute("touch", capistrano_nomad_docker_image_types_manifest_path)
 
     output = capture("cat #{capistrano_nomad_docker_image_types_manifest_path}")
 
@@ -133,8 +133,8 @@ def capistrano_nomad_push_docker_image_for_type(image_type, is_manifest_updated:
   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

@@ -3,17 +3,24 @@ 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.reverse_merge(
-    # In case image doesn't get pushed, this will still be populated
-    alias_digest: attributes[:alias],
-
     # 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
 
-def nomad_namespace(namespace, &block)
+def nomad_namespace(namespace, **options, &block)
+  nomad_namespaces = fetch(:nomad_namespaces) || {}
+  nomad_namespaces[namespace] = options
+  set(:nomad_namespaces, nomad_namespaces)
+
+  # Make namespace active for block
   @nomad_namespace = namespace
 
   instance_eval(&block)
@@ -133,6 +140,11 @@ def nomad_job(name, attributes = {})
       task :follow do
         capistrano_nomad_display_job_logs(name, namespace: namespace, f: true)
       end
+
+      desc "Open job in web UI"
+      task :ui do
+        capistrano_nomad_open_job_ui(name, namespace: namespace)
+      end
     end
   end
 

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

@@ -29,9 +29,24 @@ def capistrano_nomad_ensure_absolute_path(path)
   path[0] == "/" ? path : "/#{path}"
 end
 
-def capistrano_nomad_build_file_path(parent_path, basename, namespace: nil)
+def capistrano_nomad_build_file_path(parent_path, basename, kind: nil, namespace: nil)
   segments = [parent_path]
-  segments << namespace if namespace
+
+  if namespace
+    case kind
+
+    # Always upload to namespace folder on remote
+    when :release
+      segments << namespace
+
+    # Otherwise path can be overriden of where files belonging to namespace are stored locally
+    else
+      namespace_options = capistrano_nomad_fetch_namespace_options(namespace)
+
+      segments << (namespace_options[:path] || namespace)
+    end
+  end
+
   segments << "#{basename}.hcl"
 
   segments.join("/")
@@ -64,12 +79,16 @@ def capistrano_nomad_build_local_var_file_path(name, *args)
   capistrano_nomad_build_local_path(capistrano_nomad_build_base_var_file_path(name, *args))
 end
 
-def capistrano_nomad_build_release_job_path(*args)
-  "#{release_path}#{capistrano_nomad_ensure_absolute_path(capistrano_nomad_build_base_job_path(*args))}"
+def capistrano_nomad_build_release_job_path(name, **options)
+  options[:kind] = :release
+
+  "#{release_path}#{capistrano_nomad_ensure_absolute_path(capistrano_nomad_build_base_job_path(name, **options))}"
 end
 
-def capistrano_nomad_build_release_var_file_path(*args)
-  "#{release_path}#{capistrano_nomad_ensure_absolute_path(capistrano_nomad_build_base_var_file_path(*args))}"
+def capistrano_nomad_build_release_var_file_path(name, **options)
+  options[:kind] = :release
+
+  "#{release_path}#{capistrano_nomad_ensure_absolute_path(capistrano_nomad_build_base_var_file_path(name, **options))}"
 end
 
 def capistrano_nomad_run_nomad_command(kind, *args)
@@ -180,52 +199,53 @@ def capistrano_nomad_upload(local_path:, remote_path:, erb_vars: {})
     Dir.glob("#{local_path}/*").each do |path|
       capistrano_nomad_upload(local_path: path, remote_path: "#{remote_path}/#{File.basename(path)}")
     end
+
+  # If file, attempt to always parse it as ERB
   else
-    io =
-      if File.extname(local_path) == ".erb"
-        docker_image_types = fetch(:nomad_docker_image_types)
-        docker_image_types_manifest = capistrano_nomad_read_docker_image_types_manifest
-
-        # 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
-
-        # 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 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,
-        )
-
-        StringIO.new(erb.result(namespace.instance_eval { binding }))
-      else
-        File.open(local_path)
-      end
+    docker_image_types = fetch(:nomad_docker_image_types)
+    docker_image_types_manifest = capistrano_nomad_read_docker_image_types_manifest
+
+    # 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
+
+    # 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 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,
+    )
+
+    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!(io, remote_path)
+      upload!(string_io, remote_path)
     end
   end
 end
 
+def capistrano_nomad_fetch_namespace_options(namespace)
+  fetch(:nomad_namespaces).dig(namespace)
+end
+
 def capistrano_nomad_fetch_job_options(name, *args, namespace: nil)
   fetch(:nomad_jobs).dig(namespace, name.to_sym, *args)
 end
@@ -405,3 +425,13 @@ end
 def capistrano_nomad_tail_job_logs(*args, **options)
   capistrano_nomad_display_job_logs(*args, **options.merge(tail: true, n: 50))
 end
+
+def capistrano_nomad_open_job_ui(name, namespace: nil)
+  run_locally do
+    url = "#{fetch(:nomad_ui_url)}/ui/jobs/#{name}"
+    url += "@#{namespace}" if namespace
+
+    # Only macOS supported for now
+    execute(:open, url)
+  end
+end

data/lib/capistrano/nomad.rb

@@ -11,6 +11,7 @@ module Capistrano
     def set_defaults
       set_if_empty(:nomad_jobs_path, "nomad/jobs")
       set_if_empty(:nomad_var_files_path, "nomad/var_files")
+      set_if_empty(:nomad_ui_url, "http://localhost:4646")
       set_if_empty(:nomad_docker_image_alias, ->(**) {})
     end
 

metadata

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