History

Tim Gross 724f82e32d docs: add metrics and API docs to RPC contributors checklist		2021-01-04 15:41:12 -05:00
..
checklist-command.md
checklist-jobspec.md	docs: note manual jobspec parsing generally no longer required	2020-11-30 09:46:40 -06:00
checklist-rpc-endpoint.md	docs: add metrics and API docs to RPC contributors checklist	2021-01-04 15:41:12 -05:00
golang.md	build: upgrade from Go 1.15.5 -> 1.15.6	2021-01-04 08:34:00 -08:00
issue-labels.md	docs: add contributor docs for issue labels (#8723 )	2020-08-24 10:19:57 -04:00
README.md	build: upgrade from Go 1.15.5 -> 1.15.6	2021-01-04 08:34:00 -08:00

README.md

Nomad Codebase Documentation

This directory contains some documentation about the Nomad codebase, aimed at readers who are interested in making code contributions.

If you're looking for information on using Nomad, please instead refer to the Nomad website.

Developing with Vagrant

A development environment is supplied via Vagrant to make getting started easier.

Install Vagrant
Install Virtualbox
Bring up the Vagrant project
```
$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
$ vagrant up
```
The virtual machine will launch, and a provisioning script will install the needed dependencies within the VM.
SSH into the VM
```
$ vagrant ssh
```

Developing without Vagrant

Install Go 1.15.6+ (Note: gcc-go is not supported)

Clone this repo

$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad

Bootstrap your environment
```
$ make bootstrap
```
(Optionally) Set a higher ulimit, as Nomad creates many file handles during normal operations
```
$ [ "$(ulimit -n)" -lt 1024 ] && ulimit -n 1024
```
Verify you can run tests
```
$ make test
```

Running a development build

Compile a development binary (see the UI README to include the web UI in the binary)
```
$ make dev
# find the built binary at ./bin/nomad
```
Start the agent in dev mode
```
$ sudo bin/nomad agent -dev
```
(Optionally) Run Consul to enable service discovery and health checks
1. Download Consul
2. Start Consul in dev mode
```
$ consul agent -dev
```

Compiling Protobufs

If in the course of your development you change a Protobuf file (those ending in .proto), you'll need to recompile the protos.

Install Buf
Compile Protobufs
```
$ make proto
```

Building the Web UI

See the UI README for instructions.

Create a release binary

To create a release binary:

$ make prerelease
$ make release
$ ls ./pkg

This will generate all the static assets, compile Nomad for multiple platforms and place the resulting binaries into the ./pkg directory.

API Compatibility

Only the api/ and plugins/ packages are intended to be imported by other projects. The root Nomad module does not follow semver and is not intended to be imported directly by other projects.

Architecture

The code for Nomad's major components is organized as:

api/ provides a Go client for Nomad's HTTP API.
client/ contains Nomad's client agent code.
command/ contains Nomad's CLI code.
nomad/ contains Nomad's server agent code.
ui/ contains Nomad's UI code.
website/ contains Nomad's website and documentation.

The high level control flow for many Nomad actions (via the CLI or UI) are:

# Read actions:
Client -> HTTP API -> RPC -> StateStore

# Actions that change state:
Client -> HTTP API -> RPC -> Raft -> FSM -> StateStore

Checklists

When adding new features to Nomad there are often many places to make changes. It is difficult to determine where changes must be made and easy to make mistakes.

The following checklists are meant to be copied and pasted into PRs to give developers and reviewers confidence that the proper changes have been made:

Tooling

Go tool versions