Skip to main content

Discovery Agent Helm Values Reference

The elchi-discovery chart is configured through Helm values. Three are required for a working agent: config.apiEndpoint, config.token and clusterName. Everything else has a usable default. The defaults below are the chart's values.yaml; print them for the version you install with helm show values elchi/elchi-discovery.

Required values​

ValueDescriptionDefault
config.apiEndpointFull URL of Elchi's discovery API: your Elchi address followed by /api/discovery/k8s, for example https://elchi.example.com/api/discovery/k8s. Must be a URI.https://<elchi-main-address>/api/discovery/k8s (placeholder)
config.tokenThe project's discovery token from Settings → Tokens (<uuid>--<project>). The agent sends it as a Bearer token. Without it the install prints a warning, and Elchi rejects the reports.""
clusterNameName this cluster reports under. Must be non-empty (the install fails otherwise) and unique per project, because endpoint resources refer to clusters by name.x-cluster

Agent behaviour​

ValueDescriptionDefault
discoveryIntervalSeconds between reports. Allowed range 10 to 3600.30
config.insecureSkipVerifySkip TLS certificate verification when calling config.apiEndpoint. Set it to false when Elchi's certificate is trusted by the cluster.true
config.log.leveldebug, info, warn or error.info
config.log.formatjson or text.json
config.log.outputstdout or stderr.stdout
timezoneContainer time zone, passed as TZ.Europe/Istanbul
timezonePathHost path mounted read-only at /etc/localtime./etc/localtime
envExtra environment variables, as name/value pairs.[]
envFromExtra environment from ConfigMaps or Secrets (configMapRef / secretRef).[]

The chart renders these into a ConfigMap and mounts it at /etc/elchi/config.yaml (the agent finds it through ELCHI_CONFIG):

elchi:
token: "<config.token>"
api_endpoint: "<config.apiEndpoint>"
insecure_skip_verify: true
log:
level: "info"
format: "json"
output: "stdout"
discovery_interval: 30
cluster_name: "<clusterName>"

Image, scheduling and resources​

ValueDescriptionDefault
replicaCountNumber of agent pods.1
image.repositoryAgent image.jhonbrownn/elchi-discovery
image.tagImage tag, pinned so helm rollback restores a known image. Empty falls back to the chart's appVersion.v1.0.0
image.pullPolicyAlways, IfNotPresent or Never.Always
imagePullSecretsPull secrets for a private registry mirror.[]
resourcesRequests 100m CPU / 64Mi memory, limits 200m / 128Mi.see values
nodeSelector, tolerations, affinityStandard pod scheduling controls.empty
podAnnotationsExtra annotations on the pod.{}
nameOverride, fullnameOverrideOverride the generated resource names.""

RBAC and pod security​

ValueDescriptionDefault
serviceAccount.createCreate a ServiceAccount for the agent.true
serviceAccount.nameUse this ServiceAccount name (generated when empty).""
serviceAccount.annotationsAnnotations on the ServiceAccount.{}
rbac.createCreate a ClusterRole and ClusterRoleBinding with get, list and watch on nodes, endpoints, services and pods.true
podSecurityContextRuns as UID/GID 65534 (non-root), fsGroup: 65534.see values
securityContextRead-only root filesystem, no privilege escalation, all capabilities dropped.see values

Example values file​

config:
apiEndpoint: "https://elchi.example.com/api/discovery/k8s"
token: "3f6c…--my-project"
insecureSkipVerify: false
log:
level: info
clusterName: "prod-eu-1"
discoveryInterval: 60
timezone: "UTC"

Install it with helm install elchi-discovery elchi/elchi-discovery -n elchi-stack --create-namespace -f values.yaml. See Installation for verification and upgrades.

One token, many clusters

All clusters that report to the same project share that project's discovery token; clusterName is what tells them apart. Regenerating or deleting the token in Settings → Tokens cuts off every agent that still uses the old one.