Skip to content

Commit 517f4df

Browse files
committed
Fix: Update Helm docs to use Kubernetes secrets for API Keys
The archodex helm chart currently only supports using Kubernetes secrets for providing the API key. Updating docs to reflect this and provide more guidance.
1 parent 461689b commit 517f4df

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/content/docs/docs/getting-started/kubernetes.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Agent container runs on each Kubernetes Node.
2626
- **Chart Repository:** `https://helm.archodex.com`
2727
- **Chart Name:** `archodex-agent`
2828
- **Values:**
29-
- **`reportApiKey`:** (Optional) The Archodex Report API Key value. When provided, the agent containers will report
30-
observations periodically to your Archodex account.
29+
- **`reportApiKeySecretName`:** (Optional) The Kubernetes secret containing your Archodex Report API Key. When
30+
provided, the agent containers will report observations periodically to your Archodex account.
3131
- **`serviceEndpoint`:** (Optional) The Archodex Service Endpoint URL. Set this value to the location agent containers
3232
will send reports to when self-hosting. It must be resolvable within the cluster.
3333
- **`logReport`:** (Optional) Set to `'false'` to disable logging observations to agent container logs.
@@ -43,7 +43,11 @@ To install the Archodex Agent helm chart in your cluster using the helm CLI, fir
4343

4444
```sh
4545
$ helm repo add archodex https://helm.archodex.com
46-
$ helm install archodex-agent --set reportApiKey=<reportApiKey>
46+
# (Optional) Create a Kubernetes secret with your Report API Key to send
47+
# observations to your Archodex account
48+
$ kubectl create secret generic archodex-api-key --from-literal=value='<reportApiKey>'
49+
# Install the agent (include --set flag to enable reporting, omit for logging-only mode)
50+
$ helm install archodex-agent archodex/archodex-agent --set reportApiKeySecretName=archodex-api-key
4751
```
4852

4953
## Observing Individual Workloads

0 commit comments

Comments
 (0)