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.

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

doc(kic) add Gateway API concepts #4230

Merged
merged 2 commits into from
Aug 23, 2022
Merged

doc(kic) add Gateway API concepts #4230

merged 2 commits into from
Aug 23, 2022

Conversation

rainest
Copy link
Contributor

@rainest rainest commented Aug 11, 2022

Summary

Adds a new Gateway API page under the KIC Concepts section. This covers two alpha limitations where Kong's implementation differs from a hypothetical standard Gateway API implementation:

  • Gateways are not provisioned automatically and require configuring Kong to match their listeners.
  • A Kong instance can only support a single GatewayClass with a single Gateway.

Update the Gateway API guide with links to the new concepts page.

Update the Gateway API guide to include an example of a user-provided certificate.

Reason

Fix #4054
Fix #4229

Testing

Awaiting preview.

@rainest rainest added review:tech Request for technical review on the docs platform or processes. review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:copyedit Request for writer review. labels Aug 11, 2022
@rainest rainest requested a review from a team August 11, 2022 23:20
@rainest rainest requested a review from a team as a code owner August 11, 2022 23:20
@netlify
Copy link

netlify bot commented Aug 11, 2022

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 996ac2b
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/6303e36097b2d10009d5458d
😎 Deploy Preview https://deploy-preview-4230--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@Guaris
Copy link
Contributor

Guaris commented Aug 12, 2022

Is this ready to be reviewed?

@rainest
Copy link
Contributor Author

rainest commented Aug 12, 2022

@Guaris should be. We may get a few more comments from the rest of the Kubernetes team on tech stuff, but those hopefully don't result in huge changes. Not urgent, so if you want to wait a few days for any of those to trickle in before giving it a final pass that's fine.

Copy link
Contributor

@randmonkey randmonkey left a comment

Choose a reason for hiding this comment

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

LGTM here, so removed my change requests. But did not directly approve, to wait for others' reviews
ignore this -- dupelicated.

@randmonkey randmonkey self-requested a review August 15, 2022 02:37
Copy link
Contributor

@randmonkey randmonkey left a comment

Choose a reason for hiding this comment

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

LGTM here, so removed my change requests. But did not directly approve, to wait for others' reviews.

@randmonkey randmonkey self-requested a review August 15, 2022 02:40
@mheap mheap requested review from a team and removed request for a team August 15, 2022 12:43
Copy link
Member

@pmalek pmalek left a comment

Choose a reason for hiding this comment

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

blocking to get the whitespaces resolved

@rainest rainest requested a review from pmalek August 16, 2022 16:02
@Guaris Guaris self-assigned this Aug 22, 2022
@rainest rainest requested a review from Guaris August 22, 2022 20:13
@Guaris Guaris merged commit c26be38 into main Aug 23, 2022
@Guaris Guaris deleted the doc/gateway-concepts branch August 23, 2022 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:copyedit Request for writer review. review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:tech Request for technical review on the docs platform or processes.
Projects
None yet
5 participants