Skip to content

Commit 8d98488

Browse files
authored
Merge pull request #6139 from influxdata/fix-enterprise-docker
Fix enterprise docker
2 parents b45b117 + b79c000 commit 8d98488

File tree

9 files changed

+383
-426
lines changed

9 files changed

+383
-426
lines changed

assets/styles/layouts/article/_pagination-btns.scss

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,10 @@
3434
vertical-align: middle;
3535
}
3636
}
37+
38+
// Remove max-width when only one button is present
39+
&:only-child {
40+
max-width: none;
41+
}
3742
}
3843
}

compose.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,31 @@ services:
311311
- --log-filter=debug
312312
- --object-store=file
313313
- --data-dir=/var/lib/influxdb3
314+
influxdb3-enterprise:
315+
container_name: influxdb3-enterprise
316+
image: influxdb:3-enterprise
317+
ports:
318+
- 8181:8181
319+
# Change the INFLUXDB3_LICENSE_EMAIL environment variable to your email address. You can also set it in a `.env` file in the same directory as this compose file. Docker Compose automatically loads the .env file.
320+
# The license email option is only used the first time you run the container; you can't change the license email after the first run.
321+
# The server stores the license in the data directory in the object store and the license is associated with the cluster ID and email.
322+
command:
323+
- influxdb3
324+
- serve
325+
- --node-id=node0
326+
- --cluster-id=cluster0
327+
- --log-filter=debug
328+
- --object-store=file
329+
- --data-dir=/var/lib/influxdb3
330+
- --plugin-dir=/var/lib/influxdb3/plugins
331+
- --license-email=${INFLUXDB3_LICENSE_EMAIL}
332+
volumes:
333+
- type: bind
334+
source: docker/influxdb3/data
335+
target: /var/lib/influxdb3
336+
- type: bind
337+
source: docker/influxdb3/plugins
338+
target: /var/lib/influxdb3-plugins
314339
telegraf-pytest:
315340
container_name: telegraf-pytest
316341
image: influxdata/docs-pytest

content/influxdb3/core/install.md

Lines changed: 2 additions & 198 deletions
Original file line numberDiff line numberDiff line change
@@ -6,205 +6,9 @@ menu:
66
name: Install InfluxDB 3 Core
77
weight: 2
88
influxdb3/core/tags: [install]
9+
source: /shared/influxdb3/install.md
910
alt_links:
1011
v1: /influxdb/v1/introduction/install/
1112
---
1213

