Configuration

JSON configuration file specification for the unbounded-agent.

The agent reads a JSON config file whose path is set through the UNBOUNDED_AGENT_CONFIG_FILE environment variable. This config can be generated from the cluster using the kubectl unbounded machine manual-bootstrap command, or authored by hand.

The same config is used by unbounded-agent start and unbounded-agent preflight. Before bootstrap, run preflight on the target host to validate the loaded config, host prerequisites, API server reachability, artifact sources, nspawn provisioning paths, and GPU driver readiness when applicable. See Agent Preflight for command usage, exit behavior, and the current check list.

Example

{
  "MachineName": "mysite-worker-01",
  "Cluster": {
    "CaCertBase64": "<base64-encoded CA certificate>",
    "ClusterDNS": "10.0.0.10",
    "Version": "1.33.1"
  },
  "Kubelet": {
    "ApiServer": "https://api.example.com:6443",
    "BootstrapToken": "abc123.0123456789abcdef",
    "Labels": {
      "unbounded-cloud.io/site": "mysite"
    },
    "RegisterWithTaints": []
  }
}

Fields

Field	Description
`MachineName`	(optional) Name of the Kubernetes `Machine` and node. When omitted, the agent resolves it at startup from the `AGENT_MACHINE_NAME` environment variable, falling back to the host hostname.
`Cluster.CaCertBase64`	Base64-encoded cluster CA certificate.
`Cluster.ClusterDNS`	ClusterIP of the kube-dns Service.
`Cluster.Version`	Kubernetes version to install (e.g. `1.33.1`).
`Kubelet.ApiServer`	Address of the Kubernetes API server.
`Kubelet.BootstrapToken`	Token used for TLS bootstrapping (omit when using TPM attestation).
`Kubelet.Labels`	Key-value labels applied to the Node on registration.
`Kubelet.RegisterWithTaints`	Taints applied to the Node on registration (`key=value:effect`).
`OCIImage`	(optional) OCI registry reference, `oci-layout://` directory, or HTTPS URL to a tarred OCI image layout. Uses the built-in default image when empty. The agent automatically selects the archive’s single tagged image reference. HTTPS URLs may include signed query strings such as Azure Blob SAS parameters.
`OfflineArtifacts.Source`	(optional) Complete bootstrap artifact source. Accepts an absolute directory, `file://` directory, `oci://` artifact reference, or HTTPS tar/tar.gz archive. HTTPS archives are downloaded and extracted into the host artifact cache, and their URLs may include signed query strings such as Azure Blob SAS parameters.
`Attest.URL`	(optional) Base URL of a metalman serve-pxe instance for TPM attestation.

Edit this page on GitHub