Skip to content

Commit 7f2c18e

Browse files
committed
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
1 parent f9b7c2b commit 7f2c18e

File tree

8 files changed

+22
-112
lines changed

8 files changed

+22
-112
lines changed

influxdb/compose.yaml

100755100644
Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,3 @@ services:
2020
- type: bind
2121
source: ~/.influxdb3/core/plugins
2222
target: /var/lib/influxdb3/plugins
23-
influxdb3-enterprise:
24-
container_name: influxdb3-enterprise
25-
image: influxdb:3-enterprise
26-
ports:
27-
- 8181:8181
28-
command:
29-
- influxdb3
30-
- serve
31-
- --node-id=node0
32-
- --cluster-id=cluster0
33-
- --object-store=file
34-
- --data-dir=/var/lib/influxdb3/data
35-
- --plugin-dir=/var/lib/influxdb3/plugins
36-
environment:
37-
- INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=EMAIL_ADDRESS
38-
volumes:
39-
- type: bind
40-
source: ~/.influxdb3/enterprise/data
41-
target: /var/lib/influxdb3/data
42-
- type: bind
43-
source: ~/.influxdb3/enterprise/plugins
44-
target: /var/lib/influxdb3/plugins
45-

influxdb/content.md

100755100644
Lines changed: 22 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -6,112 +6,45 @@ InfluxDB is the time series database platform designed to collect, store, and pr
66

77
**This README covers all currently supported versions of InfluxDB:**
88

9-
- InfluxDB 3 Core: `influxdb:3-core`
10-
- InfluxDB 3 Enterprise: `influxdb:3-enterprise`
11-
- InfluxDB v2: `influxdb:2`
12-
- InfluxDB v1: `influxdb:1.11`
13-
- InfluxDB Enterprise v1: `influxdb:1.11-data` and `influxdb:1.11-meta`
9+
- InfluxDB 3: `%%IMAGE%%:3-core`, `%%IMAGE%%:3-enterprise`
10+
- InfluxDB v2: `%%IMAGE%%:2`
11+
- InfluxDB v1: `%%IMAGE%%:1.11`
12+
- InfluxDB Enterprise v1: `%%IMAGE%%:1.11-data` and `%%IMAGE%%:1.11-meta`
1413

1514
Find a specific InfluxDB version below for startup examples and links to full documentation.
1615

1716
## How to use InfluxDB 3 images
1817

1918
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.
2019

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/).
3922

4023
### Start InfluxDB 3
4124

4225
%%COMPOSE%%
4326

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

52-
**InfluxDB 3 Enterprise:**
29+
#### InfluxDB 3 server options
5330

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:
5532

5633
```bash
57-
docker compose run influxdb3-enterprise
34+
# InfluxDB 3 Core help
35+
docker run --pull --rm %%IMAGE%%:3-core influxdb3 serve --help
5836
```
5937

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:
93-
94-
- [InfluxDB 3 Core `serve` command](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/)
95-
96-
```bash
97-
docker run --rm influxdb:3-core influxdb3 serve --help
98-
```
99-
100-
- [InfluxDB 3 Enterprise `serve` command](https://docs.influxdata.com/influxdb3/enterprise/reference/clis/influxdb3/serve/)
101-
102-
```bash
103-
docker run --rm influxdb:3-enterprise influxdb3 serve --help
104-
```
38+
[InfluxDB 3 Core `serve` command](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/)
10539

10640
### Get started using InfluxDB 3
10741

108-
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:
10943

11044
- [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/)
11245
- Use the [InfluxDB 3 Explorer UI](https://docs.influxdata.com/influxdb3/explorer/) to write data, create dashboards, explore metrics, and manage your databases.
11346

114-
### How to use the InfluxDB v2 image
47+
## How to use the InfluxDB v2 image
11548

11649
*InfluxDB v2 is an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.*
11750

@@ -126,7 +59,7 @@ docker run -d -p 8086:8086 \
12659
-e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \
12760
-e DOCKER_INFLUXDB_INIT_ORG=my-org \
12861
-e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \
129-
influxdb:2
62+
%%IMAGE%%:2
13063
```
13164

13265
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
14477
```bash
14578
docker run -d -p 8086:8086 \
14679
-v $PWD:/var/lib/influxdb \
147-
influxdb:1.11
80+
%%IMAGE%%:1.11
14881
```
14982

15083
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
15588

15689
*InfluxDB Enterprise v1 is an earlier version of InfluxDB Enterprise. InfluxDB 3 Enterprise is the latest stable version.*
15790

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

16093
### Start InfluxDB v1 Enterprise Cluster
16194

@@ -174,23 +107,23 @@ docker run -d \
174107
--network=influxdb \
175108
-h influxdb-meta-0 \
176109
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
177-
influxdb:meta
110+
%%IMAGE%%:meta
178111

179112
# Meta node 1
180113
docker run -d \
181114
--name=influxdb-meta-1 \
182115
--network=influxdb \
183116
-h influxdb-meta-1 \
184117
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
185-
influxdb:meta
118+
%%IMAGE%%:meta
186119

187120
# Meta node 2
188121
docker run -d \
189122
--name=influxdb-meta-2 \
190123
--network=influxdb \
191124
-h influxdb-meta-2 \
192125
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
193-
influxdb:meta
126+
%%IMAGE%%:meta
194127
```
195128

196129
Join meta nodes into the cluster:
@@ -209,15 +142,15 @@ docker run -d \
209142
--network=influxdb \
210143
-h influxdb-data-0 \
211144
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
212-
influxdb:data
145+
%%IMAGE%%:data
213146

214147
# Data node 1
215148
docker run -d \
216149
--name=influxdb-data-1 \
217150
--network=influxdb \
218151
-h influxdb-data-1 \
219152
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
220-
influxdb:data
153+
%%IMAGE%%:data
221154
```
222155

223156
Add data nodes to the cluster:

influxdb/get-help.md

100755100644
File mode changed.

influxdb/github-repo

100755100644
File mode changed.

influxdb/license.md

100755100644
File mode changed.

influxdb/metadata.json

100755100644
File mode changed.

influxdb/variant-data.md

100755100644
File mode changed.

influxdb/variant-meta.md

100755100644
File mode changed.

0 commit comments

Comments
 (0)