Adds matrix of Agones versions to Kubernetes versions.

Includes instructions to update Agones to Kubernetes version mapping in release checklist
googleforgames · Nov 30, 2022 · 2442953 · 2442953
1 parent d2c6181
commit 2442953
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 25 deletions.
diff --git a/docs/governance/templates/release_issue.md b/docs/governance/templates/release_issue.md
@@ -40,25 +40,26 @@ and copy it into a release issue. Fill in relevant values, found inside {}
 - [ ] Ensure the [helm `tag` value][values] is correct (should be {version} if a full release, {version}-rc if release candidate)
 - [ ] Ensure the [helm `Chart` version values][chart] are correct (should be {version} if a full release, {version}-rc if release candidate)
 - [ ] Update SDK Package Versions
-    - [ ] Update the package version in [`sdks/nodejs/package.json`][package.json] and [`sdks/nodejs/package-lock.json`][package-lock.json] by running `npm version {version}` if a full release or `npm version {version}-rc` if release candidate
-    - [ ] Ensure the [`sdks/csharp/sdk/AgonesSDK.nuspec` and `sdks/csharp/sdk/csharp-sdk.csproj`][csharp] versions are correct (should be {version} if a full release, {version}-rc if release candidate)
-    - [ ] Update the package version in the [`sdks/unity/package.json`][unity] package file's `Version` field to {version} if a full release, {version}-rc if release candidate
+  - [ ] Update the package version in [`sdks/nodejs/package.json`][package.json] and [`sdks/nodejs/package-lock.json`][package-lock.json] by running `npm version {version}` if a full release or `npm version {version}-rc` if release candidate
+  - [ ] Ensure the [`sdks/csharp/sdk/AgonesSDK.nuspec` and `sdks/csharp/sdk/csharp-sdk.csproj`][csharp] versions are correct (should be {version} if a full release, {version}-rc if release candidate)
+  - [ ] Update the package version in the [`sdks/unity/package.json`][unity] package file's `Version` field to {version} if a full release, {version}-rc if release candidate
 - [ ] Run `make gen-install`
 - [ ] Run `make test-examples-on-gar` to ensure all example images exist on us-docker.pkg.dev/agones-images/examples
 - [ ] Create a *draft* release with the [release template][release-template]
     - [ ] Make a `tag` with the release version.
 - [ ] Site updated
-    - [ ] Copy the draft release content into a new `/site/content/en/blog/releases` content (this will be what you send via email).
-    - [ ] Review all `link_test` and `data-proofer-ignore` attributes and remove for link testing
-    - [ ] If full release, review and remove all instances of the `feature` shortcode
-    - [ ] If full release, add a link to previous version's documentation to nav dropdown.
-    - [ ] config.toml updates:
-        - [ ] If full release, update `release_branch` to the new release branch for {version}.
-        - [ ] If full release, update `release-version` with the new release version {version}.
-        - [ ] If full release, copy `dev_supported_k8s` to `supported_k8s`.
-        - [ ] If full release, copy `dev_aks_minor_supported_k8s` to `aks_minor_supported_k8s`.
-        - [ ] If full release, copy `dev_minikube_minor_supported_k8s` to `minikube_minor_supported_k8s`.
-        - [ ] If full release, update documentation with updated example images tags.
+  - [ ] Copy the draft release content into a new `/site/content/en/blog/releases` content (this will be what you send via email).
+  - [ ] Add the Agones release version and its supported Kubernetes version to the version matrix in `site/content/en/docs/installation/#agones-and-kubernetes-supported-versions`.
+  - [ ] Review all `link_test` and `data-proofer-ignore` attributes and remove for link testing
+  - [ ] If full release, review and remove all instances of the `feature` shortcode
+  - [ ] If full release, add a link to previous version's documentation to nav dropdown.
+  - [ ] config.toml updates:
+    - [ ] If full release, update `release_branch` to the new release branch for {version}.
+    - [ ] If full release, update `release-version` with the new release version {version}.
+    - [ ] If full release, copy `dev_supported_k8s` to `supported_k8s`.
+    - [ ] If full release, copy `dev_aks_minor_supported_k8s` to `aks_minor_supported_k8s`.
+    - [ ] If full release, copy `dev_minikube_minor_supported_k8s` to `minikube_minor_supported_k8s`.
+    - [ ] If full release, update documentation with updated example images tags.
 - [ ] Create PR with these changes, and merge them with an approval.
 - [ ] Run `git remote update && git checkout main && git reset --hard upstream/main` to ensure your code is in line
   with upstream  (unless this is a hotfix, then do the same, but for the release branch)
@@ -70,7 +71,7 @@ and copy it into a release issue. Fill in relevant values, found inside {}
       Will need [NuGet API Key](https://www.nuget.org/account/apikeys) from Agones account.
 - [ ] Run `make do-release`. (if release candidate: `make do-release RELEASE_VERSION={version}-rc`) to create and push the docker images and helm chart.
 - [ ] Run `make shell` and run `gcloud config configurations activate <your development project>` to switch Agones
-  development tooling off of the `agones-images` project.
+    development tooling off of the `agones-images` project.
 - [ ] Do a `helm repo add agones https://agones.dev/chart/stable` / `helm repo update` and verify that the new
   version is available via the command `helm search repo agones --versions --devel`.
 - [ ] Do a `helm install --namespace=agones-system agones agones/agones`
@@ -93,7 +94,7 @@ and copy it into a release issue. Fill in relevant values, found inside {}
 - [ ] Run `make gen-install gen-api-docs`
 - [ ] Create PR with these changes, and merge them with approval
 - [ ] Close this issue.
-- [ ] If full release, close the current milestone. *Congratulations!* - the release is now complete! :tada: :clap: :smile: :+1:
+- [ ] If full release, close the current milestone. _Congratulations!_ - the release is now complete! :tada: :clap: :smile: :+1:
 
 [values]: https://github.com/googleforgames/agones/blob/main/install/helm/agones/values.yaml#L33
 [chart]: https://github.com/googleforgames/agones/blob/main/install/helm/agones/Chart.yaml

diff --git a/site/content/en/docs/Installation/_index.md b/site/content/en/docs/Installation/_index.md
@@ -9,15 +9,15 @@ description: >
 ## Usage Requirements
 
 - **Kubernetes cluster version {{% k8s-version %}}**
-    - [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/),
-      [Azure Kubernetes Service](https://azure.microsoft.com/en-us/services/kubernetes-service/),
-      [Amazon EKS](https://aws.amazon.com/eks/) and [Minikube](https://github.com/kubernetes/minikube) are supported.
-    - If you are creating and managing your own Kubernetes cluster, the
+  - [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/),
+    [Azure Kubernetes Service](https://azure.microsoft.com/en-us/services/kubernetes-service/),
+    [Amazon EKS](https://aws.amazon.com/eks/) and [Minikube](https://github.com/kubernetes/minikube) are supported.
+  - If you are creating and managing your own Kubernetes cluster, the
     [MutatingAdmissionWebhook](https://kubernetes.io/docs/admin/admission-controllers/#mutatingadmissionwebhook-beta-in-19), and
     [ValidatingAdmissionWebhook](https://kubernetes.io/docs/admin/admission-controllers/#validatingadmissionwebhook-alpha-in-18-beta-in-19)
     admission controllers are required.
-       - We also recommend following the
-    [recommended set of admission controllers](https://kubernetes.io/docs/admin/admission-controllers/#is-there-a-recommended-set-of-admission-controllers-to-use).
+    - We also recommend following the
+      [recommended set of admission controllers](https://kubernetes.io/docs/admin/admission-controllers/#is-there-a-recommended-set-of-admission-controllers-to-use).
 - Firewall access for the range of ports that Game Servers can be connected to in the cluster.
 - Game Servers must have the [game server SDK]({{< ref "/docs/Guides/Client SDKs/_index.md"  >}}) integrated, to manage Game Server state, health checking, etc.
 
@@ -31,15 +31,30 @@ AKS, while also ensuring that all Cloud providers can support that version.
 
 The following container operating systems and architectures can be utilised with Agones:
 
-
 | OS        | Architecture | Support    |
-|-----------|--------------|------------|
+| --------- | ------------ | ---------- |
 | linux     | `amd64`      | **Stable** |
 | linux     | `arm64`      | Alpha      |
 | [windows] | `amd64`      | Alpha      |
 
 For all the platforms in Alpha, we would appreciate testing and bug reports on any issue found.
 
+## Agones and Kubernetes Supported Versions
+
+Each version of Agones supports a specific version of Kubernetes. When a new version of Agones supports a new version of Kubernetes, it is explicitly called out in the [release notes](https://agones.dev/site/blog/releases/).
+
+The following table lists recent Agones versions and their corresponding required Kubernetes versions:
+
+| Agones version | Kubernetes version |
+| -------------- | ------------------ |
+| 1.27           | 1.23               |
+| 1.26           | 1.23               |
+| 1.25           | 1.22               |
+| 1.24           | 1.22               |
+| 1.23           | 1.22               |
+| 1.22           | 1.21               |
+| 1.21           | 1.21               |
+
 ## Best Practices
 
 ### Separation of Agones from GameServer nodes
@@ -49,4 +64,4 @@ are scheduled for better isolation and resiliency. By default Agones prefers to
 `agones.dev/agones-system=true` and tolerates the node taint `agones.dev/agones-system=true:NoExecute`.
 If no dedicated nodes are available, Agones will run on regular nodes.
 
-[windows]: {{% ref "/docs/Guides/windows-gameservers.md" %}}
+[windows]: {{% ref "/docs/Guides/windows-gameservers.md" %}}