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.

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

Custom Controller Example Page on Agones Website #3725

Merged
merged 19 commits into from
Apr 6, 2024

Conversation

Kalaiselvi84
Copy link
Contributor

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:

Which issue(s) this PR fixes:

Closes #

Special notes for your reviewer:

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 7af85ed4-db56-4b5d-aa88-9f4408c25b52

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):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3725/head:pr_3725 && git checkout pr_3725
  • 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-1e0a881-amd64

Copy link
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.

Good work! A couple follow up comments.

examples/custom-controller/README.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 9b9a46f5-313f-4642-b715-e32d15b7d0dc

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):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3725/head:pr_3725 && git checkout pr_3725
  • 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-9c59d9a-amd64

@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 58afaf77-c331-456c-b9bb-7496c76b06fd

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

@Kalaiselvi84
Copy link
Contributor Author

Flake
VERBOSE: gameserverallocation_test.go:1442:
VERBOSE: Error Trace: /go/src/agones.dev/agones/test/e2e/gameserverallocation_test.go:1442
VERBOSE: Error: Not equal:
VERBOSE: expected: 100
VERBOSE: actual : 98
VERBOSE: Test: TestGameServerAllocationDuringMultipleAllocationClients
VERBOSE: --- FAIL: TestGameServerAllocationDuringMultipleAllocationClients (49.42s)

@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 5abc0b8b-7c49-469c-a2cf-8de6e7e23ef0

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

Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

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

Quick run through review!

site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: ac088ba2-1c84-4c96-a3f6-46674857c95e

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):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3725/head:pr_3725 && git checkout pr_3725
  • 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-8d07715-amd64

@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 014eda1a-df53-490d-82b2-414604ac9026

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

examples/custom-controller/README.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved

## Deploy the Agones Fleet

To apply the fleet configuration to your cluster, use the following command:
Copy link
Member

Choose a reason for hiding this comment

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

Can lift the create a fleet markdown from https://agones.dev/site/docs/getting-started/create-fleet/#1-create-a-fleet

Then they don't need to worry about cloning the whole repository.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently, I've copied the information from the create a fleet section. Would it be sufficient to include the link https://agones.dev/site/docs/getting-started/create-fleet/#1-create-a-fleet is enough?

something like:

## Create a Fleet

Please refer to the documentation on creating a fleet available at [this link](https://agones.dev/site/docs/getting-started/create-fleet/#1-create-a-fleet) for detailed information

site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
@markmandel
Copy link
Member

Assuming all these patterns also work - we can replicate these to the other examples as well 😄

@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: ea5196fb-6275-43c7-9bc6-8ebb3a2dad82

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

@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: c917dcb0-b017-43f0-ba84-20a7deab43d6

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

Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

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

Minor bits, but once that's done, this is good to merge 👍🏻


This is an example of how to write a customer controller integrated with Agones resources.

This example shows how to create, deploy and run a Custom Kubernetes Controller for Agones that logs changes to GameServers and modifies their labels.
Copy link
Member

Choose a reason for hiding this comment

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

As per the other ones, this should link to the documentation page we're writing now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've made all the suggested changes.

site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
site/content/en/docs/Examples/custom-controller.md Outdated Show resolved Hide resolved
Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

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

Approved!

Will take a peek at the preview before merging.

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 2b829207-dbe0-46d4-82c8-f6b61804fe86

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):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3725/head:pr_3725 && git checkout pr_3725
  • 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-9c49ce4-amd64

@markmandel markmandel enabled auto-merge (squash) April 5, 2024 23:15
@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 55e69076-82e2-4c35-a32b-227a36083846

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

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 381b9dfe-0044-47ac-9d3d-ba45c273aab7

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):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3725/head:pr_3725 && git checkout pr_3725
  • 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-7a88ceb-amd64

@markmandel markmandel merged commit c1320ee into googleforgames:main Apr 6, 2024
4 checks passed
@Kalaiselvi84 Kalaiselvi84 added kind/documentation Documentation for Agones and removed kind/other labels Apr 11, 2024
spiceratops referenced this pull request in spiceratops/k8s-gitops May 13, 2024
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [agones](https://agones.dev)
([source](https://togithub.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://togithub.com/googleforgames/agones/blob/HEAD/CHANGELOG.md#v1400-2024-04-23)

[Compare
Source](https://togithub.com/googleforgames/agones/compare/v1.39.0...v1.40.0)

[Full
Changelog](https://togithub.com/googleforgames/agones/compare/v1.39.0...v1.40.0)

**Breaking changes:**

- Counters and Lists: Remove Bool Returns by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3738](https://togithub.com/googleforgames/agones/pull/3738)

**Implemented enhancements:**

- Leader Election in Custom Controller by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3696](https://togithub.com/googleforgames/agones/pull/3696)
- Migrating from generate-groups.sh to kube_codegen.sh by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3722](https://togithub.com/googleforgames/agones/pull/3722)
- Move GKEAutopilotExtendedDurationPods to Alpha in 1.28+ by
[@&#8203;zmerlynn](https://togithub.com/zmerlynn) in
[https://github.com/googleforgames/agones/pull/3729](https://togithub.com/googleforgames/agones/pull/3729)
- Move DisableResyncOnSDKServer to Beta by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3732](https://togithub.com/googleforgames/agones/pull/3732)
- Counters & Lists landing page and doc improvements by
[@&#8203;markmandel](https://togithub.com/markmandel) in
[https://github.com/googleforgames/agones/pull/3649](https://togithub.com/googleforgames/agones/pull/3649)
- Graduate FleetAllocationOverflow to Stable by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3733](https://togithub.com/googleforgames/agones/pull/3733)
- Adds Counters and Lists to CSharp SDK by
[@&#8203;igooch](https://togithub.com/igooch) in
[https://github.com/googleforgames/agones/pull/3581](https://togithub.com/googleforgames/agones/pull/3581)
- Feat/counter and list defaulting order to ascending by
[@&#8203;lacroixthomas](https://togithub.com/lacroixthomas) in
[https://github.com/googleforgames/agones/pull/3734](https://togithub.com/googleforgames/agones/pull/3734)
- Add handling for StatusAddresses in GameServerStatus for the Unity SDK
by [@&#8203;charlesvien](https://togithub.com/charlesvien) in
[https://github.com/googleforgames/agones/pull/3739](https://togithub.com/googleforgames/agones/pull/3739)
- Feat(gameservers): Shared pod IPs with GameServer Addresses by
[@&#8203;lacroixthomas](https://togithub.com/lacroixthomas) in
[https://github.com/googleforgames/agones/pull/3764](https://togithub.com/googleforgames/agones/pull/3764)
- Be prescriptive about rotating regions when updating Kubernetes
versions by [@&#8203;zmerlynn](https://togithub.com/zmerlynn) in
[https://github.com/googleforgames/agones/pull/3716](https://togithub.com/googleforgames/agones/pull/3716)
- Fix ensure-e2e-infra-state-bucket by
[@&#8203;zmerlynn](https://togithub.com/zmerlynn) in
[https://github.com/googleforgames/agones/pull/3719](https://togithub.com/googleforgames/agones/pull/3719)
- Create Performance Cluster 1.28 by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3720](https://togithub.com/googleforgames/agones/pull/3720)
- Optimise GameServer Sub-Controller Queues by
[@&#8203;markmandel](https://togithub.com/markmandel) in
[https://github.com/googleforgames/agones/pull/3781](https://togithub.com/googleforgames/agones/pull/3781)

**Fixed bugs:**

- Counters & Lists: Consolidate `priorities` sorting by
[@&#8203;markmandel](https://togithub.com/markmandel) in
[https://github.com/googleforgames/agones/pull/3690](https://togithub.com/googleforgames/agones/pull/3690)
- Fix(Counter & Lists): Add validation for `priorities` by
[@&#8203;lacroixthomas](https://togithub.com/lacroixthomas) in
[https://github.com/googleforgames/agones/pull/3714](https://togithub.com/googleforgames/agones/pull/3714)
- fix:
[#&#8203;3607](https://togithub.com/googleforgames/agones/issues/3607)
Metrics data loss in K8S controller by
[@&#8203;alvin-7](https://togithub.com/alvin-7) in
[https://github.com/googleforgames/agones/pull/3692](https://togithub.com/googleforgames/agones/pull/3692)
- Deflake GameServerAllocationDuringMultipleAllocationClients by
allowing errors by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3750](https://togithub.com/googleforgames/agones/pull/3750)

**Security fixes:**

- Bump protobufjs from 7.2.4 to 7.2.6 in /sdks/nodejs by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/googleforgames/agones/pull/3755](https://togithub.com/googleforgames/agones/pull/3755)
- Bump golang.org/x/net from 0.19.0 to 0.23.0 by
[@&#8203;zmerlynn](https://togithub.com/zmerlynn) in
[https://github.com/googleforgames/agones/pull/3793](https://togithub.com/googleforgames/agones/pull/3793)

**Other:**

- Flaky: TestGameServerCreationAfterDeletingOneExtensionsPod by
[@&#8203;markmandel](https://togithub.com/markmandel) in
[https://github.com/googleforgames/agones/pull/3699](https://togithub.com/googleforgames/agones/pull/3699)
- Prep for release v1.40.0 by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3700](https://togithub.com/googleforgames/agones/pull/3700)
- Bumps cpp-simple Image and Refactoring Example Makefiles by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3695](https://togithub.com/googleforgames/agones/pull/3695)
- Upgrade Protobuf to 1.33.0 by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3711](https://togithub.com/googleforgames/agones/pull/3711)
- Modify Script for Makefile Version Updates in Examples Directory by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3712](https://togithub.com/googleforgames/agones/pull/3712)
- Adds simple genai server example documentation to the Agones site by
[@&#8203;igooch](https://togithub.com/igooch) in
[https://github.com/googleforgames/agones/pull/3713](https://togithub.com/googleforgames/agones/pull/3713)
- Update Supported Kubernetes to 1.27, 1.28, 1.29 by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3654](https://togithub.com/googleforgames/agones/pull/3654)
- fix: typo in docs by [@&#8203;qhyun2](https://togithub.com/qhyun2) in
[https://github.com/googleforgames/agones/pull/3723](https://togithub.com/googleforgames/agones/pull/3723)
- Tweak: Setting up the Game Server by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3717](https://togithub.com/googleforgames/agones/pull/3717)
- Docs: gke.md - spelling by
[@&#8203;daniellee](https://togithub.com/daniellee) in
[https://github.com/googleforgames/agones/pull/3740](https://togithub.com/googleforgames/agones/pull/3740)
- Aesthetic rearrangement of cloudbuild.yaml by
[@&#8203;zmerlynn](https://togithub.com/zmerlynn) in
[https://github.com/googleforgames/agones/pull/3741](https://togithub.com/googleforgames/agones/pull/3741)
- Docs: Make hitting <enter> on connection explicit by
[@&#8203;markmandel](https://togithub.com/markmandel) in
[https://github.com/googleforgames/agones/pull/3743](https://togithub.com/googleforgames/agones/pull/3743)
- CI: Don't check Unreal Link by
[@&#8203;markmandel](https://togithub.com/markmandel) in
[https://github.com/googleforgames/agones/pull/3745](https://togithub.com/googleforgames/agones/pull/3745)
- New recommendation for multi-cluster allocation by
[@&#8203;markmandel](https://togithub.com/markmandel) in
[https://github.com/googleforgames/agones/pull/3744](https://togithub.com/googleforgames/agones/pull/3744)
- Custom Controller Example Page on Agones Website by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3725](https://togithub.com/googleforgames/agones/pull/3725)
- Add Nitrado logo by [@&#8203;towolf](https://togithub.com/towolf) in
[https://github.com/googleforgames/agones/pull/3753](https://togithub.com/googleforgames/agones/pull/3753)
- Remove unnecessary args from e2e-test-cloudbuild by
[@&#8203;zmerlynn](https://togithub.com/zmerlynn) in
[https://github.com/googleforgames/agones/pull/3754](https://togithub.com/googleforgames/agones/pull/3754)
- Update Allocation from Fleet Documentation by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3761](https://togithub.com/googleforgames/agones/pull/3761)
- Transform Lint Warnings into Errors by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3756](https://togithub.com/googleforgames/agones/pull/3756)
- Update Canary Testing Documentation by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3760](https://togithub.com/googleforgames/agones/pull/3760)
- Supertuxkart Example on Agones Site by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3728](https://togithub.com/googleforgames/agones/pull/3728)
- Xonotic Example on Agones Site by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3742](https://togithub.com/googleforgames/agones/pull/3742)
- nit documentation fix in kind cluster section when building Agones by
[@&#8203;vicentefb](https://togithub.com/vicentefb) in
[https://github.com/googleforgames/agones/pull/3770](https://togithub.com/googleforgames/agones/pull/3770)
- Merged steps inside documentation about webhook certificate creation
by [@&#8203;vicentefb](https://togithub.com/vicentefb) in
[https://github.com/googleforgames/agones/pull/3768](https://togithub.com/googleforgames/agones/pull/3768)
- Example Images: Increment Tags by
[@&#8203;Kalaiselvi84](https://togithub.com/Kalaiselvi84) in
[https://github.com/googleforgames/agones/pull/3796](https://togithub.com/googleforgames/agones/pull/3796)
- Update simple game server example documentation by
[@&#8203;vicentefb](https://togithub.com/vicentefb) in
[https://github.com/googleforgames/agones/pull/3776](https://togithub.com/googleforgames/agones/pull/3776)

**New Contributors:**

- [@&#8203;lacroixthomas](https://togithub.com/lacroixthomas) made their
first contribution in
[https://github.com/googleforgames/agones/pull/3714](https://togithub.com/googleforgames/agones/pull/3714)
- [@&#8203;daniellee](https://togithub.com/daniellee) made their first
contribution in
[https://github.com/googleforgames/agones/pull/3740](https://togithub.com/googleforgames/agones/pull/3740)
- [@&#8203;charlesvien](https://togithub.com/charlesvien) made their
first contribution in
[https://github.com/googleforgames/agones/pull/3739](https://togithub.com/googleforgames/agones/pull/3739)
- [@&#8203;vicentefb](https://togithub.com/vicentefb) made their first
contribution in
[https://github.com/googleforgames/agones/pull/3770](https://togithub.com/googleforgames/agones/pull/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.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNTYuMSIsInVwZGF0ZWRJblZlciI6IjM3LjM1Ni4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJyZW5vdmF0ZS9oZWxtIiwidHlwZS9taW5vciJdfQ==-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants