Documentation
¶
Overview ¶
Command shardkeep-agent runs on every Node. It connects outbound to the Controller over mTLS and turns desired state into running containers.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
artifacts
Package artifacts keeps the Agent's cache of software artifacts, fetched from the Controller over mTLS.
|
Package artifacts keeps the Agent's cache of software artifacts, fetched from the Controller over mTLS. |
|
backup
Package backup takes, stores, exports and restores server data.
|
Package backup takes, stores, exports and restores server data. |
|
docker
Package docker is a small Docker Engine API client built on the standard library.
|
Package docker is a small Docker Engine API client built on the standard library. |
|
files
Package files is the Agent's file manager for server data.
|
Package files is the Agent's file manager for server data. |
|
hostinfo
Package hostinfo reads what the Agent reports about its Node: capacity (CPU, memory, disk), current usage and pressure conditions.
|
Package hostinfo reads what the Agent reports about its Node: capacity (CPU, memory, disk), current usage and pressure conditions. |
|
identity
Package identity keeps the Agent's identity: its private key, its Node certificate and the Controller CA it trusts.
|
Package identity keeps the Agent's identity: its private key, its Node certificate and the Controller CA it trusts. |
|
localstate
Package localstate keeps what the Agent must remember across restarts and Controller outages: the last desired specs it received, the events it recorded but the Controller has not acknowledged, and whether the Node was revoked.
|
Package localstate keeps what the Agent must remember across restarts and Controller outages: the last desired specs it received, the events it recorded but the Controller has not acknowledged, and whether the Node was revoked. |
|
netconfig
Package netconfig writes what Shardkeep manages in servers' files for the network: the proxy's whole Velocity configuration, and on members the settings that make them accept only players the proxy forwards.
|
Package netconfig writes what Shardkeep manages in servers' files for the network: the proxy's whole Velocity configuration, and on members the settings that make them accept only players the proxy forwards. |
|
operations
Package operations carries out the Controller's requests about one server: console commands, the live console, and the file manager.
|
Package operations carries out the Controller's requests about one server: console commands, the live console, and the file manager. |
|
reconcile
Package reconcile converges each server on the Node to its desired spec: it validates the spec, creates, starts, stops or deletes the server's container, watches it with the status ping, applies the restart policy, and reports observed state and events.
|
Package reconcile converges each server on the Node to its desired spec: it validates the spec, creates, starts, stops or deletes the server's container, watches it with the status ping, applies the restart policy, and reports observed state and events. |
|
runtime
Package runtime runs servers as Docker containers: one hardened container and one named volume per server.
|
Package runtime runs servers as Docker containers: one hardened container and one named volume per server. |
|
schedule
Package schedule runs servers' schedules on the Agent, from the specs it stores, so they keep running while the Controller is down.
|
Package schedule runs servers' schedules on the Agent, from the specs it stores, so they keep running while the Controller is down. |
|
session
Package session holds the Agent's long-lived mTLS session with the Controller: Hello, Welcome, heartbeats and the exchange of server state and events, reconnecting with backoff when the connection drops.
|
Package session holds the Agent's long-lived mTLS session with the Controller: Hello, Welcome, heartbeats and the exchange of server state and events, reconnecting with backoff when the connection drops. |
|
slp
Package slp implements the Minecraft Server List Ping, which the Agent uses to decide a server is RUNNING: the server answers a status request on its game port.
|
Package slp implements the Minecraft Server List Ping, which the Agent uses to decide a server is RUNNING: the server answers a status request on its game port. |
|
templates
Package templates maps the template names in server specs to what the Agent actually runs.
|
Package templates maps the template names in server specs to what the Agent actually runs. |
Click to show internal directories.
Click to hide internal directories.