Improve Tornjak NOTES. Fixes #132 (#354)

* Improve Tornjak NOTES. Fixes #132

Signed-off-by: Mariusz Sabath <[email protected]>

* Fix Tornjak ingress value

Signed-off-by: Mariusz Sabath <[email protected]>

---------

Signed-off-by: Mariusz Sabath <[email protected]>
This commit is contained in:
Mariusz Sabath
2024-05-14 13:52:55 -07:00
committed by GitHub
parent a453a2c1b4
commit 2c5dfa010f
2 changed files with 23 additions and 5 deletions
@@ -10,18 +10,27 @@ Get the currently registered SPIFFE entries from the server:
Installed {{ include "spire-tornjak.fullname" . }}… Installed {{ include "spire-tornjak.fullname" . }}…
{{- if eq .Values.tornjak.config.userManagement.issuer "" }} {{- if eq .Values.tornjak.config.userManagement.issuer "" }}
### WARNING ### ### WARNING ###
Tornjak is configured to run without authentication and is therefore NOT suitable to run in production environments. Tornjak is configured to run without authentication and is therefore NOT suitable to run in production environments.
Only use in test environments! Only use in test environments!
{{- end }} {{- end }}
Access Tornjak: Access Tornjak API (Backend):
kubectl -n {{ include "spire-server.namespace" . }} port-forward service/{{ include "spire-tornjak.servicename" . }} {{ .Values.tornjak.service.ports.http }}:10000
{{- if .Values.tornjak.ingress.enabled }}
Connect to: {{ printf "https://tornjak-backend.%s" (include "spire-lib.trust-domain" .) }}
{{- else }}
kubectl -n {{ include "spire-server.namespace" . }} port-forward service/{{ include "spire-tornjak.servicename" . }} {{ .Values.tornjak.service.ports.http }}:10000
{{- if eq (include "spire-tornjak.connectionType" .) "http" }} {{- if eq (include "spire-tornjak.connectionType" .) "http" }}
Open browser to: http://localhost:{{ .Values.tornjak.service.ports.http }}
Connect to: http://localhost:{{ .Values.tornjak.service.ports.http }}
{{- else if eq (include "spire-tornjak.connectionType" .) "tls" }} {{- else if eq (include "spire-tornjak.connectionType" .) "tls" }}
Open browser to: https://localhost:{{ .Values.tornjak.service.ports.https }}
Connect to: https://localhost:{{ .Values.tornjak.service.ports.https }}
*** NOTE: You might get a security warning if using self-signed certificate *** NOTE: You might get a security warning if using self-signed certificate
or use curl: or use curl:
@@ -37,3 +46,4 @@ Access Tornjak:
ERROR! Incorrect value selected for "Values.tornjak.config.connectionType" ERROR! Incorrect value selected for "Values.tornjak.config.connectionType"
{{- end }} {{- end }}
{{- end }} {{- end }}
{{- end }}
@@ -15,19 +15,27 @@ Tornjak UI (Frontend)
{{- if .Values.auth.enabled }} {{- if .Values.auth.enabled }}
User Management API: "{{ .Values.auth.serverURL }}" User Management API: "{{ .Values.auth.serverURL }}"
{{- else }} {{- else }}
### WARNING ### ### WARNING ###
Tornjak is configured to run without authentication and is therefore NOT suitable to run in production environments. Tornjak is configured to run without authentication and is therefore NOT suitable to run in production environments.
Only use in test environments! Only use in test environments!
{{- end }} {{- end }}
Access Tornjak: Access Tornjak UI:
{{- if .Values.ingress.enabled }}
Open browser to:
{{ printf "https://tornjak-frontend.%s" (include "spire-lib.trust-domain" .) }}
{{- else }}
kubectl -n {{ include "tornjak-frontend.namespace" . }} port-forward service/{{ include "tornjak-frontend.fullname" . }} {{ .Values.service.port }}:3000 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. Ensure you have port-forwarding for tornjak-backend as well.
Open browser to: http://localhost:{{ .Values.service.port }} Open browser to: http://localhost:{{ .Values.service.port }}
{{- end }}
To learn more about the release, try: To learn more about the release, try: