|
1 | | -ingress: |
2 | | - annotations: |
3 | | - nginx.ingress.kubernetes.io/proxy-body-size: "0" |
4 | | - nginx.ingress.kubernetes.io/proxy-read-timeout: "600" |
5 | | - nginx.ingress.kubernetes.io/proxy-send-timeout: "600" |
| 1 | +Thank you for installing {{ .Chart.Name }}. |
| 2 | + |
| 3 | +Your STAC Auth Proxy has been deployed with the following configuration: |
| 4 | + |
| 5 | +1. Application Access: |
| 6 | +{{- if .Values.ingress.enabled }} |
| 7 | +{{- if .Values.ingress.host }} |
| 8 | + Your proxy is available at: |
| 9 | + {{- if .Values.ingress.tls.enabled }} |
| 10 | + https://{{ .Values.ingress.host }} |
| 11 | + {{- else }} |
| 12 | + http://{{ .Values.ingress.host }} |
| 13 | + {{- end }} |
| 14 | +{{- end }} |
| 15 | +{{- else if contains "NodePort" .Values.service.type }} |
| 16 | + Get the application URL by running these commands: |
| 17 | + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "stac-auth-proxy.fullname" . }}) |
| 18 | + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") |
| 19 | + echo http://$NODE_IP:$NODE_PORT |
| 20 | +{{- else if contains "LoadBalancer" .Values.service.type }} |
| 21 | + Get the application URL by running these commands: |
| 22 | + NOTE: It may take a few minutes for the LoadBalancer IP to be available. |
| 23 | + You can watch the status by running: |
| 24 | + kubectl get svc --namespace {{ .Release.Namespace }} {{ include "stac-auth-proxy.fullname" . }} -w |
| 25 | + |
| 26 | + Once ready, get the external IP/hostname with: |
| 27 | + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "stac-auth-proxy.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") |
| 28 | + echo http://$SERVICE_IP:{{ .Values.service.port }} |
| 29 | +{{- else }} |
| 30 | + The service is accessible within the cluster at: |
| 31 | + {{ include "stac-auth-proxy.fullname" . }}.{{ .Release.Namespace }}.svc.cluster.local:{{ .Values.service.port }} |
| 32 | +{{- end }} |
| 33 | + |
| 34 | +2. Configuration Details: |
| 35 | + - Upstream STAC API: {{ .Values.config.upstreamUrl }} |
| 36 | + - OIDC Discovery URL: {{ .Values.config.oidc.discoveryUrl }} |
| 37 | + - Health Check Endpoint: {{ .Values.config.healthzPrefix }} |
| 38 | + - Default Public Access: {{ .Values.config.defaultPublic }} |
| 39 | + |
| 40 | +3. Verify the deployment: |
| 41 | + kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "stac-auth-proxy.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" |
| 42 | + |
| 43 | +4. View the logs: |
| 44 | + kubectl logs --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "stac-auth-proxy.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" |
| 45 | + |
| 46 | +5. Health check: |
| 47 | +{{- if .Values.ingress.enabled }} |
| 48 | +{{- if .Values.ingress.host }} |
| 49 | + {{- if .Values.ingress.tls.enabled }} |
| 50 | + curl https://{{ .Values.ingress.host }}{{ .Values.config.healthzPrefix }} |
| 51 | + {{- else }} |
| 52 | + curl http://{{ .Values.ingress.host }}{{ .Values.config.healthzPrefix }} |
| 53 | + {{- end }} |
| 54 | +{{- end }} |
| 55 | +{{- else }} |
| 56 | + kubectl port-forward --namespace {{ .Release.Namespace }} service/{{ include "stac-auth-proxy.fullname" . }} 8000:{{ .Values.service.port }} |
| 57 | + curl http://localhost:8000{{ .Values.config.healthzPrefix }} |
| 58 | +{{- end }} |
| 59 | + |
| 60 | +For more information about STAC Auth Proxy, please visit: |
| 61 | +https://github.com/developmentseed/stac-auth-proxy |
| 62 | + |
| 63 | +{{- if or (not .Values.config.upstreamUrl) (not .Values.config.oidc.discoveryUrl) }} |
| 64 | +WARNING: Some required configuration values are not set. Please ensure you have configured: |
| 65 | +{{- if not .Values.config.upstreamUrl }} |
| 66 | + - config.upstreamUrl |
| 67 | +{{- end }} |
| 68 | +{{- if not .Values.config.oidc.discoveryUrl }} |
| 69 | + - config.oidc.discoveryUrl |
| 70 | +{{- end }} |
| 71 | +{{- end }} |
0 commit comments