Skip to content

Commit 708fe42

Browse files
committed
docs: Revise README content and IMAGE tags:
1. Updated content.md with the new structure and major version tags. 2. Use `1.11` tags until `1.12` release or new `1` major version tags are published. 3. Fixed compose.yaml to use port 8181 directly 4. Updated variant files to use %%IMAGE%%:1-data and %%IMAGE%%:1-meta (these don't seem to be used) 5. Removed references to latest tag from v2 description 6. Created GitHub issue #820 in influxdata/influxdata-docker requesting to create generic v1 tags
1 parent 7e243f4 commit 708fe42

File tree

4 files changed

+91
-151
lines changed

4 files changed

+91
-151
lines changed

influxdb/compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
container_name: influxdb3-core
66
image: influxdb:3-core
77
ports:
8-
- 8282:8181
8+
- 8181:8181
99
command:
1010
- influxdb3
1111
- serve

influxdb/content.md

Lines changed: 79 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -4,192 +4,132 @@
44

55
InfluxDB is the time series database platform designed to collect, store, and process large amounts of event and time series data. Ideal for monitoring (sensors, servers, applications, networks), financial analytics, and behavioral tracking.
66

7-
**This README covers all currently supported versions of InfluxDB:**
7+
## Quick Start
88

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`
9+
Use InfluxDB 3 Core, the latest InfluxDB OSS:
1310

14-
Find a specific InfluxDB version below for startup examples and links to full documentation.
11+
```console
12+
docker run -d -p 8181:8181 %%IMAGE%%:3-core
13+
```
1514

16-
## How to use InfluxDB 3 images
15+
Available OSS tags:
1716

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.
17+
- `%%IMAGE%%:3-core` - **Latest InfluxDB OSS** (InfluxDB 3 Core)
18+
- `%%IMAGE%%:2` - Previous generation OSS (InfluxDB v2)
19+
- `%%IMAGE%%:1.11` - InfluxDB v1
1920

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/).
21+
## Available Versions
2222

23-
### Start InfluxDB 3
23+
#### InfluxDB 3 Core (`%%IMAGE%%:3-core`) - Latest OSS
2424

25-
%%COMPOSE%%
25+
- **Latest generation** with the InfluxDB 3 storage engine, Apache Arrow, and DataFusion SQL
26+
- Sub-10ms queries and unlimited cardinality
27+
- Supports SQL and InfluxQL queries
28+
- Includes Python processing engine
29+
- Designed for real-time monitoring and recent data
30+
- Includes v1 compatibility API for writing and querying data
31+
- Includes v2 compatibility API for writing data
2632

27-
The example `compose.yaml` defines a service for InfluxDB 3 Core and configures file system volumes for data persistence and plugin storage.
33+
#### InfluxDB v2 (`%%IMAGE%%:2`)
2834

29-
#### InfluxDB 3 server options
35+
- Built on the TSM storage engine
36+
- Supports Flux query language
37+
- Integrated UI and dashboards
38+
- Includes v1 compatibility API that supports InfluxQL
3039

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:
40+
#### InfluxDB v1 (`%%IMAGE%%:1.11`)
3241

33-
```bash
34-
# InfluxDB 3 Core help
35-
docker run --pull --rm %%IMAGE%%:3-core influxdb3 serve --help
36-
```
42+
- Built on the TSM storage engine
43+
- Original version with InfluxQL query language
44+
- Proven stability for existing deployments
3745

38-
[InfluxDB 3 Core `serve` command](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/)
46+
### Enterprise Editions (License Required)
3947

40-
### Get started using InfluxDB 3
48+
#### InfluxDB 3 Enterprise (`%%IMAGE%%:3-enterprise`)
4149

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:
50+
- Adds unlimited data retention, compaction, clustering, and high availability to InfluxDB 3 Core
4351

44-
- [Get started with InfluxDB 3 Core](https://docs.influxdata.com/influxdb3/core/get-started/)
45-
- Use the [InfluxDB 3 Explorer UI](https://docs.influxdata.com/influxdb3/explorer/) to write data, create dashboards, explore metrics, and manage your databases.
52+
For setup instructions, see the [InfluxDB 3 Enterprise installation documentation](https://docs.influxdata.com/influxdb3/enterprise/install/).
4653

47-
## How to use the InfluxDB v2 image
54+
#### InfluxDB v1 Enterprise
4855

49-
*InfluxDB v2 is an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.*
56+
- `%%IMAGE%%:1.11-data` - Data nodes for clustering
57+
- `%%IMAGE%%:1.11-meta` - Meta nodes for cluster coordination (port 8091)
5058

51-
Run [InfluxDB v2](https://docs.influxdata.com/influxdb/v2/) using the Docker CLI with the following command:
52-
53-
```bash
54-
docker run -d -p 8086:8086 \
55-
-v $PWD/data:/var/lib/influxdb2 \
56-
-v $PWD/config:/etc/influxdb2 \
57-
-e DOCKER_INFLUXDB_INIT_MODE=setup \
58-
-e DOCKER_INFLUXDB_INIT_USERNAME=my-user \
59-
-e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \
60-
-e DOCKER_INFLUXDB_INIT_ORG=my-org \
61-
-e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \
62-
%%IMAGE%%:2
63-
```
59+
For setup instructions, see the [InfluxDB v1 Enterprise Docker documentation](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/docker/).
6460

65-
After the container starts, visit [http://localhost:8086](http://localhost:8086) in your browser to view the UI.
61+
## Version Compatibility
6662

67-
For detailed instructions, see the [InfluxDB v2 Docker Compose documentation](https://docs.influxdata.com/influxdb/v2/install/use-docker-compose/).
63+
### Migration Paths
6864

69-
For more information about `DOCKER_INFLUXDB_INIT_*` environment variables, see the [InfluxDB v2 upgrade documentation](https://docs.influxdata.com/influxdb/v2/install/upgrade/v1-to-v2/docker/).
65+
To migrate from v1 or v2 to InfluxDB 3:
7066

71-
## How to use the InfluxDB v1 Docker image
67+
1. Dual-write new data to v1/v2 and InfluxDB 3.
68+
2. Query historical data from v1/v2 and write it to InfluxDB 3. *InfluxDB 3 Enterprise is recommended for historical query capability.*
7269

73-
*InfluxDB v1 is an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.*
70+
## Using InfluxDB 3 Core (Latest OSS)
7471

75-
Run [InfluxDB v1](https://docs.influxdata.com/influxdb/v1/) using the Docker CLI:
72+
### Start InfluxDB 3 Core
7673

77-
```bash
78-
docker run -d -p 8086:8086 \
79-
-v $PWD:/var/lib/influxdb \
80-
%%IMAGE%%:1.11
81-
```
74+
%%COMPOSE%%
8275

83-
This command maps port `8086` and mounts your current directory to persist data.
76+
The example `compose.yaml` starts InfluxDB 3 Core on port 8181 with:
8477

85-
For more information, see the [InfluxDB v1 Docker documentation](https://docs.influxdata.com/influxdb/v1/introduction/install/docker/).
78+
- Data persistence at `/var/lib/influxdb3`
79+
- Plugin directory for Python processing engine
80+
- Object storage configured (default: file)
8681

87-
## How to use the InfluxDB Enterprise v1 Docker image
82+
### Get Started Using InfluxDB 3
8883

89-
*InfluxDB Enterprise v1 is an earlier version of InfluxDB Enterprise. InfluxDB 3 Enterprise is the latest stable version.*
84+
After starting your InfluxDB 3 server:
9085

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.
86+
- Follow the [Get started guide](https://docs.influxdata.com/influxdb3/core/get-started/) to create an auth token and database, and write, query, and process data.
87+
- Use the [InfluxDB 3 Explorer UI](https://docs.influxdata.com/influxdb3/explorer/) to write data, create dashboards, explore metrics, and manage databases
9288

93-
### Start InfluxDB v1 Enterprise Cluster
89+
### InfluxDB 3 Server Options
9490

95-
Create a custom Docker network for node communication:
91+
Customize your deployment with available [server options](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/):
9692

9793
```bash
98-
docker network create influxdb
94+
# View all available options
95+
docker run --rm %%IMAGE%%:3-core influxdb3 serve --help
9996
```
10097

101-
Start three meta nodes (each with a unique hostname and license key):
98+
## Using InfluxDB v2
10299

103-
```bash
104-
# Meta node 0
105-
docker run -d \
106-
--name=influxdb-meta-0 \
107-
--network=influxdb \
108-
-h influxdb-meta-0 \
109-
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
110-
%%IMAGE%%:meta
111-
112-
# Meta node 1
113-
docker run -d \
114-
--name=influxdb-meta-1 \
115-
--network=influxdb \
116-
-h influxdb-meta-1 \
117-
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
118-
%%IMAGE%%:meta
119-
120-
# Meta node 2
121-
docker run -d \
122-
--name=influxdb-meta-2 \
123-
--network=influxdb \
124-
-h influxdb-meta-2 \
125-
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
126-
%%IMAGE%%:meta
127-
```
100+
*InfluxDB v2 is a previous version. Consider InfluxDB 3 Core for new deployments.*
128101

129-
Join meta nodes into the cluster:
102+
### Start InfluxDB v2
130103

131104
```bash
132-
docker exec influxdb-meta-0 influxd-ctl add-meta influxdb-meta-1:8091
133-
docker exec influxdb-meta-0 influxd-ctl add-meta influxdb-meta-2:8091
134-
```
135-
136-
Start data nodes:
137-
138-
```bash
139-
# Data node 0
140-
docker run -d \
141-
--name=influxdb-data-0 \
142-
--network=influxdb \
143-
-h influxdb-data-0 \
144-
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
145-
%%IMAGE%%:data
146-
147-
# Data node 1
148-
docker run -d \
149-
--name=influxdb-data-1 \
150-
--network=influxdb \
151-
-h influxdb-data-1 \
152-
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \
153-
%%IMAGE%%:data
154-
```
155-
156-
Add data nodes to the cluster:
157-
158-
```bash
159-
docker exec influxdb-meta-0 influxd-ctl add-data influxdb-data-0:8088
160-
docker exec influxdb-meta-0 influxd-ctl add-data influxdb-data-1:8088
105+
docker run -d -p 8086:8086 \
106+
-v $PWD/data:/var/lib/influxdb2 \
107+
-v $PWD/config:/etc/influxdb2 \
108+
-e DOCKER_INFLUXDB_INIT_MODE=setup \
109+
-e DOCKER_INFLUXDB_INIT_USERNAME=my-user \
110+
-e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \
111+
-e DOCKER_INFLUXDB_INIT_ORG=my-org \
112+
-e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \
113+
%%IMAGE%%:2
161114
```
162115

163-
Verify cluster status:
164-
165-
```bash
166-
docker exec influxdb-meta-0 influxd-ctl show
167-
```
116+
After the container starts, visit [http://localhost:8086](http://localhost:8086) to view the UI.
168117

169-
This displays all registered data and meta nodes.
118+
For detailed instructions, see the [InfluxDB v2 Docker Compose documentation](https://docs.influxdata.com/influxdb/v2/install/use-docker-compose/).
170119

171-
### Stop InfluxDB v1 Enterprise Containers
120+
## Using InfluxDB v1
172121

173-
To stop individual containers:
122+
*InfluxDB v1 is a previous version. Consider InfluxDB 3 Core for new deployments.*
174123

175-
```bash
176-
docker stop influxdb-meta-0
177-
docker stop influxdb-meta-1
178-
docker stop influxdb-meta-2
179-
docker stop influxdb-data-0
180-
docker stop influxdb-data-1
124+
```console
125+
docker run -d -p 8086:8086 \
126+
-v $PWD:/var/lib/influxdb \
127+
%%IMAGE%%:1.11
181128
```
182129

183-
### Restart Containers
184-
185-
To restart stopped containers:
130+
This starts InfluxDB v1 with:
186131

187-
```bash
188-
docker start influxdb-meta-0
189-
docker start influxdb-meta-1
190-
docker start influxdb-meta-2
191-
docker start influxdb-data-0
192-
docker start influxdb-data-1
193-
```
132+
- HTTP API on port 8086
133+
- Data persisted to current directory
194134

195-
For more information, see the [InfluxDB v1 Enterprise documentation](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/docker/).
135+
For more information, see the [InfluxDB v1 Docker documentation](https://docs.influxdata.com/influxdb/v1/introduction/install/docker/).

influxdb/variant-data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
## `%%IMAGE%%:data`
1+
## `%%IMAGE%%:1-data`
22

33
*Using this image for [InfluxDB Enterprise](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/meta_node_installation/#license-key-or-file) requires a valid InfluxData [license key](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/meta_node_installation/#license-key-or-file).*
44

55
This image contains the enterprise data node package for clustering. It supports all of the same options as the InfluxDB 1.x OSS image, but it needs port 8088 to be exposed to the meta nodes.
66

7-
Refer to the `influxdb:meta` variant for directions on how to setup a cluster.
7+
Refer to the `influxdb:1-meta` variant for directions on how to setup a cluster.

influxdb/variant-meta.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## `%%IMAGE%%:meta`
1+
## `%%IMAGE%%:1-meta`
22

33
*This image requires a valid license key from InfluxData.* Please visit our [products page](https://www.influxdata.com/products/) to learn more.
44

5-
This image contains the enterprise meta node package for clustering. It is meant to be used in conjunction with the `influxdb:data` package of the same version.
5+
This image contains the enterprise meta node package for clustering. It is meant to be used in conjunction with the `influxdb:1-data` package of the same version.
66

77
### Using this Image
88

@@ -13,7 +13,7 @@ The license key can be specified using either an environment variable or by over
1313
```console
1414
docker run -p 8089:8089 -p 8091:8091 \
1515
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key>
16-
%%IMAGE%%:meta
16+
%%IMAGE%%:1-meta
1717
```
1818

1919
#### Running the container
@@ -32,15 +32,15 @@ Start three meta nodes. This is the suggested number of meta nodes. We do not re
3232
docker run -d --name=influxdb-meta-0 --network=influxdb \
3333
-h influxdb-meta-0 \
3434
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
35-
%%IMAGE%%:meta
35+
%%IMAGE%%:1-meta
3636
docker run -d --name=influxdb-meta-1 --network=influxdb \
3737
-h influxdb-meta-1 \
3838
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
39-
%%IMAGE%%:meta
39+
%%IMAGE%%:1-meta
4040
docker run -d --name=influxdb-meta-2 --network=influxdb \
4141
-h influxdb-meta-2 \
4242
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
43-
%%IMAGE%%:meta
43+
%%IMAGE%%:1-meta
4444
```
4545

4646
When setting the hostname, you can use `-h <hostname>` or you can directly set the environment variable using `-e INFLUXDB_HOSTNAME=<hostname>`.
@@ -60,7 +60,7 @@ Or you can just start a single meta node. If you setup a single meta node, you d
6060
docker run -d --name=influxdb-meta --network=influxdb \
6161
-h influxdb-meta \
6262
-e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
63-
%%IMAGE%%:meta -single-server
63+
%%IMAGE%%:1-meta -single-server
6464
```
6565

6666
#### Connecting the data nodes
@@ -71,7 +71,7 @@ Start the data nodes using `%%IMAGE%%:data` with similar command line arguments
7171
docker run -d --name=influxdb-data-0 --network=influxdb \
7272
-h influxdb-data-0 \
7373
-e INFLUXDB_LICENSE_KEY=<license-key> \
74-
%%IMAGE%%:data
74+
%%IMAGE%%:1-data
7575
```
7676

7777
You can add `-p 8086:8086` to expose the http port to the host machine. After starting the container, choose one of the meta nodes and add the data node to it.
@@ -102,7 +102,7 @@ Modify the default configuration, which will now be available under `$PWD`. Then
102102
```console
103103
docker run \
104104
-v $PWD/influxdb-meta.conf:/etc/influxdb/influxdb-meta.conf:ro \
105-
%%IMAGE%% -config /etc/influxdb/influxdb-meta.conf
105+
%%IMAGE%%:1-meta -config /etc/influxdb/influxdb-meta.conf
106106
```
107107

108108
Modify `$PWD` to the directory where you want to store the configuration file.

0 commit comments

Comments
 (0)