mirror of https://github.com/status-im/consul.git
Add deprecation/removal notices regarding the APIs/CLI commands for licensing that are going away.
Co-authored-by: Freddy <freddygv@users.noreply.github.com>
This commit is contained in:
parent
f3595f5394
commit
aeaeec15e8
|
@ -2,7 +2,7 @@
|
||||||
layout: api
|
layout: api
|
||||||
page_title: License - Operator - HTTP API
|
page_title: License - Operator - HTTP API
|
||||||
description: |-
|
description: |-
|
||||||
The /operator/license endpoints allow for setting and retrieving the Consul
|
The /operator/license endpoint allows for retrieving the Consul
|
||||||
Enterprise License.
|
Enterprise License.
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -76,6 +76,9 @@ $ curl \
|
||||||
|
|
||||||
## Updating the Consul License
|
## Updating the Consul License
|
||||||
|
|
||||||
|
-> **Deprecated** This endpoint was removed in Consul v1.10.0 along with
|
||||||
|
the ability to manage the cluster's license via the API.
|
||||||
|
|
||||||
This endpoint updates the Consul license and returns some of the
|
This endpoint updates the Consul license and returns some of the
|
||||||
license contents as well as any warning messages regarding its validity.
|
license contents as well as any warning messages regarding its validity.
|
||||||
|
|
||||||
|
@ -144,6 +147,9 @@ $ curl \
|
||||||
|
|
||||||
## Resetting the Consul License
|
## Resetting the Consul License
|
||||||
|
|
||||||
|
-> **Deprecated** This endpoint was removed in Consul v1.10.0 along with
|
||||||
|
the ability to manage the cluster's license via the API.
|
||||||
|
|
||||||
This endpoint resets the Consul license to the license included in the Enterprise binary. If the included license is not valid, the replace will fail.
|
This endpoint resets the Consul license to the license included in the Enterprise binary. If the included license is not valid, the replace will fail.
|
||||||
|
|
||||||
| Method | Path | Produces |
|
| Method | Path | Produces |
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: commands
|
layout: commands
|
||||||
page_title: 'Commands: License'
|
page_title: 'Commands: License'
|
||||||
description: >
|
description: >
|
||||||
The license command provides datacenter-level management of the Consul
|
The license command provides a datacenter-level view of the Consul
|
||||||
Enterprise license.
|
Enterprise license.
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -12,7 +12,10 @@ Command: `consul license`
|
||||||
|
|
||||||
<EnterpriseAlert />
|
<EnterpriseAlert />
|
||||||
|
|
||||||
The `license` command provides datacenter-level management of the Consul Enterprise license. This was added in Consul 1.1.0.
|
The `license` command provides 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.
|
||||||
|
See the [licensing documentation](/docs/enterprise#licensing) for more information about
|
||||||
|
Consul Enterprise license management.
|
||||||
|
|
||||||
If ACLs are enabled then a token with operator privileges may be required in
|
If ACLs are enabled then a token with operator privileges may be required in
|
||||||
order to use this command. Requests are forwarded internally to the leader
|
order to use this command. Requests are forwarded internally to the leader
|
||||||
|
@ -56,6 +59,10 @@ Subcommands:
|
||||||
|
|
||||||
## put
|
## put
|
||||||
|
|
||||||
|
-> **Deprecated** The ability to manage the cluster's license via the CLI
|
||||||
|
was removed in Consul 1.10. While the CLI command still exists it will
|
||||||
|
always return an error. This command will be fully removed in a future release.
|
||||||
|
|
||||||
This command sets the Consul Enterprise license.
|
This command sets the Consul Enterprise license.
|
||||||
|
|
||||||
Usage: `consul license put [options] LICENSE`
|
Usage: `consul license put [options] LICENSE`
|
||||||
|
@ -116,6 +123,10 @@ Licensed Features:
|
||||||
|
|
||||||
## reset
|
## reset
|
||||||
|
|
||||||
|
-> **Deprecated** The ability to manage the cluster's license via the CLI
|
||||||
|
was removed in Consul 1.10. While the CLI command still exists it will
|
||||||
|
always return an error. This command will be fully removed in a future release.
|
||||||
|
|
||||||
Resets license for the datacenter to the one builtin in Consul binary, if it is still valid.
|
Resets license for the datacenter to the one builtin in Consul binary, if it is still valid.
|
||||||
If the builtin license is invalid, the current one stays active.
|
If the builtin license is invalid, the current one stays active.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue