Add implementations documentation #565

shaneutt · 2021-02-26T21:43:21Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

As per [k8s slack conversations][slack] and #558 this PR adds documentation to keep track of the downstream Gateway API implementations in other projects.

Which issue(s) this PR fixes:

Fixes #558

Does this PR introduce a user-facing change?:
NONE

k8s-ci-robot · 2021-02-26T21:43:29Z

Welcome @shaneutt!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2021-02-26T21:43:29Z

Hi @shaneutt. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

shaneutt

When I first made this doc it felt sort of odd to do write ups for other projects (I represent Kong), but I tried to pull information from previous conversations in SIG networking zoom syncs and the K8s slack channel.

@robscott I would appreciate your review on this prior to moving it out of draft phase, perhaps I should stick with yours and mine implementations only for now? Not really sure since I'm new to the project, let me know 🖖

site-src/implementations.md

SantoDE

See comments :)

site-src/implementations.md

In https://github.com/kubernetes-sigs/gateway-api/pull/565/files#r583944465 we discussed removing the version support table for now. Perhaps later we'll come back to it when there are more released and stable versions of Gateway API.

We'll need to add more context about the relationship between the Gateway API and Knative as part of some future iteration.

shaneutt · 2021-03-02T19:16:34Z

At this point I think we've received enough maintainer feedback and updated for that feedback that this PR is ready to move from draft to ready. Please let me know any other considerations, or changes that you feel need to be made! 🖖

hbagdi · 2021-03-04T15:25:43Z

/ok-to-test

hbagdi · 2021-03-04T15:29:52Z

Let's see if we can get an approval from maintainers from each implementation:

Contour: @stevesloka
GKE: @robscott @bowei
Istio: @howardjohn
Kong: Approved by mysefl and @shaneutt
Traefik: @SantoDE

bowei · 2021-03-04T17:26:50Z

site-src/implementations.md

+
+## Implementation Status
+
+- [Contour][1] (alpha)


can we make this a table?

| Implementation | Status | | ---- | ---- | etc

Also, if we can put the version implemented (instead of just Alpha)
that would be useful for users

e.g. Supports v1alpha1

When this was in draft it started out as a table, see:

#565 (comment)

However @robscott had particularly requested that I change it to the format you see here.

If Rob is OK with changing it back to a table but using the format you suggest above, that sounds good to me. Just want to check with him.

This is a minor thing and we can change in a later diff. My thinking was that table is easier to deal with more info (say which versions are supported)

I also think a table would be a bit cleaner (though we don't have to block this PR). The original table had the vendors as columns instead of rows which doesn't leave much room for written content. The following format would allow us to take the existing written content we have in the page and surface it through a table.

| Implementation | Status | | [Project/Product](link) | Explanation of progress towards support and/or support levels (which versions) | | [Project/Product](link) | Explanation of progress towards support and/or support levels (which versions) | etc

I think support is a gray area right now since we are early in the spec so it's prob too early for a clean cut version/checkmark box.

bowei · 2021-03-04T17:28:04Z

/hold
/approve

bowei · 2021-03-04T17:28:39Z

I put a hold -- let's collect ack from the impls

This looks great

robscott · 2021-03-09T05:49:45Z

Just following up on Harry's summary from above, looks like we have most approvals, but still need a couple more. We currently have approvals for:

GKE
Istio
Kong

We still need approval from:

Contour: @stevesloka
Traefik: @SantoDE

/assign @stevesloka @SantoDE

k8s-ci-robot · 2021-03-09T05:49:46Z

@robscott: GitHub didn't allow me to assign the following users: stevesloka, SantoDE.

Note that only kubernetes-sigs members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

Just following up on Harry's summary from above, looks like we have most approvals, but still need a couple more. We currently have approvals for:

GKE

Istio

Kong

We still need approval from:

[] Contour: @stevesloka

[] Traefik: @SantoDE

/assign @stevesloka @SantoDE

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

SantoDE · 2021-03-10T10:23:22Z

site-src/implementations.md

+
+Traefik currently supports the previous `v0.1.x` Gateway API specification, check the [Kubernetes Gateway Documentation][traefik-1] for information on how to deploy and use Traefik's Gateway implementation.
+
+Traefik is currently working on implementing TCP, status updates and documentation will be provided here as the work progresses.


Suggested change

Traefik is currently working on implementing TCP, status updates and documentation will be provided here as the work progresses.

Traefik is currently working towards updating the integration to the current version `v0.2.x`, TCP as well as more status updates and documentation will be provided here as the work progresses.

Just one nitpick :)

SantoDE

One minor edit outstanding, apart from that im LGTM

SantoDE · 2021-03-10T10:23:31Z

site-src/implementations.md

+
+Traefik currently supports the previous `v0.1.x` Gateway API specification, check the [Kubernetes Gateway Documentation][traefik-1] for information on how to deploy and use Traefik's Gateway implementation.
+
+Traefik is currently working on implementing TCP, status updates and documentation will be provided here as the work progresses.


Just one nitpick :)

stevesloka · 2021-03-10T15:40:40Z

LGTM for the Contour bits! 🎉

mark-church · 2021-03-10T15:53:24Z

site-src/implementations.md

+## Implementation Status
+
+- [Contour][1] (alpha)
+- [Google Cloud][2] (work in progress)


Should be:

- [Google Kubernetes Engine][2] (work in progress)

bowei · 2021-03-10T17:57:41Z

I'm going to merge this and have the remaining comments addressed as follow up PRs.
/hold cancel
/lgtm
/approve

k8s-ci-robot · 2021-03-10T17:57:49Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bowei, howardjohn, SantoDE, shaneutt

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [bowei]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

docs: add implementations.md

772ff10

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 26, 2021

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 26, 2021

k8s-ci-robot requested review from bowei and danehans February 26, 2021 21:43

shaneutt commented Feb 26, 2021

View reviewed changes

SantoDE reviewed Feb 26, 2021

View reviewed changes

site-src/implementations.md Outdated Show resolved Hide resolved

site-src/implementations.md Outdated Show resolved Hide resolved

howardjohn reviewed Feb 26, 2021

View reviewed changes

site-src/implementations.md Outdated Show resolved Hide resolved

site-src/implementations.md Outdated Show resolved Hide resolved

robscott reviewed Feb 26, 2021

View reviewed changes

site-src/implementations.md Outdated Show resolved Hide resolved

SantoDE reviewed Feb 26, 2021

View reviewed changes

site-src/implementations.md Show resolved Hide resolved

shaneutt and others added 6 commits March 2, 2021 13:58

docs: remove the version table

23703b7

In https://github.com/kubernetes-sigs/gateway-api/pull/565/files#r583944465 we discussed removing the version support table for now. Perhaps later we'll come back to it when there are more released and stable versions of Gateway API.

docs: expand contour implementation context for PR reviews

5d69618

docs: update gke representation in impl docs

267f6fb

docs: change rep for istio status in impl doc

5f51da7

docs: remove knative from impl for now

7781c9a

We'll need to add more context about the relationship between the Gateway API and Knative as part of some future iteration.

Update site-src/implementations.md

ff0eb40

shaneutt requested a review from robscott March 2, 2021 19:15

shaneutt marked this pull request as ready for review March 2, 2021 19:16

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 2, 2021

docs: update Kong section links

7b26360

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 4, 2021

howardjohn approved these changes Mar 4, 2021

View reviewed changes

bowei reviewed Mar 4, 2021

View reviewed changes

k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Mar 4, 2021

mark-church mentioned this pull request Mar 8, 2021

Index page refresh and "why this matters" content #575

Merged

SantoDE reviewed Mar 10, 2021

View reviewed changes

SantoDE approved these changes Mar 10, 2021

View reviewed changes

mark-church reviewed Mar 10, 2021

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 10, 2021

k8s-ci-robot assigned bowei Mar 10, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 10, 2021

k8s-ci-robot merged commit 509d7d5 into kubernetes-sigs:master Mar 10, 2021

shaneutt deleted the shaneutt/implementations-docs branch March 10, 2021 19:47

shaneutt mentioned this pull request Aug 16, 2021

REQUEST: New membership for shaneutt kubernetes/org#2892

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add implementations documentation #565

Add implementations documentation #565

shaneutt commented Feb 26, 2021

k8s-ci-robot commented Feb 26, 2021

k8s-ci-robot commented Feb 26, 2021

shaneutt left a comment

SantoDE left a comment

shaneutt commented Mar 2, 2021

hbagdi commented Mar 4, 2021

hbagdi commented Mar 4, 2021

bowei Mar 4, 2021

bowei Mar 4, 2021

bowei Mar 4, 2021

shaneutt Mar 5, 2021

bowei Mar 9, 2021

mark-church Mar 10, 2021

bowei commented Mar 4, 2021

bowei commented Mar 4, 2021

robscott commented Mar 9, 2021 •

edited

Loading

k8s-ci-robot commented Mar 9, 2021

SantoDE Mar 10, 2021

SantoDE Mar 10, 2021

SantoDE left a comment

SantoDE Mar 10, 2021

stevesloka commented Mar 10, 2021

mark-church Mar 10, 2021

bowei commented Mar 10, 2021

k8s-ci-robot commented Mar 10, 2021


		Traefik currently supports the previous `v0.1.x` Gateway API specification, check the [Kubernetes Gateway Documentation][traefik-1] for information on how to deploy and use Traefik's Gateway implementation.

		Traefik is currently working on implementing TCP, status updates and documentation will be provided here as the work progresses.

	Traefik is currently working on implementing TCP, status updates and documentation will be provided here as the work progresses.
	Traefik is currently working towards updating the integration to the current version `v0.2.x`, TCP as well as more status updates and documentation will be provided here as the work progresses.

Add implementations documentation #565

Add implementations documentation #565

Conversation

shaneutt commented Feb 26, 2021

k8s-ci-robot commented Feb 26, 2021

k8s-ci-robot commented Feb 26, 2021

shaneutt left a comment

Choose a reason for hiding this comment

SantoDE left a comment

Choose a reason for hiding this comment

shaneutt commented Mar 2, 2021

hbagdi commented Mar 4, 2021

hbagdi commented Mar 4, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bowei commented Mar 4, 2021

bowei commented Mar 4, 2021

robscott commented Mar 9, 2021 • edited Loading

k8s-ci-robot commented Mar 9, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SantoDE left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stevesloka commented Mar 10, 2021

Choose a reason for hiding this comment

bowei commented Mar 10, 2021

k8s-ci-robot commented Mar 10, 2021

robscott commented Mar 9, 2021 •

edited

Loading