Adoption of Sidecar Containers by markmandel · Pull Request #4146 · agones-dev/agones

markmandel · 2025-04-07T01:46:54Z

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:

This is a breaking change for both how health checking works and to the SDK lifecycles, but behind the SidecarContainer feature flag.

This moves the sdkserver into a initContainer with a RestartPolicy of always. This means that it will be alive for the entirety of the main Pod's containers.
There is no waiting for the Shutdown signal any more for the sidecar container before shutting down since it now natively waits for the main Pod containers.
The RestartPolicy of the gameserver container defaults to Never (although it can be changed), and no longer restarts before the Ready state to simplify lifecycle health checking.
Various hacky health checks are now simplified to "is the Pod in a Failed state.", and therefore we no longer need to do as much text searching for edge cases.

Which issue(s) this PR fixes:

Work on #3642

Special notes for your reviewer:

Next: Write the docs for this work.

agones-bot · 2025-04-07T03:16:09Z

Build Failed 😭

Build Id: 743d2942-f5ea-4307-87a4-0ac7f292afc7

Status: FAILURE

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

markmandel · 2025-04-07T04:46:37Z

@igooch @gongmax can you cycle the autopilot clusters please? 😄

agones-bot · 2025-04-07T23:21:00Z

Build Succeeded 🥳

Build Id: bcd4442a-a271-4d0b-b317-8f0aa3cff6f3

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.49.0-dev-eab7749
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.49.0-dev-eab7749
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.49.0-dev-eab7749-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.49.0-dev-eab7749
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.49.0-dev-eab7749
Linux C++ SDK (build): agonessdk-1.49.0-dev-eab7749-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.49.0-dev-eab7749.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4146/head:pr_4146 && git checkout pr_4146
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.49.0-dev-eab7749

markmandel · 2025-04-10T00:32:55Z

Conflicts fixed. Gentle bump on review plz :)

agones-bot · 2025-04-10T01:28:47Z

Build Succeeded 🥳

Build Id: 82100b9d-79d2-42a1-a84f-870207efca0f

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.49.0-dev-b4ecf04
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.49.0-dev-b4ecf04
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.49.0-dev-b4ecf04-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.49.0-dev-b4ecf04
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.49.0-dev-b4ecf04
Linux C++ SDK (build): agonessdk-1.49.0-dev-b4ecf04-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.49.0-dev-b4ecf04.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4146/head:pr_4146 && git checkout pr_4146
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.49.0-dev-b4ecf04

peterzhongyi · 2025-04-12T00:15:22Z

Thanks Mark! I'll take a look! Coincidentally, I just met with a potential customer who's evaluating Agones and they were specifically interested in GameServer's pod restart policy induced edge cases. So this PR might change a lot of things!

agones-bot · 2025-04-12T00:38:11Z

Build Failed 😭

Build Id: e780bc6f-9ccc-432d-97d4-1274f44aadba

Status: FAILURE

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

markmandel · 2025-04-12T03:27:23Z

Looks like it's time to recycle the autopilot clusters please.

igooch · 2025-04-14T15:27:48Z

Looks like it's time to recycle the autopilot clusters please.

Updating now.

peterzhongyi · 2025-04-14T20:02:46Z

/gcbrun

agones-bot · 2025-04-14T21:11:05Z

Build Succeeded 🥳

Build Id: 9aadf63a-9089-4c62-b4de-bbdf0cc35d7d

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.49.0-dev-1e58065
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.49.0-dev-1e58065
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.49.0-dev-1e58065-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.49.0-dev-1e58065
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.49.0-dev-1e58065
Linux C++ SDK (build): agonessdk-1.49.0-dev-1e58065-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.49.0-dev-1e58065.zip

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

https://1e58065-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4146/head:pr_4146 && git checkout pr_4146
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.49.0-dev-1e58065

agones-bot · 2025-04-15T02:14:28Z

Build Succeeded 🥳

Build Id: 5be3d922-35be-4d70-9a00-76f5be90d09f

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.49.0-dev-884674e
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.49.0-dev-884674e
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.49.0-dev-884674e-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.49.0-dev-884674e
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.49.0-dev-884674e
Linux C++ SDK (build): agonessdk-1.49.0-dev-884674e-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.49.0-dev-884674e.zip

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

https://884674e-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4146/head:pr_4146 && git checkout pr_4146
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.49.0-dev-884674e

agones-bot · 2025-04-17T03:54:22Z

Build Succeeded 🥳

Build Id: bc079cc7-a5e7-4adb-a1f0-57408872e367

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.49.0-dev-bcd0c0b
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.49.0-dev-bcd0c0b
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.49.0-dev-bcd0c0b-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.49.0-dev-bcd0c0b
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.49.0-dev-bcd0c0b
Linux C++ SDK (build): agonessdk-1.49.0-dev-bcd0c0b-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.49.0-dev-bcd0c0b.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4146/head:pr_4146 && git checkout pr_4146
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.49.0-dev-bcd0c0b

markmandel · 2025-04-17T18:30:42Z

build/Makefile

 	echo "Starting e2e integration test!"
 ifdef E2E_USE_GOTESTSUM
-	$(GOTESTSUM) --packages=$(agones_package)/test/e2e -- $(go_test_args) -timeout=30m $(ARGS) -args \
+	$(GOTESTSUM) --packages=$(agones_package)/test/e2e -- $(go_test_args) -timeout=45m $(ARGS) -args \


Revert back down to 30m?

pkg/apis/agones/v1/gameserver.go

pkg/gameservers/controller.go

pkg/gameservers/health.go

This is a breaking change for both how health checking works and to the SDK lifecycles, but behind the `SidecarContainer` feature flag. 1. This moves the sdkserver into a initContainer with a `RestartPolicy` of always. This means that it will be alive for the entirety of the main Pod's containers. 2. There is no waiting for the Shutdown signal any more for the sidecar container before shutting down since it now natively waits for the main Pod containers. 3. The RestartPolicy of the `gameserver` container defaults to `Never` (although it can be changed), and no longer restarts before the `Ready` state to simplify lifecycle health checking. 4. Various hacky health checks are now simplified to "is the Pod in a `Failed` state.", and therefore we no longer need to do as much text searching for edge cases. Next: Write the docs to make sure this change all works. Work on agones-dev#3642

agones-bot · 2025-04-29T04:56:06Z

Build Succeeded 🥳

Build Id: accafeee-0a46-4579-8686-fdc0bdd786e8

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.49.0-dev-cda7ff3
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.49.0-dev-cda7ff3
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.49.0-dev-cda7ff3-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.49.0-dev-cda7ff3
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.49.0-dev-cda7ff3
Linux C++ SDK (build): agonessdk-1.49.0-dev-cda7ff3-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.49.0-dev-cda7ff3.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4146/head:pr_4146 && git checkout pr_4146
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.49.0-dev-cda7ff3

agones-bot · 2025-04-30T19:24:22Z

Build Succeeded 🥳

Build Id: daa9c466-b770-4f65-94f0-0628d8791ff5

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.49.0-dev-7d74c4e
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.49.0-dev-7d74c4e
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.49.0-dev-7d74c4e-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.49.0-dev-7d74c4e
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.49.0-dev-7d74c4e
Linux C++ SDK (build): agonessdk-1.49.0-dev-7d74c4e-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.49.0-dev-7d74c4e.zip

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

https://7d74c4e-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4146/head:pr_4146 && git checkout pr_4146
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.49.0-dev-7d74c4e

agones-bot · 2025-04-30T21:50:14Z

Build Succeeded 🥳

Build Id: aee3da24-e49f-4528-9892-388074c0fece

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.49.0-dev-2166bee
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.49.0-dev-2166bee
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.49.0-dev-2166bee-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.49.0-dev-2166bee
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.49.0-dev-2166bee
Linux C++ SDK (build): agonessdk-1.49.0-dev-2166bee-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.49.0-dev-2166bee.zip

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

https://2166bee-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4146/head:pr_4146 && git checkout pr_4146
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.49.0-dev-2166bee

markmandel added the kind/breaking Breaking change label Apr 7, 2025

markmandel requested review from gongmax and igooch April 7, 2025 01:46

markmandel force-pushed the feature/sidecar-containers branch from 9a34a42 to eab7749 Compare April 7, 2025 20:27

markmandel force-pushed the feature/sidecar-containers branch from eab7749 to b4ecf04 Compare April 10, 2025 00:32

markmandel requested a review from peterzhongyi April 12, 2025 00:01

markmandel force-pushed the feature/sidecar-containers branch from b4ecf04 to 1e58065 Compare April 12, 2025 00:06

markmandel force-pushed the feature/sidecar-containers branch from 1e58065 to 884674e Compare April 15, 2025 01:14

markmandel force-pushed the feature/sidecar-containers branch 2 times, most recently from dce1a86 to bcd0c0b Compare April 17, 2025 03:04

markmandel commented Apr 17, 2025

View reviewed changes

peterzhongyi reviewed Apr 18, 2025

View reviewed changes

pkg/apis/agones/v1/gameserver.go Show resolved Hide resolved

pkg/gameservers/controller.go Show resolved Hide resolved

pkg/gameservers/health.go Show resolved Hide resolved

markmandel force-pushed the feature/sidecar-containers branch from bcd0c0b to cda7ff3 Compare April 29, 2025 03:52

peterzhongyi approved these changes Apr 30, 2025

View reviewed changes

Merge branch 'main' into feature/sidecar-containers

7d74c4e

markmandel enabled auto-merge (squash) April 30, 2025 20:57

Merge branch 'main' into feature/sidecar-containers

2166bee

markmandel merged commit 533ff3f into agones-dev:main Apr 30, 2025
4 checks passed

markmandel deleted the feature/sidecar-containers branch April 30, 2025 21:50

markmandel mentioned this pull request Nov 29, 2025

Move SidecarContainers to Beta #4361

Closed

5 tasks

Conversation

markmandel commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

agones-bot commented Apr 7, 2025

Uh oh!

markmandel commented Apr 7, 2025

Uh oh!

agones-bot commented Apr 7, 2025

Uh oh!

markmandel commented Apr 10, 2025

Uh oh!

agones-bot commented Apr 10, 2025

Uh oh!

peterzhongyi commented Apr 12, 2025

Uh oh!

agones-bot commented Apr 12, 2025

Uh oh!

markmandel commented Apr 12, 2025

Uh oh!

igooch commented Apr 14, 2025

Uh oh!

peterzhongyi commented Apr 14, 2025

Uh oh!

agones-bot commented Apr 14, 2025

Uh oh!

agones-bot commented Apr 15, 2025

Uh oh!

agones-bot commented Apr 17, 2025

Uh oh!

markmandel Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

agones-bot commented Apr 29, 2025

Uh oh!

agones-bot commented Apr 30, 2025

Uh oh!

agones-bot commented Apr 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

markmandel commented Apr 7, 2025 •

edited

Loading