hashicorp/nomad-pack-community-registry

A repo for Packs written and maintained by Nomad community members

Nomad Pack Community Registry

This is a registry of community-maintained packs for Nomad Pack.

Writing your own Packs

For guidance on writing your own packs, see the Writing Packs Guide in the Nomad Pack repository.

Contributions and Feedback

Contributions are welcome in any form.

Pull Requests with new packs are highly encouraged! These packs could be common applications that you believe other Nomad users will want to deploy, tools to learn Nomad better, or examples of common patterns.

When submitting a Pack, please ensure you add a Readme that explains what the pack is and mention any dependencies that the pack has (such as Consul, Vault, Volumes, or Drivers).

Suggestions on helpful packs to add can found in the Repo Issues. Upvotes and comments on packs you are interested in will help the Nomad team and community prioritize which packs to write.

nomad-pack-community-registry's Issues

Pack: CockroachDB

Good getting started guide: https://www.cockroachlabs.com/docs/stable/secure-a-cluster.html

How does Nomad Pack pull these packs from the github repo?

I was curious if Nomad Pack is getting pack sources from github or a server that's hosting the sources, updating the server cache after the github repo is updated. Just asking out of curiosity. The only way to get a list of all the files in a subdirectory of the repository would be a git pull of the entire repository (perhaps without the entire repo history) or using the GitHub API. I would imagine it's against GH's terms to serve content from GitHub for an application integration like this.

pack: add demo pack to deploy Prometheus and Grafana to replace Nomad integrations dir

Nomad has an integrations directory which includes some example configuration and dashboarding for Prometheus and Grafana. This directory is stale and does not provide a great amount of value; whereas a demo pack would provide greater value.

I propose adding a new demo_promtheus_grafana pack which deploys a single job with these two applications. It will include basic configuration and example dashboards which can be used for demos, as well as to gain initial insight into running these applications as a Nomad job.

Once the pack is available, the files from Nomad should be removed with a marker file pointing to the new pack.

chore: Move packs to `packs` sub-directory.

Pack: Kafka

Add a Kafka Pack

Pack: Basic system job

A pack which deploys a system job with basic parameterization would be helpful for educational purposes.

Pack URLs should be tested and updated to be correct and consistent for this registry

Currently, the pack.url is user-specified metadata and is inconsistent across packs in the registry.

Proposals:

1. Add tooling to generate the proper URL on a GH event (merge to main, maybe?)

or

2. Add URL checking for both URLs in the the metadata.hcl file to validate that they are resolvable as a commit check?

or

3. maybe both?

Pack: Jenkins

Add a Jenkins Pack - https://www.jenkins.io/

Pack: Selenium

Add a Selenium pack

Pack: Basic cron batch job

A pack which deploys a cron batch job with basic parameterization would be helpful for educational purposes.

This could be part of the geberal basic cron job pack, or its own pack.

nomad_ingress_nginx Multiple job rendering failed

Hi ，I started multiple jobs using the same service, but I found that when I started the second job, it would fail and lose the first one that has been rendered successfully. Normally, I want an ingress load to work with multiple jobs

Pack: Consul-Terraform-Sync

A pack that allows network engineers to easily schedule CTS processes in Nomad.

It would require as inputs:

• Consul license
• "cts-config.hcl"

source:
https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-terraform-enterprise?in=consul/network-infrastructure-automation#the-terraform-cloud-driver-block

Pack: Consul

Add a pack for Consul

Pack: Grafana OnCall

This seems like an excellent way to demonstrate the task dependencies (task lifecycles), and best practice around task and groups, and service discovery, etc.

Reference docker-compose:
https://github.com/grafana/oncall/blob/dev/docker-compose.yml

Pack: Prometheus

A pack that deploys Prometheus

Pack: Tempo

Add a pack for Grafana Tempo

Pack Contest

Hi @mikenomitch ,

