◐ Shell
clean mode source ↗

GitHub - rocketDuck/dobby: Dobby deploys jobs to nomad

⚠️ unmaintained: With the introduction of HCLv2 in nomad 1.0 it is no longer easily possible to handle the nomad files since functions in HCL require client side evaluation.

Dobby is a Jinja-powered opensource templating and deployment tool for HashiCorp Nomad inspired by Levant.

⚠️ pre-release version: The name and functionality of the project might change without warning till the first release.

Features

  • Deployment monitoring: Dobby waits for a deployment to finish, making it ideal for CI/CD usage.
  • Jinja2 templating: Templates are based on the powerful Jinja2 templating language, which allows for recursive template inclusions etc...
  • Variable file formats: Dobby currently supports .json, .yaml and .env file formats for template variables as well as operating system environment variables (more below).

Download & Install

See GitHub releases for binaries.

Example

A small example is shown below (try on your own shell for more colors ;)):

$ dobby deploy --var-file examples/vars.yaml examples/redis.nomad
Planned changes:

+ Job: "redis"
+ Task Group: "redis" (1 create)
  + Task: "redis" (forces create)

Scheduler dry-run:
- All tasks successfully allocated.

Job Submission:
- Monitoring evaluation '4bd2eb5f-36ab-4a0d-6355-91c17e8ec205'.
- Evaluation '4bd2eb5f-36ab-4a0d-6355-91c17e8ec205' completed successfully.
- Monitoring deployment 'cb857ab3-db31-cd4f-a3b3-a5175be15ad0'.
- Deployment 'cb857ab3-db31-cd4f-a3b3-a5175be15ad0' completed successfully.

Job deployment finished succesfully.

Templating

Dobby reads template variables from a variety of files (.json/.yaml/.env) and is able to merge multiple variable files before passing them on to Jinja2. To prevent conflicts with Nomad-Templates, Jinja is configured to use square instead of curly brackets (ie [[ job.name ]] instead of {{ job.name }}).

Additionally Dobby takes environment variables into account since it can be annoying to create a variable file in CI/CD just to override one variable (the job name could be a common example). Environment variables are supported by upper-casing variable names, removing underscores and hyphens as well as replacing dots with underscores. This means a variable file ala:

job:
    name: test
    dc: dc22
    db_url: postgresql://host/db

can be also specified via the following environment variables:

JOB_NAME=test
JOB_DC=dc22
JOB_DBURL=postgresql://host/db