capistrano-nomad 0.9.2 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '064875b4478852c18387c8084ff4b0e5c2cb4e9377a6854724f46119b416ecf5'
-  data.tar.gz: 15069bfd33db0a2b497a7e6a1adf816669df6ba0b508364fb8a26728e46ae329
+  metadata.gz: 76af53f1a2764deb4b91363674b6627d7b6017a30609e067d42b66cdbd5c9fc0
+  data.tar.gz: 64825bb8a9bdccf833f23cb36aeb10cba6f516bbac8e6690193eb1674339fb94
 SHA512:
-  metadata.gz: eff94039fa9b7c506fbe139670639d326423c409813c4a10c97c15e79256f4bc5f65a181a2d8608af9bdd0aa51aeaeb999ad27e02836b2af8815b961999f8470
-  data.tar.gz: 255c76c93ba40a4fd35206b31d511a7a42e2954c4e4f072154effe68643e66a938fd0aacd3f029e7e5cfa37f13f82cb924606ab4bc2fc61be92234c5e3d7428d
+  metadata.gz: d359a15febd84d1303360f8d9c51faf026fa6388cf6a8b97edc7fa99cee59007c4999d040935bad0351ad1fa3bc1aca5908819b1cd1fc302d711b09a7d3a42e6
+  data.tar.gz: 5bf77756a9d1dc2bc28ded978f0523fff65059932154c1930545dd4b06930012d45ed646108f593802e606559b2aa4c2cae867f2012bef83245308b30d1a52dd

data/Gemfile.lock

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

data/README.md

@@ -134,15 +134,15 @@ cap production nomad:analytics:grafana:restart
 cap production nomad:postgres:status
 ```
 
-Tasks can go by namespace or `all` namespaces, and can also be filtered by tags
+Tasks can apply across all namespaces or be filtered by namespaces or tags
 
 ```shell
 cap production nomad:analytics:deploy
 cap production nomad:analytics:upload_run
-cap production nomad:all:deploy
-cap production nomad:all:deploy TAG=admin
-cap production nomad:all:upload_run
-cap production nomad:all:upload_run TAGS=admin,redis
+cap production nomad:deploy
+cap production nomad:deploy TAG=admin
+cap production nomad:upload_run
+cap production nomad:upload_run TAGS=admin,redis
 ```
 
 Open console
@@ -171,7 +171,7 @@ cap production nomad:app:ui
 Create missing and delete unused namespaces
 
 ```shell
-cap production nomad:all:modify_namespaces
+cap production nomad:modify_namespaces
 ```
 
 ## Development

data/capistrano-nomad.gemspec

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

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

@@ -36,6 +36,9 @@ def nomad_namespace(namespace, **options, &block)
 end
 
 def nomad_job(name, attributes = {})
+  # This is the namespace when there's no namespace defined in Nomad too
+  @nomad_namespace ||= :default
+
   attributes[:tags] ||= []
 
   # Tags added to namespace should be added to all jobs within

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

@@ -29,7 +29,7 @@ def capistrano_nomad_ensure_absolute_path(path)
   path[0] == "/" ? path : "/#{path}"
 end
 
-def capistrano_nomad_build_file_path(parent_path, basename, kind: nil, namespace: nil)
+def capistrano_nomad_build_file_path(parent_path, basename, kind: nil, namespace: :default)
   segments = [parent_path]
 
   if namespace
@@ -132,7 +132,7 @@ def capistrano_nomad_capture_nomad_command(*args)
   output
 end
 
-def capistrano_nomad_find_job_task_details(name, namespace: nil, task: nil)
+def capistrano_nomad_find_job_task_details(name, namespace: :default, task: nil)
   task = task.presence || name
 
   # Find alloc id that contains task
@@ -170,7 +170,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)
+def capistrano_nomad_exec_within_job(name, command, namespace: :default, task: nil)
   capistrano_nomad_run_remotely do
     if (task_details = capistrano_nomad_find_job_task_details(name, namespace: namespace, task: task))
       capistrano_nomad_execute_nomad_command(
@@ -246,7 +246,7 @@ def capistrano_nomad_fetch_namespace_options(namespace)
   fetch(:nomad_namespaces)&.dig(namespace)
 end
 
-def capistrano_nomad_fetch_job_options(name, *args, namespace: nil)
+def capistrano_nomad_fetch_job_options(name, *args, namespace: :default)
   fetch(:nomad_jobs).dig(namespace, name.to_sym, *args)
 end
 
@@ -254,7 +254,7 @@ 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(namespace: :all)
+def capistrano_nomad_fetch_jobs_names_by_namespace(namespace: :default)
   # Can pass tags via command line (e.g. TAG=foo or TAGS=foo,bar)
   tags =
     [ENV["TAG"], ENV["TAGS"]].map do |tag_args|
@@ -266,7 +266,7 @@ def capistrano_nomad_fetch_jobs_names_by_namespace(namespace: :all)
       .compact
 
   fetch(:nomad_jobs).each_with_object({}) do |(jobs_namespace, jobs_options), hash|
-    next if namespace != :all && namespace != jobs_namespace
+    next if !namespace.nil? && namespace != jobs_namespace
 
     hash[jobs_namespace] = jobs_options.each_with_object([]) do |(job_name, job_options), collection|
       # Filter jobs by tags if specified
@@ -277,89 +277,97 @@ def capistrano_nomad_fetch_jobs_names_by_namespace(namespace: :all)
   end
 end
 
-def capistrano_nomad_fetch_jobs_docker_image_types(names, namespace: nil)
+def capistrano_nomad_fetch_jobs_docker_image_types(names, namespace: :default)
   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"
+  define_tasks = lambda do |nomad_namespace: nil|
+    desc "Build #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_push_jobs_docker_images(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Push #{namespace} job Docker images"
+    desc "Push #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_push_jobs_docker_images(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Build and push #{namespace} job Docker images"
+    desc "Build and push #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_assemble_jobs_docker_images(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Upload #{namespace} jobs"
+    desc "Upload #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_upload_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Run #{namespace} jobs"
+    desc "Run #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_run_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Upload and run #{namespace} jobs"
+    desc "Upload and run #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_upload_run_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Deploy #{namespace} jobs"
+    desc "Deploy #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_deploy_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Rerun #{namespace} jobs"
+    desc "Rerun #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_rerun_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Restart #{namespace} jobs"
+    desc "Restart #{nomad_namespace} jobs"
     task :restart do
-      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
-        capistrano_nomad_restart_jobs(names, namespace: namespace_by)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_restart_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Stop #{namespace} jobs"
+    desc "Stop #{nomad_namespace} jobs"
     task :stop do
-      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: namespace).each do |namespace_by, names|
-        capistrano_nomad_stop_jobs(names, namespace: namespace_by)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_stop_jobs(names, namespace: jobs_namespace)
       end
     end
 
-    desc "Purge #{namespace} jobs"
+    desc "Purge #{nomad_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)
+      capistrano_nomad_fetch_jobs_names_by_namespace(namespace: nomad_namespace).each do |jobs_namespace, names|
+        capistrano_nomad_purge_jobs(names, namespace: jobs_namespace)
       end
     end
   end
+
+  if namespace
+    namespace(namespace) do
+      define_tasks.call(nomad_namespace: namespace)
+    end
+  else
+    define_tasks.call
+  end
 end
 
 def capistrano_nomad_build_jobs_docker_images(names, *args)
@@ -421,7 +429,7 @@ def capistrano_nomad_plan_jobs(names, *args)
   end
 end
 
-def capistrano_nomad_run_jobs(names, namespace: nil, is_detached: true)
+def capistrano_nomad_run_jobs(names, namespace: :default, is_detached: true)
   names.each do |name|
     run_options = {
       namespace: namespace,
@@ -493,7 +501,7 @@ def capistrano_nomad_stop_jobs(names, **options)
   end
 end
 
-def capistrano_nomad_purge_jobs(names, namespace: nil, is_detached: true)
+def capistrano_nomad_purge_jobs(names, namespace: :default, is_detached: true)
   names.each do |name|
     capistrano_nomad_execute_nomad_command(:stop, { namespace: namespace, purge: true, detach: is_detached }, name)
   end
@@ -503,7 +511,7 @@ 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)
+def capistrano_nomad_display_job_logs(name, namespace: :default, **options)
   if (task_details = capistrano_nomad_find_job_task_details(name, namespace: namespace, task: ENV["TASK"]))
     capistrano_nomad_execute_nomad_command(
       :alloc,
@@ -526,7 +534,7 @@ 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)
+def capistrano_nomad_open_job_ui(name, namespace: :default)
   run_locally do
     url = "#{fetch(:nomad_ui_url)}/ui/jobs/#{name}"
     url += "@#{namespace}" if namespace

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

@@ -1,46 +1,37 @@
 namespace :nomad do
-  desc "Show version"
-  task :version do
-    capistrano_nomad_execute_nomad_command(:version)
-  end
-
   # Define tasks for all jobs
-  capistrano_nomad_define_group_tasks(namespace: :all)
+  capistrano_nomad_define_group_tasks(namespace: nil)
 
-  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}}'")
-      current_namespaces = output.split("|").compact.map(&:to_sym)
+  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)
 
-      # If key is nil then it actually belongs to the default namespace
-      desired_namespaces = fetch(:nomad_jobs).keys.map { |n| n.nil? ? :default : n.to_sym }
+    # If key is nil then it actually belongs to the default namespace
+    desired_namespaces = fetch(:nomad_jobs).keys.map { |n| n.nil? ? :default : n.to_sym }
 
-      missing_namespaces = desired_namespaces - current_namespaces
-      unused_namespaces = current_namespaces - desired_namespaces
+    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
+    # 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
+    # Create missing namespaces
+    missing_namespaces.each do |namespace|
+      capistrano_nomad_execute_nomad_command(:namespace, :apply, namespace)
     end
   end
 
-  namespace :docker_images do
-    desc "Used for adding hooks before or after pushing Docker images"
-    task :push
+  desc "Run garbage collector tasks"
+  task :gc do
+    capistrano_nomad_execute_nomad_command(:system, :gc)
+    capistrano_nomad_execute_nomad_command(:system, :reconcile, :summaries)
   end
 
-  namespace :system do
-    desc "Clean up Nomad"
-    task :clean do
-      capistrano_nomad_execute_nomad_command(:system, :gc)
-      capistrano_nomad_execute_nomad_command(:system, :reconcile, :summaries)
-    end
+  desc "Show version"
+  task :version do
+    capistrano_nomad_execute_nomad_command(:version)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-nomad
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.1
 platform: ruby
 authors:
 - James Hu