From ca423c80b9538ea0f9d3e48d2518640f438c9862 Mon Sep 17 00:00:00 2001 From: Matt Keeler Date: Wed, 2 Jun 2021 15:11:53 -0400 Subject: [PATCH] Add enterprise v1.10 specific upgrade notes. --- .../docs/upgrading/upgrade-specific.mdx | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/website/content/docs/upgrading/upgrade-specific.mdx b/website/content/docs/upgrading/upgrade-specific.mdx index 5e78de6af6..5f7cf6649d 100644 --- a/website/content/docs/upgrading/upgrade-specific.mdx +++ b/website/content/docs/upgrading/upgrade-specific.mdx @@ -14,6 +14,38 @@ provided for their upgrades as a result of new features or changed behavior. This page is used to document those details separately from the standard upgrade flow. +## Consul 1.10.0 + +Consul Enterprise 1.10 has removed temporary licensing capabilities from the binaries +found on https://releases.hashicorp.com. Servers will no longer load a license previously +set through the CLI or API. Instead the license must be present in the server's configuration +or environment prior to starting. See the [licensing documentation](/docs/enterprise#licensing) +for more information about how to configure the license. Client agents previously retrieved their +license from the servers in the cluster within 30 minutes of starting and the snapshot agent +would similarly retrieve its license from the server or client agent it was configured to use. As +of Consul Enterprise 1.10 both the snapshot agent and client agent have gained the ability to +have a license loaded from a configuration file or from their environment the same way server +agents must have the license specified. Both agents can still perform automatic retrieval of their +license but with a few extra stipulations. First, license auto-retrieval now requires that ACLs +are on and that the client or snapshot agent is configured with a valid ACL token. Secondly, client +agents require that either the [`start_join`](/docs/agent/opts#start_join) or +[`retry_join`](/docs/agent/opts#retry_join) configurations are set and that they resolve to server +agents. If those stipulations are not met, attempting to start the client or snapshot agent will +result in it immediately shutting down. + +### Migration +Prior to upgrading Consul Enterprise to v1.10 you should ensure the license is set in all the right places. +In general following these steps should be all thats necessary to ensure a smooth upgrade. + +1. Retrieve the existing license from your existing cluster by running `consul license get -signed` +2. Ensure that the license is configured on all your servers by setting the one of the `license_path` + configuration item, the `CONSUL_LICENSE_PATH` environment variable or the `CONSUL_LICENSE` + environment variable. +3. If ACLs are not in use or if not all client agents are configured with the necessary `start_join` / + `retry_join` configurations pointing to servers, then repeat step 2 for all client agents. +4. If ACLs are not in use then repeat step 2 for all snapshot agents. +5. Now proceed with the [standard upgrade procedure](/docs/upgrading#standard-upgrades). + ## Consul 1.9.0 ### Changes to Raft Protocol Support