You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/consul/v1.22.x/content/docs/upgrade/automated.mdx
+20-18Lines changed: 20 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,21 +6,21 @@ description: >-
6
6
---
7
7
8
8
# Automated Upgrades
9
+
9
10
This page describes automated upgrades, a Consul Enterprise feature that helps you upgrade the version of Consul your servers are running.
10
11
12
+
@include 'alerts/enterprise-alert.mdx'
13
+
11
14
## 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.
13
15
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.
15
17
16
18
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.
17
19
18
-
@include 'alerts/enterprise-alert.mdx'
19
-
20
20
Automated upgrades can help you in the following scenarios:
21
21
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.
24
24
25
25
## Prerequisites
26
26
@@ -31,16 +31,16 @@ To test the automated upgrades feature explained in this tutorial you will need:
31
31
32
32
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.
33
33
34
-
## Workflow
34
+
## Upgrade to a new Consul version
35
35
36
36
The process to upgrade Consul servers to a newer version with automated upgrades consists of the following steps:
37
37
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)
42
42
43
-
## Verify that automated upgrades is enabled
43
+
###Verify that automated upgrades is enabled
44
44
45
45
The automated upgrades feature is enabled by default in Consul Enterprise.
46
46
@@ -70,7 +70,7 @@ UpgradeVersionTag = ""
70
70
71
71
If the feature is disabled in your datacenter, enable it with the `consul operator autopilot set-config -disable-upgrade-migration=false` command.
72
72
73
-
## Add new servers
73
+
###Add new Consul servers
74
74
75
75
The following example uses an existing Consul Enterprise `1.21.7` datacenter with three servers and `bootstrap_expect = 3`.
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.
100
100
101
-
## Verify upgrade
101
+
###Verify upgrade
102
102
103
103
After enough servers running the new version join the datacenter, Consul autopilot starts the upgrade process.
104
104
@@ -185,10 +185,10 @@ For example, if `UpgradeVersionTag` is set to `build`, and `node-meta.build` is
185
185
`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`.
186
186
187
187
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)
192
192
193
193
### Configure autopilot for existing servers
194
194
@@ -300,6 +300,8 @@ autopilot {
300
300
301
301
</CodeTabs>
302
302
303
+
### Verify upgrade
304
+
303
305
After the third new server starts, autopilot detects the possibility of a quorum among the new servers, and promotes them to voters.
0 commit comments