chore: add instructions for configuring NATS correctly in lagoon-remote

See nats-io/nats-server#3232 for details.
uselagoon · Sep 13, 2022 · 52b04b9 · 52b04b9
1 parent 17d9e39
commit 52b04b9
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/charts/lagoon-remote/README.md b/charts/lagoon-remote/README.md
@@ -35,3 +35,25 @@ helm uninstall lagoon-remote
 ## ServiceAccounts
 
 * The `kubernetesbuilddeploy` serviceaccount is bound to `cluster-admin`.
+
+## NATS
+
+This section only applies if using NATS for ssh-portal support.
+NATS and ssh-portal are currently disabled by default.
+
+### Configuring NATS
+
+The minimum configuration required to enable NATS is:
+
+```
+nats:
+  enabled: true
+  cluster:
+    name: lagoon-remote-example
+```
+
+Note that the cluster name used in Lagoon Core and each Lagoon Remote _must_ be unique in order for NATS routing to work correctly.
+
+### Securing NATS
+
+See the Lagoon Core chart README for instructions for securing NATS.
diff --git a/charts/lagoon-remote/ci/linter-values.yaml b/charts/lagoon-remote/ci/linter-values.yaml
@@ -29,6 +29,8 @@ mxoutHost: mxout1.example.com
 
 nats:
   enabled: true
+  cluster:
+    name: lagoon-remote-ci-example
   # natsbox:
   #   enabled: true
   #   # additional labels are required due to the network policy