Adding missing documentation about: add option for extensions components to use host network and configure ports #3912

Orza · 2024-07-18T12:58:14Z

What type of PR is this?
/kind documentation

What this PR does / Why we need it:

Adding missing documentation about: add option for extensions components to use host network and configure ports

Which issue(s) this PR fixes:
Closes #3911

Special notes for your reviewer:

Added `agones.extensions.webhooks.port` & `agones.extensions.hostNetwork` params to helm installation Added topic about using custom CNI plugins with EKS

agones-bot · 2024-07-18T14:04:27Z

Build Succeeded 👏

Build Id: 688a961f-ff29-4991-aea3-17e71e073a89

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://238c64d-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3912/head:pr_3912 && git checkout pr_3912
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.43.0-dev-238c64d-amd64

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

markmandel · 2024-07-19T01:08:19Z

site/content/en/docs/Installation/Install Agones/helm.md

@@ -287,6 +287,8 @@ The following tables lists the configurable parameters of the Agones chart and t
 | Parameter                                                | Description                                                                                                                                                                                                                                                                                                      | Default                                   |
 |----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
 | `agones.extensions.http.port`                            | Port to use for liveness probe service and metrics                                                                                                                                                                                                                                                               | `8080`                                    |
+|`agones.extensions.webhooks.port`                         | Port to use for webhook service                                                                                                                                                                                                                                                                                  | `8081`                                    |
+|`agones.extensions.hostNetwork`                           | Determines if the Agones extensions should operate in hostNetwork mode. If running in hostNetwork mode, you should change `http.port` and `webhooks.port` to an available port.                                                                                                                                  | `false`                                   |


Two things.

(non blocking question): Should agones.extensions.hostNetwork go first, since it refers to agones.extensions.webhooks.port ?

Same as above, will need a feature shortcode. The renderer tends to dislike it in a middle of a table, so you will need to duplciate the table and have one that has a publishVersion and one with an expireyVersion.

markmandel · 2024-07-19T01:09:50Z

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

@@ -41,6 +41,12 @@ For Agones to work correctly, we need to allow UDP traffic to pass through to ou
 * Select **Inbound Rules**
 * **Edit Rules** to add a new **Custom UDP Rule** with a 7000-8000 port range and an appropriate **Source** CIDR range (`0.0.0.0/0` allows all traffic)

+## Use with custom CNI plugins
+
+To ensure compatibility with custom CNI plugins (such as Calico or Cilium), configure extensions application to use `hostNetwork` for proper functionality.


Suggested change

To ensure compatibility with custom CNI plugins (such as Calico or Cilium), configure extensions application to use `hostNetwork` for proper functionality.

To ensure compatibility with custom CNI plugins (such as Calico or [Cilium](https://docs.cilium.io/en/stable/installation/k8s-install-helm/)), configure extensions application to use `hostNetwork` for proper functionality.

Although, I'd love a way to link to the EKS docs tab, since it specifically references using hostNetwork?

agones-bot · 2024-07-22T10:01:40Z

Build Succeeded 👏

Build Id: 57019c4c-093e-481f-b6a8-4dc38ddae2e7

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://3fcaae7-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3912/head:pr_3912 && git checkout pr_3912
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.43.0-dev-3fcaae7-amd64

zmerlynn · 2024-07-25T01:43:15Z

/gcbrun

zmerlynn · 2024-07-25T01:45:03Z

/gcbrun

agones-bot · 2024-07-25T03:18:27Z

Build Succeeded 👏

Build Id: a501ee49-9699-4480-b071-e908306defd0

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://cf86648-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3912/head:pr_3912 && git checkout pr_3912
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.43.0-dev-cf86648-amd64

markmandel

👍🏻 feature shortcodes look good! Just a few docs improvements and we should be good to go.

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

site/content/en/docs/Installation/Install Agones/helm.md

markmandel · 2024-08-22T08:19:43Z

Gentle bump on this to see if we can get these changes in?

Co-authored-by: Mark Mandel <markmandel@google.com>

agones-bot · 2024-08-22T12:47:04Z

Build Failed 😭

Build Id: 2e280511-8a21-4ed6-a0bf-611f37d496f0

Status: FAILURE

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

agones-bot · 2024-08-28T13:32:42Z

Build Succeeded 🥳

Build Id: af193caa-233b-413a-9ff0-aef9192e5000

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

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.43.0-dev-76dfaf6
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.43.0-dev-76dfaf6
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.43.0-dev-76dfaf6-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.43.0-dev-76dfaf6
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.43.0-dev-76dfaf6
Linux C++ SDK (build): agonessdk-1.43.0-dev-76dfaf6-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.43.0-dev-76dfaf6.zip

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

https://76dfaf6-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3912/head:pr_3912 && git checkout pr_3912
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.43.0-dev-76dfaf6

agones-bot · 2024-09-09T07:34:22Z

Build Succeeded 🥳

Build Id: 3d96a273-8504-49f3-863b-4c2faaaa82e3

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

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.44.0-dev-e04e7de
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.44.0-dev-e04e7de
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.44.0-dev-e04e7de-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.44.0-dev-e04e7de
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.44.0-dev-e04e7de
Linux C++ SDK (build): agonessdk-1.44.0-dev-e04e7de-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.44.0-dev-e04e7de.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3912/head:pr_3912 && git checkout pr_3912
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.44.0-dev-e04e7de

igooch

This needs bit of editing around the feature publishVersion and feature expiryVersion. It might be easier to rebase the original commit off of main?

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

site/content/en/docs/Installation/Install Agones/helm.md

igooch

This feature was published in 1.43, so the publish blocks should be removed.

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

…y released

…dy released

igooch

One last update.

igooch · 2024-09-19T17:25:21Z

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

@@ -41,6 +41,12 @@ For Agones to work correctly, we need to allow UDP traffic to pass through to ou
 * Select **Inbound Rules**
 * **Edit Rules** to add a new **Custom UDP Rule** with a 7000-8000 port range and an appropriate **Source** CIDR range (`0.0.0.0/0` allows all traffic)

+## Use with custom CNI plugins
+
+To ensure compatibility with custom CNI plugins (such as Calico or [Cilium](https://docs.cilium.io/en/stable/installation/k8s-install-helm/)), configure extensions application to use `hostNetwork` for proper functionality via the `agones.extensions.hostNetwork` Agones [Helm]({{ ref "something-I-can't-do-off-the-top-of-my-head"}}) variable. Also make sure to set the `agones.extensions.http.port` and the `agones.extensions.webhooks.port` values as well.


Suggested change

To ensure compatibility with custom CNI plugins (such as Calico or [Cilium](https://docs.cilium.io/en/stable/installation/k8s-install-helm/)), configure extensions application to use `hostNetwork` for proper functionality via the `agones.extensions.hostNetwork` Agones [Helm]({{ ref "something-I-can't-do-off-the-top-of-my-head"}}) variable. Also make sure to set the `agones.extensions.http.port` and the `agones.extensions.webhooks.port` values as well.

To ensure compatibility with custom CNI plugins (such as Calico or [Cilium](https://docs.cilium.io/en/stable/installation/k8s-install-helm/)), configure extensions application to use `hostNetwork` for proper functionality via the `agones.extensions.hostNetwork` Agones [Helm]({{ ref "../Install Agones/helm.md"}}) variable. Also make sure to set the `agones.extensions.http.port` and the `agones.extensions.webhooks.port` values as well.

I haven't tested the updated ref, but it should be something like that.

agones-bot · 2024-09-19T18:49:22Z

Build Succeeded 🥳

Build Id: fabc5397-b186-498b-8fab-aba41dbf81c0

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

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.44.0-dev-026450c
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.44.0-dev-026450c
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.44.0-dev-026450c-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.44.0-dev-026450c
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.44.0-dev-026450c
Linux C++ SDK (build): agonessdk-1.44.0-dev-026450c-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.44.0-dev-026450c.zip

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

https://026450c-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3912/head:pr_3912 && git checkout pr_3912
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.44.0-dev-026450c

Docs updated:

238c64d

Added `agones.extensions.webhooks.port` & `agones.extensions.hostNetwork` params to helm installation Added topic about using custom CNI plugins with EKS

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

markmandel reviewed Jul 19, 2024

View reviewed changes

hide new options with feature shortcode for v1.43 release

3fcaae7

Orza requested a review from markmandel July 23, 2024 17:40

Merge branch 'main' into update-docs-for-extensions-components

cf86648

markmandel reviewed Jul 30, 2024

View reviewed changes

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

site/content/en/docs/Installation/Install Agones/helm.md Outdated Show resolved Hide resolved

Orza and others added 3 commits August 22, 2024 14:14

Merge branch 'main' into update-docs-for-extensions-components

b65b34b

Update site/content/en/docs/Installation/Creating Cluster/eks.md

076cacd

Co-authored-by: Mark Mandel <markmandel@google.com>

Update site/content/en/docs/Installation/Install Agones/helm.md

e180384

Co-authored-by: Mark Mandel <markmandel@google.com>

Merge branch 'main' into update-docs-for-extensions-components

76dfaf6

Orza requested a review from markmandel August 28, 2024 13:53

Merge branch 'main' into update-docs-for-extensions-components

e04e7de

igooch reviewed Sep 9, 2024

View reviewed changes

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

site/content/en/docs/Installation/Install Agones/helm.md Outdated Show resolved Hide resolved

gongmax added 3 commits September 19, 2024 09:51

Update helm.md to reflect the new published version

54df4c5

Update eks.md to reflect the new published version

13c8b30

Merge branch 'main' into update-docs-for-extensions-components

dff86c8

igooch reviewed Sep 19, 2024

View reviewed changes

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

gongmax added 2 commits September 19, 2024 10:10

Update eks.md to remove the feature block since the feature is alread…

311f9a8

…y released

Update helm.md to remove the feature block since the feature is alrea…

fe07856

…dy released

igooch reviewed Sep 19, 2024

View reviewed changes

Update eks.md to fix an invalid link

026450c

igooch approved these changes Sep 19, 2024

View reviewed changes

igooch enabled auto-merge (squash) September 19, 2024 18:03

igooch merged commit 5c18bef into googleforgames:main Sep 19, 2024
4 checks passed

Orza deleted the update-docs-for-extensions-components branch September 20, 2024 15:46

	To ensure compatibility with custom CNI plugins (such as Calico or Cilium), configure extensions application to use `hostNetwork` for proper functionality.
	To ensure compatibility with custom CNI plugins (such as Calico or [Cilium](https://docs.cilium.io/en/stable/installation/k8s-install-helm/)), configure extensions application to use `hostNetwork` for proper functionality.

Adding missing documentation about: add option for extensions components to use host network and configure ports #3912

Adding missing documentation about: add option for extensions components to use host network and configure ports #3912

Uh oh!

Conversation

Orza commented Jul 18, 2024

Uh oh!

agones-bot commented Jul 18, 2024

Uh oh!

Uh oh!

markmandel Jul 19, 2024

Choose a reason for hiding this comment

Uh oh!

markmandel Jul 19, 2024

Choose a reason for hiding this comment

Uh oh!

agones-bot commented Jul 22, 2024

Uh oh!

zmerlynn commented Jul 25, 2024

Uh oh!

zmerlynn commented Jul 25, 2024

Uh oh!

agones-bot commented Jul 25, 2024

Uh oh!

markmandel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

markmandel commented Aug 22, 2024

Uh oh!

agones-bot commented Aug 22, 2024

Uh oh!

agones-bot commented Aug 28, 2024

Uh oh!

agones-bot commented Sep 9, 2024

Uh oh!

igooch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

igooch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

igooch left a comment

Choose a reason for hiding this comment

Uh oh!

igooch Sep 19, 2024

Choose a reason for hiding this comment

Uh oh!

agones-bot commented Sep 19, 2024

Uh oh!

Uh oh!

Uh oh!