717741a4cb
* doc: nomad debug cli * CHANGELOG * website/data/docs-navigation: add debug to navigation * contributing/checklist-command: add website nav link to checklist |
||
|---|---|---|
| .. | ||
| checklist-command.md | ||
| checklist-jobspec.md | ||
| checklist-rpc-endpoint.md | ||
| golang.md | ||
| 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.
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: