docs: licensing improvements (#14488)

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
This commit is contained in:
Krastin Krastev 2022-09-07 04:39:07 +03:00 committed by GitHub
parent 3bf1edfb3f
commit 0abb923d66
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 2 deletions

View File

@ -12,8 +12,9 @@ Command: `consul license`
<EnterpriseAlert /> <EnterpriseAlert />
The `license` command provides a datacenter-level view of the Consul Enterprise license. This was added The `license` command provides a list of all datacenters that use the Consul Enterprise license applied to the current datacenter.
in Consul 1.1.0 but Consul 1.10.0 removed the ability to set and reset the license using the CLI.
~> **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 See the [licensing documentation](/docs/enterprise/license/overview) for more information about
Consul Enterprise license management. Consul Enterprise license management.

View File

@ -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`. 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. You must manually issue the `consul reload` command or send a `SIGHUP` to the Consul process to reload the new values.
- Watches - Watches
- [License](/docs/enterprise/license/overview)

View File

@ -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, 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. 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 #### Client Agent License Retrieval
When a client agent starts without a license in its configuration or environment, it will try to retrieve the When a client agent starts without a license in its configuration or environment, it will try to retrieve the