nomadsl 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '0127938dacfdb464f8ea34378d0abe6330c285b2'
-  data.tar.gz: 62317fa19f399de8449961f4972d892c2fc931f4
+SHA256:
+  metadata.gz: 7e373810efb5dc4ba6cb71d0788e6e114c6bb9db7f5eacd7aa45e5a3d5cf8903
+  data.tar.gz: 94270c72e2bf26c7c387c87ae9d612dbb5ce2de26decadec9559cd963d1440c1
 SHA512:
-  metadata.gz: 9a4d37afa4367cbc5c78bb4a81a65161ae38c85779c345c139a44d351eaad654be0e2f2fc7ac8aefd9bcb4c8e1bfd851eabd89296dab49812de46ba488d7c5c7
-  data.tar.gz: b57b996831ac58382c691fe36ab149effe3744b3f3663a9a1406ecb2745da71a4ff78400376ae1bec37d210a02a315981af4ec22c58f3a5c8396e1c430b49ed4
+  metadata.gz: 8f1d263ba2e882a691724734df548cd91fd948bbd15d6ed2a51d8b5a7a376548dd1e6faaab24067d4defb5f713f40731cf83d459193637a5f1d14a2bf845522d
+  data.tar.gz: 752afd8496be3adfbe72c38dc7890c85e3f724f64ab5515a59e41bbfb9f580cf7659a377241b03f72a6b41cd79781bf4d09a28bc1b1fbb73b91c7dfe5acd5ed7

data/README.md

@@ -2,11 +2,13 @@
 
 Nomadsl is a Ruby DSL for generating Nomad job specification files.
 
-Methods mapping to keys and attributes described in the Nomad Job Specification
-(https://www.nomadproject.io/docs/job-specification/index.html) are defined in
-an includable module.
+Methods mapping to keys and attributes described in the
+[Nomad Job Specification](https://www.nomadproject.io/docs/job-specification/index.html)
+are defined in an includable module.
 
-The mapping of key and attribute names to method names is generally one-to-one.
+Nomadsl supports Nomad configuration syntax through version 0.12.0. The mapping
+of key and attribute names to method names is generally one-to-one, but you can
+specify arbitrary configuration values to be rendered if necessary.
 
 ## Example: DSL direct to stdout
 
@@ -85,6 +87,21 @@ Will generate this output:
       }
     }
 
+## Using `nomadsl` as the interpreter
+
+You can also set your shbang line to use `nomadsl` as the interpreter of the
+script. This will evaluate everything as Ruby, but with the necessary `nomadsl`
+boilerplate already built in:
+
+    #!/usr/bin/env nomadsl
+
+    job "nomadsl-example" do
+      # ...
+    end
+
+If the file is then marked as executable, you can simply run it to generate
+the corresponding Nomad job specification.
+
 ## Other uses
 
 By requiring only `nomadsl`, you can inject these methods into another class:
@@ -107,7 +124,6 @@ By requiring only `nomadsl`, you can inject these methods into another class:
 
 ## Roadmap
 
-* Make all attributes explicitly callable
 * Make subkeys embeddable in arglists if sensible
 * Allow injecting comments into the rendered file
 * Finish custom config blocks for each task driver

data/bin/nomadsl

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'nomadsl/dsl'
+
+eval ARGF.read

data/lib/nomadsl.rb

@@ -13,6 +13,10 @@ module Nomadsl
     @nomadsl_print = b
   end
 
+  def parent
+    @stack.last
+  end
+
   def only(*levels)
     unless levels.include? @stack.last
       loc = caller_locations(1,1)[0]
@@ -69,6 +73,21 @@ module Nomadsl
     @out << "#{v.chomp}\nBLOB\n"
   end
 
+  def strmap!(k, v)
+    die "Value for '#{k}' is nil" if v.nil?
+    strmap(k, v)
+  end
+
+  def strmap(k, v)
+    if v
+      block(k) do
+        v.each do |k2,v2|
+          str k2, v2
+        end
+      end
+    end
+  end
+
   # try really hard
   def any(k, v)
     if v.nil?
@@ -137,18 +156,23 @@ module Nomadsl
       str! :source, source
       str :destination, destination
       str :mode, mode
-      if options
-        block(:options) do
-          options.each do |k,v|
-            str k, v
-          end
-        end
-      end
+      strmap :options, options
+    end
+  end
+
+  # https://www.nomadproject.io/docs/job-specification/affinity.html
+  def affinity(attribute: nil, operator: nil, value: nil, weight: nil)
+    only :job, :group, :task, :device
+    block(:affinity) do
+      str! :attribute, attribute
+      str :operator, operator
+      str! :value, value
+      int :weight, weight
     end
   end
 
   # https://www.nomadproject.io/docs/job-specification/service.html#check-parameters
-  def check(address_mode: nil, args: nil, command: nil, grpc_service: nil, grpc_use_tls: nil, initial_status: nil, interval: nil, method: nil, name: nil, path: nil, port: nil, protocol: nil, timeout: nil, type: nil, tls_skip_verify: nil)
+  def check(address_mode: nil, args: nil, command: nil, grpc_service: nil, grpc_use_tls: nil, initial_status: nil, interval: nil, method: nil, name: nil, path: nil, expose: nil, port: nil, protocol: nil, task: nil, timeout: nil, type: nil, tls_skip_verify: nil)
     only :service
     block(:check) do
       str :address_mode, address_mode
@@ -157,14 +181,16 @@ module Nomadsl
       str :grpc_service, grpc_service
       bool :grpc_use_tls, grpc_use_tls
       str :initial_status, initial_status
-      str :interval, interval
+      str! :interval, interval
       str :method, method
       str :name, name
       str :path, path
+      bool :expose, expose
       str :port, port
       str :protocol, protocol
-      str :timeout, timeout
-      str :type, type
+      str :task, task
+      str! :timeout, timeout
+      str! :type, type
       bool :tls_skip_verify, tls_skip_verify
       yield if block_given?
     end
@@ -182,7 +208,7 @@ module Nomadsl
 
   # https://www.nomadproject.io/docs/job-specification/task.html#config
   def config(**opts)
-    only :task
+    only :task, :sidecar_task, :proxy
     config_method = "__config_#{@driver}".to_sym
     if private_methods.include?(config_method)
       send(config_method, **opts)
@@ -204,10 +230,18 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/connect
+  def connect(native: nil)
+    only :service
+    block(:connect) do
+      bool :native, native
+      yield if block_given?
+    end
+  end
 
   # https://www.nomadproject.io/docs/job-specification/constraint.html
   def constraint(attribute: nil, operator: nil, value: nil)
-    only :job, :group, :task
+    only :job, :group, :task, :device
     block(:constraint) do
       str :attribute, attribute
       str :operator, operator
@@ -215,12 +249,31 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/csi_plugin
+  def csi_plugin(id: nil, type: nil, mount_dir: nil)
+    only :volume
+    block(:csi_plugin) do
+      str! :id, id
+      str! :type, type
+      str! :mount_dir, mount_dir
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/job.html#datacenters
   def datacenters(*d)
     only :job
     list! :datacenters, d
   end
 
+  # https://www.nomadproject.io/docs/job-specification/device.html
+  def device(name: nil, count: nil)
+    only :resources
+    block(:device, name) do
+      int :count, count
+      yield if block_given?
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/dispatch_payload.html
   def dispatch_payload(file:)
     only :task
@@ -229,14 +282,20 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/network#dns-parameters
+  def dns(servers: nil, searches: nil, options: nil)
+    only :network
+    block(:dns) do
+      list :servers, servers
+      list :searches, searches
+      list :options, options
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/env.html
   def env(**opts)
-    only :task
-    block(:env) do
-      opts.each do |k,v|
-        str k, v
-      end
-    end
+    only :task, :sidecar_task
+    strmap :env, opts
   end
 
   # https://www.nomadproject.io/docs/job-specification/ephemeral_disk.html
@@ -249,11 +308,21 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/expose
+  def expose
+    only :proxy
+    block(:expose) do
+      yield if block_given?
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/group.html
-  def group(name, count: nil)
+  def group(name, count: nil, shutdown_delay: nil, stop_after_client_disconnect: nil)
     only :job
     block(:group, name) do
       int :count, count
+      str :shutdown_delay, shutdown_delay
+      str :stop_after_client_disconnect, stop_after_client_disconnect
       yield
     end
   end
@@ -266,6 +335,15 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/lifecycle
+  def lifecycle(hook: nil, sidecar: nil)
+    only :task
+    block(:lifecycle) do
+      str :hook, hook
+      bool :sidecar, sidecar
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/job.html
   def job(j)
     # initialize the variables since this is the actual root
@@ -284,7 +362,7 @@ module Nomadsl
 
   # https://www.nomadproject.io/docs/job-specification/logs.html
   def logs(max_files: nil, max_file_size: nil)
-    only :task
+    only :task, :sidecar_task
     block(:logs) do
       int :max_files, max_files
       int :max_file_size, max_file_size
@@ -293,12 +371,8 @@ module Nomadsl
 
   # https://www.nomadproject.io/docs/job-specification/meta.html
   def meta(**opts)
-    only :job, :group, :task
-    block(:meta) do
-      opts.each do |k,v|
-        str k, v
-      end
-    end
+    only :job, :group, :task, :sidecar_task, :region
+    strmap :meta, opts
   end
 
   # https://www.nomadproject.io/docs/job-specification/migrate.html
@@ -312,6 +386,14 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/multiregion
+  def multiregion
+    only :job
+    block(:multiregion) do
+      yield if block_given?
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/job.html#namespace
   # Supported by Nomad Enterprise ONLY
   def namespace(n)
@@ -339,6 +421,17 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/expose#path-parameters
+  def path(path: nil, protocol: nil, local_path_port: nil)
+    only :expose
+    block(:path) do
+      str! :path, path
+      str! :protocol, protocol
+      int! :local_path_port, local_path_port
+      yield if block_given?
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/periodic.html
   def periodic(cron: nil, prohibit_overlap: nil, time_zone: nil)
     only :job
@@ -349,9 +442,15 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/scaling#policy
+  def policy(**args)
+    only :scaling
+    any :policy, args
+  end
+
   # https://www.nomadproject.io/docs/job-specification/network.html#port
   def port(n, static: nil)
-    only :network
+    only :network, :path
     if static
       block(:port, n) do
         int :static, static
@@ -367,10 +466,29 @@ module Nomadsl
     int! :priority, p
   end
 
+  # https://www.nomadproject.io/docs/job-specification/proxy
+  def proxy(local_service_address: nil, local_service_port: nil)
+    only :sidecar_service
+    block(:proxy) do
+      str :local_service_address, local_service_address
+      int :local_service_port, local_service_port
+      yield if block_given?
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/job.html#region
-  def region(r)
-    only :job
-    str! :region, r
+  # https://www.nomadproject.io/docs/job-specification/multiregion#region-parameters
+  def region(name, count: nil, datacenters: nil)
+    only :job, :multiregion
+    if parent == :job
+      str! :region, name
+    elsif parent == :multiregion
+      block(:region, name) do
+        int :count, count
+        list :datacenters, datacenters
+        yield if block_given?
+      end
+    end
   end
 
   # https://www.nomadproject.io/docs/job-specification/reschedule.html
@@ -388,10 +506,9 @@ module Nomadsl
 
   # https://www.nomadproject.io/docs/job-specification/resources.html
   def resources(cpu: nil, iops: nil, memory: nil)
-    only :task
+    only :task, :sidecar_task
     block(:resources) do
       int :cpu, cpu
-      int :iops, iops
       int :memory, memory
       yield if block_given?
     end
@@ -408,6 +525,17 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/scaling
+  def scaling(min: nil, max: nil, enabled: nil)
+    only :group
+    block(:scaling) do
+      int :min, min
+      int! :max, max
+      bool :enabled, enabled
+      yield if block_given?
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/service.html
   def service(address_mode: nil, canary_tags: nil, name: nil, port: nil, tags: nil)
     only :task
@@ -421,6 +549,58 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/sidecar_service
+  def sidecar_service(tags: nil, port: nil)
+    only :connect
+    block(:sidecar_service) do
+      list :tags, tags
+      int :port, port
+      yield if block_given?
+    end
+  end
+
+  # https://www.nomadproject.io/docs/job-specification/sidecar_task
+  def sidecar_task(name: nil, driver: nil, user: nil, logs: nil, kill_timeout: nil, shutdown_delay: nil, kill_signal: nil)
+    only :connect
+    block(:sidecar_task) do
+      str :name, name
+      str :driver, driver
+      str :user, user
+      str :kill_timeout, kill_timeout
+      str :shutdown_delay, shutdown_delay
+      str :kill_signal, kill_signal
+      yielf if block_given?
+    end
+  end
+
+  # https://www.nomadproject.io/docs/job-specification/spread.html
+  def spread(attribute: nil, weight: nil)
+    only :job, :group, :task
+    block(:spread) do
+      str! :attribute, attribute
+      int :weight, weight
+      yield if block_given?
+    end
+  end
+
+  # https://www.nomadproject.io/docs/job-specification/multiregion#strategy-parameters
+  def strategy(max_parallel: nil, on_failure: nil)
+    only :multiregion
+    block(:strategy) do
+      int :max_parallel, max_parallel
+      str :on_failure, on_failure
+    end
+  end
+
+  # https://www.nomadproject.io/docs/job-specification/spread.html#target-parameters
+  def target(name: nil, value: nil, percent: nil)
+    only :spread
+    block(:target, name) do
+      str :value, value
+      str :weight, weight
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/task.html
   def task(t, driver: "exec", kill_signal: nil, kill_timeout: nil, leader: nil, shutdown_delay: nil, user: nil)
     only :group
@@ -476,6 +656,15 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/upstreams
+  def upstreams(destination_name: nil, local_bind_port: nil)
+    only :proxy
+    block(:upstreams) do
+      str! :destination_name, destination_name
+      int! :local_bind_port, local_bind_port
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/vault.html
   def vault(change_mode: nil, change_token: nil, env: nil, policies: nil)
     only :job, :group, :task
@@ -487,6 +676,26 @@ module Nomadsl
     end
   end
 
+  # https://www.nomadproject.io/docs/job-specification/volume
+  def volume(name, type: nil, source: nil, read_only: nil)
+    only :group
+    block(:volume, name) do
+      str :type, type
+      str! :source, source
+      bool :read_only, read_only
+    end
+  end
+
+  # https://www.nomadproject.io/docs/job-specification/volume_mount
+  def volume_mount(volume: nil, destination: nil, read_only: nil)
+    only :task
+    block(:volume_mount) do
+      str! :volume, volume
+      str! :destination, destination
+      bool :read_only, read_only
+    end
+  end
+
   # https://www.nomadproject.io/docs/job-specification/job.html#vault_token
   # NOTE: explicitly unsupported, dangerous
 
@@ -502,43 +711,49 @@ module Nomadsl
     end
   end
 
