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]>
This commit is contained in:
Marco Franssen
2023-05-16 19:31:38 +02:00
parent 80d34f0485
commit 6ddf6ab9fa
6 changed files with 60 additions and 36 deletions
@@ -8,15 +8,19 @@ Namespace: {{ include "tornjak-frontend.namespace" . }}
Tornjak UI (Frontend)
image: {{ template "spire-lib.image" (dict "appVersion" $.Chart.AppVersion "image" .Values.image "global" .Values.global) }}
pull policy: {{ .Values.image.pullPolicy }}
Configured with Tornjak API (Backend): {{ include "tornjak-frontend.apiURL" . }}
Tornjak API (Backend): {{ include "tornjak-frontend.apiURL" . }}
### WARNING ###
This Tornjak is configured without authentication and it is intended for
testing only. Please do not use this version in production.
You can use port forwarding to access UI:
Tornjak runs without authentication and is therefore NOT suitable to run in production environments.
Only use in test environments!
Access Tornjak:
kubectl -n {{ include "tornjak-frontend.namespace" . }} port-forward service/{{ include "tornjak-frontend.fullname" . }} {{ .Values.service.port }}:3000
Ensure you have port-forwarding for tornjak-backend as well.
Open browser to: http://localhost:{{ .Values.service.port }}
To learn more about the release, try: