Skip to content

Commit

Permalink
docs: add a dedicated page in the website for Kubernetes compatibility.
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
KayenM committed Nov 4, 2024
1 parent 75e7da2 commit 2a7b3a6
Show file tree
Hide file tree
Showing 27 changed files with 237 additions and 33 deletions.
16 changes: 0 additions & 16 deletions docs/Release_Management.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 21 additions & 0 deletions website/docs/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
3 changes: 2 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ module.exports = {
items: [
'operations',
'performance-tuning',
'opa-versions'
'opa-versions',
'kubernetes-versions'
],
},
{
Expand Down
14 changes: 14 additions & 0 deletions website/versioned_docs/version-v3.10.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
15 changes: 15 additions & 0 deletions website/versioned_docs/version-v3.11.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
16 changes: 16 additions & 0 deletions website/versioned_docs/version-v3.12.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
17 changes: 17 additions & 0 deletions website/versioned_docs/version-v3.13.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
18 changes: 18 additions & 0 deletions website/versioned_docs/version-v3.14.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
19 changes: 19 additions & 0 deletions website/versioned_docs/version-v3.15.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
20 changes: 20 additions & 0 deletions website/versioned_docs/version-v3.16.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
21 changes: 21 additions & 0 deletions website/versioned_docs/version-v3.17.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
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 Versions |
|--------------------|------------------------------------------------------|
| `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.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
10 changes: 10 additions & 0 deletions website/versioned_docs/version-v3.6.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
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 Versions |
|--------------------|---------------------------------------------|
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
11 changes: 11 additions & 0 deletions website/versioned_docs/version-v3.7.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
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 Versions |
|--------------------|---------------------------------------------|
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
12 changes: 12 additions & 0 deletions website/versioned_docs/version-v3.8.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
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 Versions |
|--------------------|---------------------------------------------|
| `v3.8` | `v1.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
13 changes: 13 additions & 0 deletions website/versioned_docs/version-v3.9.x/kubernetes-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
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 Versions |
|--------------------|---------------------------------------------|
| `v3.9` | `v1.22`, `v1.23`, `v1.24`, `v1.25`, `v1.26` |
| `v3.8` | `v1.21`, `v1.22`, `v1.23`, `v1.24`, `v1.25` |
| `v3.7` | `v1.20`, `v1.21`, `v1.22`, `v1.23`, `v1.24` |
| `v3.6` | `v1.19`, `v1.20`, `v1.21`, `v1.22`, `v1.23` |
4 changes: 2 additions & 2 deletions website/versioned_sidebars/version-v3.10.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
"items": [
"operations",
"performance-tuning",
"opa-versions"
]
"opa-versions",
"kubernetes-versions" ]
},
{
"type": "category",
Expand Down
4 changes: 2 additions & 2 deletions website/versioned_sidebars/version-v3.11.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
"items": [
"operations",
"performance-tuning",
"opa-versions"
]
"opa-versions",
"kubernetes-versions" ]
},
{
"type": "category",
Expand Down
4 changes: 2 additions & 2 deletions website/versioned_sidebars/version-v3.12.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
"items": [
"operations",
"performance-tuning",
"opa-versions"
]
"opa-versions",
"kubernetes-versions" ]
},
{
"type": "category",
Expand Down
4 changes: 2 additions & 2 deletions website/versioned_sidebars/version-v3.13.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@
"items": [
"operations",
"performance-tuning",
"opa-versions"
]
"opa-versions",
"kubernetes-versions" ]
},
{
"type": "category",
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.14.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"items": [
"operations",
"performance-tuning",
"opa-versions"
"opa-versions",
"kubernetes-versions"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.15.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"items": [
"operations",
"performance-tuning",
"opa-versions"
"opa-versions",
"kubernetes-versions"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.16.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"items": [
"operations",
"performance-tuning",
"opa-versions"
"opa-versions",
"kubernetes-versions"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion website/versioned_sidebars/version-v3.17.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@
"items": [
"operations",
"performance-tuning",
"opa-versions"
"opa-versions",
"kubernetes-versions"
]
},
{
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_sidebars/version-v3.6.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@
{
"type": "doc",
"id": "version-v3.6.x/opa-versions"
},
{
"type": "doc",
"id": "version-v3.6.x/kubernetes-versions"
}
]
},
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_sidebars/version-v3.7.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@
{
"type": "doc",
"id": "version-v3.7.x/opa-versions"
},
{
"type": "doc",
"id": "version-v3.7.x/kubernetes-versions"
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions website/versioned_sidebars/version-v3.8.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
"collapsed": false,
"items": [
"operations",
"opa-versions"
]
"opa-versions",
"kubernetes-versions" ]
},
{
"type": "category",
Expand Down
4 changes: 2 additions & 2 deletions website/versioned_sidebars/version-v3.9.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
"collapsed": false,
"items": [
"operations",
"opa-versions"
]
"opa-versions",
"kubernetes-versions" ]
},
{
"type": "category",
Expand Down

0 comments on commit 2a7b3a6

Please sign in to comment.