From 5b976634abcf27a2ec2c0423dfb457a0649a1309 Mon Sep 17 00:00:00 2001 From: romain Date: Wed, 4 Oct 2023 16:20:45 +0200 Subject: [PATCH] Update config documentation --- charts/warpstream-agent/Chart.yaml | 2 +- charts/warpstream-agent/README.md | 7 +++++-- charts/warpstream-agent/values.yaml | 3 +++ 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/charts/warpstream-agent/Chart.yaml b/charts/warpstream-agent/Chart.yaml index e8c32fb..968d97a 100644 --- a/charts/warpstream-agent/Chart.yaml +++ b/charts/warpstream-agent/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: warpstream-agent description: WarpStream Agent for Kubernetes. type: application -version: 0.2.0 +version: 0.2.1 appVersion: v507 icon: https://avatars.githubusercontent.com/u/132156278 home: https://docs.warpstream.com/warpstream/ diff --git a/charts/warpstream-agent/README.md b/charts/warpstream-agent/README.md index 717cd84..b17cc52 100644 --- a/charts/warpstream-agent/README.md +++ b/charts/warpstream-agent/README.md @@ -16,11 +16,14 @@ This chart requires Helm v3.6 or later. helm repo add warpstream https://warpstreamlabs.github.io/charts helm repo update helm upgrade --install warpstream-agent warpstream/warpstream-agent \ - --set config.bucketURL="mem://mem_bucket" \ + --set config.bucketURL="$YOUR_OBJECT_STORE" \ --set config.apiKey="$YOUR_API_KEY" \ --set config.virtualClusterID="$YOUR_VIRTUAL_CLUSTER_ID" ``` +To learn what values to set for those config variables, look at our documentation +for [configuring the WarpStream Agents for production](https://docs.warpstream.com/warpstream/how-to/configure-the-warpstream-agent-for-production). + ### Upgrade an existing release ```shell @@ -38,7 +41,7 @@ See [`values.yaml`](./values.yaml). git clone https://github.com/warpstreamlabs/charts cd charts/warpstream-agent helm upgrade --install warpstream-agent . \ - --set config.bucketURL="mem://mem_bucket" \ + --set config.bucketURL="$YOUR_OBJECT_STORE" \ --set config.apiKey="$YOUR_API_KEY" \ --set config.virtualClusterID="$YOUR_VIRTUAL_CLUSTER_ID" ``` diff --git a/charts/warpstream-agent/values.yaml b/charts/warpstream-agent/values.yaml index 7da1e1c..7d048f7 100644 --- a/charts/warpstream-agent/values.yaml +++ b/charts/warpstream-agent/values.yaml @@ -32,6 +32,9 @@ service: config: playground: false + ## To learn what values to set for the config variables, look at our documentation + ## for configuring the WarpStream Agents for production. + ## https://docs.warpstream.com/warpstream/how-to/configure-the-warpstream-agent-for-production # bucketURL: "mem://mem_bucket" # apiKey: "YOUR_API_KEY" # virtualClusterID: "YOUR_VIRTUAL_CLUSTER_ID"