13-
- [System Requirements](#system-requirements)
14-
- [Quick install](#quick-install)
15-
- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries)
16-
- [Docker image](#docker-image)
17-
18-
## System Requirements
19-
20-
#### Operating system
21-
22-
{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**.
23-
24-
#### Object storage
25-
26-
A key feature of InfluxDB 3 is its use of object storage to store time series
27-
data in Apache Parquet format. You can choose to store these files on your local
28-
file system. Performance on your local filesystem will likely be better, but
29-
object storage has the advantage of not running out of space and being accessible
30-
by other systems over the network. {{< product-name >}} natively supports Amazon S3,
31-
Azure Blob Storage, and Google Cloud Storage.
32-
You can also use many local object storage implementations that provide an
33-
S3-compatible API, such as [Minio](https://min.io/).
34-
35-
## Quick install
36-
37-
Use the InfluxDB 3 quick install script to install {{< product-name >}} on
38-
**Linux** and **macOS**.
39-
40-
> [!Important]
41-
> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries).
42-
43-
1. Use the following command to download and install the appropriate
44-
{{< product-name >}} package on your local machine:
45-
<!--pytest.mark.skip-->
46-
```bash
47-
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
48-
&& sh install_influxdb3.sh
49-
```
50-
51-
2. Verify that installation completed successfully:
52-
53-
```bash
54-
influxdb3 --version
55-
```
56-
57-
> [!Note]
58-
>
59-
> #### influxdb3 not found
60-
>
61-
> If your system can't locate your `influxdb3` binary, `source` your
62-
> current shell configuration file (`.bashrc`, `.zshrc`, etc.).
63-
>
64-
> {{< code-tabs-wrapper >}}
65-
{{% code-tabs %}}
66-
[.bashrc](#)
67-
[.zshrc](#)
68-
{{% /code-tabs %}}
69-
{{% code-tab-content %}}
70-
```bash
71-
source ~/.bashrc
72-
```
73-
{{% /code-tab-content %}}
74-
{{% code-tab-content %}}
75-
<!--pytest.mark.skip-->
76-
```bash
77-
source ~/.zshrc
78-
```
79-
{{% /code-tab-content %}}
80-
{{< /code-tabs-wrapper >}}
81-
82-
## Download {{% product-name %}} binaries
83-
84-
{{< tabs-wrapper >}}
85-
{{% tabs %}}
86-
[Linux](#)
87-
[macOS](#)
88-
[Windows](#)
89-
{{% /tabs %}}
90-
{{% tab-content %}}
91-
92-
<!-------------------------------- BEGIN LINUX -------------------------------->
93-
94-
- [{{< product-name >}} • Linux (AMD64, x86_64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz)
95-
96-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256)
97-
98-
- [{{< product-name >}} • Linux (ARM64, AArch64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz)
99-
100-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256)
101-
102-
<!--------------------------------- END LINUX --------------------------------->
103-
104-
{{% /tab-content %}}
105-
{{% tab-content %}}
106-
107-
<!-------------------------------- BEGIN MACOS -------------------------------->
108-
109-
- [{{< product-name >}} • macOS (Silicon, ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz)
110-
111-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256)
112-
113-
> [!Note]
114-
> macOS Intel builds are coming soon.
115-
116-
<!--------------------------------- END MACOS --------------------------------->
117-
118-
{{% /tab-content %}}
119-
{{% tab-content %}}
120-
121-
<!------------------------------- BEGIN WINDOWS ------------------------------->
122-
123-
- [{{< product-name >}} • Windows (AMD64, x86_64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
124-
125-
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256)
126-
127-
<!-------------------------------- END WINDOWS -------------------------------->
128-
129-
{{% /tab-content %}}
130-
{{< /tabs-wrapper >}}
131-
132-
## Docker image
133-
134-
Use the `influxdb3-{{< product-key >}}` Docker image to deploy {{< product-name >}} in a
135-
Docker container.
136-
The image is available for x86_64 (AMD64) and ARM64 architectures.
137-
138-
### Use Docker CLI
139-
140-
<!--pytest.mark.skip-->
141-
```bash
142-
docker pull influxdb:3-{{< product-key >}}
143-
```
144-
145-
Docker automatically pulls the appropriate image for your system architecture.
146-
147-
To specify the system architecture, use platform-specific tags--for example:
148-
149-
```bash
150-
# For x86_64/AMD64
151-
docker pull \
152-
--platform linux/amd64 \
153-
influxdb:3-{{< product-key >}}
154-
```
155-
156-
```bash
157-
# For ARM64
158-
docker pull \
159-
--platform linux/arm64 \
160-
influxdb:3-{{< product-key >}}
161-
```
162-
163-
> [!Note]
164-
> The {{% product-name %}} Docker image exposes port `8181`, the `influxdb3` server default for HTTP connections.
165-
> To map the exposed port to a different port when running a container, see the Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/).
166-
167-
### Use Docker Compose
168-
169-
1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}--for example:
170-
171-
```yaml
172-
# compose.yaml
173-
services:
174-
influxdb3-{{< product-key >}}:
175-
container_name: influxdb3-{{< product-key >}}
176-
image: influxdb:3-{{< product-key >}}
177-
ports:
178-
- 8181:8181
179-
command:
180-
- influxdb3
181-
- serve
182-
- --node-id=node0
183-
- --object-store=file
184-
- --data-dir=/var/lib/influxdb3
185-
```
186-
187-
2. Use the Docker Compose CLI to start the server.
188-
189-
Optional: to make sure you have the latest version of the image before you
190-
start the server, run `docker compose pull`.
191-
192-
<!--pytest.mark.skip-->
193-
```bash
194-
docker compose pull && docker compose run influxdb3-{{< product-key >}}
195-
```
196-
197-
> [!Note]
198-
> #### Stopping an InfluxDB 3 container
199-
>
200-
> To stop a running InfluxDB 3 container, find and terminate the process--for example:
201-
>
202-
> <!--pytest.mark.skip-->
203-
> ```bash
204-
> ps -ef | grep influxdb3
205-
> kill -9 <PROCESS_ID>
206-
> ```
207-
>
208-
> Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container.
209-
210-
{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}}
14+
<!--SOURCE content/shared/influxdb3/install.md -->

content/influxdb3/enterprise/admin/license.md

Lines changed: 71 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,22 +73,49 @@ physical and virtual CPU cores.
7373
7474
## Activate a license
7575

76-
Each {{< product-name >}} license must be activated, but the process of activating
77-
the license depends on the license type:
76+
Each {{< product-name >}} license must be activated when you start the server,
77+
but the process of activating the license depends on the license type:
7878

7979
- [Activate a trial or at-home license](#activate-a-trial-or-at-home-license)
8080
- [Activate a commercial license](#activate-a-commercial-license)
8181

8282
### Activate a trial or at-home license
8383

84-
When starting the {{< product-name >}} server, it asks what type of
85-
license you would like to use.
86-
Select `trial` or `home` and provide your
87-
email address.
88-
The server auto-generates and stores your license.
89-
84+
1. Use the [`influxdb3 serve` command](/influxdb3/enterprise/reference/cli/influxdb3/serve/) to start the server.
85+
If the server doesn't find a license file or email address, the server prompts you
86+
to enter your email address.
87+
If you're [activating a trial or home license with Docker](#activate-a-trial-or-home-license-with-docker), include options to [skip the email prompt](#skip-the-email-prompt).
88+
2. The server prompts you to select a license type. Select `trial` or `home`.
89+
3. In the verification email from {{% product-name %}},
90+
click the button to verify your email address.
91+
92+
After you verify your email address, {{% product-name %}} auto-generates a
93+
license (associated with your cluster and email address) and stores the license
94+
file in your object store.
9095
The license file is a JWT file that contains the license information.
9196

97+
> [!Important]
98+
> #### Activate a trial or home license with Docker
99+
>
100+
> If you're starting a new {{% product-name %}} server in a Docker container, you must
101+
> use one of the methods to [skip the email prompt](#skip-the-email-prompt).
102+
> This ensures that the container can generate the license file after you
103+
> verify your email address.
104+
> See the [Docker Compose example](?t=Docker+compose#activate-a-trial-or-home-license-with-docker).
105+
106+
#### Skip the email prompt
107+
108+
To skip the email prompt when starting the server, you can provide your email
109+
address using one of the following methods:
110+
111+
- Use the [`--license-email`](/influxdb3/enterprise/reference/config-options/#license-email) option with the `influxdb3 serve` command
112+
- Set the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable
113+
114+
If the server finds a valid license file in your object store, it ignores the
115+
license email option.
116+
117+
See examples to [start the server with your license email](#start-the-server-with-your-license-email).
118+
92119
#### Use an existing trial or at-home license
93120

94121
When you activate a trial or at-home license, InfluxDB registers your email
@@ -153,12 +180,13 @@ existing license if it's still valid.
153180
environment variable
154181
7. If no license is found, the server won't start
155182
156-
#### Example: Start the {{% product-name %}} server with your license email:
183+
### Start the server with your license email
157184
158185
{{< code-tabs-wrapper >}}
159186
{{% code-tabs %}}
160187
[influxdb3 options](#)
161188
[Environment variables](#)
189+
[Docker compose](#example-activate-trial-or-home-with-compose)
162190
{{% /code-tabs %}}
163191
{{% code-tab-content %}}
164192
<!------------------------ BEGIN INFLUXDB3 CLI OPTIONS ------------------------>
@@ -185,9 +213,42 @@ influxdb3 serve \
185213
```
186214
<!------------------------- END ENVIRONMENT VARIABLES ------------------------->
187215
{{% /code-tab-content %}}
216+
{{% code-tab-content %}}
217+
<!------------------------ BEGIN DOCKER COMPOSE ------------------------>
218+
```yaml
219+
# compose.yaml
220+
name: data-crunching-stack
221+
services:
222+
influxdb3-enterprise:
223+
container_name: influxdb3-enterprise
224+
image: influxdb:3-enterprise
225+
ports:
226+
- 8181:8181
227+
# In the following command, replace INFLUXDB3_LICENSE_EMAIL with your email address.
228+
# Alternatively, pass the `INFLUXDB3_LICENSE_EMAIL` environment variable or
229+
# store the email address in a compose CLI .env file.
230+
command:
231+
- influxdb3
232+
- serve
233+
- --node-id=node0
234+
- --cluster-id=cluster0
235+
- --object-store=file
236+
- --data-dir=/var/lib/influxdb3
237+
- --plugin-dir=/var/lib/influxdb3/plugins
238+
- --license-email=INFLUXDB3_LICENSE_EMAIL
239+
volumes:
240+
- type: bind
241+
source: ~/.influxdb3/data
242+
target: /var/lib/influxdb3
243+
- type: bind
244+
source: ~/.influxdb3/plugins
245+
target: /var/lib/influxdb3/plugins
246+
```
247+
<!------------------------- END DOCKER COMPOSE ------------------------->
248+
{{% /code-tab-content %}}
188249
{{< /code-tabs-wrapper >}}
189250
190-
#### Example: Start the {{% product-name %}} server with your license file:
251+
### Start the server with your license file
191252
192253
{{< code-tabs-wrapper >}}
193254
{{% code-tabs %}}

0 commit comments

Comments
 (0)