I was wondering if the contest to win t-shirts was still a thing that was happening (this one from the blog: https://www.hashicorp.com/blog/share-your-nomad-packs-for-a-pack-contest), and if so, how is it communicated and/or is there a way to see who was included in each month's draw?

Looking at PRs, mine (#100) was one of 3 for December, so was kinda hoping for a T-Shirt :)

Thanks!

Pack: Basic docker service job

A pack which deploys a docker service job with basic parameterization would be helpful for educational purposes.

Pack: Promscale

Docker guide: https://docs.timescale.com/promscale/latest/installation/docker/

Clarification on stateful workloads

Hi!

I am looking to send a PR for a Listmonk pack. It requires to run a PostgreSQL database as a dependency. What would be the best way to create volume/mount config blocks here? Should we assume a CSI plugin is used and create a volume resource in the pack? Or keep it simple and provide an example with host_volumes (Note: That also requires the user to enable them)

bug: simple_service fails to parse outputs

Running this command

nomad-pack run simple_service --var="count=4"

Generates the following error.

! Failed To Render Output Template

    Error:   failed to render outputs.tpl: template: outputs.tpl:7:18: executing "outputs.tpl" at <.hello_world.register_consul_service>: nil pointer evaluating interface {}.register_consul_service
    Type:    *errors.errorString
    Context: 
             - Pack Name: simple_service

Pack: add etcd pack for deploying etcd to Nomad

Application documentation: https://etcd.io/

A number of useful cluster tools, such as Calico, only support etcd as a non-kubernetes datastore. It would therefore be useful to have a pack which minimally runs etcd on Nomad as a service job.

Defined Standards & Best Practices for Packs

Hello!

While creating a couple of packs to submit to the registry I immediately noticed some areas where there were multiple ways a scenario could be handled. A few scenarios that came up:

1. Application configuration files handling
2. Setting up Vault configurations.
3. Configuring task mounts.

For the packs I ended up creating, I ultimately decided to go with the "Provide a sane default while allowing the user to customize/override this" approach which I realized quickly could be implemented in many different ways.

Common scenarios like template blocks for configuration files, vault blocks for secrets, and custom mount configurations needed for users specific environments will pop up in nearly all packs and it would make life for both end-users and pack creators much simpler if there were some well defined guidelines for how these common scenarios should be implemented.

For example, handling vault configurations. Per the Nomad Job Specification, this block can be defined from Job level scope all the way down to individual Task level scopes. If a pack provides task(s) that allow for passing in configuration options, I think it makes sense for that package to facilitate enabling vault access as needed in the job spec so that users can securely provide those options if they choose to.

In order to provide a consistent experience across the official packs in the community, there should exist a standard way for "enabling" vault usage in a pack. This would include providing a set of standard variables declarations as well as boilerplate template (or possibly creating a predefined builtin function/template with sprig) code that should be added to the job template.

IMHO, defining, implementing and documenting these sorts of standards early on will greatly reduce the learning curve by providing concrete ways to handle some of the most common implementation details.

Just wanted to throw the idea out there and see if this was something that had been considered or is worth having a discussion about.

Thanks!

Pack: Sentry

Guide for running Sentry: https://develop.sentry.dev/self-hosted/ (they're using docker-compose)

Pack: Apache Airflow

Pack: Grafana

Add a pack that deploys a service Grafana

Pack: Zookeeper

Add a Zookeeper Pack

Pack: gitlab-ci runner

Add gitlab-ci runner pack

Pack: ELK Stack

Podman should be an option instead of hard coding docker driver

Packs that use docker images all use the docker driver. Not sure about other nomad drivers but podman should also work in the templates. I can fork the repo and find/replace the docker driver with podman, but it would be nice if it was a variable with docker as the default.

Pack: VerneMQ

Add a pack for VerneMQ

CSI driver for direct attached storage

As there are already a few CSI drivers in the registry https://github.com/minio/directpv might be a good addition.

Pack: Wordpress

Add a Wordpress pack

Pack: CoreDNS

link to repo: https://github.com/coredns/coredns

Pack: Basic parameterized job

A pack which deploys a parameterized job with basic parameterization would be helpful for educational purposes.

Pack: Basic exec service job

A pack which deploys an exec service job with basic parameterization would be helpful for educational purposes.

Pack: Mastodon

creating a mastodon pack, based on this docker compose file seems to be 5 moving parts

Postgres
Redis
One or more rails web application processes
One or more worker processes
One or more node streaming processes

Here’s the docker compose file:
https://github.com/mastodon/mastodon/blob/main/docker-compose.yml

I know at least one other potential user, so I’m opening this issue to see if anyone more experienced with nomad pack would be up for collaborating on creating this.

Pack: deployment of GitHub Runners

A Nomad pack to deploy github action runners in Nomad.

There are a couple of projects mentioned here that have a Nomad example, mainly:

• https://github.com/myoung34/docker-github-actions-runner#nomad
• https://github.com/aslafy-z/github-runner

This could be accompanied by a webhook style operator to trigger the deployment/scaling of said runners, as explained here https://docs.github.com/en/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners

Pack: Vault

Add a pack for Vault

Pack: Common CSI Plugins

Add packs for common CSI plugins

Pack: add Falco implementation

Falco running guide: https://falco.org/docs/getting-started/running/#docker

Pack: Nomad Autoscaler

Add a Nomad autoscaler pack.

Feel free to use these templates (from another tool) as reference - https://github.com/mikenomitch/nomad-packages/tree/main/autoscaler

Pack: MLOps

Add an MLOps Pack

Pack: Redis

Would be great to have a Redis pack.

Some guidance/explanation on volumes would be great too. :)

Pack: Boundary

Initial pack to install the core boundary application on Nomad.

Pack: Loki

Add a Loki Pack

Pack: Basic batch job

A pack which deploys a batch job with basic parameterization would be helpful for educational purposes.

jenkins pack fails to run chown tasks on systems to blacklist root user

the jenkins pack tries to run the chown task as root, which is a user that is on the default deny list. This should be documented or reworked imho.

Pack: Grafana Nomad Exemplars

Add a pack or helper for Nomad metrics.

Issues with heredoc within included hcl variables

I'm writing my own version of the traefik pack (needs a lot of modification for internal use) and this:

variable "toml_config" {
	type = string
	description = "traefik.toml config"
	default     = <<EOF
[entryPoints]
  [entryPoints.http]
  address = ":8080"
  [entryPoints.traefik]
  address = ":1936"
[api]
  dashboard = true
  insecure = true
[providers.consulCatalog]
  prefix           = "traefik"
  exposedByDefault = false
[providers.consulCatalog.endpoint]
  address = "{{ env "attr.unique.network.ip-address" }}:8500"
  scheme  = "http"
EOF
}

Produces exactly that block, no problems.

However, when doing nomad-pack render -f vars.hcl . where vars.hcl contains

toml_config = <<EOF
[example]
  toml-config
EOF

The error is

! Failed To Process Pack

	Error:   No closing marker was found for the string.
	Type:    *errors.errorString
	Context:
	         - HCL Range: test.hcl:28,4-4
	         - Registry Name: dev
	         - Pack Name: traefik
	         - Pack Ref: dev

I've gotten through everything else but this problem without too much trouble, but this one really has me stuck...

I can use a string literal here (and I am, for now) but that's really unmaintainable long-term.