Skip to content

Commit

Permalink
Merge pull request #1560 from inteon/gatewayapi_core_group
Browse files Browse the repository at this point in the history
Fix bug in docs saying group should be core instead of the empty string
  • Loading branch information
inteon committed Sep 18, 2024
2 parents e1db5f9 + 6d567ee commit 2087fd2
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions content/docs/usage/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ spec:
certificateRefs:
- name: example-com-tls
kind: Secret
group: core
group: ""
# ❌ "mode: Passthrough" is not supported, the following listener is skipped.
- name: example-3
Expand All @@ -199,7 +199,7 @@ spec:
certificateRefs:
- name: example-com-tls
kind: Secret
group: core
group: ""
# ❌ Cross-namespace secret references are not supported, the following listener is skipped.
- name: example-4
Expand All @@ -214,7 +214,7 @@ spec:
certificateRefs:
- name: example-com-tls
kind: Secret
group: core
group: ""
namespace: other-namespace
# ✅ The following listener is valid.
Expand All @@ -229,8 +229,8 @@ spec:
mode: Terminate # ✅ Required. "Terminate" is the only supported mode.
certificateRefs:
- name: example-com-tls # ✅ Required.
kind: Secret # ✅ Required. "Secret" is the only valid value.
group: core # ✅ Required. "core" is the only valid value.
kind: Secret # ✅ Optional. "Secret" is the only valid value.
group: "" # ✅ Optional. "" is the only valid value.
```

cert-manager has skipped over the first four listener blocks and has created a
Expand Down Expand Up @@ -275,8 +275,6 @@ spec:
mode: Terminate
certificateRefs:
- name: example-com-tls
kind: Secret
group: core
# Listener 2: Same Secret name as Listener 1, with a different hostname.
- name: example-2
Expand All @@ -287,8 +285,6 @@ spec:
mode: Terminate
certificateRefs:
- name: example-com-tls
kind: Secret
group: core
# Listener 3: also same Secret name, except the hostname is also the same.
- name: example-3
Expand All @@ -299,8 +295,6 @@ spec:
mode: Terminate
certificateRefs:
- name: example-com-tls
kind: Secret
group: core
# Listener 4: different Secret name.
- name: example-4
Expand All @@ -311,8 +305,6 @@ spec:
mode: Terminate
certificateRefs:
- name: site-org-tls
kind: Secret
group: core
```

cert-manager will create two Certificates since two Secret names are used:
Expand Down

0 comments on commit 2087fd2

Please sign in to comment.