capistrano-nomad 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9766d262aebd461e4801a9bdde77735250dfeb7625faf9c4d6771f20db0516ee
+  data.tar.gz: 4afe079c96f410f5998adad6347e22cb73453d44d9a7a3b550503b5ad03166b1
+SHA512:
+  metadata.gz: ce0f93781fdd9ea9f4a97130cff43421bd272052f588a9240aa1718cbf8640c0271f14fdb2fd14a52007f19a05eb9746dfdd02ec0f2ed623f586032a8e3bbc18
+  data.tar.gz: 3e5df7d419965dd0e289170ebb3c292d46d86dcfd7dee5fb534ea272f4e2f09b5912c2c5d09e1b30c0eaab5b1a367789615eccfb590bd5192ce59eff16d10da5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capistrano-nomad.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    capistrano-nomad (0.1.0)
+      activesupport (= 7.0.8)
+      byebug
+      capistrano (= 3.14.1)
+      git (= 1.10.2)
+      rake (~> 13.0)
+      sshkit (= 1.21.2)
+      sshkit-interactive (= 0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    airbrussh (1.5.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    byebug (11.1.3)
+    capistrano (3.14.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.2.2)
+    git (1.10.2)
+      rchardet (~> 1.8)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.20.0)
+    net-scp (4.0.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-ssh (7.2.0)
+    rake (13.0.6)
+    rchardet (1.8.0)
+    sshkit (1.21.2)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    sshkit-interactive (0.3.0)
+      sshkit (~> 1.12)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  capistrano-nomad!
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 James Hu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# capistrano-nomad
+
+Capistrano plugin for deploying and managing [Nomad](http://nomadproject.io) jobs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "capistrano-nomad"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install capistrano-nomad
+
+## Usage
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/axsuul/capistrano-nomad.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/capistrano-nomad.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/capistrano/nomad/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "capistrano-nomad"
+  spec.version = Capistrano::Nomad::VERSION
+  spec.authors = ["James Hu"]
+
+  spec.summary = "Capistrano plugin for deploying and managing Nomad jobs"
+  spec.description = "Capistrano plugin for deploying and managing Nomad jobs"
+  spec.homepage = "https://github.com/axsuul/capistrano-nomad"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/axsuul/capistrano-nomad"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport", "7.0.8"
+  spec.add_dependency "byebug"
+  spec.add_dependency "capistrano", "3.14.1"
+  spec.add_dependency "git", "1.10.2"
+  spec.add_dependency "rake", "~> 13.0"
+  spec.add_dependency "sshkit", "1.21.2"
+  spec.add_dependency "sshkit-interactive", "0.3.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

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

@@ -0,0 +1,3 @@
+def capistrano_nomad_deep_symbolize_hash_keys(hash)
+  JSON.parse(JSON[hash], symbolize_names: true)
+end

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

@@ -0,0 +1,134 @@
+def capistrano_nomad_docker_image_types_manifest_path
+  shared_path.join("docker-image-types.json")
+end
+
+def capistrano_nomad_read_docker_image_types_manifest
+  manifest = {}
+
+  on(roles(:manager)) do |_host|
+    # Ensure file exists
+    execute("mkdir -p #{shared_path}")
+    execute("touch #{capistrano_nomad_docker_image_types_manifest_path}")
+
+    output = capture "cat #{capistrano_nomad_docker_image_types_manifest_path}"
+
+    unless output.blank?
+      manifest = JSON.parse(output)
+    end
+  end
+
+  capistrano_nomad_deep_symbolize_hash_keys(manifest)
+end
+
+def capistrano_nomad_update_docker_image_types_manifest(image_type, properties = {})
+  on(roles(:manager)) do |_host|
+    # Read and update manifest
+    manifest = capistrano_nomad_read_docker_image_types_manifest
+    manifest[image_type] = (manifest[image_type] || {}).merge(properties.stringify_keys)
+
+    io = StringIO.new(JSON.pretty_generate(manifest))
+
+    # Write to manifest
+    upload!(io, capistrano_nomad_docker_image_types_manifest_path)
+  end
+end
+
+def capistrano_nomad_build_docker_image_alias(image_type, ref)
+  # Define nomad_docker_image_alias has a proc to return image alias
+  fetch(:nomad_docker_image_alias).call(image_type: image_type, ref: ref)
+end
+
+# Fetch image alias from manifest
+def current_docker_service_image_alias(image_type)
+  image_alias =
+    capistrano_nomad_read_docker_image_types_manifest
+      .try(:[], image_type.to_sym)
+      .try(:[], :image_alias)
+
+  return image_alias if image_alias
+
+  capistrano_nomad_build_docker_image_alias(image_type, capistrano_nomad_fetch_git_commit_id)
+end
+
+# Builds docker image from image type
+#
+# @param image_type [String, Symbol]
+def capistrano_nomad_build_docker_image(image_type, path, *args)
+  run_locally do
+    git_commit_id = capistrano_nomad_fetch_git_commit_id
+
+    [
+      capistrano_nomad_build_docker_image_alias(image_type, git_commit_id),
+      capistrano_nomad_build_docker_image_alias(image_type, "latest"),
+      "trunk/#{fetch(:stage)}/#{image_type}:latest",
+    ].each do |tag|
+      args << "--tag #{tag}"
+    end
+
+    # 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?("#{fetch(:git).dir.path}/.git/#{f}") }
+      raise StandardError, "still in the middle of git rebase, interrupting docker image build"
+    end
+
+    system "docker build #{args.join(' ')} #{path}"
+  end
+end
+
+def capistrano_nomad_build_docker_image_for_type(image_type)
+  image_type = image_type.to_sym
+
+  attributes = fetch(:nomad_docker_image_types)[image_type]
+
+  return unless attributes
+
+  args = [
+    # Ensure images are built for x86_64 which is production env otherwise it will default to local development env
+    # which can be arm64 (Apple Silicon)
+    "--platform linux/amd64",
+  ]
+
+  build_args =
+    if attributes[:build_args].is_a?(Proc)
+      proc_args = attributes[:build_args].arity == 1 ? [capistrano_nomad_fetch_git_commit_id] : []
+
+      attributes[:build_args].call(*proc_args)
+    else
+      attributes[:build_args]
+    end
+
+  if (target = attributes[:target])
+    args << "--target #{target}"
+  end
+
+  (build_args || []).each do |key, value|
+    args << "--build-arg #{key}=#{value}"
+  end
+
+  capistrano_nomad_build_docker_image(image_type, attributes[:path], args)
+end
+
+def capistrano_nomad_push_docker_image_for_type(image_type, is_manifest_updated: true)
+  # Allows end user to add hooks
+  invoke("nomad:docker_images:push")
+
+  run_locally do
+    git_commit_id = capistrano_nomad_fetch_git_commit_id
+    revision_image_alias = capistrano_nomad_build_docker_image_alias(image_type, git_commit_id)
+    latest_image_alias = capistrano_nomad_build_docker_image_alias(image_type, "latest")
+
+    [revision_image_alias, latest_image_alias].each do |image_alias|
+      # We should not proceed if image cannot be pushed
+      unless system("docker push #{image_alias}")
+        raise StandardError, "Docker image push unsuccessful!"
+      end
+    end
+
+    return unless is_manifest_updated
+
+    # Update image type manifest
+    capistrano_nomad_update_docker_image_types_manifest(image_type,
+      ref: git_commit_id,
+      image_alias: revision_image_alias
+    )
+  end
+end

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

@@ -0,0 +1,127 @@
+def nomad_docker_image_type(image_type, attributes = {})
+  docker_image_types = fetch(:nomad_docker_image_types) || {}
+  docker_image_types[image_type] = attributes
+
+  set(:nomad_docker_image_types, docker_image_types)
+end
+
+def nomad_namespace(namespace, &block)
+  @nomad_namespace = namespace
+
+  instance_eval(&block)
+
+  @nomad_namespace = nil
+
+  true
+end
+
+def nomad_job(name, attributes = {})
+  nomad_jobs = fetch(:nomad_jobs) || Hash.new { |h, n| h[n] = {} }
+  nomad_jobs[@nomad_namespace][name] = attributes
+
+  set(:nomad_jobs, nomad_jobs)
+
+  define_tasks = lambda do |namespace: nil|
+    description_name = ""
+    description_name << "#{namespace}/" if namespace
+    description_name << name.to_s
+
+    namespace(name) do
+      desc "Build #{description_name} job Docker images"
+      task :build do
+        capistrano_nomad_build_jobs_docker_images([name], namespace: namespace)
+      end
+
+      desc "Push #{description_name} job Docker images"
+      task :push do
+        capistrano_nomad_push_jobs_docker_images([name], namespace: namespace)
+      end
+
+      desc "Build and push #{description_name} job Docker images"
+      task :assemble do
+        capistrano_nomad_build_jobs_docker_images([name], namespace: namespace)
+        capistrano_nomad_push_jobs_docker_images([name], namespace: namespace)
+      end
+
+      desc "Upload #{description_name} job and related files"
+      task :upload do
+        capistrano_nomad_upload_jobs([name], namespace: namespace)
+      end
+
+      desc "Run #{description_name} job"
+      task :run do
+        capistrano_nomad_run_jobs([name], namespace: namespace)
+      end
+
+      desc "Purge and run #{description_name} job again"
+      task :rerun do
+        capistrano_nomad_rerun_jobs([name], namespace: namespace)
+      end
+
+      desc "Purge #{description_name} job"
+      task :purge do
+        capistrano_nomad_purge_jobs([name], namespace: namespace, is_detached: false)
+      end
+
+      desc "Display status of #{description_name} job"
+      task :status do
+        capistrano_nomad_display_job_status(name, namespace: namespace)
+      end
+
+      desc "Upload and plan #{description_name} job"
+      task :upload_plan do
+        capistrano_nomad_upload_plan_jobs([name], namespace: namespace)
+      end
+
+      desc "Upload and run #{description_name} job"
+      task :upload_run do
+        capistrano_nomad_upload_run_jobs([name], namespace: namespace)
+      end
+
+      desc "Upload and re-run #{description_name} job"
+      task :upload_rerun do
+        capistrano_nomad_upload_rerun_jobs([name], namespace: namespace)
+      end
+
+      desc "Deploy #{description_name} job"
+      task :deploy do
+        capistrano_nomad_deploy_jobs([name], namespace: namespace)
+      end
+
+      desc "Restart #{description_name} job"
+      task :restart do
+        on roles :manager do
+          # We can't restart the job directly so we'll need to fetch all its running allocs and restart each of one
+          # individually instead
+          running_alloc_ids_output = capture(
+            "nomad job allocs " \
+            "-t '{{range .}}{{if eq .ClientStatus \"running\"}}{{ println .ID}}{{end}}{{end}}' " \
+            "#{name}",
+          )
+
+          running_alloc_ids = running_alloc_ids_output.strip.split("\n")
+
+          running_alloc_ids.each do |alloc_id|
+            capistrano_nomad_execute_nomad_command(:alloc, :restart, alloc_id)
+          end
+        end
+      end
+
+      desc "Open console to #{description_name} job"
+      task :console do
+        capistrano_nomad_exec_within_job(name, "/bin/bash", namespace: namespace)
+      end
+    end
+  end
+
+  namespace(:nomad) do
+    # Define tasks for service
+    if @nomad_namespace
+      namespace(@nomad_namespace) do
+        define_tasks.call(namespace: @nomad_namespace)
+      end
+    else
+      define_tasks.call
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require "git"
+
+def capistrano_nomad_git
+  Git.open(".")
+end
+
+def capistrano_nomad_fetch_git_commit_id
+  capistrano_nomad_git.log.first.sha
+end

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

@@ -0,0 +1,275 @@
+require "active_support/core_ext/string"
+require "sshkit/interactive"
+
+class NomadErbNamespace
+  def initialize(context:, vars: {})
+    @context = context
+
+    vars.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end
+  end
+
+  # Use default value passed in unless `nomad_job_task_cpu_resource` is set
+  def build_nomad_job_task_cpu_resource(default:)
+    nomad_job_task_cpu_resource == "null" ? default : nomad_job_task_cpu_resource
+  end
+
+  # Use default value passed in unless `nomad_job_task_memory_resource` is set
+  def build_nomad_job_task_memory_resource(default:)
+    nomad_job_task_memory_resource == "null" ? default : nomad_job_task_memory_resource
+  end
+
+  # rubocop:disable Style/MissingRespondToMissing
+  def method_missing(name, *args)
+    instance_variable = "@#{name}"
+
+    # First try to see if it's a variable we're trying to access which is stored in an instance variable otherwise try
+    # to see if there's a local method defineds
+    if instance_variable_defined?(instance_variable)
+      instance_variable_get(instance_variable)
+    elsif respond_to?(name)
+      send(name, *args)
+    end
+  end
+  # rubocop:enable Style/MissingRespondToMissing
+end
+
+def capistrano_nomad_build_file_path(parent_path, basename, namespace: nil)
+  # Remove initial slash if it exists
+  parent_path = parent_path[1..] if parent_path[0] == "/"
+
+  segments = [parent_path]
+  segments << namespace if namespace
+  segments << "#{basename}.hcl"
+
+  segments.join("/")
+end
+
+def capistrano_nomad_build_base_job_path(*args)
+  capistrano_nomad_build_file_path(fetch(:nomad_jobs_path), *args)
+end
+
+def capistrano_nomad_build_base_var_file_path(*args)
+  capistrano_nomad_build_file_path(fetch(:nomad_var_files_path), *args)
+end
+
+def capistrano_nomad_build_local_job_path(name, *args)
+  local_path = fetch(:root).join(capistrano_nomad_build_base_job_path(name, *args))
+
+  # Determine if it has .erb appended or not
+  [local_path, "#{local_path}.erb"].find { |path| File.exist?(path) }
+end
+
+def capistrano_nomad_build_release_job_path(*args)
+  "#{release_path}/#{capistrano_nomad_build_base_job_path(*args)}"
+end
+
+def capistrano_nomad_build_release_var_file_path(*args)
+  "#{release_path}/#{capistrano_nomad_build_base_var_file_path(*args)}"
+end
+
+def capistrano_nomad_execute_nomad_command(*args)
+  converted_args = args.each_with_object([]) do |arg, collection|
+    # If hash then convert it as options
+    if arg.is_a?(Hash)
+      arg.each do |key, value|
+        next unless value
+
+        option = "-#{key.to_s.dasherize}"
+
+        # Doesn't need a value if it's just meant to be a flag
+        option << "=#{value}" unless value == true
+
+        collection << option
+      end
+    else
+      collection << arg
+    end
+  end
+
+  on(roles(:manager)) do |host|
+    run_interactively(host) do
+      # Ignore errors
+      execute(:nomad, *converted_args, raise_on_non_zero_exit: false)
+    end
+  end
+end
+
+def capistrano_nomad_exec_within_job(name, command, namespace: nil)
+  capistrano_nomad_execute_nomad_command(:alloc, :exec, { namespace: namespace, task: name, job: name }, command)
+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
+
+  # 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_fetch_git_commit_id,
+    docker_image_types: docker_image_types,
+  }
+
+  # Add global ERB vars
+  final_erb_vars.merge!(fetch(:nomad_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 = NomadErbNamespace.new(
+    context: self,
+    vars: final_erb_vars,
+  )
+  erb_io = StringIO.new(erb.result(namespace.instance_eval { binding }))
+
+  on(roles(:manager)) do
+    execute(:mkdir, "-p", File.dirname(remote_path))
+    upload!(erb_io, remote_path)
+  end
+end
+
+def capistrano_nomad_fetch_job_options(name, *args, namespace: nil)
+  fetch(:nomad_jobs).dig(namespace, name.to_sym, *args)
+end
+
+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)
+end
+
+def capistrano_nomad_fetch_jobs_docker_image_types(names, namespace: nil)
+  names.map { |n| fetch(:nomad_jobs).dig(namespace, n.to_sym, :image_types) }.flatten.compact.uniq
+end
+
+def capistrano_nomad_build_jobs_docker_images(names, *args)
+  image_types = capistrano_nomad_fetch_jobs_docker_image_types(names, *args)
+
+  return false if image_types.empty?
+
+  image_types.each { |i| capistrano_nomad_build_docker_image_for_type(i, *args) }
+end
+
+def capistrano_nomad_push_jobs_docker_images(names, *args)
+  image_types = capistrano_nomad_fetch_jobs_docker_image_types(names, *args)
+
+  return false if image_types.empty?
+
+  image_types.each { |i| capistrano_nomad_push_docker_image_for_type(i, *args) }
+end
+
+def capistrano_nomad_assemble_jobs_docker_images(names, *args)
+  capistrano_nomad_build_jobs_docker_images(names, *args)
+  capistrano_nomad_push_jobs_docker_images(names, *args)
+end
+
+def capistrano_nomad_upload_jobs(names, *args)
+  # Var files can be shared between jobs so don't upload duplicates
+  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(
+      local_path: capistrano_nomad_build_base_var_file_path(var_file, *args),
+      remote_path: capistrano_nomad_build_release_var_file_path(var_file, *args),
+    )
+  end
+
+  run_locally do
+    names.each do |name|
+      nomad_job_options = capistrano_nomad_fetch_job_options(name, *args)
+
+      # Can set job-specific ERB vars
+      erb_vars = nomad_job_options[:erb_vars] || {}
+
+      # Can set a custom template instead
+      file_basename = nomad_job_options[:template] || name
+
+      capistrano_nomad_upload_file(
+        local_path: capistrano_nomad_build_base_job_path(file_basename, *args),
+        remote_path: capistrano_nomad_build_release_job_path(name, *args),
+        erb_vars: erb_vars,
+      )
+    end
+  end
+end
+
+def capistrano_nomad_plan_jobs(names, *args)
+  names.each do |name|
+    args = [capistrano_nomad_build_release_job_path(name, *args)]
+
+    capistrano_nomad_execute_nomad_command(:plan, *args)
+  end
+end
+
+def capistrano_nomad_run_jobs(names, namespace: nil)
+  names.each do |name|
+    run_options = {
+      namespace: namespace,
+      detach: true,
+
+      # Don't reset counts since they may have been scaled
+      preserve_counts: true,
+    }
+
+    capistrano_nomad_fetch_job_var_files(name, namespace: namespace).each do |var_file|
+      run_options[:var_file] = capistrano_nomad_build_release_var_file_path(var_file, namespace: namespace)
+    end
+
+    capistrano_nomad_execute_nomad_command(
+      :run,
+      run_options,
+      capistrano_nomad_build_release_job_path(name, namespace: namespace),
+    )
+  end
+end
+
+# Remove job and run again
+def capistrano_nomad_rerun_jobs(names)
+  names.each do |name|
+    # Wait for jobs to be purged before running again
+    capistrano_nomad_purge_jobs([name], is_detached: false)
+
+    capistrano_nomad_run_jobs([name])
+  end
+end
+
+def capistrano_nomad_upload_plan_jobs(names, *args)
+  capistrano_nomad_upload_jobs(names, *args)
+  capistrano_nomad_plan_jobs(names, *args)
+end
+
+def capistrano_nomad_upload_run_jobs(names, *args)
+  capistrano_nomad_upload_jobs(names, *args)
+  capistrano_nomad_run_jobs(names, *args)
+end
+
+def capistrano_nomad_upload_rerun_jobs(names, *args)
+  capistrano_nomad_upload_jobs(names, *args)
+  capistrano_nomad_rerun_jobs(names, *args)
+end
+
+def capistrano_nomad_deploy_jobs(names, *args)
+  capistrano_nomad_assemble_jobs_docker_images(names, *args)
+  capistrano_nomad_upload_run_jobs(names, *args)
+end
+
+def capistrano_nomad_purge_jobs(names, namespace: nil, is_detached: true)
+  names.each do |name|
+    capistrano_nomad_execute_nomad_command(:stop, { namespace: namespace, purge: true, detach: is_detached }, name)
+  end
+end
+
+def capistrano_nomad_display_job_status(name, *args)
+  capistrano_nomad_execute_nomad_command(:status, *args, name)
+end

data/lib/capistrano/nomad/scm/git_local.rb

@@ -0,0 +1,25 @@
+require "capistrano/scm/plugin"
+require_relative "../helpers/git"
+
+class Capistrano::SCM::GitLocal < Capistrano::SCM::Plugin
+  def define_tasks
+    namespace :git_local do
+      task :set_current_revision do
+        on release_roles :manager do
+          set :current_revision, capistrano_nomad_fetch_git_commit_id
+        end
+      end
+
+      task :create_release do
+        on release_roles :manager do
+          execute :mkdir, "-p", release_path
+        end
+      end
+    end
+  end
+
+  def register_hooks
+    before "deploy:set_current_revision", "git_local:set_current_revision"
+    after "deploy:new_release_path", "git_local:create_release"
+  end
+end

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

@@ -0,0 +1,70 @@
+namespace :nomad do
+  desc "Show version"
+  task :version do
+    capistrano_nomad_execute_nomad_command(:version)
+  end
+
+  namespace :docker_images do
+    desc "Used for adding hooks before or after pushing Docker images"
+    task :push
+  end
+
+  namespace :jobs 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
+  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
+  end
+end

data/lib/capistrano/nomad/version.rb

@@ -0,0 +1,6 @@
+module Capistrano
+  module Nomad
+    VERSION = "0.1.0".freeze
+  end
+end
+

data/lib/capistrano/nomad.rb

@@ -0,0 +1,20 @@
+require "capistrano/plugin"
+require_relative "nomad/helpers/base"
+require_relative "nomad/helpers/docker"
+require_relative "nomad/helpers/dsl"
+require_relative "nomad/helpers/git"
+require_relative "nomad/helpers/nomad"
+
+module Capistrano
+  class Nomad < Capistrano::Plugin
+    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_docker_image_alias, ->(**) {})
+    end
+
+    def define_tasks
+      eval_rakefile(File.expand_path("nomad/tasks/nomad.rake", __dir__))
+    end
+  end
+end

data/sig/capistrano/nomad.rbs

@@ -0,0 +1,6 @@
+module Capistrano
+  module Nomad
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-nomad
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Hu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.8
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.14.1
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.2
+- !ruby/object:Gem::Dependency
+  name: sshkit-interactive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: Capistrano plugin for deploying and managing Nomad jobs
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-nomad.gemspec
+- lib/capistrano/nomad.rb
+- lib/capistrano/nomad/helpers/base.rb
+- lib/capistrano/nomad/helpers/docker.rb
+- lib/capistrano/nomad/helpers/dsl.rb
+- lib/capistrano/nomad/helpers/git.rb
+- lib/capistrano/nomad/helpers/nomad.rb
+- lib/capistrano/nomad/scm/git_local.rb
+- lib/capistrano/nomad/tasks/nomad.rake
+- lib/capistrano/nomad/version.rb
+- sig/capistrano/nomad.rbs
+homepage: https://github.com/axsuul/capistrano-nomad
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/axsuul/capistrano-nomad
+  source_code_uri: https://github.com/axsuul/capistrano-nomad
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin for deploying and managing Nomad jobs
+test_files: []