Skip to content

Commit b64d40f

Browse files
committed
Update implementations.md with removal policy
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 ed2bd6b commit b64d40f

File tree

1 file changed

+84
-2
lines changed

1 file changed

+84
-2
lines changed

site-src/implementations.md

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,90 @@ 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.
9-
8+
cover, and documentation to help users get started. This status information should
9+
be no longer than a few paragraphs.
10+
11+
There are three main classes of implementation:
12+
13+
* **Conformant** implementations - these implementations have submitted at least
14+
one conformance report passing all claimed features for one of the two (2) most
15+
recent Gateway API releases.
16+
* **Partially Conformant** implementations - these implementations are being actively
17+
developed but have not yet submitted at least one completely passing conformance
18+
report for a recent Gateway API version.
19+
To remain Partially Conformant, implementations must submit at least one
20+
conformance report per release. The conformance report submitted must also be
21+
for one of the three (3) most recent Gateway API versions.
22+
* **Stale** implementations - these implementations may not be being actively
23+
developed and will be removed from this page on the next page review unless
24+
they submit a conformance report moving them to one of the other categories.
25+
Page reviews are performed at least one month after every Gateway API release,
26+
with the first being performed after the release of Gateway API v1.4, due in
27+
October 2025. This category will also be removed in the Gateway API v1.5
28+
review process, due in mid-2026.
29+
30+
Implementations also generally fall into two categories:
31+
32+
* **Gateway** controllers reconcile the Gateway resource and are intended to
33+
handle north-south traffic, mainly concerned with coming from outside the
34+
cluster to inside.
35+
* **Mesh** controllers reconcile Service resources with HTTPRoutes attached
36+
and are intended to handle east-west traffic, within the same cluster or
37+
set of clusters.
38+
39+
Also listed on this page are **integrations**, which are other software
40+
projects that are able to make use of Gateway API resources to perform
41+
other functions (like managing DNS or creating certificates).
42+
43+
!!! note
44+
This page contains links to third party projects that provide functionality
45+
required for Gateway API to work. The Gateway API project authors aren't
46+
responsible for these projects, which are listed alphabetically within their
47+
class.
48+
49+
## Page Review Policy
50+
51+
This page is intended to showcase actively developed and conformant implementations
52+
of Gateway API, and so is subject to regular reviews.
53+
54+
These reviews are performed at least one month after every Gateway API release
55+
(starting with the Gateway API v1.3 release).
56+
57+
As part of the review, a maintainer will check:
58+
* which implementations are **Conformant** - that is, they have submitted at
59+
least one passing conformance report for one of the last two (2) versions of
60+
Gateway API (where "passing conformance report" means a conformance report
61+
that passes all claimed features for each supported Gateway API conformanc profile).
62+
* which implementations are **Partially Conformant**, that is, they have
63+
submitted at least one conformance report that passes at least some conformance
64+
tests, for a Gateway API version that is one of the last three (3) released
65+
versions of Gateway API.
66+
67+
If the maintainer performing the review finds that there are implementations
68+
that no longer satisfy the criteria for Partially Conformant or Conformant, or
69+
finds implementations that are in the "Stale" state, then that maintainer will:
70+
71+
* Inform the other maintainers and get their agreement on the list of stale and
72+
to-be-removed implementations
73+
* Post on the #sig-network-gateway-api channel informing implementations that
74+
as far as they can see, they are no longer conformant or partially conformant, and should
75+
request contact the maintainers to discuss the implementations status within a lazy
76+
consensus period.
77+
* Any implementations that do not respond within the lazy consensus will be
78+
downgraded in status, either by being moved to "Stale", or being removed
79+
from this page if they are already "Stale".
80+
81+
Page review timeline, starting with the v1.3 Page Review:
82+
* Gateway API v1.3 release Page Review: a maintainer will move anyone who hasn't
83+
submitted a conformance report using the rules above to "Stale". They will also
84+
contact anyone who moves to Stale to inform them about this rule change.
85+
* Gateway API v1.4 release Page Review (at least one month after the actual
86+
release): A maintainer will perform the Page Review process again, removing
87+
any implementations that are are still Stale (after a right-of-reply period).
88+
* Gateway API v1.5 release Page Review (at least one month after the actual
89+
release: The Stale category will be removed, and implementation maintainers
90+
will need to submit at least partial conformance reports during the
91+
right-of-reply period, or be removed.
1092

1193
!!! info "Compare extended supported features across implementations"
1294

0 commit comments

Comments
 (0)