Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
cmd
|
|
|
armada
command
Command armada is the client: it manages apps on an Armada cluster through the control plane's API.
|
Command armada is the client: it manages apps on an Armada cluster through the control plane's API. |
|
armadad
command
Command armadad runs on every machine of an Armada cluster: the control plane, the node agent, and the embedded container runtime.
|
Command armadad runs on every machine of an Armada cluster: the control plane, the node agent, and the embedded container runtime. |
|
internal
|
|
|
agent
Package agent runs on every node: it receives the desired set of replicas from the server and reconciles local containers against it.
|
Package agent runs on every node: it receives the desired set of replicas from the server and reconciles local containers against it. |
|
backup
Package backup creates and restores archives of a control plane: a snapshot of its etcd keyspace, the secrets master key, the cluster CA, the server certificate, ACME certificates, and the embedded agent's identity.
|
Package backup creates and restores archives of a control plane: a snapshot of its etcd keyspace, the secrets master key, the cluster CA, the server certificate, ACME certificates, and the embedded agent's identity. |
|
certs
Package certs obtains and renews TLS certificates on the control plane with ACME (certmagic).
|
Package certs obtains and renews TLS certificates on the control plane with ACME (certmagic). |
|
cli
Package cli wires the armada command tree: the client that talks to the control plane.
|
Package cli wires the armada command tree: the client that talks to the control plane. |
|
clientconfig
Package clientconfig loads and stores the CLI's credentials (~/.armada/config) and dials the control plane with them.
|
Package clientconfig loads and stores the CLI's credentials (~/.armada/config) and dials the control plane with them. |
|
clusternet
Package clusternet routes the cluster network's node subnets between nodes (ADR 0025).
|
Package clusternet routes the cluster network's node subnets between nodes (ADR 0025). |
|
conntrack
Package conntrack reads and raises the limit of the kernel's connection tracking table on a node (ADR 0025).
|
Package conntrack reads and raises the limit of the kernel's connection tracking table on a node (ADR 0025). |
|
daemon
Package daemon wires the armadad command tree: the services that run on every machine (control plane, agent, embedded runtime) and the commands that set a machine up or inspect it as root.
|
Package daemon wires the armadad command tree: the services that run on every machine (control plane, agent, embedded runtime) and the commands that set a machine up or inspect it as root. |
|
dnsserver
Package dnsserver is the node-local resolver for app containers.
|
Package dnsserver is the node-local resolver for app containers. |
|
etcd
Package etcd runs the embedded etcd member that holds the control plane's state, and connects clients to it.
|
Package etcd runs the embedded etcd member that holds the control plane's state, and connects clients to it. |
|
fsutil
Package fsutil writes and reads sensitive files with strict permissions.
|
Package fsutil writes and reads sensitive files with strict permissions. |
|
netutil
Package netutil enforces that internal services only listen on private network addresses.
|
Package netutil enforces that internal services only listen on private network addresses. |
|
pki
Package pki implements the cluster's internal certificate authority and the mTLS configuration used between the CLI, the server, and agents.
|
Package pki implements the cluster's internal certificate authority and the mTLS configuration used between the CLI, the server, and agents. |
|
proxy
Package proxy defines the ingress configuration pushed to every node and the Driver interface implemented by proxy backends (HAProxy in v0.1, Nginx planned for v0.2).
|
Package proxy defines the ingress configuration pushed to every node and the Driver interface implemented by proxy backends (HAProxy in v0.1, Nginx planned for v0.2). |
|
proxy/fake
Package fake provides an in-memory proxy.Driver for tests.
|
Package fake provides an in-memory proxy.Driver for tests. |
|
proxy/haproxy
Package haproxy implements proxy.Driver with HAProxy running as an Armada-managed system container.
|
Package haproxy implements proxy.Driver with HAProxy running as an Armada-managed system container. |
|
release
Package release finds Armada's latest release and compares versions (ADR 0030).
|
Package release finds Armada's latest release and compares versions (ADR 0030). |
|
runtime
Package runtime abstracts the container engine.
|
Package runtime abstracts the container engine. |
|
runtime/conformance
Package conformance tests that the container runtime behaves as Armada needs (ADR 0011): the security defaults, checked from inside containers, the container lifecycle, labels, publishing on a private address, logs, exec, stats, volumes, and errors.
|
Package conformance tests that the container runtime behaves as Armada needs (ADR 0011): the security defaults, checked from inside containers, the container lifecycle, labels, publishing on a private address, logs, exec, stats, volumes, and errors. |
|
runtime/containerd
Package containerd implements runtime.Driver on the containerd instance that Armada embeds (ADR 0011).
|
Package containerd implements runtime.Driver on the containerd instance that Armada embeds (ADR 0011). |
|
runtime/embedded
Package embedded runs containers on Armada's own containerd instance (ADR 0011).
|
Package embedded runs containers on Armada's own containerd instance (ADR 0011). |
|
runtime/embedded/mkbundle
command
Command mkbundle downloads the artifacts pinned in embedded.Lock, checks their SHA-256, and writes the runtime pack that release builds embed.
|
Command mkbundle downloads the artifacts pinned in embedded.Lock, checks their SHA-256, and writes the runtime pack that release builds embed. |
|
runtime/fake
Package fake provides an in-memory runtime.Driver for tests.
|
Package fake provides an in-memory runtime.Driver for tests. |
|
secrets
Package secrets encrypts secret values at rest with envelope encryption and provides a value type that never prints its contents.
|
Package secrets encrypts secret values at rest with envelope encryption and provides a value type that never prints its contents. |
|
server
Package server implements the control plane: the gRPC API for the CLI and agents, and the reconciler that turns desired state into assignments.
|
Package server implements the control plane: the gRPC API for the CLI and agents, and the reconciler that turns desired state into assignments. |
|
spec
Package spec defines the user-facing app configuration format, its strict YAML parsing, defaulting, and validation.
|
Package spec defines the user-facing app configuration format, its strict YAML parsing, defaulting, and validation. |
|
store
Package store persists cluster state.
|
Package store persists cluster state. |
|
store/storetest
Package storetest provides etcd-backed stores for tests in other packages.
|
Package storetest provides etcd-backed stores for tests in other packages. |
|
version
Package version exposes build metadata for the armada binary.
|
Package version exposes build metadata for the armada binary. |
Click to show internal directories.
Click to hide internal directories.