Skip to content

Commit 8b61d34

Browse files
committed
refactor(influxdb): streamline documentation structure
- Reorganize content to prioritize InfluxDB 3 Core as the latest OSS version - Consolidate v1 Enterprise documentation by removing separate variant files - Improve clarity with structured sections for each InfluxDB version - Add recommended tools section for InfluxDB 3 Core ecosystem - Enhance Docker command examples with better formatting
1 parent 47491be commit 8b61d34

File tree

3 files changed

+53
-178
lines changed

3 files changed

+53
-178
lines changed

influxdb/content.md

Lines changed: 53 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -4,102 +4,104 @@
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-
## Quick Start
7+
## Start InfluxDB 3 Core
88

9-
Use InfluxDB 3 Core, the latest InfluxDB OSS:
9+
%%COMPOSE%%
10+
11+
Alternatively, you can use the following command to start InfluxDB 3 Core:
12+
13+
```bash
14+
docker run --rm -p 8181:8181 \
15+
-v $PWD/data:/var/lib/influxdb3/data \
16+
-v $PWD/plugins:/var/lib/influxdb3/plugins \
17+
%%IMAGE%%:3-core influxdb3 serve \
18+
--node-id=my-node-0 \
19+
--object-store=file \
20+
--data-dir=/var/lib/influxdb3/data \
21+
--plugin-dir=/var/lib/influxdb3/plugins
22+
```
23+
24+
InfluxDB 3 Core starts with:
25+
26+
- Data persistence at `/var/lib/influxdb3/data`
27+
- Python processing engine enabled with plugin directory
28+
- HTTP API listening on port `8181`
29+
30+
### Using InfluxDB 3 Core
1031

11-
```console
12-
docker run -d -p 8181:8181 %%IMAGE%%:3-core
32+
After starting your InfluxDB 3 server, follow the [Get Started guide](https://docs.influxdata.com/influxdb3/core/get-started/) to create an authorization token and start writing, querying, and processing data via the built-in `influxdb3` CLI or the HTTP API.
33+
34+
### Recommended tools for InfluxDB 3 Core
35+
36+
Use the following tools with InfluxDB 3 Core:
37+
38+
- **[InfluxDB 3 Explorer UI](https://docs.influxdata.com/influxdb3/explorer/)**: Visualize, query, and manage your data with the standalone web interface designed for InfluxDB 3. [View on Docker Hub](https://hub.docker.com/r/influxdata/influxdb3-ui)
39+
- **[Telegraf](https://docs.influxdata.com/telegraf/v1/)**: Collect, transform, and send metrics from hundreds of sources directly to InfluxDB 3. [View on Docker Hub](https://hub.docker.com/_/telegraf)
40+
- **[Official Client Libraries](https://docs.influxdata.com/influxdb3/core/reference/client-libraries/)**: Integrate InfluxDB 3 into your applications using supported libraries for Python, Go, JavaScript, and more.
41+
42+
### Customize server options
43+
44+
Customize your instance with available [server options](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/):
45+
46+
```bash
47+
docker run --rm %%IMAGE%%:3-core influxdb3 serve --help
1348
```
1449

15-
Available OSS tags:
50+
## Available InfluxDB variants
1651

1752
- `%%IMAGE%%:3-core` - **Latest InfluxDB OSS** (InfluxDB 3 Core)
1853
- `%%IMAGE%%:2` - Previous generation OSS (InfluxDB v2)
1954
- `%%IMAGE%%:1.11` - InfluxDB v1
2055

21-
## Available Versions
22-
23-
#### InfluxDB 3 Core (`%%IMAGE%%:3-core`) - Latest OSS
56+
### InfluxDB 3 Core (`%%IMAGE%%:3-core`) - Latest OSS
2457

25-
- **Latest generation** with the InfluxDB 3 storage engine, Apache Arrow, and DataFusion SQL
58+
- **Latest generation** using object storage with the InfluxDB 3 storage engine, Apache Arrow, and DataFusion SQL
2659
- Sub-10ms queries and unlimited cardinality
2760
- Supports SQL and InfluxQL queries
2861
- Includes Python processing engine
2962
- 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
63+
- Includes InfluxDB v1 and v2 compatibility APIs
3264

33-
#### InfluxDB v2 (`%%IMAGE%%:2`)
65+
### InfluxDB v2 (`%%IMAGE%%:2`)
3466

3567
- Built on the TSM storage engine
3668
- Supports Flux query language
3769
- Integrated UI and dashboards
3870
- Includes v1 compatibility API that supports InfluxQL
3971

40-
#### InfluxDB v1 (`%%IMAGE%%:1.11`)
72+
### InfluxDB v1 (`%%IMAGE%%:1.11`)
4173

4274
- Built on the TSM storage engine
4375
- Original version with InfluxQL query language
4476
- Proven stability for existing deployments
4577

46-
### Enterprise Editions (License Required)
78+
### InfluxDB 3 Enterprise (license required) (`%%IMAGE%%:3-enterprise`)
4779

48-
#### InfluxDB 3 Enterprise (`%%IMAGE%%:3-enterprise`)
49-
50-
- Adds unlimited data retention, compaction, clustering, and high availability to InfluxDB 3 Core
80+
Adds unlimited data retention, compaction, clustering, and high availability to InfluxDB 3 Core.
5181

5282
For setup instructions, see the [InfluxDB 3 Enterprise installation documentation](https://docs.influxdata.com/influxdb3/enterprise/install/).
5383

54-
#### InfluxDB v1 Enterprise
84+
### InfluxDB v1 Enterprise (license required)
5585

5686
- `%%IMAGE%%:1.11-data` - Data nodes for clustering
5787
- `%%IMAGE%%:1.11-meta` - Meta nodes for cluster coordination (port 8091)
5888

5989
For setup instructions, see the [InfluxDB v1 Enterprise Docker documentation](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/docker/).
6090

61-
## Version Compatibility
91+
## Version compatibility
6292

63-
### Migration Paths
93+
### Migration paths
6494

6595
To migrate from v1 or v2 to InfluxDB 3:
6696

6797
1. Dual-write new data to v1/v2 and InfluxDB 3.
6898
2. Query historical data from v1/v2 and write it to InfluxDB 3. *InfluxDB 3 Enterprise is recommended for historical query capability.*
6999

70-
## Using InfluxDB 3 Core (Latest OSS)
71-
72-
### Start InfluxDB 3 Core
73-
74-
%%COMPOSE%%
75-
76-
The example `compose.yaml` starts InfluxDB 3 Core on port 8181 with:
77-
78-
- Data persistence at `/var/lib/influxdb3`
79-
- Plugin directory for Python processing engine
80-
- Object storage configured (default: file)
81-
82-
### Get Started Using InfluxDB 3
83-
84-
After starting your InfluxDB 3 server:
85-
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
88-
89-
### InfluxDB 3 Server Options
90-
91-
Customize your deployment with available [server options](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/):
92-
93-
```bash
94-
# View all available options
95-
docker run --rm %%IMAGE%%:3-core influxdb3 serve --help
96-
```
97-
98100
## Using InfluxDB v2
99101

100102
*InfluxDB v2 is a previous version. Consider InfluxDB 3 Core for new deployments.*
101103

102-
### Start InfluxDB v2
104+
Enter the following command to start InfluxDB v2 initialized with custom configuration:
103105

104106
```bash
105107
docker run -d -p 8086:8086 \
@@ -121,7 +123,7 @@ For detailed instructions, see the [InfluxDB v2 Docker Compose documentation](ht
121123

122124
*InfluxDB v1 is a previous version. Consider InfluxDB 3 Core for new deployments.*
123125

124-
```console
126+
```bash
125127
docker run -d -p 8086:8086 \
126128
-v $PWD:/var/lib/influxdb \
127129
%%IMAGE%%:1.11
@@ -132,4 +134,4 @@ This starts InfluxDB v1 with:
132134
- HTTP API on port 8086
133135
- Data persisted to current directory
134136

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

influxdb/variant-data.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

influxdb/variant-meta.md

Lines changed: 0 additions & 120 deletions
This file was deleted.

0 commit comments

Comments
 (0)