document

Author: jsirianni

README.md

@@ -23,6 +23,7 @@ The secret should have the following keys:
 - `password`: Basic auth password to use for the default admin user
 - `secret_key`: Random UUIDv4 to use for authenticating OpAMP clients
 - `sessions_secret`: Random UUIDv4 used to derive web interface session tokens
+- `license`: Your BindPlane license key
 
 Example: Create secret with `kubectl`:
 
@@ -31,7 +32,8 @@ kubectl -n default create secret generic bindplane \
   --from-literal=username=myuser \
   --from-literal=password=mypassword \
   --from-literal=secret_key=353753ca-ae48-40f9-9588-28cf86430910 \
-  --from-literal=sessions_secret=d9425db6-c4ee-4769-9c1f-a66987679e90
+  --from-literal=sessions_secret=d9425db6-c4ee-4769-9c1f-a66987679e90 \
+  --from-literal=license=your_license_key
 ```
 
 ## Configuration
@@ -110,4 +112,4 @@ BindPlane OP Helm follows the [CNCF Code of Conduct](https://github.com/cncf/fou
 
 # Other questions?
 
-Send us an [email](mailto:support@observiq.com), or open an issue with your question. We'd love to hear from you!
+Send us an [email](mailto:support@observiq.com), or open an issue with your question. We'd love to hear from you!

values/large.yaml

@@ -47,6 +47,7 @@ config:
   #   --from-literal=username=myuser \
   #   --from-literal=password=mypassword \
   #   --from-literal=secret_key=353753ca-ae48-40f9-9588-28cf86430910 \
-  #   --from-literal=sessions_secret=d9425db6-c4ee-4769-9c1f-a66987679e90
-  # -- Name of the Kubernetes secret which contains the `username`, `password`, `secret_key`, and `sessions_secret` configuration options.
+  #   --from-literal=sessions_secret=d9425db6-c4ee-4769-9c1f-a66987679e90 \
+  #   --from-literal=license=your_license_key
+  # -- Name of the Kubernetes secret which contains the `username`, `password`, `secret_key`, `sessions_secret`, and `license` configuration options.
   secret: bindplane

values/small.yaml

@@ -47,6 +47,7 @@ config:
   #   --from-literal=username=myuser \
   #   --from-literal=password=mypassword \
   #   --from-literal=secret_key=353753ca-ae48-40f9-9588-28cf86430910 \
-  #   --from-literal=sessions_secret=d9425db6-c4ee-4769-9c1f-a66987679e90
-  # -- Name of the Kubernetes secret which contains the `username`, `password`, `secret_key`, and `sessions_secret` configuration options.
+  #   --from-literal=sessions_secret=d9425db6-c4ee-4769-9c1f-a66987679e90 \
+  #   --from-literal=license=your_license_key
+  # -- Name of the Kubernetes secret which contains the `username`, `password`, `secret_key`, `sessions_secret`, and `license` configuration options.
   secret: bindplane