search

open-policy-agent / gatekeeper

🐊 Gatekeeper - Policy Controller for Kubernetes
https://open-policy-agent.github.io/gatekeeper/
Apache License 2.0
3.72k stars 765 forks source link

docs: Add a Gatekeeper-Kubernetes compatibility matrix to the release… #3664

Open KayenM opened 1 month ago

KayenM commented 1 month ago

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!

ritazh commented 1 month ago

Thank you for adding this @KayenM!

Do you think maybe moving the table to a new page e.g. kubernetes-versions under Architecture similar to https://open-policy-agent.github.io/gatekeeper/website/docs/opa-versions would be better for discovery?

KayenM commented 1 month ago

Thank you for adding this @KayenM!

Do you think maybe moving the table to a new page e.g. kubernetes-versions under Architecture similar to https://open-policy-agent.github.io/gatekeeper/website/docs/opa-versions would be better for discovery?

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.

KayenM commented 1 month ago

I've moved the table to a new page in the Gatekeeper website docs for better discovery.

ritazh commented 1 month ago

@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.

KayenM commented 3 weeks ago

@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.

KayenM commented 3 weeks ago

LGTM

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.