Move supported site K8s version to shortcodes #1917

markmandel · 2020-12-08T00:20:56Z

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature
/kind hotfix

What this PR does / Why we need it:

Implements two new shortcodes:

{{% k8s-version %}} - which outputs the currently supported version
{{% k8s-api href="#podtemplatespec-v1-core" %}} - which outputs the api reference url to the supported k8s version.

These shortcode utilise the HUGO_ENV environment to determine if it should show the current K8s version, or the next - as it is only set to the value of "production" when it is generated for the release version of the agones.dev website.

Also added updates to the release checklist to manage this as well.

Ideally, this will remove lots of busy work of feature shortcoding a lot of content as we churn through Kubernetes versions.

Which issue(s) this PR fixes:

Work on #1824

Special notes for your reviewer:

Long term, we may want to expand this to include separate tools for current and next full semver versions - i.e. rather than just
1.16 ➡ 1.17, but something like 1.16.3 ➡ 1.17.14.

We cheat a little on this release as there is 1.16.13 and 1.17.13 released on both 1.16 and 1.17.

agones-bot · 2020-12-08T00:42:02Z

Build Succeeded 👏

Build Id: 40b9342a-0f1b-42cc-9e3d-d08ee8d2dc42

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

image: gcr.io/agones-images/agones-controller:1.11.0-275cfa7
image: gcr.io/agones-images/agones-sdk:1.11.0-275cfa7
image: gcr.io/agones-images/agones-ping:1.11.0-275cfa7
Linux C++ SDK (build): agonessdk-1.11.0-275cfa7-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.11.0-275cfa7.zip

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

https://275cfa7-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1917/head:pr_1917 && git checkout pr_1917
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.11.0-275cfa7

agones-bot · 2020-12-08T01:16:23Z

Build Succeeded 👏

Build Id: 08955d6b-827b-4fef-bc60-dd21916a9431

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

image: gcr.io/agones-images/agones-controller:1.11.0-03e2510
image: gcr.io/agones-images/agones-sdk:1.11.0-03e2510
image: gcr.io/agones-images/agones-ping:1.11.0-03e2510
Linux C++ SDK (build): agonessdk-1.11.0-03e2510-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.11.0-03e2510.zip

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

https://03e2510-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1917/head:pr_1917 && git checkout pr_1917
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.11.0-03e2510

markmandel · 2020-12-08T02:11:09Z

I'm kinda proud of this one - should hopefully save lots of time in the long run 😄

roberthbailey · 2020-12-08T03:30:41Z

site/content/en/docs/Installation/Creating Cluster/aks.md

@@ -28,8 +28,8 @@ az group create --name $AKS_RESOURCE_GROUP --location $AKS_LOCATION

 # Create the AKS cluster - this might take some time. Type 'az aks create -h' to see all available options

-# The following command will create a four Node AKS cluster. Node size is Standard A1 v1 and Kubernetes version is 1.16.13. Plus, SSH keys will be generated for you, use --ssh-key-value to provide your values
-az aks create --resource-group $AKS_RESOURCE_GROUP --name $AKS_NAME --node-count 4 --generate-ssh-keys --node-vm-size Standard_A4_v2 --kubernetes-version 1.16.13
+# The following command will create a four Node AKS cluster. Node size is Standard A1 v1 and Kubernetes version is {{% k8s-version %}}.13. Plus, SSH keys will be generated for you, use --ssh-key-value to provide your values


We need to remember to change the minor versions too. Maybe make a short-code for aks-k8s-minor-version?

roberthbailey · 2020-12-08T03:31:32Z

site/content/en/docs/Installation/Creating Cluster/minikube.md

@@ -30,7 +30,7 @@ The following command starts a local minikube cluster via virtualbox - but this
 replaced by a [vm-driver](https://github.com/kubernetes/minikube#requirements) of your choice.

 ```bash
-minikube start --kubernetes-version v1.16.13 --vm-driver virtualbox
+minikube start --kubernetes-version v{{% k8s-version %}}.13 --vm-driver virtualbox


minikube-k8s-minor-version

These are good ideas. I'll make this change 👍

Done! I like it!

Implements two new shortcodes: * {{% k8s-version %}} - which outputs the currently supported version * {{% k8s-api href="#podtemplatespec-v1-core" %}} - which outputs the api reference url to the supported k8s version. These shortcode utilise the `HUGO_ENV` environment to determine if it should show the current K8s version, or the next - as it is only set to the value of "production" when it is generated for the release version of the agones.dev website. Also added updates to the release checklist to manage this as well. Ideally, this will remove lots of busy work of feature shortcoding a lot of content as we churn through Kubernetes versions. Long term, we may want to expand this to include separate tools for current and next full semver versions - i.e. rather than just 1.16 ➡ 1.17, but something like 1.16.3 ➡ 1.17.14. We cheat a little on this release as there is 1.16.13 and 1.17.13 released on both 1.16 and 1.17. Work on googleforgames#1824

agones-bot · 2020-12-08T22:11:16Z

Build Failed 😱

Build Id: 2d465f9e-22df-4421-8770-9518053f22e5

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

roberthbailey

Not sure why the tests failed, but this looks great. It will definitely decrease our maintenance for each future k8s version upgrade. :)

google-oss-robot · 2020-12-08T22:56:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: markmandel, 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:

~~OWNERS~~ [markmandel,roberthbailey]

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

agones-bot · 2020-12-08T23:02:40Z

Build Failed 😱

Build Id: 70c14b1f-fd04-41fa-bef0-10e19797af71

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2020-12-08T23:34:09Z

Build Succeeded 👏

Build Id: d7a949dd-0997-44ec-994e-10728c21cc75

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

image: gcr.io/agones-images/agones-controller:1.11.0-7350641
image: gcr.io/agones-images/agones-sdk:1.11.0-7350641
image: gcr.io/agones-images/agones-ping:1.11.0-7350641
Linux C++ SDK (build): agonessdk-1.11.0-7350641-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.11.0-7350641.zip

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

https://7350641-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1917/head:pr_1917 && git checkout pr_1917
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.11.0-7350641

markmandel added kind/feature New features for Agones kind/documentation Documentation for Agones area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. labels Dec 8, 2020

markmandel requested review from roberthbailey and pooneh-m December 8, 2020 00:20

google-cla bot added the cla: yes label Dec 8, 2020

google-oss-robot added the size/M label Dec 8, 2020

google-oss-robot requested review from aLekSer and dzlier-gcp December 8, 2020 00:21

google-oss-robot added the approved label Dec 8, 2020

markmandel force-pushed the cleanup/site-1.17 branch from 275cfa7 to 03e2510 Compare December 8, 2020 00:55

roberthbailey reviewed Dec 8, 2020

View reviewed changes

roberthbailey self-assigned this Dec 8, 2020

markmandel force-pushed the cleanup/site-1.17 branch from 03e2510 to b26389e Compare December 8, 2020 21:53

Review updates.

7350641

markmandel force-pushed the cleanup/site-1.17 branch from b26389e to 7350641 Compare December 8, 2020 21:54

roberthbailey approved these changes Dec 8, 2020

View reviewed changes

google-oss-robot added the lgtm label Dec 8, 2020

markmandel merged commit 7b7096d into googleforgames:master Dec 8, 2020

markmandel deleted the cleanup/site-1.17 branch December 8, 2020 23:42

markmandel added this to the 1.11.0 milestone Dec 8, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move supported site K8s version to shortcodes #1917

Move supported site K8s version to shortcodes #1917

markmandel commented Dec 8, 2020

agones-bot commented Dec 8, 2020

agones-bot commented Dec 8, 2020

markmandel commented Dec 8, 2020

roberthbailey Dec 8, 2020

roberthbailey Dec 8, 2020

markmandel Dec 8, 2020

markmandel Dec 8, 2020

agones-bot commented Dec 8, 2020

roberthbailey left a comment

google-oss-robot commented Dec 8, 2020

agones-bot commented Dec 8, 2020

agones-bot commented Dec 8, 2020

Move supported site K8s version to shortcodes #1917

Move supported site K8s version to shortcodes #1917

Conversation

markmandel commented Dec 8, 2020

agones-bot commented Dec 8, 2020

agones-bot commented Dec 8, 2020

markmandel commented Dec 8, 2020

roberthbailey Dec 8, 2020

Choose a reason for hiding this comment

roberthbailey Dec 8, 2020

Choose a reason for hiding this comment

markmandel Dec 8, 2020

Choose a reason for hiding this comment

markmandel Dec 8, 2020

Choose a reason for hiding this comment

agones-bot commented Dec 8, 2020

roberthbailey left a comment

Choose a reason for hiding this comment

google-oss-robot commented Dec 8, 2020

agones-bot commented Dec 8, 2020

agones-bot commented Dec 8, 2020