status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: applied feedback about licensing FAQ and upgrade paths

This commit is contained in:
trujillo-adam 2021-06-21 16:27:16 -07:00
parent e0740d2019
commit 2c9b8e067f
1 changed files with 26 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
website/content/docs/enterprise/license/faq.mdx
View File

@ -22,56 +22,55 @@ This will no longer work since each server must be able to find a valid license
## Q: What are the upgrade requirements?
If ACLs are enabled, customers on Consul Enterprise 1.8+ or 1.9+ must upgrade Consul agents to the latest patch available (1.8.13 or 1.9.7) prior to upgrading the Consul server instances to 1.10.0.
Otherwise, the Consul agents will fail to retrieve the license with a valid agent token.
All customers on Consul Enterprise 1.8/1.9 must first upgrade their agents to the latest patch release.
The license file must also be set in an environment variable or file path. Otherwise,
the Consul agents will fail to retrieve the license with a valid agent token.
The upgrade process varies if ACLs are enabled or disabled in the cluster. The following table and corresponding sections describe common 1.10.0 upgrade scenarios.
The following table provides an overview of 1.10.0 upgrade scenarios.
| Client Version | Server Version | ACLs | Snapshot Agent Version | Guidance |
| -------------- | -------------- | -------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| 1.9.x | 1.9.x | Enabled | Do not upgrade Snapshot Agent to the latest 1.9.x. | See [Upgrade Path for Consul Clients and Servers 1.9.x - ACLs Enabled](faq#upgrade-path-for-consul-clients-and-servers-1-9-x-acls-enabled). |
| 1.9.x | 1.9.x | Disabled | Snapshot Agent affected by upgrade. | See [Upgrade Path for Consul Clients and Servers 1.9.x - ACLs Disabled](faq#upgrade-path-for-consul-clients-and-servers-1-9-x-acls-disabled). |
| 1.8.x | 1.8.x | Enabled | Do not upgrade Snapshot Agent to the latest 1.8.x | See [Upgrade Path for Consul Clients and Servers 1.8.x - ACLs Disabled](faq#upgrade-path-for-consul-clients-and-servers-1-8-x-acls-enabled). |
| 1.8.x | 1.8.x | Disabled | Snapshot Agent affected by upgrade. | See [Upgrade Path for Consul Clients and Servers 1.8.x - ACLs Disabled](faq#upgrade-path-for-consul-clients-and-servers-1-8-x-acls-disabled). |
| Client Version | Server Version | ACLs | Guidance |
| -------------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| 1.9.x | 1.9.x | Enabled | See [Upgrade Path for Consul Clients and Servers 1.9.x - ACLs Enabled](faq#upgrade-path-for-consul-clients-and-servers-1-9-x-acls-enabled). |
| 1.9.x | 1.9.x | Disabled | See [Upgrade Path for Consul Clients and Servers 1.9.x - ACLs Disabled](faq#upgrade-path-for-consul-clients-and-servers-1-9-x-acls-disabled). |
| 1.8.x | 1.8.x | Enabled | See [Upgrade Path for Consul Clients and Servers 1.8.x - ACLs Disabled](faq#upgrade-path-for-consul-clients-and-servers-1-8-x-acls-enabled). |
| 1.8.x | 1.8.x | Disabled | See [Upgrade Path for Consul Clients and Servers 1.8.x - ACLs Disabled](faq#upgrade-path-for-consul-clients-and-servers-1-8-x-acls-disabled). |
For Consul clients and servers older than 1.8, follow the instructions for [upgrading to specific versions](https://www.consul.io/docs/upgrading/upgrade-specific) to install Consul 1.8.X on clients and servers before performing one of the following upgrade scenarios.
### Upgrade Path for Consul Clients and Servers 1.9.x - ACLs Enabled
1. Upgrade Consul clients to the latest version of 1.9.x.
1. Upgrade Consul servers to the latest version of 1.9.x.
1. Upgrade Consul servers to 1.10.0 and configure the license file or set the license environment variable.
1. Upgrade Consul servers to the latest version of 1.9.x and confiure the license file or set the license environment variable.
1. Upgrade Consul clients to the latest version of 1.9.x and configure the license file or set the license environment variable.
1. Upgrade Consul servers to 1.10.0.
1. Upgrade Consul clients to 1.10.0.
1. Upgrade Snapshot Agent to 1.10.0.
1. Upgrade the Snapshot agent to 1.10.0.
### Upgrade Path for Consul Clients and Servers 1.9.x - ACLs Disabled
1. Upgrade Snapshot Agent to the latest version of 1.9.x and the license file/environment variable must be configured.
1. Configure the license file or set the license environment variable for Consul clients and servers.
1. Upgrade Consul clients to the latest version of 1.9.x.
1. Upgrade Consul servers to the latest version of 1.9.x.
1. Upgrade Consul servers to the latest version of 1.9.x and confiure the license file or set the license environment variable.
1. Upgrade Consul clients to the latest version of 1.9.x and confiure the license file or set the license environment variable.
1. Upgrade Snapshot agents to the latest version of 1.9.x and confiure the license file or set the license environment variable.
1. Upgrade Consul servers to 1.10.0.
1. Upgrade Consul clients to 1.10.0.
1. Upgrade Snapshot Agents to 1.10.0.
1. Upgrade the Snapshot agent to 1.10.0.
### Upgrade Path for Consul Clients and Servers 1.8.x - ACLs Enabled
1. Configure the license file or set the license environment variable for Consul clients and servers.
1. Upgrade Consul clients to the latest version of 1.8.x.
1. Upgrade Consul servers to the latest version of 1.8.x.
1. Upgrade Consul servers to 1.10.0.
1. Upgrade Consul clients to 1.10.0.
1. Upgrade Snapshot Agents to 1.10.0.
1. Upgrade Consul clients to the latest version of 1.8.x.
1. Upgrade Consul servers to 1.10.0 and confiure the license file or set the license environment variable.
1. Upgrade Consul clients to 1.10.0 and confiure the license file or set the license environment variable.
1. Upgrade the Snapshot agent to 1.10.0 and confiure the license file or set the license environment variable.
### Upgrade Path for Consul Clients and Servers 1.8.x - ACLs Disabled
1. Upgrade Snapshot Agent to the latest version of 1.8.x and the license file/environment variable must be configured.
1. Configure the license file or set the license environment variable for Consul clients and servers.
1. Upgrade Consul clients to the latest version of 1.8.x.
1. Upgrade Consul servers to the latest version of 1.8.x.
1. Upgrade Consul servers to the latest version of 1.8.x and confiure the license file or set the license environment variable.
1. Upgrade Consul clients to the latest version of 1.8.x and confiure the license file or set the license environment variable.
1. Upgrade Snapshot Agents to the latest version of 1.8.x and confiure the license file or set the license environment variable.
1. Upgrade Consul servers to 1.10.0.
1. Upgrade Consul clients to 1.10.0.
1. Upgrade Snapshot Agents to 1.10.0.
1. Upgrade the Snapshot agent to 1.10.0.
## Q: Is there a tutorial available for the license configuration steps?