Skip to content

Commit 81aa9d7

Browse files
apkatsikasdominiquemetz
apkatsikas
authored and
dominiquemetz
committed
docs(keycloakx): add notes and README for httproute and listenerset
Signed-off-by: apkatsikas <apkatsikas@gmail.com>
1 parent 1bf76b7 commit 81aa9d7

2 files changed

Lines changed: 34 additions & 1 deletion

File tree

‎charts/keycloakx/README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,25 @@ The following table lists the configurable parameters of the Keycloak-X chart an
167167
| `networkPolicy.enabled` | If true, the ingress network policy is deployed | `false` |
168168
| `networkPolicy.extraFrom` | Allows to define allowed external ingress traffic (see Kubernetes doc for network policy `from` format) | `[]` |
169169
| `networkPolicy.egress` | Allows to define allowed egress from Keycloak pods (see Kubernetes doc for network policy `egress` format) | `[]` |
170+
| `httpRoute.enabled` | If `true`, a Gateway API HTTPRoute is created | `false` |
171+
| `httpRoute.labels` | Additional HTTPRoute labels | `{}` |
172+
| `httpRoute.annotations` | HTTPRoute annotations | `{}` |
173+
| `httpRoute.servicePort` | The Service port targeted by the HTTPRoute | `80` |
174+
| `httpRoute.parentRefs` | Gateways this HTTPRoute is attached to. Unused when `listenerSet.enabled` is `true` | see values.yaml |
175+
| `httpRoute.hostnames` | Hostnames matching HTTP header. Unused when `listenerSet.enabled` is `true` | `[chart-example.local]` |
176+
| `httpRoute.rules` | List of rules and filters applied | see values.yaml |
177+
| `httpRoute.console.enabled` | If `true`, a separate HTTPRoute is created for the admin console path only | `false` |
178+
| `httpRoute.console.labels` | Additional labels for the console HTTPRoute | `{}` |
179+
| `httpRoute.console.annotations` | Annotations for the console HTTPRoute | `{}` |
180+
| `httpRoute.console.parentRefs` | Gateways the console HTTPRoute is attached to. Falls back to `httpRoute.parentRefs` if unset | see values.yaml |
181+
| `httpRoute.console.hostnames` | Hostnames for the console HTTPRoute. Falls back to `httpRoute.hostnames` if unset | `[chart-example.local]` |
182+
| `httpRoute.console.rules` | Rules for the console HTTPRoute | see values.yaml |
183+
| `httpRoute.listenerSet.enabled` | If `true`, a Gateway API ListenerSet is created alongside the HTTPRoute, enabling namespace-level listener configuration without Gateway write access | `false` |
184+
| `httpRoute.listenerSet.labels` | Additional ListenerSet labels | `{}` |
185+
| `httpRoute.listenerSet.annotations` | ListenerSet annotations | `{}` |
186+
| `httpRoute.listenerSet.parentRef.name` | Name of the Gateway this ListenerSet attaches to | `gateway` |
187+
| `httpRoute.listenerSet.parentRef.namespace` | Namespace of the Gateway this ListenerSet attaches to | `""` |
188+
| `httpRoute.listenerSet.listeners` | Listeners to attach to the Gateway. Full Gateway API listener spec accepted. Listener hostnames are used to populate the HTTPRoute `hostnames` field | `[]` |
170189
| `route.enabled` | If `true`, an OpenShift Route is created | `false` |
171190
| `route.path` | Path for the Route | `/` |
172191
| `route.annotations` | Route annotations | `{}` |

‎charts/keycloakx/templates/NOTES.txt‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,21 @@
44
* *
55
***********************************************************************
66

7-
{{- if .Values.ingress.enabled }}
7+
{{- if and .Values.httpRoute.enabled .Values.httpRoute.listenerSet.enabled }}
8+
9+
Keycloak was installed with a Gateway API HTTPRoute and ListenerSet.
10+
The ListenerSet {{ include "keycloak.fullname" . }} attaches listeners to the Gateway "{{ .Values.httpRoute.listenerSet.parentRef.name }}"{{ with .Values.httpRoute.listenerSet.parentRef.namespace }} in namespace "{{ . }}"{{ end }}.
11+
12+
Ensure the Gateway is configured to allow ListenerSet attachment from namespace {{ .Release.Namespace }}.
13+
14+
{{- else if .Values.httpRoute.enabled }}
15+
16+
Keycloak was installed with a Gateway API HTTPRoute attached to:
17+
{{- range .Values.httpRoute.parentRefs }}
18+
- Gateway: {{ .name }}{{ with .sectionName }}, section: {{ . }}{{ end }}
19+
{{- end }}
20+
21+
{{- else if .Values.ingress.enabled }}
822

923
Keycloak was installed with an Ingress and an be reached at the following URL(s):
1024
{{ range $unused, $rule := .Values.ingress.rules }}

0 commit comments

Comments
 (0)