Directories
¶
| Path | Synopsis |
|---|---|
|
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. |
|
Package alert sends notices about cluster events to people (ADR 0045): a JSON webhook, Slack, Discord, Telegram, or email over SMTP.
|
Package alert sends notices about cluster events to people (ADR 0045): a JSON webhook, Slack, Discord, Telegram, or email over SMTP. |
|
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. |
|
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). |
|
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. |
|
Package clidoc writes the command line reference (docs/cli) from the commands themselves, so it never drifts from them.
|
Package clidoc writes the command line reference (docs/cli) from the commands themselves, so it never drifts from them. |
|
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. |
|
sshtest
Package sshtest stands in for ssh(1) in tests.
|
Package sshtest stands in for ssh(1) in tests. |
|
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). |
|
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). |
|
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. |
|
Package dnsserver is the node-local resolver for app containers.
|
Package dnsserver is the node-local resolver for app containers. |
|
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. |
|
etcdtest
Package etcdtest starts embedded etcd members for tests on loopback ports picked at run time.
|
Package etcdtest starts embedded etcd members for tests on loopback ports picked at run time. |
|
Package fsutil writes and reads sensitive files with strict permissions.
|
Package fsutil writes and reads sensitive files with strict permissions. |
|
Package logexport sends app output to a log store outside the cluster (ADR 0044): a Loki push endpoint or an OTLP/HTTP logs endpoint, both as JSON, gzipped.
|
Package logexport sends app output to a log store outside the cluster (ADR 0044): a Loki push endpoint or an OTLP/HTTP logs endpoint, both as JSON, gzipped. |
|
Package netutil enforces that internal services only listen on private network addresses.
|
Package netutil enforces that internal services only listen on private network addresses. |
|
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. |
|
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). |
|
fake
Package fake provides an in-memory proxy.Driver for tests.
|
Package fake provides an in-memory proxy.Driver for tests. |
|
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. |
|
Package queuelen reads the length of a Redis list or a RabbitMQ queue for queue autoscaling rules (ADR 0034).
|
Package queuelen reads the length of a Redis list or a RabbitMQ queue for queue autoscaling rules (ADR 0034). |
|
Package release finds Armada's latest release and compares versions (ADR 0030).
|
Package release finds Armada's latest release and compares versions (ADR 0030). |
|
Package runtime abstracts the container engine.
|
Package runtime abstracts the container engine. |
|
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, network sandboxes, 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, network sandboxes, and errors. |
|
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). |
|
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). |
|
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. |
|
fake
Package fake provides an in-memory runtime.Driver for tests.
|
Package fake provides an in-memory runtime.Driver for tests. |
|
imagecheck
Package imagecheck checks that an image's layers are what its config says they are before a runtime reuses an unpacked layer for it.
|
Package imagecheck checks that an image's layers are what its config says they are before a runtime reuses an unpacked layer for it. |
|
supervisor
Package supervisor is the container runtime of ADR 0046: images and container records kept by the agent itself, containers supervised by armada-shim.
|
Package supervisor is the container runtime of ADR 0046: images and container records kept by the agent itself, containers supervised by armada-shim. |
|
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. |
|
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. |
|
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. |
|
Package store persists cluster state.
|
Package store persists cluster state. |
|
storetest
Package storetest provides etcd-backed stores for tests in other packages.
|
Package storetest provides etcd-backed stores for tests in other packages. |
|
Package version exposes build metadata for the armada binary.
|
Package version exposes build metadata for the armada binary. |
|
Package volbackup keeps deduplicated, encrypted backups of volumes (ADR 0041) and of the control plane (ADR 0051) in an S3-compatible bucket.
|
Package volbackup keeps deduplicated, encrypted backups of volumes (ADR 0041) and of the control plane (ADR 0051) in an S3-compatible bucket. |
Click to show internal directories.
Click to hide internal directories.