Skip to content

Commit 73e4f87

Browse files
sandersonCopilotjstirnaman
authored
InfluxDB 3 Enterprise license management (#5973)
* enteprise license management * added description to license mgmnt page * Update content/influxdb3/enterprise/admin/license.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fixed description * Update content/influxdb3/enterprise/admin/license.md Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * Apply suggestions from code review * Update content/influxdb3/enterprise/admin/license.md * Update content/influxdb3/enterprise/admin/license.md --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent a5b9b56 commit 73e4f87

File tree

2 files changed

+149
-1
lines changed

2 files changed

+149
-1
lines changed

‎content/influxdb3/enterprise/admin/license.md

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
title: Manage your InfluxDB 3 Enterprise license
3+
description: >
4+
{{< product-name >}} licenses authorize the use of the {{< product-name >}}
5+
software. Learn how licenses work, how to activate and renew licenses, and more.
6+
menu:
7+
influxdb3_enterprise:
8+
name: Manage your license
9+
parent: Administer InfluxDB
10+
weight: 101
11+
---
12+
13+
{{< product-name >}} licenses authorize the use of the {{< product-name >}}
14+
software and apply to a single cluster. Licenses are primarily based on the
15+
number of CPUs InfluxDB can use, but there are other limitations depending on
16+
the license type. The following {{< product-name >}} license types are available:
17+
18+
- **Trial**: 30-day trial license with full access to {{< product-name >}} capabilities.
19+
- **At-Home**: For at-home hobbyist use with limited access to {{< product-name >}} capabilities.
20+
- **Commercial**: Commercial license with full access to {{< product-name >}} capabilities.
21+
22+
#### License feature comparison
23+
24+
| Features | Trial | At-Home | Commercial |
25+
| :------------- | :-----------------------: | :-----: | :-----------------------: |
26+
| CPU Core Limit | 256 | 2 | _Per contract_ |
27+
| Expiration | 30 days | _Never_ | _Per contract_ |
28+
| Multi-node | {{% icon "check" "v2" %}} | | {{% icon "check" "v2" %}} |
29+
| Commercial use | {{% icon "check" "v2" %}} | | {{% icon "check" "v2" %}} |
30+
31+
{{% caption %}}
32+
All other {{< product-name >}} features are available to all licenses.
33+
{{% /caption %}}
34+
35+
## CPU limit
36+
37+
Each {{< product-name >}} license limits the number of CPUs InfluxDB can use.
38+
The CPU limit is per cluster, not per machine. A cluster may consist of
39+
multiple nodes that share the available CPU limit.
40+
41+
For example, you can purchase a 32-CPU Commercial license and set up an
42+
{{< product-name >}} cluster with the following:
43+
44+
- 3 × writer nodes, each with 4 CPUs (12 total)
45+
- 1 × compactor node with 8 CPUs
46+
- 3 × query nodes, each with 4 CPUs (12 total)
47+
48+
With the {{< product-name >}} Commercial license, CPU cores are purchased in
49+
batches of 8, 16, 32, 64, or 128 cores.
50+
51+
### CPU accounting
52+
53+
CPU cores are determined by whatever the operating system of the host machine
54+
reports as its core count. {{< product-name >}} does not differentiate between
55+
physical and virtual CPU cores.
56+
57+
> [!Note]
58+
> If using Linux, InfluxDB uses whatever cgroup CPU accounting is active--for
59+
> example: `cpuset` or `cpu.shares`.
60+
61+
## Activate a license
62+
63+
Each {{< product-name >}} license must be activated, but the process of activating
64+
the license depends on the license type:
65+
66+
- [Activate a Trial or At-Home license](#activate-a-trial-or-at-home-license)
67+
- [Activate a Commercial license](#activate-a-commercial-license)
68+
69+
### Activate a Trial or At-Home license
70+
71+
When starting the {{< product-name >}} server, it will ask you what type of
72+
license you would like to use. Select `trial` or `home` and provide your
73+
email address. The server auto-generates and stores your license.
74+
75+
### Activate a Commercial license
76+
77+
1. [Contact InfluxData Sales](https://influxdata.com/contact-sales/) to obtain
78+
an {{< product-name >}} Commercial license. Provide the following:
79+
80+
- Cluster UUID
81+
- Object Store Info
82+
83+
> [!Note]
84+
> This information is provided in the output of the {{< product-name >}}
85+
> server if you try to start the server without a valid license.
86+
87+
InfluxData will provide you with a Commercial license file.
88+
89+
2. Provide the following when starting the {{< product-name >}} server:
90+
91+
- **License email**: The email address associated with your Commercial license.
92+
93+
Use either the `--license-email` option or set the
94+
`INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable.
95+
96+
- **License file**: The file path of the provided Commercial license file.
97+
98+
Use either the `--license-file` option or set the
99+
`INFLUXDB3_ENTERPRISE_LICENSE_FILE` environment variable.
100+
101+
{{< code-tabs-wrapper >}}
102+
{{% code-tabs %}}
103+
[influxdb3 options](#)
104+
[Environment variables](#)
105+
{{% /code-tabs %}}
106+
{{% code-tab-content %}}
107+
<!------------------------ BEGIN INFLUXDB3 CLI OPTIONS ------------------------>
108+
<!-- pytest.mark.skip -->
109+
```bash
110+
influxdb3 serve \
111+
--cluster-id cluster01 \
112+
--node-id node01 \
113+
--license-email example@email.com \
114+
--license-file /path/to/license-file.jwt \
115+
# ...
116+
```
117+
<!------------------------- END INFLUXDB3 CLI OPTIONS ------------------------->
118+
{{% /code-tab-content %}}
119+
{{% code-tab-content %}}
120+
<!------------------------ BEGIN ENVIRONMENT VARIABLES ------------------------>
121+
<!-- pytest.mark.skip -->
122+
```bash
123+
INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=example@email.com
124+
INFLUXDB3_ENTERPRISE_LICENSE_FILE=/path/to/license-file.jwt
125+
126+
influxdb3 serve \
127+
--cluster-id cluster01 \
128+
--node-id node01 \
129+
# ...
130+
```
131+
<!------------------------- END ENVIRONMENT VARIABLES ------------------------->
132+
{{% /code-tab-content %}}
133+
{{< /code-tabs-wrapper >}}
134+
135+
## Renew a license
136+
137+
To renew an {{< product-name >}} Commercial license, contact
138+
[InfluxData Sales](https://influxdata.com/contact-sales/).
139+
140+
## Expiration behavior
141+
142+
When your {{< product-name >}} license expires, the following occurs:
143+
144+
- Write requests continue to be accepted and processed.
145+
- Compactions continue to optimize persisted data.
146+
- Query requests return an error.
147+
- If the {{< product-name >}} server stops, it will not restart without a valid,
148+
non-expired license.

‎content/influxdb3/enterprise/admin/query-system-data/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menu:
99
influxdb3_enterprise:
1010
name: Query system data
1111
parent: Administer InfluxDB
12-
weight: 3
12+
weight: 103
1313
influxdb3/enterprise/tags: [query, api, system information, schemas]
1414
related:
1515
- /influxdb3/enterprise/query-data/sql/

0 commit comments

Comments
 (0)