Running nodes

Configuration and files

A node’s settings are in one file, agent.yml. The controller sets most of them. It writes the file during setup. Later it can change parts of the file over the socket, such as the images when it updates the agent or the plugin. You edit the rest, such as the memory cap, on the host.

agent.yml

The file is /srv/ankor/agent.yml. Its schema is AgentConfigSchema in agent-config.ts.

token: 3f1c…
controller:
  host: cs.example.com
  tls: true
pinned_ip: 203.0.113.7
cs2_image: ghcr.io/ankorcs/ankor-cs2:0.9
agent_image: ghcr.io/ankorcs/ankor-agent:0.9
memory_mb: 1536
demo_upload:
  url: https://demos.example.com/upload
  header:
    name: Authorization
    value: Bearer 9b2e…
  limit_mbit: 40
slots:
  - id: s1
    port: 27015
    tv_port: 27020
    gslt: 0123456789ABCDEF0123456789ABCDEF
  - id: s2
    port: 27016
    tv_port: 27021
    gslt: FEDCBA9876543210FEDCBA9876543210

• A nested key is required only when its parent is present.
• The agent warns about keys it does not know and ignores them.
• A file that fails validation stops the agent, and its log lists each invalid key.
• A controller on a private address or localhost, including 127.0.0.1:<port> on the node’s host, usually needs tls: false under controller. No certificate authority issues certificates for those addresses.

Changing settings

The controller can change slots, pinned_ip, auto_update, controller, demo_upload and memory_mb while the node is connected, with set_config.

• The agent refuses an edit that would disturb an occupied slot. It also refuses any change to the controller address while a slot is occupied. The AgentErrorCode in its reply names the case. Stop new launches on the node in the controller, wait for the slots to go idle, then edit again.
• Demo settings and changes to idle slots apply while other slots are occupied.
• An offline node cannot receive a corrected address. Fix controller.host in the file and restart the agent.
• A slot’s login token can be changed while the slot runs a server. The server keeps the token it started with until it ends. Revoking that token at Steam drops the server, so replace a token once its slot is idle.

Edit the other keys in the file on the host, then restart the agent.

File layout

Everything a node keeps is under /srv/ankor/ or in the Docker volume ankor_cs2_data.

In the game container

Node paths are relative to /srv/ankor/, and container paths to /home/steam/cs2-dedicated/game/. Each column is a tree. A row names its path relative to the row it is indented under. The rest of the install is the Docker volume ankor_cs2_data. Every server shares it read-only, and only a CS2 update writes to it.

A launch runs your cfgs from cfg/ by naming them in exec. The protocol guide lists when they run, and their order among the game mode’s cfg and Ankor’s.

SwiftlyS2 gives a plugin its paths through these functions. They map to these directories on the node:

Data and logs stay across the slot’s launches.

Only on the node

No game container mounts these. Only the agent reads and writes them.