Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Best practices for game server shutdown #1752

Merged
merged 2 commits into from
Aug 17, 2020
Merged

Best practices for game server shutdown #1752

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4d9437
Best practices for game server shutdown
markmandel Aug 14, 2020
7236ece
Merge branch 'master' into docs/shutdown
aLekSer Aug 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions site/content/en/docs/Guides/Client SDKs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,17 @@ relinquish control to an external service which likely doesn't have as much info
{{< /alert >}}

#### Shutdown()
This tells Agones to shut down the currently running game server.
The GameServer state will be set `Shutdown` and the
backing Pod will be deleted, if they have not shut themselves down already.
This tells Agones to shut down the currently running game server. The GameServer state will be set `Shutdown` and the
backing Pod will be Terminated.

It's worth reading the [Termination of Pods](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination)
Kubernetes documentation, to understand the termination process, and the related configuration options.

As a rule of thumb, implement a graceful shutdown in your game sever process when it receives the TERM signal
from Kubernetes when the backing Pod goes into Termination state.

Be aware that if you use a variation of `System.exit(0)` after calling SDK.Shutdown(), your game server container may
restart for a brief period, inline with our [Health Checking]({{% ref "/docs/Guides/health-checking.md#health-failure-strategy" %}}) policies.

### Configuration Retrieval

Expand Down