Skip to content

Commit ea2415d

Browse files
committed
Fix partial and backport
1 parent 6d2ef5b commit ea2415d

File tree

6 files changed

+1367
-274
lines changed

6 files changed

+1367
-274
lines changed

content/consul/v1.18.x/content/docs/enterprise/upgrades.mdx

Lines changed: 375 additions & 12 deletions
Large diffs are not rendered by default.

content/consul/v1.19.x/content/docs/enterprise/upgrades.mdx

Lines changed: 375 additions & 12 deletions
Large diffs are not rendered by default.

content/consul/v1.20.x/content/docs/enterprise/upgrades.mdx

Lines changed: 375 additions & 12 deletions
Large diffs are not rendered by default.

content/consul/v1.21.x/content/docs/upgrade/automated.mdx

Lines changed: 221 additions & 218 deletions
Large diffs are not rendered by default.

content/consul/v1.22.x/content/docs/upgrade/automated.mdx

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ description: >-
66
---
77

88
# Automated Upgrades
9+
910
This page describes automated upgrades, a Consul Enterprise feature that helps you upgrade the version of Consul your servers are running.
1011

12+
@include 'alerts/enterprise-alert.mdx'
13+
1114
## Introduction
12-
One of the fundamental operations to be performed in any production environment is to upgrade Consul servers to a new version without experiencing downtime, while minimizing any risk factors that could lead to future outages.
1315

14-
Consul Enterprise helps you automatically upgrade a cluster of Consul servers to a new version.
16+
One of the fundamental operations to be performed in any production environment is to upgrade Consul servers to a new version without experiencing downtime, while minimizing any risk factors that could lead to future outages.
1517

1618
Consul autopilot monitors the amount of servers in the cluster. When a sufficient amount of new server nodes join, Consul promotes them to voters, elects a new leader among the new servers, and then demotes the servers running old versions to non-voters. Once this demotion occurs, the old servers can be safely removed from the cluster.
1719

18-
@include 'alerts/enterprise-alert.mdx'
19-
2020
Automated upgrades can help you in the following scenarios:
2121

22-
- **Upgrade to a new Consul version**: When you want to upgrade Consul servers to a newer version without downtime.
23-
- **Migrate to different server nodes**: When you have a new Consul server image with security patches and want to replace the running Consul server instances automatically, without experiencing downtime.
22+
- [Upgrade to a new Consul version](#upgrade-to-a-new-consul-version): When you want to upgrade Consul servers to a newer version without downtime.
23+
- [Migrate to different server nodes](#migrate-to-different-server-nodes): When you have a new Consul server image with security patches and want to replace the running Consul server instances automatically, without experiencing downtime.
2424

2525
## Prerequisites
2626

@@ -31,16 +31,16 @@ To test the automated upgrades feature explained in this tutorial you will need:
3131

3232
The different Consul versions need to be compatible for a direct upgrade. Check [Protocol Compatibility Promise](/consul/docs/upgrade/compatibility) and [Upgrade instructions](/consul/docs/upgrade/instructions) to make sure the versions you are using are compatible.
3333

34-
## Workflow
34+
## Upgrade to a new Consul version
3535

3636
The process to upgrade Consul servers to a newer version with automated upgrades consists of the following steps:
3737

38-
1. Verify that automated upgrades is enabled
39-
1. Add new Consul servers
40-
1. Verify upgrade
41-
1. Stop old servers
38+
1. [Verify that automated upgrades is enabled](#verify-that-automated-upgrades-is-enabled)
39+
1. [Add new Consul servers](#add-new-consul-servers)
40+
1. [Verify upgrade](#verify-upgrade)
41+
1. [Stop old servers](#stop-old-servers)
4242

43-
## Verify that automated upgrades is enabled
43+
### Verify that automated upgrades is enabled
4444

4545
The automated upgrades feature is enabled by default in Consul Enterprise.
4646

@@ -70,7 +70,7 @@ UpgradeVersionTag = ""
7070

7171
If the feature is disabled in your datacenter, enable it with the `consul operator autopilot set-config -disable-upgrade-migration=false` command.
7272

73-
## Add new servers
73+
### Add new Consul servers
7474

7575
The following example uses an existing Consul Enterprise `1.21.7` datacenter with three servers and `bootstrap_expect = 3`.
7676

@@ -98,7 +98,7 @@ consul-server-2a 73e267e5-f817-0577-bbe5-2f843adff357 172.18.0.4:8300 follow
9898

9999
Consul will keep the added servers as `non-voter` members until enough servers running the new Consul version are part of the datacenter. When the number of new servers is enough to form a quorum and elect a new leader, autopilot promotes the new servers to voters and triggers a new leader election, before it finally demotes the old servers.
100100

101-
## Verify upgrade
101+
### Verify upgrade
102102

103103
After enough servers running the new version join the datacenter, Consul autopilot starts the upgrade process.
104104

@@ -185,10 +185,10 @@ For example, if `UpgradeVersionTag` is set to `build`, and `node-meta.build` is
185185
`0.0.2` when considered by autopilot for a migration. The upgrade logic will follow semantic versioning and the version string must be in the form of either `X`, `X.Y`, or `X.Y.Z`.
186186

187187
To upgrade Consul servers using `UpgradeVersionTag`, complete the following steps:
188-
1. Configure autopilot for existing servers
189-
1. Add new Consul servers
190-
1. Verify upgrade
191-
1. Stop old servers
188+
1. [Configure autopilot for existing servers](#configure-autopilot-for-existing-servers)
189+
1. [Add new Consul servers ](#add-new-consul-servers-1)
190+
1. [Verify upgrade](#verify-upgrade-1)
191+
1. [Stop old servers](#stop-old-servers-1)
192192

193193
### Configure autopilot for existing servers
194194

@@ -300,6 +300,8 @@ autopilot {
300300

301301
</CodeTabs>
302302

303+
### Verify upgrade
304+
303305
After the third new server starts, autopilot detects the possibility of a quorum among the new servers, and promotes them to voters.
304306

305307
New nodes are first promoted to `voter` state.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<EnterpriseAlert>
22

3-
This feature requires
4-
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
3+
This feature requires Consul Enterprise.
54
Refer to the [enterprise feature matrix](/consul/docs/enterprise#consul-enterprise-feature-availability) for additional information.
65

76
</EnterpriseAlert>

0 commit comments

Comments
 (0)