+  def _vault_aws_creds(path, export)
+    prefix = export ? "export " : ""
+    path = path.is_a?(String) ? [path] : path
+    args = path.reduce("") do |concat, str|
+      concat = "#{concat} \"#{str}\""
+    end
+    <<~DATA
+      {{with secret #{args}}}
+      #{prefix}AWS_ACCESS_KEY_ID={{.Data.access_key}}
+      #{prefix}AWS_SECRET_ACCESS_KEY={{.Data.secret_key}}
+      {{if .Data.security_token}}
+      #{prefix}AWS_SESSION_TOKEN={{.Data.security_token}}
+      {{end}}
+      {{end}}
+    DATA
+  end
+
   def preloaded_vault_aws_creds(name, path)
-    data = <<DATA
-{{with secret "#{path}"}}
-AWS_ACCESS_KEY_ID={{.Data.access_key}}
-AWS_SECRET_ACCESS_KEY={{.Data.secret_key}}
-AWS_SESSION_TOKEN={{.Data.security_token}}
-{{end}}
-DATA
-    template(data: data, destination: "secrets/#{name}.env", env: true)
+    template(data: _vault_aws_creds(path, false), destination: "secrets/#{name}.env", env: true)
   end
 
   def vault_aws_creds(name, path)
-    data = <<DATA
-{{with secret "#{path}"}}
-export AWS_ACCESS_KEY_ID={{.Data.access_key}}
-export AWS_SECRET_ACCESS_KEY={{.Data.secret_key}}
-export AWS_SESSION_TOKEN={{.Data.security_token}}
-{{end}}
-DATA
-    template(data: data, destination: "secrets/#{name}.env")
+    template(data: _vault_aws_creds(path, true), destination: "secrets/#{name}.env")
+  end
+
+  def _vault_consul_creds(path, export)
+    prefix = export ? "export " : ""
+    path = path.is_a?(String) ? [path] : path
+    args = path.reduce("") do |concat, str|
+      concat = "#{concat} \"#{str}\""
+    end
+    <<~DATA
+      {{with secret #{args}}}
+      #{prefix}CONSUL_HTTP_TOKEN={{.Data.token}}
+      {{end}}
+    DATA
   end
 
   def preloaded_vault_consul_creds(name, path)
-    data = <<DATA
-{{with secret "#{path}"}}
-CONSUL_HTTP_TOKEN={{.Data.token}}
-{{end}}
-DATA
-    template(data: data, destination: "secrets/#{name}.env", env: true)
+    template(data: _vault_consul_creds(path, false), destination: "secrets/#{name}.env", env: true)
   end
 
   def vault_consul_creds(name, path)
-    data = <<DATA
-{{with secret "#{path}"}}
-export CONSUL_HTTP_TOKEN={{.Data.token}}
-{{end}}
-DATA
-    template(data: data, destination: "secrets/#{name}.env")
+    template(data: _vault_consul_creds(path, true), destination: "secrets/#{name}.env")
   end
 end

data/lib/nomadsl/version.rb

@@ -1,3 +1,3 @@
 module Nomadsl
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/nomadsl.gemspec

@@ -8,14 +8,17 @@ Gem::Specification.new do |s|
   s.date = Time.now.strftime('%Y-%m-%d')
   s.license = 'CC0'
   s.homepage = 'https://github.com/daveadams/nomadsl'
-  s.required_ruby_version = '>=2.4.0'
+  s.required_ruby_version = '>=2.5.0'
 
   s.summary = 'Ruby DSL for generating Nomad job specification files'
 
   s.require_paths = ['lib']
   s.files = Dir["lib/**/*.rb"] + [
+    'bin/nomadsl',
     'README.md',
     'LICENSE',
     'nomadsl.gemspec'
   ]
+  s.bindir = 'bin'
+  s.executables = ['nomadsl']
 end

metadata

@@ -1,23 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: nomadsl
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - David Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: daveadams@gmail.com
-executables: []
+executables:
+- nomadsl
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/nomadsl
 - lib/nomadsl.rb
 - lib/nomadsl/dsl.rb
 - lib/nomadsl/version.rb
@@ -34,15 +36,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby DSL for generating Nomad job specification files