Merge pull request #10336 from hashicorp/docs/licensing-updates

[Docs] Update documentation with information about v1.10 licensing changes.

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           |

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`
 
 <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
 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.
 

website/content/commands/snapshot/agent.mdx

@@ -150,6 +150,7 @@ Usage: `consul snapshot agent [options]`
     "ca_path": "",
     "cert_file": "",
     "key_file": "",
+    "license_path": "",
     "tls_server_name": "",
     "log": {
       "level": "INFO",
@@ -378,3 +379,20 @@ $ consul snapshot agent -interval=0
 
 Please see the [HTTP API](/api/snapshot) documentation for
 more details about snapshot internals.
+
+## Licensing
+
+The snapshot agent requires a license when it starts before it will perform any other
+actions. This can be provided using the `license_path` configuration item, the
+`CONSUL_LICENSE_PATH` environment variable or the `CONSUL_LICENSE` environment variable.
+The `license_path` configuration and `CONSUL_LICENSE_PATH` variable should point to
+files that contain the license whereas the `CONSUL_LICENSE` variable value should be
+the contents of the license itself. If a license is present in multiple ways the
+then the order of precedence is as follows:
+
+1. `CONSUL_LICENSE` variable
+2. `CONSUL_LICENSE_PATH` variable
+3. `license_path` configuration.
+
+See the [licensing documentation](/docs/enterprise#licensing) for more information about 
+Consul Enterprise license management.

website/content/docs/agent/options.mdx

@@ -1636,6 +1636,8 @@ bind_addr = "{{ GetPrivateInterfaces | include \"network\" \"10.0.0.0/8\" | attr
 
 - `leave_on_terminate` If enabled, when the agent receives a TERM signal, it will send a `Leave` message to the rest of the cluster and gracefully leave. The default behavior for this feature varies based on whether or not the agent is running as a client or a server (prior to Consul 0.7 the default value was unconditionally set to `false`). On agents in client-mode, this defaults to `true` and for agents in server-mode, this defaults to `false`.
 
+- `license_path` <EnterpriseAlert inline /> This specifies the path to a file that contains the Consul Enterprise license. See the [licensing documentation](/docs/enterprise#licensing) for more information about Consul Enterprise license management.
+
 - `limits` Available in Consul 0.9.3 and later, this is a nested
   object that configures limits that are enforced by the agent. Prior to Consul 1.5.2,
   this only applied to agents in client mode, not Consul servers. The following parameters