Skip to content

Documentation for Sidecar Containers#4171

Merged
igooch merged 1 commit intoagones-dev:mainfrom
markmandel:docs/sidecar-containers
May 5, 2025
Merged

Documentation for Sidecar Containers#4171
igooch merged 1 commit intoagones-dev:mainfrom
markmandel:docs/sidecar-containers

Conversation

@markmandel
Copy link
Copy Markdown
Collaborator

@markmandel markmandel commented May 2, 2025

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:

Updates to the following documentation to finish sidecar containers work:

  • Feature gates page.
  • SDK configuration shutdown docs.
  • Health Checking.

Which issue(s) this PR fixes:

Closes #3642

Special notes for your reviewer:

N/A

@markmandel markmandel requested review from igooch and peterzhongyi May 2, 2025 20:17
@github-actions github-actions bot added the kind/documentation Documentation for Agones label May 2, 2025
lacroixthomas
lacroixthomas reviewed May 2, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@lacroixthomas lacroixthomas left a comment

Choose a reason for hiding this comment

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

Otherwise LGTM

site/content/en/docs/Guides/feature-stages.md Outdated
| [Support Passthrough on GKE Autopilot](https://github.com/googleforgames/agones/issues/3721) | `AutopilotPassthroughPort` | Enabled | `Beta` | 1.43.0 |
| [Support for Extended Duration Pods on GKE Autopilot (*1.28+ only*)](https://github.com/googleforgames/agones/issues/3386) | `GKEAutopilotExtendedDurationPods` | Enabled | `Beta` | 1.44.0 |
| [Port Policy None](https://github.com/googleforgames/agones/issues/3804) | `PortPolicyNone` | Enabled | `Beta` | 1.49.0 |
| [Support for Extended Duration Pods on GKE Autopilot (*1.28+ only*)](https://github.com/googleforgames/agones/issues/3386) | `GKEAutopilotExtendedDurationPods` | Enabled | `Beta` | 1.44.0 || [Port Policy None](https://github.com/googleforgames/agones/issues/3804) | `PortPolicyNone` | Enabled | `Beta` | 1.49.0 |
Copy link
Copy Markdown
Collaborator

@lacroixthomas lacroixthomas May 2, 2025

Choose a reason for hiding this comment

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

There seems to be a missing new line here, might not show in the table

Suggested change
| [Support for Extended Duration Pods on GKE Autopilot (*1.28+ only*)](https://github.com/googleforgames/agones/issues/3386) | `GKEAutopilotExtendedDurationPods` | Enabled | `Beta` | 1.44.0 || [Port Policy None](https://github.com/googleforgames/agones/issues/3804) | `PortPolicyNone` | Enabled | `Beta` | 1.49.0 |
| [Support for Extended Duration Pods on GKE Autopilot (*1.28+ only*)](https://github.com/googleforgames/agones/issues/3386) | `GKEAutopilotExtendedDurationPods` | Enabled | `Beta` | 1.44.0 |
| [Port Policy None](https://github.com/googleforgames/agones/issues/3804) | `PortPolicyNone` | Enabled | `Beta` | 1.49.0 |

Copy link
Copy Markdown
Collaborator Author

@markmandel markmandel May 2, 2025

Choose a reason for hiding this comment

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

Well spotted!

@markmandel
Documentation for Sidecar Containers
d7ab419 
Updates to the following documentation to finish sidecar containers
work:

* Feature gates page.
* SDK configuration shutdown docs.
* Health Checking.

Closes agones-dev#3642
@markmandel markmandel force-pushed the docs/sidecar-containers branch from b14a56c to d7ab419 Compare May 2, 2025 20:55
@agones-bot
Copy link
Copy Markdown
Collaborator

agones-bot commented May 2, 2025

Build Failed 😭

Build Id: ed6fa667-2d3e-477b-80dc-7be26715bb55

Status: FAILURE

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

@igooch
Copy link
Copy Markdown
Collaborator

igooch commented May 2, 2025 

FAIL test/e2e.TestSuperTuxKartGameServerReady (116.54s)
--- FAIL: TestSuperTuxKartGameServerReady (116.54s)
        	Test:       	TestSuperTuxKartGameServerReady
        	            	waiting for {supertuxkart [{default  Dynamic <nil> 8080 0 UDP}] {false 60 0 30}  { 0 0} {{      0 0001-01-01 00:00:00 +0000 UTC <nil> <nil> map[] map[] [] [] []} {[] [] [{supertuxkart us-docker.pkg.dev/agones-images/examples/supertuxkart-example:0.16 [] []  [] [] [{ENABLE_PLAYER_TRACKING false nil}] {map[] map[] []} [] <nil> [] [] nil nil nil nil    nil false false false}] []  <nil> <nil>  map[]   <nil>  false false false <nil> nil []   nil  [] []  <nil> nil [] <nil> <nil> <nil> map[] [] <nil> nil <nil> [] []}} <nil> map[] map[] <nil>} GameServer instance readiness timed out (): waiting for GameServer 1746222765/supertuxkart-j6b4j to be Ready: GameServer reached terminal state Unhealthy
        	Error:      	Received unexpected error:
        	Error Trace:	/go/src/agones.dev/agones/test/e2e/examples_test.go:83
    examples_test.go:83:

That's... a new one.

@igooch
Copy link
Copy Markdown
Collaborator

igooch commented May 2, 2025

/gcbrun

@agones-bot
Copy link
Copy Markdown
Collaborator

agones-bot commented May 3, 2025

Build Failed 😭

Build Id: fea80eae-2dee-479a-ad65-8a1fd6bb8fd2

Status: FAILURE

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

@markmandel
Copy link
Copy Markdown
Collaborator Author

markmandel commented May 4, 2025 

FAIL test/e2e.TestSuperTuxKartGameServerReady (116.54s)
--- FAIL: TestSuperTuxKartGameServerReady (116.54s)
        	Test:       	TestSuperTuxKartGameServerReady
        	            	waiting for {supertuxkart [{default  Dynamic <nil> 8080 0 UDP}] {false 60 0 30}  { 0 0} {{      0 0001-01-01 00:00:00 +0000 UTC <nil> <nil> map[] map[] [] [] []} {[] [] [{supertuxkart us-docker.pkg.dev/agones-images/examples/supertuxkart-example:0.16 [] []  [] [] [{ENABLE_PLAYER_TRACKING false nil}] {map[] map[] []} [] <nil> [] [] nil nil nil nil    nil false false false}] []  <nil> <nil>  map[]   <nil>  false false false <nil> nil []   nil  [] []  <nil> nil [] <nil> <nil> <nil> map[] [] <nil> nil <nil> [] []}} <nil> map[] map[] <nil>} GameServer instance readiness timed out (): waiting for GameServer 1746222765/supertuxkart-j6b4j to be Ready: GameServer reached terminal state Unhealthy
        	Error:      	Received unexpected error:
        	Error Trace:	/go/src/agones.dev/agones/test/e2e/examples_test.go:83
    examples_test.go:83:

That's... a new one.

That looks like what I'd see when the autopilot CNI issue was happening. Could it have come back?

@markmandel
Copy link
Copy Markdown
Collaborator Author

markmandel commented May 4, 2025

There we go, passed. No preview though - probably b/c ii reran the failed github action.

@markmandel
Copy link
Copy Markdown
Collaborator Author

markmandel commented May 4, 2025

Preview: https://d7ab419-dot-preview-dot-agones-images.uc.r.appspot.com/site/docs/guides/feature-stages/

igooch
igooch approved these changes May 5, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@igooch igooch left a comment

Choose a reason for hiding this comment

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

LGTM

@igooch igooch merged commit 346000e into agones-dev:main May 5, 2025
4 checks passed
@markmandel markmandel deleted the docs/sidecar-containers branch May 24, 2025 21:48
@lacroixthomas lacroixthomas mentioned this pull request Aug 13, 2025
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lacroixthomas lacroixthomas lacroixthomas left review comments

@igooch igooch igooch approved these changes

@peterzhongyi peterzhongyi Awaiting requested review from peterzhongyi

Assignees

No one assigned

Labels

kind/documentation Documentation for Agones

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

SDK Server: Adopt Sidecar Containers

4 participants

@markmandel @agones-bot @igooch @lacroixthomas