Skip to content

Commit 8897a8b

Browse files
authored
docs: Update Boundary Enterprise licensing info (#1290)
This PR recreates `boundary` PR [#5999](hashicorp/boundary#5999) in the `web-unified-docs` repo. It includes the following updates to the previous PR: - Updates the description of what happens during a graceful shutdown with an existing description from the controller docs - Explains how the time of license expiration is determined - Updates the warning message to be more realistic (🤞 ) - Adds the `license` parameter to the controller configuration docs View the updates in the preview deployment: - [Boundary Enterprise licensing](https://unified-docs-frontend-preview-4xj07ghr7-hashicorp.vercel.app/boundary/docs/enterprise/licensing) - [controller stanza configuration](https://unified-docs-frontend-preview-4xj07ghr7-hashicorp.vercel.app/boundary/docs/configuration/controller) ______________________________________________________________________________________________________ **From #5999:** Per [SPE-1197](https://hashicorp.atlassian.net/browse/SPE-1197), a customer had some questions about what happens when the Boundary Enterprise license expires. These included: - What happens when the license expires? Is there a grace period? - Are there any notifications prior to expiration? - How do you update a license key and is there downtime? - What is the recommended upgrade path? These scenarios were documented in the Vault docs, and the customer expected to find the information in the Boundary docs too. This PR updates the Boundary Enterprise licensing documentation with more information about what happens in the scenarios listed above. [SPE-1197]: https://hashicorp.atlassian.net/browse/SPE-1197?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
2 parents 7e73598 + bd30cf5 commit 8897a8b

File tree

3 files changed

+107
-13
lines changed

3 files changed

+107
-13
lines changed

content/boundary/v0.20.x/content/docs/configuration/controller.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,13 @@ description will be read.
8484
address will be read; or a [go-sockaddr template](https://godoc.org/github.com/hashicorp/go-sockaddr/template).
8585
Note that the address should not include the protocol prefixes like `http://` or `https://`.
8686

87+
- `license` - The license key value to enable Boundary Enterprise.
88+
The HashiCorp account team sends you a license to enable enterprise features.
89+
You can enter the raw license key or the directory path to the file that contains the license key.
90+
Alternatively, you can configure the license as an environment variable.
91+
92+
For more information, refer to [Boundary Enterprise licensing](/boundary/docs/enterprise/licensing).
93+
8794
- `auth_token_time_to_live` - Maximum time to live (TTL) for all auth tokens globally (pertains
8895
to all tokens from all auth methods). Valid time units are anything specified by Golang's
8996
[ParseDuration()](https://golang.org/pkg/time/#ParseDuration) method. Default is 7 days.
@@ -229,6 +236,9 @@ controller {
229236
name = "demo-controller-1"
230237
description = "A controller for a demo!"
231238
239+
# Path to a valid license to enable Boundary Enterprise.
240+
license = "file:///folder_path/license.hclic"
241+
232242
# After receiving a shutdown signal, Boundary will wait 10s before initiating the shutdown process.
233243
graceful_shutdown_wait_duration = "10s"
234244

content/boundary/v0.20.x/content/docs/enterprise/licensing.mdx

Lines changed: 87 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,16 @@ description: >-
55
Learn how to enable Boundary Enterprise with a valid license. Request access from an account team to enable enterprise features.
66
---
77

8-
# License Boundary Enterprise
8+
# Boundary Enterprise licensing
9+
10+
<EnterpriseAlert product="boundary">This feature requires <a href="https://www.hashicorp.com/products/boundary">Boundary Enterprise</a></EnterpriseAlert>
911

1012
The Boundary Enterprise binaries require a license key to enforce entitlements and time restrictions according to your contractual agreement.
11-
Once purchased, your HashiCorp account team send you a valid Boundary license for environment activation.
13+
Once purchased, your HashiCorp account team sends you a valid Boundary license to activate the environment.
1214
If you don't yet have an acccount team, but are interested in Boundary Enterprise, you can [contact sales](https://www.hashicorp.com/contact-sales).
1315

16+
## Enable Boundary Enterprise
17+
1418
Once you have received your valid Boundary license, there are two options for enabling Boundary Enterprise:
1519

1620
1. You may set the enterprise license for Boundary using an environment variable.
@@ -53,4 +57,84 @@ Refer to the sample configurations below:
5357
}
5458
```
5559

56-
Refer to the [controller](/boundary/docs/configuration/controller) configuration documentation for more information.
60+
Refer to the [controller](/boundary/docs/configuration/controller) configuration documentation for more information.
61+
62+
## License expiration
63+
64+
When the account team generates a new Boundary Enterprise license, it contains an expiration date based on your contractual agreement.
65+
Prior to the license expiration, Boundary logs five system event warnings to the event stream at the following intervals:
66+
67+
| Warning | Interval |
68+
|---------|-------------------------------------|
69+
| First | 30 days before license expiration |
70+
| Second | 7 days before license expiration |
71+
| Third | 24 hours before license expiration |
72+
| Fourth | 1 hour before license expiration |
73+
| Fifth | 1 minute before license expiration |
74+
75+
If you use an external monitoring system, you can create alerts for `"msg": "license warning"` and `"op": "licensing.StartWatching"` to watch for license expiration warnings.
76+
77+
Refer to the following example of how the warnings appear in the log:
78+
79+
<CodeBlockConfig hideClipboard>
80+
81+
```plaintext
82+
{
83+
"id": "ymFHcb1H1Z",
84+
"source": "https://hashicorp.com/boundary/nixos/controller+worker",
85+
"specversion": "1.0",
86+
"type": "system",
87+
"data": {
88+
"version": "v0.1",
89+
"op": "licensing.StartWatching",
90+
"data": {
91+
"expiration_time": "2025-09-08T11:14:33-07:00",
92+
"msg": "licensing warning",
93+
"time_left_seconds": 60
94+
}
95+
},
96+
"datacontentype": "text/plain",
97+
"time": "2025-09-08T11:14:03.457471753-07:00"
98+
}
99+
```
100+
101+
</CodeBlockConfig>
102+
103+
When the license expires, you receive the following message as an error:
104+
105+
<CodeBlockConfig hideClipboard>
106+
107+
```plaintext
108+
{
109+
"id": "SJkaNV09xP",
110+
"source": "https://hashicorp.com/boundary/nixos/controller+worker",
111+
"specversion": "1.0",
112+
"type": "error",
113+
"data": {
114+
"error": "error from licensing watcher: invalid license or license is expired",
115+
"error_fields": {},
116+
"id": "e_33IKa8BqB3",
117+
"version": "v0.1",
118+
"op": "licensing.StartWatching"
119+
},
120+
"datacontentype": "text/plain",
121+
"time": "2025-08-01T16:54:14.34408533-07:00"
122+
}
123+
==> Boundary dev environment self-terminating
124+
==> Health is enabled, waiting 0s before shutdown
125+
==> Boundary dev environment graceful shutdown triggered, interrupt again to enter shutdown
126+
```
127+
128+
</CodeBlockConfig>
129+
130+
When the license expires, Boundary performs a graceful shutdown.
131+
A graceful shutdown closes listeners and servers before shutting down the controller to preemptively stop any new traffic to the Boundary instance.
132+
133+
To update your license key, refer to the steps in [Enable Boundary Enterprise](#enable-boundary-enterprise).
134+
As a best practice, we recommend restarting the controller after you update the license key.
135+
136+
## More information
137+
138+
Refer to the [Upgrade and database migration](/boundary/tutorials/self-managed-deployment/upgrade-version) tutorial for step-by-step instructions to upgrade Boundary to the latest version, including database backup and data migration.
139+
140+
Refer to [Monitor Boundary](/boundary/docs/monitor) for more information about configuring Boundary to monitor events.

content/boundary/v0.20.x/data/docs-nav-data.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@
798798
"title": "Overview",
799799
"path": "hcp",
800800
"badge": {
801-
"text": "HCP/ENT",
801+
"text": "HCP",
802802
"type": "outlined",
803803
"color": "neutral"
804804
}
@@ -810,7 +810,7 @@
810810
"title": "Deploy and log in",
811811
"path": "hcp/get-started/deploy-and-login",
812812
"badge": {
813-
"text": "HCP/ENT",
813+
"text": "HCP",
814814
"type": "outlined",
815815
"color": "neutral"
816816
}
@@ -819,7 +819,7 @@
819819
"title": "Connect to a target",
820820
"path": "hcp/get-started/connect-to-target",
821821
"badge": {
822-
"text": "HCP/ENT",
822+
"text": "HCP",
823823
"type": "outlined",
824824
"color": "neutral"
825825
}
@@ -830,7 +830,7 @@
830830
"title": "Documentation",
831831
"href": "https://cloud.hashicorp.com/docs/boundary",
832832
"badge": {
833-
"text": "HCP/ENT",
833+
"text": "HCP",
834834
"type": "outlined",
835835
"color": "neutral"
836836
}
@@ -844,7 +844,7 @@
844844
"title": "Overview",
845845
"path": "enterprise",
846846
"badge": {
847-
"text": "HCP/ENT",
847+
"text": "ENT",
848848
"type": "outlined",
849849
"color": "neutral"
850850
}
@@ -853,7 +853,7 @@
853853
"title": "Licensing",
854854
"path": "enterprise/licensing",
855855
"badge": {
856-
"text": "HCP/ENT",
856+
"text": "ENT",
857857
"type": "outlined",
858858
"color": "neutral"
859859
}
@@ -862,7 +862,7 @@
862862
"title": "Automated license reporting",
863863
"path": "enterprise/automated-license-reporting",
864864
"badge": {
865-
"text": "HCP/ENT",
865+
"text": "ENT",
866866
"type": "outlined",
867867
"color": "neutral"
868868
}
@@ -871,7 +871,7 @@
871871
"title": "Supported versions policy",
872872
"path": "enterprise/supported-versions",
873873
"badge": {
874-
"text": "HCP/ENT",
874+
"text": "ENT",
875875
"type": "outlined",
876876
"color": "neutral"
877877
}
@@ -880,7 +880,7 @@
880880
"title": "Deployment guide",
881881
"href": "https://developer.hashicorp.com/boundary/tutorials/enterprise/ent-deployment-guide",
882882
"badge": {
883-
"text": "HCP/ENT",
883+
"text": "ENT",
884884
"type": "outlined",
885885
"color": "neutral"
886886
}
@@ -889,7 +889,7 @@
889889
"title": "Reference architecture",
890890
"href": "https://developer.hashicorp.com/boundary/tutorials/enterprise/ent-reference-architecture",
891891
"badge": {
892-
"text": "HCP/ENT",
892+
"text": "ENT",
893893
"type": "outlined",
894894
"color": "neutral"
895895
}

0 commit comments

Comments
 (0)