kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-01 16:05:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: extend code layout in contributing guides (#25330)

Browse Source 
Expand this document with some rough signposts to the major packages that developers will need to know about when getting started.
This commit is contained in:
Tim Gross
2025-03-10 11:55:38 -04:00
committed by GitHub
parent 182c46a746
commit 4a1b050eb8
1 changed files with 31 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
contributing/README.md
View File

@@ -108,14 +108,38 @@ Only the `api/` and `plugins/` packages are intended to be imported by other pro
## Architecture
The code for Nomad's major components is organized as:
When working on Nomad, there are a few major packages that are the entrypoint
for most tasks you might be working on:
* `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.
* `acl/`: The definition of ACL policies and authorization methods
* `api/`: The public-facing Go SDK for the HTTP API.
* `client/`: Most of the code that runs in the Nomad client agents.
* `client/allocrunner/`: The code that manages a single allocation, including
hooks for workload identity, CSI, and networking. The allocrunner calls into
`taskrunner` for each task.
* `client/allocrunner/taskrunner/`: The code that manages a single task within
an allocation, including hooks for artifacts, templates, Consul service
mesh, logging, etc. The task runner invokes the task driver found in
`drivers`.
* `command/`: The definition of Nomad CLI commands, most of which use the HTTP
API.
* `command/agent/`: The parts of the Nomad agent that are neither server or
client, including the HTTP API server and configuration parsing.
* `command/agent/consul/`: The Consul API client for service registration.
* `drivers/`: The implementations of the built-in `docker`, `exec`, `raw_exec`,
`java`, and `qemu` task drivers, as well as shared "executor" code.
* `e2e/` and `enos/`: Packages defining infrastructure and tests for nightly
end-to-end testing.
* `nomad/`: The Nomad server code, including RPC handlers, running a Raft node,
the plan applier, the eval broker, and the keyring.
* `nomad/state/`: The in-memory state (memdb) of the Nomad servers
* `nomad/structs/`: Type definitions used in RPC and state.
* `plugins/`: Interface definitions for task drivers, device drivers, and CSI
drivers. Implementations can be found in `drivers` (and as external repos).
* `scheduler/`: The logic for scheduling workloads lives here, called from the
server code in `nomad`.
* `ui/`: The web UI.
* `website/`: The documentation website.
The high level control flow for many Nomad actions (via the CLI or UI) are: