capistrano-nomad 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e70ce696bab8b3ef8545e9f4eff59e12aa8c39a9705da8ba92a9ae0516b2534b
-  data.tar.gz: 8053ced9f62a0d56046cc7162f5efd20ddd9ab20e0d22a23b9e237a84db5f605
+  metadata.gz: 9993fb04b78b68b03c055faa66454360543c92108f2e410f7156bedf7158f763
+  data.tar.gz: 20b4708abc11215f259bc46b8b4c7f4f0606fb0d2ff7e3c862c799b850ead5ee
 SHA512:
-  metadata.gz: f861c87b67f797851738b1e0a29cab2286489b6067029f9314d55a2099e9e1751bd2e0f8df3ba3ba190545ddffecbe38e086515a2a520d7f39b5900299c783d3
-  data.tar.gz: 62817162ccf5ed2e0c72464e5846bfcb3474964f9a3d3339565c66f58d154c53483341e955e067458398ac69c61aeeb8f698157b114c9802338468bf43d1c950
+  metadata.gz: 86d6750e7e181d120db5b56da6c5b7b083310901939e452aee8e7a6de12db22544f2c1accfe8fb9790c75c188644ed0108446a8281875566b0d6243ae8db6191
+  data.tar.gz: f80d0003e093e3ed5e0fefc69b6b89db158064145c7c21573944b8fc88f8beb40a1cb0b40fbbbb956856bbc637f217a72001c5a1de10ed992ea46e6fd45b8809

data/Gemfile.lock

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

data/README.md

@@ -102,11 +102,14 @@ 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], tags: [:redis]
-nomad_job :"traefik-default", template: :traefik, erb_vars: { role: :default }, tags: [:traefik]
-nomad_job :"traefik-secondary", template: :traefik, erb_vars: { role: :secondary }, tags: [:traefik]
-nomad_job :"traefik-tertiary", template: :traefik, erb_vars: { role: :secondary }, tags: [:traefik]
-
-nomad_namespace :analytics do
+nomad_job :"traefik-default", template: :admin,
+  erb_vars: { role: :default },
+  tags: [:traefik]
+nomad_job :"traefik-secondary", template: :admin,
+  erb_vars: { role: :secondary },
+  tags: [:traefik]
+
+nomad_namespace :analytics, tags: [:admin] do
   nomad_job :grafana
 end
 
@@ -131,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=traefik
-cap production nomad:all:upload_run
-cap production nomad:all:upload_run TAGS=traefik,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
@@ -168,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.1"
+  spec.version = "0.10.0"
   spec.authors = ["James Hu"]
 
   spec.summary = "Capistrano plugin for deploying and managing Nomad jobs"

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

@@ -36,6 +36,16 @@ 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
+  if (nomad_namespace_options = capistrano_nomad_fetch_namespace_options(@nomad_namespace))
+    attributes[:tags] += nomad_namespace_options[:tags] || []
+  end
+
   nomad_jobs = fetch(:nomad_jobs) || Hash.new { |h, n| h[n] = {} }
   nomad_jobs[@nomad_namespace][name] = attributes
 

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

@@ -243,7 +243,7 @@ def capistrano_nomad_upload(local_path:, remote_path:, erb_vars: {})
 end
 
 def capistrano_nomad_fetch_namespace_options(namespace)
-  fetch(:nomad_namespaces).dig(namespace)
+  fetch(:nomad_namespaces)&.dig(namespace)
 end
 
 def capistrano_nomad_fetch_job_options(name, *args, namespace: nil)
@@ -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: nil)
   # 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
@@ -281,85 +281,93 @@ 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"
+def capistrano_nomad_define_group_tasks(namespace: nil)
+  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)

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 :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.1
+  version: 0.10.0
 platform: ruby
 authors:
 - James Hu