capistrano-nomad 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac8deb55e886ac97912499380a208f03ef15f7f952123afda2d6f8910e30df0
-  data.tar.gz: 730715ed63a01273775a7dccc403993866d73cb562de7cf70d0c22cf2754b493
+  metadata.gz: 3410efa72a3baf19cc0d7fa93f33af57c3e1c0c703685a7f21aa42ed41179d55
+  data.tar.gz: '0971e538df8c3fc79c633423f4db322ea4629d1ec22c2a457fa2404ae32035cb'
 SHA512:
-  metadata.gz: 933da9e873b7d6ed030983f0a441a157a4b2bac6c8803076a6dbeebb2bf3afeb922e57d5d3f5ba1b437f9da371386c9a09676d4e3f8dc32e68e3bfa86e5ae4b8
-  data.tar.gz: a87d69e22c6df4fcb9189a43279e399e27d9a625d1a86d728626fba63327daeed6a924113f019ed639d2782fae6db47367fbcd2568337faeafe9410ed3176b9f
+  metadata.gz: 624793f5e75a00ac9de53a25a1ffa38a226d95f84850e38f9c82917865f0c5de66d7ac1e02bdda2e3b9cf01f3771aa154d1398fd3a70371e2c7bdb0e84fade09
+  data.tar.gz: ec008b557f39991b002950cbbfecb1c11a038d9ef9a08e7d250a73201266a0c5c2503735ca7fe24fdc941b53a75f944edc5b6f80ab13a32675dea16bcb64a6f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-nomad (0.7.1)
+    capistrano-nomad (0.8.0)
       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
   {
@@ -92,12 +95,10 @@ nomad_job :"traefik-secondary", template: :traefik, erb_vars: { role: :secondary
 nomad_namespace :analytics do
   nomad_job :grafana
 end
-```
 
-Deploy all jobs
-
-```shell
-cap production nomad:all:deploy
+nomad_namespace :maintenance, path: "maintenance-stuff" do
+  nomad_job :garbage_collection
+end
 ```
 
 Deploy individual jobs
@@ -116,6 +117,15 @@ cap production nomad:analytics:grafana:restart
 cap production nomad:postgres:status
 ```
 
+Most tasks are also available for namespace or all
+
+```shell
+cap production nomad:analytics:deploy
+cap production nomad:analytics:upload_run
+cap production nomad:all:deploy
+cap production nomad:all:upload_run
+```
+
 Open console
 
 ```shell
@@ -133,6 +143,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.1"
+  spec.version = "0.8.0"
   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}")
 

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

@@ -15,13 +15,23 @@ def nomad_docker_image_type(image_type, attributes = {})
   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)
 
   @nomad_namespace = nil
 
+  # Define tasks for namespace jobs
+  namespace(:nomad) do
+    capistrano_nomad_define_group_tasks(namespace: namespace)
+  end
+
   true
 end
 
@@ -135,6 +145,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)
@@ -223,6 +242,10 @@ def capistrano_nomad_upload(local_path:, remote_path:, erb_vars: {})
   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
@@ -231,14 +254,86 @@ def capistrano_nomad_fetch_job_var_files(name, *args)
   capistrano_nomad_fetch_job_options(name, :var_files, *args) || []
 end
 
-def capistrano_nomad_fetch_jobs_names_by_namespace
-  fetch(:nomad_jobs).transform_values(&:keys)
+def capistrano_nomad_fetch_jobs_names_by_namespace(namespace: :all)
+  jobs_names_by_namespace = fetch(:nomad_jobs).transform_values(&:keys)
+
+  # Filter by namespace unless it's all
+  jobs_names_by_namespace = jobs_names_by_namespace.slice(namespace) unless namespace == :all
+
+  jobs_names_by_namespace
 end
 
 def capistrano_nomad_fetch_jobs_docker_image_types(names, namespace: nil)
   names.map { |n| fetch(:nomad_jobs).dig(namespace, n.to_sym, :docker_image_types) }.flatten.compact.uniq
 end
 
+def capistrano_nomad_define_group_tasks(namespace:)
+  namespace(namespace) do
+    desc "Build #{namespace} job Docker images"
+    task :build do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_push_jobs_docker_images(names, namespace: namespace_by)
+      end
+    end
+
+    desc "Push #{namespace} job Docker images"
+    task :push do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_push_jobs_docker_images(names, namespace: namespace_by)
+      end
+    end
+
+    desc "Build and push #{namespace} job Docker images"
+    task :assemble do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_assemble_jobs_docker_images(names, namespace: namespace_by)
+      end
+    end
+
+    desc "Upload #{namespace} jobs"
+    task :upload do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_upload_jobs(names, namespace: namespace_by)
+      end
+    end
+
+    desc "Run #{namespace} jobs"
+    task :run do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_run_jobs(names, namespace: namespace_by)
+      end
+    end
+
+    desc "Upload and run #{namespace} jobs"
+    task :upload_run do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_upload_run_jobs(names, namespace: namespace_by)
+      end
+    end
+
+    desc "Deploy #{namespace} jobs"
+    task :deploy do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_deploy_jobs(names, namespace: namespace_by)
+      end
+    end
+
+    desc "Rerun #{namespace} jobs"
+    task :rerun do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_rerun_jobs(names, namespace: namespace_by)
+      end
+    end
+
+    desc "Purge #{namespace} jobs"
+    task :purge do
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
+        capistrano_nomad_purge_jobs(names, namespace: namespace_by)
+      end
+    end
+  end
+end
+
 def capistrano_nomad_build_jobs_docker_images(names, *args)
   image_types = capistrano_nomad_fetch_jobs_docker_image_types(names, *args)
 
@@ -402,3 +497,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/tasks/nomad.rake

@@ -4,56 +4,10 @@ namespace :nomad do
     capistrano_nomad_execute_nomad_command(:version)
   end
 
-  namespace :all do
-    desc "Build all job Docker images"
-    task :build do
-      capistrano_nomad_fetch_jobs_names_by_namespace.each do |namespace, names|
-        capistrano_nomad_push_jobs_docker_images(names, namespace: namespace)
-      end
-    end
-
-    desc "Push all job Docker images"
-    task :push do
-      capistrano_nomad_fetch_jobs_names_by_namespace.each do |namespace, names|
-        capistrano_nomad_push_jobs_docker_images(names, namespace: namespace)
-      end
-    end
-
-    desc "Build and push all job Docker images"
-    task :assemble do
-      capistrano_nomad_fetch_jobs_names_by_namespace.each do |namespace, names|
-        capistrano_nomad_assemble_jobs_docker_images(names, namespace: namespace)
-      end
-    end
-
-    desc "Upload and run all jobs"
-    task :upload_run do
-      capistrano_nomad_fetch_jobs_names_by_namespace.each do |namespace, names|
-        capistrano_nomad_upload_run_jobs(names, namespace: namespace)
-      end
-    end
-
-    desc "Deploy all jobs"
-    task :deploy do
-      capistrano_nomad_fetch_jobs_names_by_namespace.each do |namespace, names|
-        capistrano_nomad_deploy_jobs(names, namespace: namespace)
-      end
-    end
-
-    desc "Rerun all jobs"
-    task :rerun do
-      capistrano_nomad_fetch_jobs_names_by_namespace.each do |namespace, names|
-        capistrano_nomad_rerun_jobs(names, namespace: namespace)
-      end
-    end
-
-    desc "Purge all jobs"
-    task :purge do
-      capistrano_nomad_fetch_jobs_names_by_namespace.each do |namespace, names|
-        capistrano_nomad_purge_jobs(names, namespace: namespace)
-      end
-    end
+  # Define tasks for all jobs
+  capistrano_nomad_define_group_tasks(namespace: :all)
 
+  namespace :all do
     desc "Create missing and remove unused namespaces"
     task :modify_namespaces do
       output = capistrano_nomad_capture_nomad_command(:namespace, :list, t: "'{{range .}}{{ .Name }}|{{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.1
+  version: 0.8.0
 platform: ruby
 authors:
 - James Hu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2024-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport