[PLATFORM] Add Keycloak to ONAP
[oom.git] / kubernetes / platform / components / keycloak / templates / NOTES.txt
1 ***********************************************************************
2 *                                                                     *
3 *                Keycloak Helm Chart by codecentric AG                *
4 *                                                                     *
5 ***********************************************************************
6
7 {{- if .Values.ingress.enabled }}
8
9 Keycloak was installed with an Ingress and can be reached at the following URL(s):
10 {{ range $unused, $rule := .Values.ingress.rules }}
11   {{- range $rule.paths }}
12   {{- if $rule.host }}
13   - http{{ if $.Values.ingress.tls }}s{{ end }}://{{ tpl $rule.host $ }}{{ .path }}
14   {{- else }}
15   - http{{ if $.Values.ingress.tls }}s{{ end }}://<INGRESS_ADDRESS>{{ .path }}
16   {{-  end }}
17   {{-  end }}
18 {{- end }}
19
20 {{- else if eq "NodePort" .Values.service.type }}
21
22 Keycloak was installed with a Service of type NodePort.
23 {{ if .Values.service.httpNodePort }}
24 Get its HTTP URL with the following commands:
25
26 export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} service {{ include "keycloak.fullname" . }}-http --template='{{"{{ range .spec.ports }}{{ if eq .name \"http\" }}{{ .nodePort }}{{ end }}{{ end }}"}}')
27 export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
28 echo "http://$NODE_IP:$NODE_PORT"
29 {{- end }}
30 {{ if .Values.service.httpsNodePort }}
31 Get its HTTPS URL with the following commands:
32
33 export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} service {{ include "keycloak.fullname" . }}-http --template='{{"{{ range .spec.ports }}{{ if eq .name \"https\" }}{{ .nodePort }}{{ end }}{{ end }}"}}')
34 export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
35 echo "http://$NODE_IP:$NODE_PORT"
36 {{- end }}
37
38 {{- else if eq "LoadBalancer" .Values.service.type }}
39
40 Keycloak was installed with a Service of type LoadBalancer
41
42 NOTE: It may take a few minutes for the LoadBalancer IP to be available.
43      You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} service -w {{ include "keycloak.fullname" . }}'
44
45 Get its HTTP URL with the following commands:
46
47 export SERVICE_IP=$(kubectl get service --namespace {{ .Release.Namespace }} {{ include "keycloak.fullname" . }}-http --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
48 echo "http://$SERVICE_IP:{{ .Values.service.httpPort }}"
49
50 Get its HTTPS URL with the following commands:
51
52 export SERVICE_IP=$(kubectl get service --namespace {{ .Release.Namespace }} {{ include "keycloak.fullname" . }}-http --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
53 echo "http://$SERVICE_IP:{{ .Values.service.httpsPort }}"
54
55 {{- else if eq "ClusterIP" .Values.service.type }}
56
57 Keycloak was installed with a Service of type ClusterIP
58
59 Create a port-forwarding with the following commands:
60
61 export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "keycloak.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o name)
62 echo "Visit http://127.0.0.1:8080 to use your application"
63 kubectl --namespace {{ .Release.Namespace }} port-forward "$POD_NAME" 8080
64
65 {{- end }}