Update simple game server example documentation #3776

vicentefb · 2024-04-17T21:50:31Z

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 Quickstart: Edit a Game Server documentation to reflect the usage of Makefile instead of docker build/push command, updates code snippet from main.go, updates kubectl command to retrieve IP Address and Port as well as create instead of apply command.

Which issue(s) this PR fixes:

Closes #

Special notes for your reviewer:

vicentefb · 2024-04-17T21:51:09Z

cc @zmerlynn

agones-bot · 2024-04-17T22:58:09Z

Build Succeeded 👏

Build Id: 34cf6a70-45f8-4ba9-ab14-d18de59c5e3f

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3776/head:pr_3776 && git checkout pr_3776
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-9c99475-amd64

examples/simple-game-server/gameserver.yaml

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

roberthbailey · 2024-04-18T16:42:16Z

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

@@ -86,7 +79,7 @@ Apply the latest settings to the Kubernetes container.
 ```bash
 gcloud config set container/cluster [CLUSTER_NAME]
 gcloud container clusters get-credentials [CLUSTER_NAME]
-kubectl apply -f gameserver.yaml
+kubectl create -f gameserver.yaml


I think apply should work - why change to create?

I always ran into the following issue error: from simple-game-server-: cannot use generate name with apply and turns out that kubectl apply doesn't support generateName. Found some old random issues about it, tektoncd/pipeline#2170, kubernetes/kubernetes#44501 and argoproj/argo-cd#1639. The workaround is to use kubectl create -f.

site/content/en/docs/Getting Started/edit-first-gameserver-go.md

agones-bot · 2024-04-18T18:20:19Z

Build Failed 😱

Build Id: 5cb3bdae-2198-49c6-9701-d46f3478baed

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

agones-bot · 2024-04-22T21:17:35Z

Build Failed 😱

Build Id: 28de2771-e4e9-4f70-8c1b-3f40f97329c6

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

agones-bot · 2024-04-22T22:02:19Z

Build Failed 😱

Build Id: 91f66bc7-9638-4502-afc1-3a0edaaed449

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

vicentefb · 2024-04-22T22:34:27Z

/retest

agones-bot · 2024-04-22T23:59:55Z

Build Succeeded 👏

Build Id: ff485566-0733-4848-b6e4-b19be6d96517

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3776/head:pr_3776 && git checkout pr_3776
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-7186017-amd64

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [agones](https://agones.dev) ([source](https://github.com/googleforgames/agones)) | minor | `1.39.0` -> `1.40.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>googleforgames/agones (agones)</summary> ### [`v1.40.0`](https://github.com/googleforgames/agones/blob/HEAD/CHANGELOG.md#v1400-2024-04-23) [Compare Source](https://github.com/googleforgames/agones/compare/v1.39.0...v1.40.0) [Full Changelog](https://github.com/googleforgames/agones/compare/v1.39.0...v1.40.0) **Breaking changes:** - Counters and Lists: Remove Bool Returns by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3738 **Implemented enhancements:** - Leader Election in Custom Controller by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3696 - Migrating from generate-groups.sh to kube_codegen.sh by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3722 - Move GKEAutopilotExtendedDurationPods to Alpha in 1.28+ by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3729 - Move DisableResyncOnSDKServer to Beta by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3732 - Counters & Lists landing page and doc improvements by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3649 - Graduate FleetAllocationOverflow to Stable by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3733 - Adds Counters and Lists to CSharp SDK by [@igooch](https://github.com/igooch) in [googleforgames/agones#3581 - Feat/counter and list defaulting order to ascending by [@lacroixthomas](https://github.com/lacroixthomas) in [googleforgames/agones#3734 - Add handling for StatusAddresses in GameServerStatus for the Unity SDK by [@charlesvien](https://github.com/charlesvien) in [googleforgames/agones#3739 - Feat(gameservers): Shared pod IPs with GameServer Addresses by [@lacroixthomas](https://github.com/lacroixthomas) in [googleforgames/agones#3764 - Be prescriptive about rotating regions when updating Kubernetes versions by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3716 - Fix ensure-e2e-infra-state-bucket by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3719 - Create Performance Cluster 1.28 by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3720 - Optimise GameServer Sub-Controller Queues by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3781 **Fixed bugs:** - Counters & Lists: Consolidate `priorities` sorting by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3690 - Fix(Counter & Lists): Add validation for `priorities` by [@lacroixthomas](https://github.com/lacroixthomas) in [googleforgames/agones#3714 - fix: [#3607](https://github.com/googleforgames/agones/issues/3607) Metrics data loss in K8S controller by [@alvin-7](https://github.com/alvin-7) in [googleforgames/agones#3692 - Deflake GameServerAllocationDuringMultipleAllocationClients by allowing errors by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3750 **Security fixes:** - Bump protobufjs from 7.2.4 to 7.2.6 in /sdks/nodejs by [@dependabot](https://github.com/dependabot) in [googleforgames/agones#3755 - Bump golang.org/x/net from 0.19.0 to 0.23.0 by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3793 **Other:** - Flaky: TestGameServerCreationAfterDeletingOneExtensionsPod by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3699 - Prep for release v1.40.0 by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3700 - Bumps cpp-simple Image and Refactoring Example Makefiles by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3695 - Upgrade Protobuf to 1.33.0 by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3711 - Modify Script for Makefile Version Updates in Examples Directory by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3712 - Adds simple genai server example documentation to the Agones site by [@igooch](https://github.com/igooch) in [googleforgames/agones#3713 - Update Supported Kubernetes to 1.27, 1.28, 1.29 by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3654 - fix: typo in docs by [@qhyun2](https://github.com/qhyun2) in [googleforgames/agones#3723 - Tweak: Setting up the Game Server by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3717 - Docs: gke.md - spelling by [@daniellee](https://github.com/daniellee) in [googleforgames/agones#3740 - Aesthetic rearrangement of cloudbuild.yaml by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3741 - Docs: Make hitting <enter> on connection explicit by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3743 - CI: Don't check Unreal Link by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3745 - New recommendation for multi-cluster allocation by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3744 - Custom Controller Example Page on Agones Website by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3725 - Add Nitrado logo by [@towolf](https://github.com/towolf) in [googleforgames/agones#3753 - Remove unnecessary args from e2e-test-cloudbuild by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3754 - Update Allocation from Fleet Documentation by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3761 - Transform Lint Warnings into Errors by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3756 - Update Canary Testing Documentation by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3760 - Supertuxkart Example on Agones Site by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3728 - Xonotic Example on Agones Site by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3742 - nit documentation fix in kind cluster section when building Agones by [@vicentefb](https://github.com/vicentefb) in [googleforgames/agones#3770 - Merged steps inside documentation about webhook certificate creation by [@vicentefb](https://github.com/vicentefb) in [googleforgames/agones#3768 - Example Images: Increment Tags by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3796 - Update simple game server example documentation by [@vicentefb](https://github.com/vicentefb) in [googleforgames/agones#3776 **New Contributors:** - [@lacroixthomas](https://github.com/lacroixthomas) made their first contribution in [googleforgames/agones#3714 - [@daniellee](https://github.com/daniellee) made their first contribution in [googleforgames/agones#3740 - [@charlesvien](https://github.com/charlesvien) made their first contribution in [googleforgames/agones#3739 - [@vicentefb](https://github.com/vicentefb) made their first contribution in [googleforgames/agones#3770 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

updated simple game server example documentation

9c99475

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

roberthbailey reviewed Apr 18, 2024

View reviewed changes

examples/simple-game-server/gameserver.yaml Outdated Show resolved Hide resolved

roberthbailey reviewed Apr 18, 2024

View reviewed changes

site/content/en/docs/Getting Started/edit-first-gameserver-go.md Outdated Show resolved Hide resolved

roberthbailey reviewed Apr 18, 2024

View reviewed changes

site/content/en/docs/Getting Started/edit-first-gameserver-go.md Outdated Show resolved Hide resolved

roberthbailey reviewed Apr 18, 2024

View reviewed changes

site/content/en/docs/Getting Started/edit-first-gameserver-go.md Outdated Show resolved Hide resolved

addressed comments

7f8efa3

vicentefb requested a review from roberthbailey April 18, 2024 17:33

vicentefb added 2 commits April 22, 2024 16:49

reverted image change in yaml

c1ddd2c

updated kubectl get gs command

15606b7

vicentefb requested a review from zmerlynn April 22, 2024 19:32

zmerlynn requested a review from markmandel April 22, 2024 19:59

Merge branch 'main' into EditGameServer

7186017

zmerlynn approved these changes Apr 22, 2024

View reviewed changes

zmerlynn enabled auto-merge (squash) April 22, 2024 20:01

zmerlynn merged commit dcae5cb into googleforgames:main Apr 22, 2024
4 checks passed

markmandel mentioned this pull request Jun 26, 2024

Review: Quickstart: Edit a Game Server #3030

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update simple game server example documentation #3776

Update simple game server example documentation #3776

vicentefb commented Apr 17, 2024

vicentefb commented Apr 17, 2024

agones-bot commented Apr 17, 2024

roberthbailey Apr 18, 2024

vicentefb Apr 18, 2024

agones-bot commented Apr 18, 2024

agones-bot commented Apr 22, 2024

agones-bot commented Apr 22, 2024

vicentefb commented Apr 22, 2024

agones-bot commented Apr 22, 2024

Update simple game server example documentation #3776

Update simple game server example documentation #3776

Conversation

vicentefb commented Apr 17, 2024

vicentefb commented Apr 17, 2024

agones-bot commented Apr 17, 2024

roberthbailey Apr 18, 2024

Choose a reason for hiding this comment

vicentefb Apr 18, 2024

Choose a reason for hiding this comment

agones-bot commented Apr 18, 2024

agones-bot commented Apr 22, 2024

agones-bot commented Apr 22, 2024

vicentefb commented Apr 22, 2024

agones-bot commented Apr 22, 2024