docs: make a dedicated page in the website for Kubernetes compatibility.

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]>
open-policy-agent · Oct 27, 2024 · eced830 · eced830
1 parent 75e7da2
commit eced830
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 17 deletions.
diff --git a/docs/Release_Management.md b/docs/Release_Management.md
@@ -60,22 +60,6 @@ Gatekeeper is assumed to be compatible with the [current Kubernetes Supported Ve
 
 For example, if Gatekeeper _supported_ versions are v3.7 and v3.8, and Kubernetes _supported_ versions are v1.22, v1.23, v1.24, then all supported Gatekeeper versions (v3.7, v3.8) are assumed to be compatible with all supported Kubernetes versions (v1.22, v1.23, v1.24). If Kubernetes v1.25 is released later, then Gatekeeper v3.7 and v3.8 will be assumed to be compatible with v1.25 if those Gatekeeper versions are still supported at that time.
 
-This is the official compatibility between Gatekeeper and Kubernetes versions.
-
-|                     | Kubernetes 1.22.z | Kubernetes 1.23.z | Kubernetes 1.24.z | Kubernetes 1.25.z | Kubernetes 1.26.z | Kubernetes 1.27.z | Kubernetes 1.28.z | Kubernetes 1.29.z | Kubernetes 1.30.z | Kubernetes 1.31.z |
-|---------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|
-| **Gatekeeper 3.7**  | ✓                 | ✓                 | ✓                 | -                 | -                 | -                 | -                 | -                 | -                 | -                 |
-| **Gatekeeper 3.8**  | ✓                 | ✓                 | ✓                 | ✓                 | -                 | -                 | -                 | -                 | -                 | -                 |
-| **Gatekeeper 3.9**  | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 | -                 | -                 | -                 | -                 | -                 |
-| **Gatekeeper 3.10** | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 | -                 | -                 | -                 | -                 |
-| **Gatekeeper 3.11** | -                 | -                 | ✓                 | ✓                 | ✓                 | ✓                 | -                 | -                 | -                 | -                 |
-| **Gatekeeper 3.12** | -                 | -                 | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 | -                 | -                 | -                 |
-| **Gatekeeper 3.13** | -                 | -                 | -                 | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 | -                 | -                 |
-| **Gatekeeper 3.14** | -                 | -                 | -                 | -                 | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 | -                 |
-| **Gatekeeper 3.15** | -                 | -                 | -                 | -                 | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 |
-| **Gatekeeper 3.16** | -                 | -                 | -                 | -                 | -                 | ✓                 | ✓                 | ✓                 | ✓                 | ✓                 |
-| **Gatekeeper 3.17** | -                 | -                 | -                 | -                 | -                 | -                 | ✓                 | ✓                 | ✓                 | ✓                 |
-
 If you choose to use Gatekeeper with a version of Kubernetes that it does not support, you are using it at your own risk.
 
 ## Upgrades

diff --git a/website/docs/kubernetes-versions.md b/website/docs/kubernetes-versions.md
@@ -0,0 +1,20 @@
+---
+id: kubernetes-versions
+title: Kubernetes Versions
+---
+
+Gatekeeper is a policy engine for the [Kubernetes Project](https://kubernetes.io/). To see which version of Kubernetes is compatible with a particular Gatekeeper release, reference the table below.
+
+| Gatekeeper Version | Kubernetes Version                                   |
+|--------------------|------------------------------------------------------|
+| `v3.17`            | `v1.28`,`v1.29`, `v1.30`, `v1.31`                    |
+| `v3.16`            | `v1.27`, `v1.28`,`v1.29`, `v1.30`, `v1.31`           |
+| `v3.15`            | `v1.26`, `v1.27`, `v1.28`,`v1.29`, `v1.30`, `v1.31`  |
+| `v3.14`            | `v1.26`, `v1.27`, `v1.28`,`v1.29`, `v1.30`           |
+| `v3.13`            | `v1.25`, `v1.26`, `v1.27`, `v1.28`, `v1.29`          |
+| `v3.12`            | `v1.24`, `v1.25`, `v1.26`, `v1.27`, `v1.28`          |
+| `v3.11`            | `v1.24`, `v1.25`, `v1.26`, `v1.27`                   |
+| `v3.10`            | `v1.22`, `v1.23`, `v1.24`, `v1.25`, `v1.26`, `v1.27` |
+| `v3.9`             | `v1.22`, `v1.23`, `v1.24`, `v1.25`, `v1.26`          |
+| `v3.8`             | `v1.22`, `v1.23`, `v1.24`, `v1.25`                   |
+| `v3.7`             | `v1.22`, `v1.23`, `v1.24`                            |
diff --git a/website/sidebars.js b/website/sidebars.js
@@ -46,7 +46,8 @@ module.exports = {
       items: [
         'operations',
         'performance-tuning',
-        'opa-versions'
+        'opa-versions',
+        'kubernetes-versions'
       ],
     },
     {