Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds matrix of Agones versions to Kubernetes versions. #2819

Conversation

igooch
Copy link
Collaborator

@igooch igooch commented Nov 21, 2022

/kind documentation

What this PR does / Why we need it:
This makes the Agones version --> Kubernetes version mappings clear in the overview installation documentation.

Which issue(s) this PR fixes:
Fixes #2237

Special notes for your reviewer:
n/a

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: e0a47afd-cdd4-47cf-acf8-0ba867d5dbbd

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-62acae8-amd64

Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oooh neat! As a quick double check, did this take into account #2279?

We should also update the release checklist to update this at release time as well if the K8s version changes.


| Agones version | Kubernetes version |
| -------------- | ------------------ |
| 1.27 | 1.23 |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the top row pull the data from the k8s-version and release-version shortcodes?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea -- I'll add that in.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried adding | {{% release-version %}} | {{% k8s-version %}} | as the top line, but when I ran make site-server ENV=RELEASE_VERSION=1.20 the output was not as expected:

| Agones version | Kubernetes version |
| 1.20 | 1.23 |

Any idea if I'm using the shortcode incorrectly? Or is this an issue with the shortcode itself? Or an issue with the make site-server input args?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The k8s-version shortcode is hardcoded (here and here), and there is no validation to ensure the mapping between it and the release-version is correct. I think to use make site-server, you have to use the correct environment variable of RELEASE_VERSION, or just do not use any input args so it will pick the correct value by default

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm understanding correctly, it would be better not to add in | {{% release-version %}} | {{% k8s-version %}} | because the release-version is variable and the k8s-version is hard-coded?

@igooch
Copy link
Collaborator Author

igooch commented Nov 21, 2022

Oooh neat! As a quick double check, did this take into account #2279?

This PR does not address #2279

@google-oss-prow google-oss-prow bot removed the lgtm label Nov 22, 2022
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 32dbbc33-d6ad-4305-a669-fe147bd3bb7d

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-01fc17e-amd64


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 [Agones version release notes](https://agones.dev/site/blog/releases/).

The following table lists recent Agones versions and their corresponding required Kubernetes versions for Game Servers:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Remove the "for Game Servers" bit at the end of the sentence.

| 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 [Agones version release notes](https://agones.dev/site/blog/releases/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Maybe s/Agones version release notes/release notes/ (I think that the first part is implied and doesn't need to be explicit).

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 28c7d5f4-eab7-4f35-8c57-21cb1e96c050

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-f6ddc69-amd64

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 0566f2d4-b24a-492f-b425-77d189dc9b8b

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-2f0b548-amd64

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: b4102356-0fee-480a-b8b3-4095c8af2cea

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-3dfb5ec-amd64

@mangalpalli mangalpalli added the feature-freeze-do-not-merge Only eligible to be merged once we are out of feature freeze (next full release) label Nov 29, 2022
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: cc72f595-8dee-40fd-a39b-da6b2c4541c9

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-7f040d4-amd64

- [ ] 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file seems to have gained some duplicate lines.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah whoops, looks like I messed up the merge. I'll revert that commit and retry the merge.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gah, this PR just got extra messy. I'm going to reset to a previous commit before any merges, and then rebase to main.

@google-oss-prow google-oss-prow bot added size/L and removed size/M labels Nov 30, 2022
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 11a12403-8ce0-4d42-ac59-994f9580fa9d

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-1e5cac0-amd64

@google-oss-prow google-oss-prow bot added size/XL and removed size/L labels Nov 30, 2022
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: adf16192-83c8-4287-97f9-1ee6b967ce91

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-58bc6b6-amd64

Includes instructions to update Agones to Kubernetes version mapping in release checklist
@igooch igooch force-pushed the agones-kubernetes-version-matrix-2237 branch from 58bc6b6 to 2442953 Compare November 30, 2022 18:50
@google-oss-prow google-oss-prow bot added size/M and removed size/XL labels Nov 30, 2022
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 52b34f71-87ea-4927-8343-93e99e123b9d

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/2819/head:pr_2819 && git checkout pr_2819
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.28.0-2442953-amd64

@google-oss-prow
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gongmax, igooch, roberthbailey

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@roberthbailey roberthbailey merged commit 85726ea into googleforgames:main Dec 1, 2022
@roberthbailey
Copy link
Member

Merging during the freeze since this is a documentation only change.

@roberthbailey roberthbailey removed the feature-freeze-do-not-merge Only eligible to be merged once we are out of feature freeze (next full release) label Dec 1, 2022
@mangalpalli mangalpalli added this to the 1.28.0 milestone Dec 6, 2022
chiayi pushed a commit to chiayi/agones that referenced this pull request Dec 13, 2022
…s#2819)

Includes instructions to update Agones to Kubernetes version mapping in release checklist
@igooch igooch deleted the agones-kubernetes-version-matrix-2237 branch January 26, 2023 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Kubernetes and Agones supported version matrix
6 participants