CE-865 - Update the Consul Autopilot doc page #1427
+68
−293
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerNo broken links found! 🎉 |
boruszak
reviewed
Dec 5, 2025
Contributor
boruszak
left a comment
boruszak
left a comment
There was a problem hiding this comment.
Suggestions for style/clarity. I also included a request to explain the "default autopilot configuration" that Consul returns
| This page describes Consul autopilot, which supports automatic, operator-friendly management of Consul | ||
| servers. It includes cleanup of dead servers, monitoring the state of the Raft | ||
| cluster, and stable server introduction. | ||
| This page describes Consul Autopilot, which supports automatic, operator-friendly management of Consul servers. Autopilot helps maintain the health and stability of the Consul server cluster by monitoring server health, introducing stable servers, and cleaning up dead servers. Furthermore, Consul Enterprise customers can leverage two additional Autopilot features, namely redundancy zones and automated upgrades to enhance datacenter resiliency and simplify operations. |
Contributor
There was a problem hiding this comment.
Suggested change
| This page describes Consul Autopilot, which supports automatic, operator-friendly management of Consul servers. Autopilot helps maintain the health and stability of the Consul server cluster by monitoring server health, introducing stable servers, and cleaning up dead servers. Furthermore, Consul Enterprise customers can leverage two additional Autopilot features, namely redundancy zones and automated upgrades to enhance datacenter resiliency and simplify operations. | |
| This page describes Consul Autopilot, a set of features that provide operator-friendly management automations for Consul servers. |
|
|
||
| In this tutorial you will learn how Consul tracks the stability of servers, how | ||
| to tune those conditions, and get some details on the other autopilot's features. | ||
| Autopilot includes the following features: |
Contributor
There was a problem hiding this comment.
Suggested change
| Autopilot includes the following features: | |
| Consul autopilot helps you maintain the health and stability of the Consul server cluster. It includes the following features: |
Moved the sentence so that there's less at the top and more before the list.
| You can check the default values using the `consul operator` CLI command or | ||
| using the [`/v1/operator/autopilot` | ||
| endpoint](/consul/api-docs/operator/autopilot) | ||
| You can check the default Autopilot values using the `consul operator` CLI command or using the [`/v1/operator/autopilot` endpoint](/consul/api-docs/operator/autopilot) |
Contributor
There was a problem hiding this comment.
Suggested change
| You can check the default Autopilot values using the `consul operator` CLI command or using the [`/v1/operator/autopilot` endpoint](/consul/api-docs/operator/autopilot) | |
| To check the default autopilot values, use the `consul operator` CLI command or the [`/v1/operator/autopilot` endpoint](/consul/api-docs/operator/autopilot). |
| </Tabs> | ||
|
|
||
| ### Autopilot and Consul snapshots | ||
| Changes to the Autopilot configuration are persisted in the Raft database maintained by the Consul servers. This means that Autopilott configuration will be included in the Consul snapshot data. |
Contributor
There was a problem hiding this comment.
Suggested change
| Changes to the Autopilot configuration are persisted in the Raft database maintained by the Consul servers. This means that Autopilott configuration will be included in the Consul snapshot data. | |
| Consul servers maintain changes to the autopilot configuration in the Raft database. As a result, autopilot configurations are included in the Consul snapshot data. |
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
Contributor
There was a problem hiding this comment.
After the tabs, include a table that lists the value names, descriptions, types, etc. Example:
| Autopilot setting | Description | Type | Default value |
| :----------------: | :------------------| :-----: | :-----------: |
| CleanupDeadServers | Consul servers xxx | Boolean | `true` |
| autopilot. Autopilot allows you to add new servers directly to the datacenter | ||
| and waits until you have enough servers running the new version to perform a | ||
| leadership change and demote the old servers as "non-voters". | ||
| Consul’s automatic upgrades provide a simplified way to upgrade existing Consul datacenter. This functionally is provided through the Enterprise feature of Autopilot. Autopilot allows you to add new servers directly to the datacenter and waits until you have enough servers running the new version to perform a leadership change and demote the old servers as "non-voters". |
Contributor
There was a problem hiding this comment.
Suggested change
| Consul’s automatic upgrades provide a simplified way to upgrade existing Consul datacenter. This functionally is provided through the Enterprise feature of Autopilot. Autopilot allows you to add new servers directly to the datacenter and waits until you have enough servers running the new version to perform a leadership change and demote the old servers as "non-voters". | |
| Automatic upgrades are an Enterprise feature that helps you upgrade existing Consul datacenter. With autopilot, you can add new servers running a new Consul version directly to the datacenter. Then when you have enough servers running the new version, you can perform a leadership change and demote the old servers to "non-voters". |
|
|
||
| Check [automate upgrades with Consul Enterprise](/consul/tutorials/datacenter-operations/upgrade-automation) | ||
| to learn more on the functionality. | ||
| Check [automate upgrades with Consul Enterprise](/consul/docs/upgrade/automated) to learn more on the functionality. |
Contributor
There was a problem hiding this comment.
Suggested change
| Check [automate upgrades with Consul Enterprise](/consul/docs/upgrade/automated) to learn more on the functionality. | |
| To learn more, refer to [automate upgrades with Consul Enterprise](/consul/docs/upgrade/automated). |
|
|
||
| In this tutorial you got an overview of the autopilot features and got examples | ||
| on how and when tune the default values. | ||
| To read further about [Autopilot](/consul/docs/manage/scale/autopilot) functionality, check the [read replicas](/consul/docs/manage/scale/read-replica) and [redundancy zones](/consul/docs/manage/scale/redundancy-zone) pages. |
Contributor
There was a problem hiding this comment.
Suggested change
| To read further about [Autopilot](/consul/docs/manage/scale/autopilot) functionality, check the [read replicas](/consul/docs/manage/scale/read-replica) and [redundancy zones](/consul/docs/manage/scale/redundancy-zone) pages. | |
| To learn more about the autopilot features described on this page, refer to [read replicas](/consul/docs/manage/scale/read-replica) and [redundancy zones](/consul/docs/manage/scale/redundancy-zone). |
| [max_trailing_logs](/consul/docs/reference/agent/configuration-file/general#max_trailing_logs), | ||
| either read the agent configuration documentation or use the help flag with the | ||
| operator autopilot `consul operator autopilot set-config -h`. | ||
| To learn more about operational Autopilot settings regarding stability, check the [last_contact_threshold](/consul/docs/reference/agent/configuration-file/bootstrap#last_contact_threshold) and [max_trailing_logs](/consul/docs/reference/agent/configuration-file/bootstrap#max_trailing_logs) parameters in the Consul agent configuration documentation. |
Contributor
There was a problem hiding this comment.
Suggested change
| To learn more about operational Autopilot settings regarding stability, check the [last_contact_threshold](/consul/docs/reference/agent/configuration-file/bootstrap#last_contact_threshold) and [max_trailing_logs](/consul/docs/reference/agent/configuration-file/bootstrap#max_trailing_logs) parameters in the Consul agent configuration documentation. | |
| For agent specifications related to autopilot settings for stability, refer to the [last_contact_threshold](/consul/docs/reference/agent/configuration-file/bootstrap#last_contact_threshold) and [max_trailing_logs](/consul/docs/reference/agent/configuration-file/bootstrap#max_trailing_logs) parameters in the Consul agent configuration documentation. |
| We do not recommend automated scaling of Consul server nodes based on load or usage unless it is coupled by some logic that prevents the cluster from losing quorum. | ||
|
|
||
| One way to improve your datacenter resiliency and to leverage automatic scaling is to use [read replicas](/consul/docs/manage/scale/read-replica) and [redundancy zones](/consul/docs/manage/scale/redundancy-zone). | ||
| One way to improve your datacenter resiliency and to leverage automatic scaling is to use [autopilot](/consul/docs/manage/scale/autopilot), [read replicas](/consul/docs/manage/scale/read-replica) and [redundancy zones](/consul/docs/manage/scale/redundancy-zone). |
Contributor
There was a problem hiding this comment.
Suggested change
| One way to improve your datacenter resiliency and to leverage automatic scaling is to use [autopilot](/consul/docs/manage/scale/autopilot), [read replicas](/consul/docs/manage/scale/read-replica) and [redundancy zones](/consul/docs/manage/scale/redundancy-zone). | |
| One way to improve your datacenter resiliency and to leverage automatic scaling is to use [autopilot](/consul/docs/manage/scale/autopilot), as well as Enterprise features such as [read replicas](/consul/docs/manage/scale/read-replica) and [redundancy zones](/consul/docs/manage/scale/redundancy-zone). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is the documentation point of reference for the Consul Autopilot functionality.
The origins of this article can be traced to the K8s OpenShift RedHat tutorial.
Current change impacts docs version
1.22.xand1.21.x.Links
Jira: CE-865
Deploy previews: Autopilot
Contributor checklists
Review urgency:
Pull request:
Content:
Reviewer checklist