You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(influxdb): address review comments from tianon
- Replace v1 Enterprise image aliases with version-specific tags
- Changed all instances of %%IMAGE%%:meta to %%IMAGE%%:1.11-meta
- Changed all instances of %%IMAGE%%:data to %%IMAGE%%:1.11-data
- Focus InfluxDB 3 section primarily on Core with brief Enterprise mentions
- Ensure consistent use of %%IMAGE%% template variable throughout
- InfluxDB Enterprise v1: `%%IMAGE%%:1.11-data` and `%%IMAGE%%:1.11-meta`
14
13
15
14
Find a specific InfluxDB version below for startup examples and links to full documentation.
16
15
17
16
## How to use InfluxDB 3 images
18
17
19
18
InfluxDB 3 is the latest version and features Apache Arrow, DataFusion SQL, and object storage for sub-10ms queries and unlimited cardinality. The InfluxDB 3 Core and InfluxDB 3 Enterprise editions both support SQL and InfluxQL queries, include the Python processing engine, and work with the InfluxDB 3 Explorer UI.
20
19
21
-
-**Core** (free, open source): For real-time monitoring and recent data
22
-
-**Enterprise**: Adds historical data, clustering, HA, and security. Includes 30-day trial.
23
-
24
-
### Pull the Image
25
-
26
-
Pull the official Docker image for InfluxDB 3 Core or InfluxDB 3 Enterprise:
27
-
28
-
**InfluxDB 3 Core:**
29
-
30
-
```bash
31
-
docker pull influxdb:3-core
32
-
```
33
-
34
-
**InfluxDB 3 Enterprise:**
35
-
36
-
```bash
37
-
docker pull influxdb:3-enterprise
38
-
```
20
+
-**Core** (free, open source): For real-time monitoring and recent data. Covered in this guide.
21
+
-**Enterprise** (requires a license): Adds historical data, clustering, HA, and security. See the InfluxData documentation to [Get started with InfluxDB 3 Enterprise](https://docs.influxdata.com/influxdb3/enterprise/get-started/).
39
22
40
23
### Start InfluxDB 3
41
24
42
25
%%COMPOSE%%
43
26
44
-
The example `compose.yaml` defines services for InfluxDB 3 Core and InfluxDB 3 Enterprise, including file system volumes for data persistence. You can customize the example to suit your needs, such as changing the node ID or object store type (for example, `s3`).
45
-
46
-
**InfluxDB 3 Core:**
47
-
48
-
```bash
49
-
docker compose run influxdb3-core
50
-
```
27
+
The example `compose.yaml` defines a service for InfluxDB 3 Core and configures file system volumes for data persistence and plugin storage.
51
28
52
-
**InfluxDB 3 Enterprise:**
29
+
#### InfluxDB 3 server options
53
30
54
-
\***License key for Enterprise**: InfluxDB 3 Enterprise requires a license key. In the example, configure your email address to start the free 30-day trial. For more options, see the [InfluxDB 3 Enterprise licensing documentation](https://docs.influxdata.com/influxdb3/enterprise/admin/license/).\*
31
+
You can customize the example, such as changing the node ID or object store type (for example, `s3`). See the full list of server options:
55
32
56
33
```bash
57
-
docker compose run influxdb3-enterprise
34
+
# InfluxDB 3 Core help
35
+
docker run --pull --rm %%IMAGE%%:3-core influxdb3 serve --help
58
36
```
59
37
60
-
... via `docker` CLI
61
-
62
-
Use the following commands to start InfluxDB 3 Core or InfluxDB 3 Enterprise using the Docker CLI:
63
-
64
-
**InfluxDB 3 Core:**
65
-
66
-
```bash
67
-
docker run -d --name influxdb3-core \
68
-
--publish 8181:8181 \
69
-
--volume /path/on/host:/path/in/container \
70
-
influxdb:3-core influxdb3 serve \
71
-
--node-id node0 \
72
-
--object-store file \
73
-
--data-dir /path/in/container
74
-
```
75
-
76
-
**InfluxDB 3 Enterprise:**
77
-
78
-
\***License key for Enterprise**: InfluxDB 3 Enterprise requires a license key. In the example, configure your email address to start the free 30-day trial. For more options, see the [InfluxDB 3 Enterprise licensing documentation](https://docs.influxdata.com/influxdb3/enterprise/admin/license/).\*
79
-
80
-
```bash
81
-
docker run -d --name influxdb3-enterprise \
82
-
--publish 8181:8181 \
83
-
--volume /path/on/host:/path/in/container \
84
-
influxdb:3-enterprise influxdb3 serve \
85
-
--node-id node0 \
86
-
--cluster-id cluster0 \
87
-
--object-store file \
88
-
--data-dir /path/in/container \
89
-
--license-email EMAIL_ADDRESS
90
-
```
91
-
92
-
For more information about server options, access the documentation:
After you have started your InfluxDB 3 server, follow the step-by-step guides to create an auth token and database, and write, query, and process data in InfluxDB 3:
42
+
After starting your InfluxDB 3 server, follow the guide to create an auth token and database, and write, query, and process data in InfluxDB 3:
109
43
110
44
-[Get started with InfluxDB 3 Core](https://docs.influxdata.com/influxdb3/core/get-started/)
111
-
-[Get started with InfluxDB 3 Enterprise](https://docs.influxdata.com/influxdb3/enterprise/get-started/)
112
45
- Use the [InfluxDB 3 Explorer UI](https://docs.influxdata.com/influxdb3/explorer/) to write data, create dashboards, explore metrics, and manage your databases.
113
46
114
-
###How to use the InfluxDB v2 image
47
+
## How to use the InfluxDB v2 image
115
48
116
49
*InfluxDB v2 is an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.*
117
50
@@ -126,7 +59,7 @@ docker run -d -p 8086:8086 \
126
59
-e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \
127
60
-e DOCKER_INFLUXDB_INIT_ORG=my-org \
128
61
-e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \
129
-
influxdb:2
62
+
%%IMAGE%%:2
130
63
```
131
64
132
65
After the container starts, visit [http://localhost:8086](http://localhost:8086) in your browser to view the UI.
@@ -144,7 +77,7 @@ Run [InfluxDB v1](https://docs.influxdata.com/influxdb/v1/) using the Docker CLI
144
77
```bash
145
78
docker run -d -p 8086:8086 \
146
79
-v $PWD:/var/lib/influxdb \
147
-
influxdb:1.11
80
+
%%IMAGE%%:1.11
148
81
```
149
82
150
83
This command maps port `8086` and mounts your current directory to persist data.
@@ -155,7 +88,7 @@ For more information, see the [InfluxDB v1 Docker documentation](https://docs.in
155
88
156
89
*InfluxDB Enterprise v1 is an earlier version of InfluxDB Enterprise. InfluxDB 3 Enterprise is the latest stable version.*
157
90
158
-
Use the official `influxdb:meta` and `influxdb:data` Docker images to deploy and manage an InfluxDB v1 Enterprise cluster. A valid license is required.
91
+
Use the official `%%IMAGE%%:meta` and `%%IMAGE%%:data` Docker images to deploy and manage an InfluxDB v1 Enterprise cluster. A valid license is required.
0 commit comments