From aeaeec15e8ec133d3964e791f0394652eadd739b Mon Sep 17 00:00:00 2001 From: Matt Keeler Date: Thu, 3 Jun 2021 09:40:12 -0400 Subject: [PATCH] Add deprecation/removal notices regarding the APIs/CLI commands for licensing that are going away. Co-authored-by: Freddy --- website/content/api-docs/operator/license.mdx | 8 +++++++- website/content/commands/license.mdx | 15 +++++++++++++-- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/website/content/api-docs/operator/license.mdx b/website/content/api-docs/operator/license.mdx index 9ea06b6811..415491966e 100644 --- a/website/content/api-docs/operator/license.mdx +++ b/website/content/api-docs/operator/license.mdx @@ -2,7 +2,7 @@ layout: api page_title: License - Operator - HTTP API description: |- - The /operator/license endpoints allow for setting and retrieving the Consul + The /operator/license endpoint allows for retrieving the Consul Enterprise License. --- @@ -76,6 +76,9 @@ $ curl \ ## 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 license contents as well as any warning messages regarding its validity. @@ -144,6 +147,9 @@ $ curl \ ## 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. | Method | Path | Produces | diff --git a/website/content/commands/license.mdx b/website/content/commands/license.mdx index fe22a91988..a9216cf101 100644 --- a/website/content/commands/license.mdx +++ b/website/content/commands/license.mdx @@ -2,7 +2,7 @@ layout: commands page_title: 'Commands: License' description: > - The license command provides datacenter-level management of the Consul + The license command provides a datacenter-level view of the Consul Enterprise license. --- @@ -12,7 +12,10 @@ Command: `consul license` -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 order to use this command. Requests are forwarded internally to the leader @@ -56,6 +59,10 @@ Subcommands: ## 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. Usage: `consul license put [options] LICENSE` @@ -116,6 +123,10 @@ Licensed Features: ## 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. If the builtin license is invalid, the current one stays active.