Skip to main content

Enable Workloads

Workloads run on a Nex node that Control Plane tells what to run. Enable the Workloads platform component on your system, connect a Nex node to it, then enable Workloads on each account that deploys them.

Enable the Workloads component​

  • In Control Plane, go to Settings for your NATS system.
  • Scroll to Enable Workloads, nested under the Platform section, and turn it on. Click Submit at the top.
  • Click the Component Token button below Enable Workloads and copy the token. The Nex node uses it to register with Control Plane.

Connect a Nex node​

In the node's configuration, turn on the platform connection, point it at your Control Plane, and set the component token you copied:

{
  "platform": {
    "enabled": true,
    "url": "https://<your control plane>",
    "token": "<your workloads component token>"
  }
}

Control Plane supplies the NATS servers and the control account, so the configuration omits them. For every option, see Nex deployment.

Enable Workloads on an account​

Workloads are enabled per account, which lets you control who can deploy them.

  • Open the account you deploy to, go to Settings, and turn on Enable Workloads. Click Save.
  • A Workloads tab appears in the account navigation.

Workload logs​

Output from your running workloads is published to subjects inside your account:

  • STDOUT: $NEX.logs.<Account ID>.*.stdout
  • STDERR: $NEX.logs.<Account ID>.*.stderr

To keep the logs for later, set a Workload Log Stream in the account's settings and these subjects are added to that stream.