Skip to content

docs: Add Getting Started guide for Gateway API support #21908

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
Merged
merged 2 commits into from
Nov 14, 2022
Merged

docs: Add Getting Started guide for Gateway API support #21908

merged 2 commits into from
Nov 14, 2022

Conversation

sayboras
Copy link
Member

@sayboras sayboras commented Oct 28, 2022 •
edited
Loading

Relates: #21749

The changes can be reviewed in https://deploy-preview-21908--docs-cilium-io.netlify.app/

docs: Add Getting Started guide for Gateway API support

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 28, 2022
@sayboras sayboras added the dont-merge/preview-only Only for preview or testing, don't merge it. label Oct 28, 2022
@sayboras sayboras force-pushed the tam/gateway-api-docs branch from f05125e to dfdbc8b Compare October 28, 2022 12:49
@sayboras sayboras mentioned this pull request Oct 28, 2022
Merged
30 tasks
@sayboras sayboras force-pushed the tam/gateway-api-docs branch 4 times, most recently from d3d3a8d to 3c8d968 Compare October 30, 2022 11:45
@sayboras sayboras changed the base branch from ft/master/gateway-api-support to master October 30, 2022 11:45
@sayboras sayboras force-pushed the tam/gateway-api-docs branch 2 times, most recently from b4d2fbe to ac981fe Compare October 30, 2022 13:52
@aanm aanm mentioned this pull request Oct 31, 2022
Closed
14 tasks
@sayboras sayboras force-pushed the tam/gateway-api-docs branch from ac981fe to 801c8d2 Compare October 31, 2022 10:28
@sayboras sayboras removed dont-merge/preview-only Only for preview or testing, don't merge it. dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Oct 31, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 31, 2022
@sayboras sayboras marked this pull request as ready for review October 31, 2022 10:31
@sayboras sayboras requested review from a team as code owners October 31, 2022 10:31
@sayboras sayboras added the release-note/minor This PR changes functionality that users may find relevant to operating Cilium. label Oct 31, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 31, 2022
qmonnet
qmonnet reviewed Oct 31, 2022
View reviewed changes
@sayboras sayboras requested a review from qmonnet October 31, 2022 12:00
@sayboras sayboras force-pushed the tam/gateway-api-docs branch from 801c8d2 to 3638909 Compare October 31, 2022 12:01
qmonnet
qmonnet approved these changes Oct 31, 2022
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@qmonnet qmonnet added the area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. label Nov 1, 2022
@qmonnet qmonnet added the area/servicemesh GH issues or PRs regarding servicemesh label Nov 1, 2022
@sayboras
docs: Refactor Ingress docs
07b0085 
This is to move demo app and tls cert creation to separate files for
re-use later.

Signed-off-by: Tam Mach <tam.mach@cilium.io>
@sayboras
docs: Add getting started guide for Gateway API
ceb42b7 
Similar to Ingress, a user guide is required for Gateway API. Basic
examples for HTTP and HTTPS are added. For detailed use cases, user
can still refer to upstream documentation.

Also, update installation step for cert-manager with Gateway API support
as per https://cert-manager.io/docs/usage/gateway/.

Signed-off-by: Tam Mach <tam.mach@cilium.io>
@sayboras sayboras force-pushed the tam/gateway-api-docs branch from 3638909 to ceb42b7 Compare November 2, 2022 01:51
@qmonnet
Copy link
Member

qmonnet commented Nov 2, 2022

I'd label with release-note/misc? There's no new feature introduced in this PR, only documentation?

@sayboras sayboras added release-note/misc This PR makes changes that have no direct user impact. and removed release-note/minor This PR changes functionality that users may find relevant to operating Cilium. labels Nov 2, 2022
@nvibert
Copy link
Contributor

nvibert commented Nov 4, 2022

As mentioned on Slack, I think the docs missed the part where we need to deploy the GatewayClass. I may have missed something though but if not, we just need to add a GatewayClass Resource for Cilium on this manifest: https://github.com/cilium/cilium/blob/master/examples/kubernetes/gateway/basic-http.yaml

@sayboras
Copy link
Member Author

As mentioned on Slack, I think the docs missed the part where we need to deploy the GatewayClass. I may have missed something though but if not, we just need to add a GatewayClass Resource for Cilium on this manifest: https://github.com/cilium/cilium/blob/master/examples/kubernetes/gateway/basic-http.yaml

Default GatewayClass is installed as part of cilium helm chart, provided that CRD is installed in advance.

youngnick
youngnick approved these changes Nov 14, 2022
View reviewed changes
Copy link
Contributor

@youngnick youngnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, although we could possibly emphasize the requirement to preinstall the CRDs for this experimental version.

(The install order is tricky because Gateway API also has a validating webhook for objects, that really should be installed at some point, but we run the risk of circular dependencies there).

@aanm aanm merged commit 3adeadb into cilium:master Nov 14, 2022
@sayboras sayboras deleted the tam/gateway-api-docs branch November 14, 2022 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@youngnick youngnick youngnick approved these changes

@qmonnet qmonnet qmonnet approved these changes

@tommyp1ckles tommyp1ckles Awaiting requested review from tommyp1ckles tommyp1ckles was automatically assigned from cilium/sig-k8s

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/servicemesh GH issues or PRs regarding servicemesh release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@sayboras @qmonnet @nvibert @youngnick @aanm