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

Docs: Game Server Allocation Details #3583

Merged
merged 9 commits into from
Jan 24, 2024
Merged

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: ab6a5350-7dce-42d8-9675-5878b34bb8a8

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/3583/head:pr_3583 && git checkout pr_3583
  • 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.38.0-dev-2f53eaa-amd64

@Kalaiselvi84
Copy link
Contributor Author

@markmandel, I have updated the site/content/en/docs/Reference/gameserverallocation.md file with information about game server allocation. Could you please review it and share your thoughts?

@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: a1a7be14-68f1-4bc1-88c5-01ca0c2bdf48

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

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: c6914b7e-ff7e-4c8d-884b-859a3b6ff629

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/3583/head:pr_3583 && git checkout pr_3583
  • 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.38.0-dev-890445d-amd64

@@ -7,6 +7,10 @@ description: "A `GameServerAllocation` is used to atomically allocate a GameServ
weight: 30
---

{{% feature publishVersion="1.38.0" %}}
Copy link
Member

Choose a reason for hiding this comment

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

No need for a feature flag - feature flags are only for when we talk about a feature that hasn't been released yet. Updated/improvements to existing docs for existing features don't need it.

@@ -7,6 +7,10 @@ description: "A `GameServerAllocation` is used to atomically allocate a GameServ
weight: 30
---

{{% feature publishVersion="1.38.0" %}}
Copy link
Member

Choose a reason for hiding this comment

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

I like this place better for this documentation improvement! 👍🏻

@@ -7,6 +7,10 @@ description: "A `GameServerAllocation` is used to atomically allocate a GameServ
weight: 30
---

{{% feature publishVersion="1.38.0" %}}
When we have a fleet of game servers ready, allocation is the process of selecting a one of these servers for use. This is achieved using a `GameServerAllocation`. The allocation process marks the chosen game server for gameplay and marks it as `Allocated`. This ensures that the server is reserved for active players and not considered `ready` for other allocations until `SDK.Shutdown()` is called, or it is manually deleted.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
When we have a fleet of game servers ready, allocation is the process of selecting a one of these servers for use. This is achieved using a `GameServerAllocation`. The allocation process marks the chosen game server for gameplay and marks it as `Allocated`. This ensures that the server is reserved for active players and not considered `ready` for other allocations until `SDK.Shutdown()` is called, or it is manually deleted.
Allocation is the process of selecting the optimal `GameServer` that matches the filters defined in the `GameServerAllocation` specification below, and returning its details.
A successful Alloction moves the `GameServer` to the `Allocated` state, which demarcates that it is currently active, likely with players on it, and should not be removed until SDK.Shutdown() is called, or it is explicitly manually deleted.

Some tweaks to the language.

@roberthbailey, @Kalaiselvi84 WDYT?

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 updated this change. Shall we include this info in FAQ page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So the answer is no. Shall we merge this PR?

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: f1ab4dab-d657-42e7-892e-3f3fa0d5c4b9

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/3583/head:pr_3583 && git checkout pr_3583
  • 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.38.0-dev-0f911e3-amd64

@Kalaiselvi84 Kalaiselvi84 changed the title Update FAQ Docs: Game Server Allocation Details Jan 17, 2024
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 03692ca0-fbfe-4e6c-88d4-6dc2539c5cd6

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/3583/head:pr_3583 && git checkout pr_3583
  • 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.38.0-dev-92fe813-amd64

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 679494a5-83e4-411d-b41e-ec86b0a2aaa4

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/3583/head:pr_3583 && git checkout pr_3583
  • 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.38.0-dev-2f10fe4-amd64

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: ba1d9d53-3f2c-4bf9-8789-d865d6d976c5

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/3583/head:pr_3583 && git checkout pr_3583
  • 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.38.0-dev-a0e31ff-amd64

@markmandel markmandel merged commit 38b1d33 into googleforgames:main Jan 24, 2024
4 checks passed
@Kalaiselvi84 Kalaiselvi84 deleted the faq branch March 15, 2024 01:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Documentation for Agones size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants