From 0abb923d661350f0bea344887f16a1d58c1836df Mon Sep 17 00:00:00 2001 From: Krastin Krastev Date: Wed, 7 Sep 2022 04:39:07 +0300 Subject: [PATCH] docs: licensing improvements (#14488) Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --- website/content/commands/license.mdx | 5 +++-- website/content/docs/agent/config/index.mdx | 1 + website/content/docs/enterprise/license/overview.mdx | 7 +++++++ 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/website/content/commands/license.mdx b/website/content/commands/license.mdx index 08ee230b03..6c230a4700 100644 --- a/website/content/commands/license.mdx +++ b/website/content/commands/license.mdx @@ -12,8 +12,9 @@ Command: `consul license` -The `license` command provides a datacenter-level view of the Consul Enterprise license. This was added -in Consul 1.1.0 but Consul 1.10.0 removed the ability to set and reset the license using the CLI. +The `license` command provides a list of all datacenters that use the Consul Enterprise license applied to the current datacenter. + +~> **Warning**: Consul 1.10.0 removed the ability to set and reset the license using the CLI. See the [licensing documentation](/docs/enterprise/license/overview) for more information about Consul Enterprise license management. diff --git a/website/content/docs/agent/config/index.mdx b/website/content/docs/agent/config/index.mdx index 11953b506a..db77f5dcfd 100644 --- a/website/content/docs/agent/config/index.mdx +++ b/website/content/docs/agent/config/index.mdx @@ -90,3 +90,4 @@ items which are reloaded include: Consul will issue the following warning, `Static Runtime config has changed and need a manual config reload to be applied`. You must manually issue the `consul reload` command or send a `SIGHUP` to the Consul process to reload the new values. - Watches +- [License](/docs/enterprise/license/overview) diff --git a/website/content/docs/enterprise/license/overview.mdx b/website/content/docs/enterprise/license/overview.mdx index 8652f357ff..8066240d9c 100644 --- a/website/content/docs/enterprise/license/overview.mdx +++ b/website/content/docs/enterprise/license/overview.mdx @@ -40,6 +40,13 @@ may also be licensed in the very same manner. However, to avoid the need to configure the license on many client agents and snapshot agents, those agents have the capability to retrieve the license automatically under the conditions described below. +Updating the license for an agent depends on the method you used to apply the license. +- **If you used the `CONSUL_LICENSE` +environment variable**: After updating the environment variable, restart the affected agents. +- **If you used the +`CONSUL_LICENSE_PATH` environment variable**: Update the license file first. Then, restart the affected agents. +- **If you used the `license_path` configuration item**: Update the license file first. Then, run [`consul reload`](/commands/reload) for the affected agents. + #### Client Agent License Retrieval When a client agent starts without a license in its configuration or environment, it will try to retrieve the