feat(htp): improve readme

honeycombio · Jan 22, 2025 · 6f4469e · 6f4469e
1 parent dd344bd
commit 6f4469e
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 20 deletions.
diff --git a/charts/htp/Chart.yaml b/charts/htp/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: htp
 description: Honeycomb Telemetry Pipeline
 type: application
-version: 0.0.1-alpha
+version: 0.0.2-alpha
 appVersion: 1.84.2
 home: https://honeycomb.io
 sources:

diff --git a/charts/htp/README.md b/charts/htp/README.md
@@ -16,21 +16,6 @@ Kubernetes 1.24+
 helm repo add honeycomb https://honeycombio.github.io/helm-charts
 ```
 
-### Install helm chart with hard-coded secrets
-
-The easiest way to install the chart is by setting the license key directly:
-
-```sh
-export LICENSE_KEY='your-license-key'
-
-helm install htp honeycomb/htp \
-  --set htp.config.licenseUseSecret=false \
-  --set htp.config.license=$LICENSE_KEY \
-  --set htp.config.username='admin' \
-  --set htp.config.password='admin' \
-  --set htp.config.sessions_secret=$(uuidgen)
-```
-
 ### Install helm chart with secret
 
 The best practice is to manage your secret separately.
@@ -41,19 +26,32 @@ export LICENSE_KEY='your-license-key'
 
 kubectl create secret generic hny-secrets \
   --from-literal=license=$LICENSE_KEY \
-  --from-literal=username=admin \
-  --from-literal=password=admin \
   --from-literal=sessions_secret=$(uuidgen)
 
 helm install htp honeycomb/htp
 ```
 
+### Install helm chart with hard-coded secrets
+
+If you cannot use secrets you can set the license key directly when installing the chart:
+
+```sh
+export LICENSE_KEY='your-license-key'
+
+helm install htp honeycomb/htp \
+  --set htp.config.licenseUseSecret=false \
+  --set htp.config.license=$LICENSE_KEY \
+  --set htp.config.sessions_secret=$(uuidgen)
+```
+
 ### Port-forward to view in UI
 
 ```sh
 kubectl port-forward svc/htp 3001
 ```
 
+By default the helm chart sets the username to `admin` and the password to `admin`.
+
 ## Values
 
 See the [subchart's values.yaml](https://github.com/observIQ/bindplane-op-helm/blob/main/charts/bindplane/values.yaml) for details.
diff --git a/charts/htp/values.yaml b/charts/htp/values.yaml
@@ -3,9 +3,9 @@
 htp:
   config:
     # Basic auth username to use for the default admin user
-    username: ''
+    username: 'admin'
     # Basic auth password to use for the default admin user
-    password: ''
+    password: 'admin'
     # Random UUIDv4 used to derive web interface session tokens
     sessions_secret: ''
     # Honeycomb HTP License Key