Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix bug in docs saying group should be core instead of the empty string #1560

Merged
merged 1 commit into from
Sep 18, 2024
Merged

Fix bug in docs saying group should be core instead of the empty string #1560

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions content/docs/usage/gateway.md
View file
Open in desktop
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