docs: Add a Gatekeeper-Kubernetes compatibility matrix to the release… #3664
Conversation
management page. A compatibility matrix would be helpful to Gatekeeper users who are using non-supported versions of Kubernetes. Gatekeeper’s support policy is that it ensures compatibility of currently supported Gatekeeper versions with currently supported Kubernetes versions. Gatekeeper supports n-1 minor release versions where n is the current release. This matrix assumes that at any point in time where there is overlap between a supported version of Gatekeeper and a supported version of Kubernetes, they will be compatible. Signed-off-by: KayenM <[email protected]>
|
Thank you for adding this @KayenM! Do you think maybe moving the table to a new page e.g. kubernetes-versions under |
Hey @ritazh, yes for sure, thanks for pointing me to that! I can modify this PR to make a new page very similar to OPA Versions compatibility. I can also change the matrix to be a 2-column table as it would be easier to maintain going forward. |
|
I've moved the table to a new page in the Gatekeeper website docs for better discovery. |
|
|
||
| | Gatekeeper Version | Kubernetes Version | | ||
| |--------------------|------------------------------------------------------| | ||
| | `v3.17` | `v1.28`,`v1.29`, `v1.30`, `v1.31` | |
There was a problem hiding this comment.
This is great as a snapshot in time. Unfortunately, unless this is part of the release CI, it will go out of date quickly as new GK and K8s versions are released. Can we automate creation of this table?
There was a problem hiding this comment.
Hey thank you both! Sorry for the delay here.
That's a great point @sozercan, I'd be happy to add that feature as part of this change or after this is merged. It might take me a bit longer to complete if that's alright (end of November)?
There was a problem hiding this comment.
I am fine with merging this, creating issue for automation. If we are not implementing automation right now, I suggest highlighting this in release guidance - https://github.com/open-policy-agent/gatekeeper/blob/master/docs/RELEASE.md - untill the automation is in.
Updating RELEASE.md should be one of the todo in issue tracking the automation.
|
@KayenM can you pls also add the changes to https://github.com/open-policy-agent/gatekeeper/tree/master/website/versioned_docs each version doc should go up to that GK version. |
For sure, thanks for pointing that out! I've amended my commit to make the change to the versioned docs. |
Summary: For improved discovery, this moves the matrix from the release management file in the Gatekeeper repo, to the Gatekeeper website under the Architecture heading. For better readability and simpler maintenance, instead of using a matrix, we are using a 2 column table. This way, the team won't need to add a new row and column to the matrix for each new release. Reviewers: ritazh Signed-off-by: KayenM <[email protected]>
Thank you! I fixed a typo I made in the 3.6 version docs caught by the last deploy workflow, it needs another approval to be rerun. |
What this PR does / why we need it:
A compatibility table would be helpful to Gatekeeper users who are using non-supported versions of Kubernetes.
Gatekeeper’s support policy is that it ensures compatibility of currently supported Gatekeeper versions with currently supported Kubernetes versions. Gatekeeper supports n-1 minor release versions where n is the current release. This matrix assumes that at any point in time where there is overlap between a supported version of Gatekeeper and a supported version of Kubernetes, they will be compatible.
This table was created by checking overlap between supported versions of GK and Kubernetes, with the dates defined in this spreadsheet.
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when the PR gets merged):Fixes #
Special notes for your reviewer: This addition was discussed in this GitHub discussion thread. Please let me know if any changes are needed, thank you!