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: add missing MinQuorum docs #24536

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing MinQuorum docs #24536

wants to merge 1 commit into from

Conversation

schmichael
Copy link
Member

Also update Autopilot API examples.

Reviewer Checklist

  • Backport Labels Please add the correct backport labels as described by the internal
    backporting document.
  • Commit Type Ensure the correct merge method is selected which should be "squash and merge"
    in the majority of situations. The main exceptions are long-lived feature branches or merges where
    history should be preserved.

Also update Autopilot API examples.
@schmichael schmichael requested review from a team as code owners November 22, 2024 00:58
@schmichael schmichael added backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.9.x backport to 1.9.x release line labels Nov 22, 2024
Copy link
Member

@jrasell jrasell left a comment

Choose a reason for hiding this comment

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

If we are going to change the curl commands to use the operator api, should we do this across all, rather than have have mix?

Copy link
Contributor

@aimeeu aimeeu left a comment

Choose a reason for hiding this comment

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

A few style guide nits to use present tense and active voice.

@@ -101,6 +100,10 @@ The table below shows this endpoint's support for
- `MaxTrailingLogs` `(int: 250)` specifies the maximum number of log entries
that a server can trail the leader by before being considered unhealthy.

- `MinQuorum` `(int: 0)` - Sets the minimum number of servers necessary in a
cluster. Autopilot will stop pruning dead servers when this minimum is
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
cluster. Autopilot will stop pruning dead servers when this minimum is
cluster. Autopilot stops pruning dead servers when this minimum is

Comment on lines +236 to +237
The HTTP status code will indicate the health of the cluster. If `Healthy` is true, then a
status of 200 will be returned. If `Healthy` is false, then a status of 429 will be returned.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The HTTP status code will indicate the health of the cluster. If `Healthy` is true, then a
status of 200 will be returned. If `Healthy` is false, then a status of 429 will be returned.
The HTTP status code indicates the health of the cluster. If `Healthy` is true, Nomad
returns status of 200. If `Healthy` is false, then Nomad returns a status of 429.

@@ -37,6 +38,10 @@ autopilot {
- `max_trailing_logs` `(int: 250)` specifies the maximum number of log entries
that a server can trail the leader by before being considered unhealthy.

- `min_quorum` `(int: 0)` - Sets the minimum number of servers necessary in a
cluster. Autopilot will stop pruning dead servers when this minimum is
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
cluster. Autopilot will stop pruning dead servers when this minimum is
cluster. Autopilot stops pruning dead servers when this minimum is

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.9.x backport to 1.9.x release line
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants