Skip to main content
This page lists every configuration key you might need to touch, with its default and meaning: first the VM configuration file, then the Helm chart values. For task-oriented guidance, see the configuration guide.

VM configuration file

On a Linux VM the connector reads /etc/clicklink/config.yaml. clicklink clctl init writes it and keeps it across re-runs unless you pass --force. Keys omitted from the file fall back to the compiled defaults below. init writes no credentials into it: the HMAC keys live in the *_file paths and the client certificate under /etc/clicklink/tls.

Top-level keys

The daemons ignore an instances: section in this file. Instances live in the instance registry.

api

Instance registry

Instances live in /var/lib/clicklink/instances.yaml, a top-level instances: map keyed by name. init seeds it and the executor maintains it; the scraper watches the file, so edits apply without a restart. Each entry describes one ClickHouse native-protocol target:

scraper

troubleshooter

executor

The executor runs in managed mode. init --managed writes enabled: true and the cluster identity; the rest falls back to the defaults. executor.cluster is a single mapping: one cluster per executor. The loader folds a legacy one-entry clusters: list with no cluster: mapping into cluster. It refuses a list with more than one entry, or one beside a cluster: key, when the executor is enabled.

observability

Each daemon serves /livez (a JSON status body), /readyz, /healthz, and /metrics on one listener; there is no separate metrics port. Per-component observability blocks overlay this base: the scraper uses 8082, the troubleshooter 8084, the executor 8086, and the gateway listens on 8443 when enabled. A metrics_port key from an older configuration still loads but binds nothing.

Default table allowlist

The troubleshooter’s default allowed_tables set, identical to the chart’s troubleshooter.allowedTables default:

Helm chart values

On Kubernetes the connector is configured through the clicklink-connector chart’s values. clicklink clctl init stages a clicklink-values.yaml overlay with everything below filled in and keeps it across re-runs unless you pass --force. The tables list the chart defaults. Standard workload knobs (resources, nodeSelector, tolerations, affinity, serviceAccount.annotations, env) exist on each component with empty defaults and are not repeated per table.

Top-level keys

cluster

image

api

secrets

The chart consumes pre-created Secrets; init creates them before install.

scraper

troubleshooter

executor

The executor for managed mode: a single-replica Deployment on a PersistentVolumeClaim. init --managed stages it enabled with the cluster identity filled in. executor.cluster is a single mapping: one cluster per executor. A clusters list fails the render.

persistence

clctl.gateway

The session gateway for support sessions.

networkPolicy

Last modified on September 22, 2026