Skip to content

Commit a5e4997

Browse files
committed
Clarify HTTPRoute Gateway references in chart docs
1 parent 51b43e9 commit a5e4997

3 files changed

Lines changed: 27 additions & 13 deletions

File tree

helm-chart/README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ EOF
2525
helm install onyxia onyxia/onyxia --version "10.32.5" -f onyxia-values.yaml
2626
```
2727

28-
To expose Onyxia with the Kubernetes Gateway API instead of an Ingress, use an `HTTPRoute`:
28+
To expose Onyxia with the Kubernetes Gateway API instead of an Ingress, use an `HTTPRoute`.
29+
The `parentRefs` entries must point to the `Gateway` already configured by your cluster administrator:
2930

3031
```bash
3132
cat << EOF > ./onyxia-values.yaml
@@ -93,16 +94,6 @@ Documentation reference for the available configuration parameter of the Onyxia
9394
Below is a sample `onyxia-values.yaml` file that illustrates where to specify the `api` and `web` configuration parameters.
9495

9596
```diff
96-
ingress:
97-
enabled: true
98-
hosts:
99-
- host: datalab.yourdomain.com
100-
+httpRoute:
101-
+ enabled: true
102-
+ parentRefs:
103-
+ - name: onyxia-gateway
104-
+ hostnames:
105-
+ - datalab.yourdomain.com
10697
+web:
10798
+ env:
10899
+ HEADER_LOGO=https://example.com/logo.svg
@@ -125,6 +116,27 @@ Below is a sample `onyxia-values.yaml` file that illustrates where to specify th
125116
+ # ...
126117
```
127118

119+
Ingress example:
120+
121+
```yaml
122+
ingress:
123+
enabled: true
124+
hosts:
125+
- host: datalab.yourdomain.com
126+
```
127+
128+
HTTPRoute example:
129+
130+
```yaml
131+
httpRoute:
132+
enabled: true
133+
parentRefs:
134+
# Reference the Gateway configured by your cluster administrator.
135+
- name: onyxia-gateway
136+
hostnames:
137+
- datalab.yourdomain.com
138+
```
139+
128140
## Catalogs `x-onyxia` specifications
129141

130142
If you are building your own service catalog for Onyxia ([learn how](https://docs.onyxia.sh/catalog-of-services)).

helm-chart/templates/httproute.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ metadata:
1313
name: {{ $fullName }}
1414
labels:
1515
{{- include "onyxia.labels" . | nindent 4 }}
16-
annotations:
1716
{{- with .Values.httpRoute.annotations }}
17+
annotations:
1818
{{- toYaml . | nindent 4 }}
1919
{{- end }}
2020
spec:

helm-chart/values.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ httpRoute:
1717
enabled: false
1818
annotations: {}
1919
parentRefs:
20-
- name: ""
20+
# parentRefs must reference the Gateway configured by the cluster administrator.
21+
# parentRefs[0].name is required when httpRoute.enabled=true.
22+
- name: onyxia-gateway
2123
# namespace:
2224
# sectionName:
2325
# port:

0 commit comments

Comments
 (0)