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

Jump to bottom

Fix GameServerAllocation preferred documentation #2029

Merged
merged 1 commit into from
Mar 18, 2021
Merged

Fix GameServerAllocation preferred documentation #2029

merged 1 commit into from
Mar 18, 2021

Conversation

markmandel
Copy link
Member

What type of PR is this?

Uncomment only one /kind <> line, hit 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

What this PR does / Why we need it:

There was a bug in the reference docs that read that the required check was applied to all queries, including the preferred check.

This is not the case - each label selector is independent.

Fixing this in the documentation.

Which issue(s) this PR fixes:

N/A

Special notes for your reviewer:

N/A

@markmandel markmandel added kind/bug These are bugs. kind/documentation Documentation for Agones labels Mar 17, 2021
@google-cla google-cla bot added the cla: yes label Mar 17, 2021
@markmandel
Copy link
Member Author

@highlyunavailable does this look better?

highlyunavailable
highlyunavailable reviewed Mar 17, 2021
View reviewed changes
site/content/en/docs/Reference/gameserverallocation.md
@@ -25,7 +25,8 @@ spec:
game: my-game
matchExpressions:
- {key: tier, operator: In, values: [cache]}
# ordered list of preferred allocations out of the `required` set.
# An ordered list of preferred GameServer label selectors
# that are optional to be fulfilled, but will be searched before the `required` selector.
Copy link
Contributor

Choose a reason for hiding this comment

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

"If any of the Preferred selectors are matched, the required selector is not considered" might be in order here.

site/content/en/docs/Reference/gameserverallocation.md
- `preferred` is an ordered list of preferred
[label selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
that are _optional_ to be fulfilled, but will be searched before the `required` selector.
If the first selector is not matched, the selection attempts the second selector, and so on.
Copy link
Contributor

Choose a reason for hiding this comment

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

"finally, if no preferred selectors match, the required selector is searched" might also make sense here, just like above.

@highlyunavailable
Copy link
Contributor

I a couple comments that I think encapsulated my confusion and the solution to it. Looks good though!

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 0efec093-fde7-405c-8295-be8df22588ea

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/2029/head:pr_2029 && git checkout pr_2029
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.14.0-5614be2

@markmandel
Fix GameServerAllocation preferred documentation
6fba59b 
There was a bug in the reference docs that read that the `required`
check was applied to all queries, including the preferred check.

This is not the case - each label selector is independent.

Fixing this in the documentation.
@markmandel
Copy link
Member Author

Thanks for the comments! Updated!

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: b75e7e9d-f33c-49c4-9e18-fdc8799f8a12

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/2029/head:pr_2029 && git checkout pr_2029
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.14.0-6fba59b

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: markmandel, roberthbailey

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [markmandel,roberthbailey]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@roberthbailey
Copy link
Member

Waiting for @highlyunavailable to see your fixes before merging.

@highlyunavailable
Copy link
Contributor

👍 Thanks!

@markmandel
Copy link
Member Author

Seems like we are good to go! Merging!

@markmandel markmandel merged commit 8629bbb into googleforgames:main Mar 18, 2021
@markmandel markmandel added this to the 1.14.0 milestone Mar 18, 2021
@markmandel markmandel deleted the docs/gsa-preferred branch April 13, 2021 02:17
@roberthbailey roberthbailey mentioned this pull request Jun 21, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@highlyunavailable highlyunavailable highlyunavailable left review comments

@roberthbailey roberthbailey roberthbailey approved these changes

@pooneh-m pooneh-m Awaiting requested review from pooneh-m

@aLekSer aLekSer Awaiting requested review from aLekSer

Assignees

@roberthbailey roberthbailey

Labels
approved cla: yes kind/bug These are bugs. kind/documentation Documentation for Agones lgtm size/S
Projects
None yet
Milestone
1.14.0
Development

Successfully merging this pull request may close these issues.
5 participants
@markmandel @highlyunavailable @agones-bot @google-oss-robot @roberthbailey