Update site documentation to reflect firewall prefix and default to Autopilot cluster creation for Agones #3769

vicentefb · 2024-04-16T23:06:42Z

What type of PR is this?

Uncomment only one /kind <> line, press 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
/kind release

What this PR does / Why we need it:
Nit fix on site documentation so that the firewall created has a name with the prefix "gke-" so that the GCE enforcer doesn't delete it. Also, include a reference link to the firewall creation in each pre-reqs. On the other hand, switched the order of cluster creation so that it defaults to Autopilot cluster creation first.

Which issue(s) this PR fixes:

Closes #

Special notes for your reviewer:

…irewall prefix name and link

agones-bot · 2024-04-17T01:04:05Z

Build Succeeded 👏

Build Id: 6c8e50f4-0536-411c-b000-5abe6d5b9db1

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):

https://6b24311-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3769/head:pr_3769 && git checkout pr_3769
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-6b24311-amd64

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

agones-bot · 2024-04-19T03:22:03Z

Build Failed 😱

Build Id: b31ceac1-3cb0-40b3-885b-e2a36123dbb3

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

agones-bot · 2024-04-19T16:38:17Z

Build Succeeded 👏

Build Id: 870b3591-9600-4aef-bcf0-24451450933d

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):

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3769/head:pr_3769 && git checkout pr_3769
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-d51c107-amd64

markmandel · 2024-04-19T17:31:35Z

site/layouts/shortcodes/gs-prerequisites.html

@@ -2,7 +2,7 @@
 {{- $test := eq (.Get "link_test") "true" | default true }}
 <p>The following prerequisites are required to create a GameServer:</p>
 <ol>
-<li>A Kubernetes cluster with the UDP port range 7000-8000 open on each node.</li>
+<li>A Kubernetes cluster with the UDP port range 7000-8000 open on each node. <a href="https://agones.dev/site/docs/installation/creating-cluster/gke/#creating-the-firewall">Creating the firewall</a></li>


This should resolve to either the local or which snapshot version you are seeing - so it can't point at the domain directly.

You can use:

agones/site/config.toml

Line 15 in 772fffb

baseURL = "/site/"

As the root of the link, via:

https://gohugo.io/templates/shortcode-templates/#:~:text=Params.shortcode_color).-,%24.Page.Site.Params,-refers%20to%20parameters

Okok sg, i used /site/ now inside the href

I think what @markmandel is saying is that even baseURL could be variable, so you need to use a function here to grab the config.

@markmandel any reason we can't use https://gohugo.io/methods/site/baseurl/ here? I think this just becomes {{ .Site.BaseURL }}docs/installation/creating-cluster/gke/#creating-the-firewall.

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

agones-bot · 2024-04-22T19:25:33Z

Build Succeeded 👏

Build Id: 1c3b19ba-ee02-490a-a72b-1a02028a98ed

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):

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3769/head:pr_3769 && git checkout pr_3769
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-a0a6606-amd64

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

agones-bot · 2024-04-22T22:52:28Z

Build Succeeded 👏

Build Id: 602efab9-1dd1-41de-93c1-ccd557b362d3

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):

https://3be0171-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3769/head:pr_3769 && git checkout pr_3769
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-3be0171-amd64

zmerlynn

Almost!

site/layouts/shortcodes/gs-prerequisites.html

zmerlynn · 2024-04-22T23:01:51Z

site/layouts/shortcodes/gs-prerequisites.html

@@ -2,7 +2,7 @@
 {{- $test := eq (.Get "link_test") "true" | default true }}
 <p>The following prerequisites are required to create a GameServer:</p>
 <ol>
-<li>A Kubernetes cluster with the UDP port range 7000-8000 open on each node.</li>
+<li>A Kubernetes cluster with the UDP port range 7000-8000 open on each node. <a href="https://agones.dev/site/docs/installation/creating-cluster/gke/#creating-the-firewall">Creating the firewall</a></li>


I think what @markmandel is saying is that even baseURL could be variable, so you need to use a function here to grab the config.

@markmandel any reason we can't use https://gohugo.io/methods/site/baseurl/ here? I think this just becomes {{ .Site.BaseURL }}docs/installation/creating-cluster/gke/#creating-the-firewall.

agones-bot · 2024-04-23T00:48:40Z

Build Failed 😱

Build Id: 1bb3da91-09df-41e6-8569-77535b47d571

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

agones-bot · 2024-04-23T16:38:13Z

Build Succeeded 👏

Build Id: 464b85ce-ccf9-4287-a091-97acf7c7983e

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):

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3769/head:pr_3769 && git checkout pr_3769
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-cbf0d3d-amd64

agones-bot · 2024-04-24T19:44:06Z

Build Succeeded 👏

Build Id: a242b552-25da-4a4d-9294-df74a19697f7

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):

https://60c1b17-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3769/head:pr_3769 && git checkout pr_3769
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.41.0-dev-60c1b17-amd64

updated site documentation reflecting default autopilot cluster and f…

6b24311

…irewall prefix name and link

github-actions bot added kind/documentation Documentation for Agones size/S labels Apr 16, 2024

zmerlynn self-assigned this Apr 17, 2024

zmerlynn requested changes Apr 18, 2024

View reviewed changes

site/content/en/docs/Installation/Creating Cluster/gke.md Outdated Show resolved Hide resolved

removed alert clause

d51c107

markmandel reviewed Apr 19, 2024

View reviewed changes

site/content/en/docs/Installation/Creating Cluster/gke.md Show resolved Hide resolved

site/content/en/docs/Installation/Creating Cluster/gke.md Outdated Show resolved Hide resolved

reorder cluster selection section, reference site link

a0a6606

vicentefb requested review from zmerlynn and markmandel April 22, 2024 19:12

nit

f437027

zmerlynn reviewed Apr 22, 2024

View reviewed changes

site/content/en/docs/Installation/Creating Cluster/gke.md Outdated Show resolved Hide resolved

site/content/en/docs/Installation/Creating Cluster/gke.md Show resolved Hide resolved

swapped blocks

3be0171

zmerlynn reviewed Apr 22, 2024

View reviewed changes

changed site link to use hugo

9412981

vicentefb requested a review from zmerlynn April 22, 2024 23:42

Merge branch 'main' into Firewall_Documentation

cbf0d3d

zmerlynn approved these changes Apr 23, 2024

View reviewed changes

zmerlynn enabled auto-merge (squash) April 23, 2024 15:31

zmerlynn disabled auto-merge April 23, 2024 16:21

Merge branch 'main' into Firewall_Documentation

60c1b17

zmerlynn enabled auto-merge (squash) April 24, 2024 18:41

zmerlynn merged commit 2e34147 into googleforgames:main Apr 24, 2024
4 checks passed

vicentefb mentioned this pull request Oct 15, 2024

Request to become approver of Agones repo #4017

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update site documentation to reflect firewall prefix and default to Autopilot cluster creation for Agones #3769

Update site documentation to reflect firewall prefix and default to Autopilot cluster creation for Agones #3769

vicentefb commented Apr 16, 2024

agones-bot commented Apr 17, 2024

agones-bot commented Apr 19, 2024

agones-bot commented Apr 19, 2024

markmandel Apr 19, 2024

vicentefb Apr 22, 2024

zmerlynn Apr 22, 2024

agones-bot commented Apr 22, 2024

agones-bot commented Apr 22, 2024

zmerlynn left a comment

zmerlynn Apr 22, 2024

agones-bot commented Apr 23, 2024

agones-bot commented Apr 23, 2024

agones-bot commented Apr 24, 2024

Update site documentation to reflect firewall prefix and default to Autopilot cluster creation for Agones #3769

Update site documentation to reflect firewall prefix and default to Autopilot cluster creation for Agones #3769

Conversation

vicentefb commented Apr 16, 2024

agones-bot commented Apr 17, 2024

agones-bot commented Apr 19, 2024

agones-bot commented Apr 19, 2024

markmandel Apr 19, 2024

Choose a reason for hiding this comment

vicentefb Apr 22, 2024

Choose a reason for hiding this comment

zmerlynn Apr 22, 2024

Choose a reason for hiding this comment

agones-bot commented Apr 22, 2024

agones-bot commented Apr 22, 2024

zmerlynn left a comment

Choose a reason for hiding this comment

zmerlynn Apr 22, 2024

Choose a reason for hiding this comment

agones-bot commented Apr 23, 2024

agones-bot commented Apr 23, 2024

agones-bot commented Apr 24, 2024