Skip to content

Commit e1310bb

Browse files
authored
Update implementations.md with removal policy (#3863)
This commit updates the "Implementations" page with details on what implementations need to do in order to stay a current and registered implementation of Gateway API. This includes a policy about when implementations will be removed from the page. Signed-off-by: Nick Young <[email protected]>
1 parent b58707c commit e1310bb

File tree

1 file changed

+125
-1
lines changed

1 file changed

+125
-1
lines changed

site-src/implementations.md

Lines changed: 125 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,77 @@ and provides status and resource references for them.
55

66
Implementors and integrators of Gateway API are encouraged to update this
77
document with status information about their implementations, the versions they
8-
cover, and documentation to help users get started.
8+
cover, and documentation to help users get started. This status information should
9+
be no longer than a few paragraphs.
910

11+
## Conformance levels
12+
13+
There are three levels of Gateway API conformance:
14+
15+
### Conformant implementations
16+
17+
These implementations have submitted at least one conformance report that has passes for:
18+
19+
* All core conformance tests for at least one combination of Route type and
20+
Profile
21+
* All claimed Extended features
22+
23+
for one of the two (2) most recent Gateway API releases.
24+
25+
So, it's conformant to support Mesh + HTTPRoute, or Gateway + HTTPRoute, or
26+
Gateway + TLSRoute, or Gateway + Mesh + HTTPRoute, plus any extended features
27+
the implementation claims. But implementaions _must_ support at least one
28+
Profile and one Route type in that profile, and must pass all Core conformance
29+
tests for that Profile and Route type in addition to all claimed Extended
30+
features.
31+
32+
### Partially Conformant implementations
33+
34+
These implementations are aiming for full conformance but are not currently
35+
achieving it. They have submitted at least one conformance report passing some
36+
of the tests to be Conformant (as above) for one of the three (3) most recent
37+
Gateway API releases. Note that the requirements to be considered "partially
38+
conformant" may be tightened in a future release of Gateway API.
39+
40+
### Stale implementations
41+
42+
These implementations may not be being actively developed and will be removed
43+
from this page on the next page review unless they submit a conformance report
44+
moving them to one of the other categories.
45+
46+
Page reviews are performed at least one month after every Gateway API release,
47+
with the first being performed after the release of Gateway API v1.3, in late
48+
June 2025. Following the Gateway API v1.5 review process, due in mid-2026,
49+
stale implementations will no longer be listed.
50+
51+
## Implementation profiles
52+
53+
Implementations also generally fall into two categories, which are called
54+
_profiles_:
55+
56+
* **Gateway** controllers reconcile the Gateway resource and are intended to
57+
handle north-south traffic, mainly concerned with coming from outside the
58+
cluster to inside.
59+
* **Mesh** controllers reconcile Service resources with HTTPRoutes attached
60+
and are intended to handle east-west traffic, within the same cluster or
61+
set of clusters.
62+
63+
Each profile has a set of conformance tests associated with it, that lay out
64+
the expected behavior for implementations to be conformant (as above).
65+
66+
Implementations may also fit both profiles.
67+
68+
## Integrations
69+
70+
Also listed on this page are **integrations**, which are other software
71+
projects that are able to make use of Gateway API resources to perform
72+
other functions (like managing DNS or creating certificates).
73+
74+
!!! note
75+
This page contains links to third party projects that provide functionality
76+
required for Gateway API to work. The Gateway API project authors aren't
77+
responsible for these projects, which are listed alphabetically within their
78+
class.
1079

1180
!!! info "Compare extended supported features across implementations"
1281

@@ -609,3 +678,58 @@ For help and support with Kuadrant's implementation please feel free to [create
609678
[kuadrant-issue-new]:https://github.com/Kuadrant/kuadrant-operator/issues/new
610679
[kuadrant-slack]:https://kubernetes.slack.com/archives/C05J0D0V525
611680

681+
682+
## Adding new entries
683+
684+
Implementations are free to make a PR to add their entry to this page; however,
685+
in order to meet the requirements for being Partially Conformant or Conformant,
686+
the implementation must have had a conformance report submission PR merged.
687+
688+
Part of the review process for new additions to this page is that a maintainer
689+
will check the conformance level and verify the state.
690+
691+
## Page Review Policy
692+
693+
This page is intended to showcase actively developed and conformant implementations
694+
of Gateway API, and so is subject to regular reviews.
695+
696+
These reviews are performed at least one month after every Gateway API release
697+
(starting with the Gateway API v1.3 release).
698+
699+
As part of the review, a maintainer will check:
700+
701+
* which implementations are **Conformant** - as defined above in this document.
702+
* which implementations are **Partially Conformant**, as defined above in this
703+
document.
704+
705+
If the maintainer performing the review finds that there are implementations
706+
that no longer satisfy the criteria for Partially Conformant or Conformant, or
707+
finds implementations that are in the "Stale" state, then that maintainer will:
708+
709+
* Inform the other maintainers and get their agreement on the list of stale and
710+
to-be-removed implementations
711+
* Post on the #sig-network-gateway-api channel informing the maintainers of
712+
implementations that are no longer at least partially conformant should contact
713+
the Gateway API maintainers to discuss the implementation's status. This period
714+
is called the "**right-of-reply**" period, is at least two weeks long, and functions
715+
as a lazy consensus period.
716+
* Any implementations that do not respond within the right-of-reply period will be
717+
downgraded in status, either by being moved to "Stale", or being removed
718+
from this page if they are already "Stale".
719+
720+
Page review timeline, starting with the v1.3 Page Review:
721+
722+
* Gateway API v1.3 release Page Review: a maintainer will move anyone who hasn't
723+
submitted a conformance report using the rules above to "Stale". They will also
724+
contact anyone who moves to Stale to inform them about this rule change.
725+
* Gateway API v1.4 release Page Review (at least one month after the actual
726+
release): A maintainer will perform the Page Review process again, removing
727+
any implementations that are are still Stale (after a right-of-reply period).
728+
* Gateway API v1.5 release Page Review (at least one month after the actual
729+
release): We will remove the Stale category, and implementation maintainers
730+
will need to be at least partially conformant on each review, or during the
731+
right-of-reply period, or be removed from the implementations page.
732+
733+
This means that, after the Gateway API v1.5 release, implementations cannot be
734+
added to this page unless they have submitted at least a Partially Conformant
735+
conformance report.

0 commit comments

Comments
 (0)