Configuration

Global config file: ~/.nr/config.yaml. Override the directory with --config-dir.

API

api:
  base_url: "https://api.noderings.com"
  timeout: 20
  tls_insecure: false   # never true in production
  ca_cert_path: ""      # optional PEM CA for private roots

API URL precedence

--api-url
NR_API_URL / API_BASE_URL / NODERINGS_API_URL
api.base_url in config (production default https://api.noderings.com)

Authentication

auth:
  token: ""                 # optional service account JWT
  token_file: "~/.nr/tokens"
  refresh_threshold: 300    # seconds before OAuth expiry to refresh

Token resolution order: Authentication how-to.

File-backed tokens use mode 0600. Prefer the OS keyring for interactive OAuth when available.

Logging

logging:
  level: "info"
  file: "~/.nr/nr.log"

Install defaults

Local YAML provides fallbacks when the API omits a component pin. Prefer server pins from the platform versions endpoint during register.

downloads:
  verify_checksums: true

k3s:
  version: ""               # usually filled by server pin
  kubeconfig_mode: "600"

calico:
  version: "v3.30.2"
  rollout_timeout: "10m"

liqo:
  version: ""               # usually filled by server pin
  timeout: "10m"
  gw_service_type: "NodePort"
  gw_server_service_location: "Provider"
  pod_offloading_strategy: "Local"

You normally do not need to edit these for production. The CLI fetches pinned versions before install.

State directory

Per-agent checkpoints and metadata live under ~/.nr/ (for example cluster state files). Do not copy this directory between machines. See Local state.