You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Armaël Guéneau 14476852d4 initial networking setup 3 months ago
example initial networking setup 3 months ago
hello initial networking setup 3 months ago
.gitignore improve documentation 4 years ago
GNUmakefile improve documentation 4 years ago
LICENSE [COMPLIANCE] Update MPL 2.0 LICENSE 12 months ago build: cleanup go mod file, update go 1 year ago
go.mod Bump from 1.4.2 to 1.4.4 4 months ago
go.sum Bump from 1.4.2 to 1.4.4 4 months ago
main.go [COMPLIANCE] Add Copyright and License Headers 7 months ago

Nomad Skeleton Driver Plugin

Skeleton project for Nomad task driver plugins.

This project is intended for bootstrapping development of a new task driver plugin.


  • Go v1.18 or later (to compile the plugin)
  • Nomad v0.9+ (to run the plugin)

Building the Skeleton Plugin

Generate a new repository in your account from this template by clicking the Use this template button above.

Clone the repository somewhere in your computer. This project uses Go modules so you will need to set the environment variable GO111MODULE=on or work outside your GOPATH if it is set to auto or not declared.

$ git clone<ORG>/<REPO>git

Enter the plugin directory and update the paths in go.mod and main.go to match your repository path.

// go.mod

- module
+ module<ORG>/<REPO>
// main.go

package main

import (
    log ""
-   ""
+.  "<REPO>/<ORG>/hello"

Build the skeleton plugin.

$ make build

Deploying Driver Plugins in Nomad

The initial version of the skeleton is a simple task that outputs a greeting. You can try it out by starting a Nomad agent and running the job provided in the example folder:

$ make build
$ nomad agent -dev -config=./example/agent.hcl -plugin-dir=$(pwd)

# in another shell
$ nomad run ./example/example.nomad
$ nomad logs <ALLOCATION ID>

Code Organization

Follow the comments marked with a TODO tag to implement your driver's logic. For more information check the Nomad documentation on plugins.