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

Add to SplitControllerAndExtensions documentation for leader election #3083

Merged
merged 1 commit into from Apr 12, 2023

Conversation

chiayi
Copy link
Collaborator

@chiayi chiayi commented Apr 10, 2023

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

What this PR does / Why we need it:
Add documentation to High Availability Agones for controller leader election

Which issue(s) this PR fixes:
Work on #2797

Special notes for your reviewer:

@chiayi chiayi requested review from zmerlynn and removed request for EricFortin and aLekSer April 10, 2023 20:47
@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 5e0ddae5-13b2-4669-a45d-782f9283671e

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

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 220e4616-1c28-4cd3-bac2-44e7f8db8ddd

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/3083/head:pr_3083 && git checkout pr_3083
  • helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.31.0-57f2b98-amd64

site/content/en/docs/Advanced/high-availability-agones.md Outdated Show resolved Hide resolved
Leader election will automatically be enabled while `SplitControllerAndExtensions` is enabled and while `agones.controller.replicas` is set to > 1. The current default value for [`agones.controller.replicas`]({{< relref "/docs/Installation/Install Agones/helm.md#configuration" >}}) is 2.
{{% /feature %}}

When `SplitControllerAndExtensions` is enabled, what was previously a single `agones-controller` pod is deployed as {{% feature publishVersion="1.31.0" %}}, possibly 2+,{{% /feature %}} `agones-controller` and 2 `agones-extensions` pods. For example:
Copy link
Collaborator

Choose a reason for hiding this comment

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

since you already have a publishVersion block here, just duplicate this paragraph to make it easier on the review rather than embedding a publish in the middle.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Going to remove the publishVersion blocks since the release already started. I'm thinking we can merge this after the release is done.

@google-oss-prow google-oss-prow bot added the lgtm label Apr 10, 2023
@google-oss-prow google-oss-prow bot removed the lgtm label Apr 11, 2023
@zmerlynn zmerlynn changed the title Add to Command SplitControllerAndExtensions not found documentation f… Add to SplitControllerAndExtensions documentation for leader election Apr 11, 2023
@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 6d2c34b3-cdc6-4f93-9c2e-3c7f578e1b53

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

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 5a0eb727-1051-4288-88ca-70db4ce2a221

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/3083/head:pr_3083 && git checkout pr_3083
  • helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.32.0-a73dcc7-amd64

agones-ping-5b9647874-rksgg 1/1 Running 0 27h
```

Or if `agones.controller.replicas` > 1
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would just show this list. I think this is over-focusing on replicas being modifiable and it's kind of a lot of real estate to devote - we have to assume the user has a working knowledge of k8s.

When `SplitControllerAndExtensions` is enabled, what was previously a single `agones-controller` pod is deployed as `agones-controller` and 2 `agones-extensions` pods. For example:
Leader election will automatically be enabled when `SplitControllerAndExtensions` is enabled and `agones.controller.replicas` is > 1. [`agones.controller.replicas`]({{< relref "/docs/Installation/Install Agones/helm.md#configuration" >}}) defaults to 2.

When `SplitControllerAndExtensions` is enabled, what was previously a single `agones-controller` pod is deployed as , possibly 2+, `agones-controller` and 2 `agones-extensions` pods. For example:
Copy link
Collaborator

Choose a reason for hiding this comment

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

as , possibly 2+,

just say 2. Both replica settings are changeable, so you don't need to say "possibly 2+". Maybe like this:

When `SplitControllerAndExtensions` is enabled, what was previously a single `agones-controller` pod is deployed by default as 2 `agones-controller` and 2 `agones-extensions` pods. For example:

@google-oss-prow google-oss-prow bot added the lgtm label Apr 12, 2023
@google-oss-prow
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: chiayi, zmerlynn
Once this PR has been reviewed and has the lgtm label, please assign ericfortin for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

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

@zmerlynn zmerlynn enabled auto-merge (squash) April 12, 2023 20:10
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: c6502595-3461-4fae-8f67-36618eb5f1e8

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/3083/head:pr_3083 && git checkout pr_3083
  • helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.32.0-54a3814-amd64

@zmerlynn zmerlynn merged commit 1be9ef5 into googleforgames:main Apr 12, 2023
2 checks passed
@Kalaiselvi84 Kalaiselvi84 added the kind/documentation Documentation for Agones label May 18, 2023
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.

None yet

5 participants