Improve tornjak docs (#276)

- Align tornjak backend naming with same convention as frontend - Align Tornjak backend and frontend notes style - Add disclaimer for Tornjak usage to example --------- Signed-off-by: Marco Franssen <[email protected]>
2023-05-16 19:31:38 +02:00
parent 80d34f0485
commit 6ddf6ab9fa
6 changed files with 60 additions and 36 deletions
@@ -1,5 +1,7 @@
 # Recommended setup to deploy Tornjak

+> **Warning**: The current version of Tornjak in this chart is deployed without authentication. Therefore it is not suitable to run this version in production.
+
 To install Spire with the least privileges possible we deploy spire across 2 namespaces.

 ```shell
@@ -9,11 +11,27 @@ kubectl create namespace "spire-server"
 kubectl label namespace "spire-server" pod-security.kubernetes.io/enforce=restricted

 # deploy SPIRE with Tornjak enabled
-helm upgrade --install --namespace spire-server --values ../production/values.yaml \
- --values ./values.yaml spire charts/spire
+helm upgrade --install --namespace spire-server \
+  --values ../production/values.yaml \
+  --values ./values.yaml \
+  --render-subchart-notes \
+  spire charts/spire

 # test the Tornjak deployment
 helm test spire -n spire-server
 ```

+## Access tornjak
+
+To access Tornjak you will have to use port-forwarding for the time being *(until we add authentication and ingress)*.
+
+Run following commands from your shell, if you ran with different values your namespace might differ. Consult the install notes printed when running above `helm upgrade` command in that case.
+
+```shell
+kubectl -n spire-server port-forward service/spire-tornjak-backend 10000:10000
+kubectl -n spire-server port-forward service/spire-tornjak-frontend 3000:3000
+```
+
+You can now access Tornjak at [localhost:3000](http://localhost:3000).
+
 See [values.yaml](./values.yaml) for more details on the chart configurations to achieve this setup.