Skip to content

Commit 4c13ff4

Browse files
committed
trying to resolve markdown formatting to pass CI
1 parent 9578857 commit 4c13ff4

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

influxdb/content.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,51 @@
11
**This README covers all currently supported versions of InfluxDB:**
22

3-
- **InfluxDB 3** (Core and Enterprise)
4-
- **InfluxDB v2**
5-
- **InfluxDB v1**
3+
- **InfluxDB 3** (Core and Enterprise)
4+
- **InfluxDB v2**
5+
- **InfluxDB v1**
66

77
Scroll to the appropriate section below for Docker setup instructions, configuration flags, and usage examples.
88

99
# InfluxDB Docker Image Overview
1010

11-
InfluxDB is the time series database platform designed to collect, store, and process large amounts of timestamped data. InfluxDB supports high write and query workloads and is commonly used for:
11+
InfluxDB is the time series database platform designed to collect, store, and process large amounts of timestamped data. InfluxDB supports high write and query workloads and is commonly used for:
1212

13-
- Monitoring infrastructure and applications
14-
- Collecting data from IoT devices
15-
- Storing log and event data
13+
- Monitoring infrastructure and applications
14+
- Collecting data from IoT devices
15+
- Storing log and event data
1616

1717
InfluxDB offers multiple versions and deployment options to meet diverse technical and operational requirements.
1818

19-
## InfluxDB 3
19+
## InfluxDB 3
2020

2121
InfluxDB 3 is a new InfluxDB engine that uses an object store-backed architecture. It stores time series and event data using Apache Arrow and Parquet. It supports high-ingest workloads and fast queries.
2222

2323
InfluxDB 3 comes in two editions:
2424

25-
- **InfluxDB 3 Core**: A free, open source version of the new engine for local development and prototyping.
26-
- **InfluxDB 3 Enterprise**: A production-grade, scalable time series database that includes support for clustering, security, and enterprise features.
25+
- **InfluxDB 3 Core**: A free, open source version of the new engine for local development and prototyping.
26+
- **InfluxDB 3 Enterprise**: A production-grade, scalable time series database that includes support for clustering, security, and enterprise features.
2727

28-
**License key for Enterprise**
29-
To run InfluxDB 3 Enterprise, you need a license key. Obtain one from [InfluxData's pricing page](https://www.influxdata.com/pricing/).
28+
**License key for Enterprise** To run InfluxDB 3 Enterprise, you need a license key. Obtain one from [InfluxData's pricing page](https://www.influxdata.com/pricing/).
3029

3130
For full documentation, visit the [InfluxDB 3 documentation site](https://docs.influxdata.com)
3231

3332
## Docker Images
3433

3534
Use the official images hosted on Quay.io:
3635

37-
- **Core:** `quay.io/influxdb/influxdb3:latest`
38-
- **Enterprise:** `quay.io/influxdb/influxdb3-enterprise:latest`
36+
- **Core:** `quay.io/influxdb/influxdb3:latest`
37+
- **Enterprise:** `quay.io/influxdb/influxdb3-enterprise:latest`
3938

4039
## Parameter glossary
4140

42-
| Parameter | Description |
43-
|------------------|--------------------------------------------------------------|
44-
| `--host-id` | Unique identifier for the InfluxDB Core server node. Required. |
45-
| `--node-id` | Unique identifier for the node within an Enterprise cluster. |
41+
| Parameter | Description |
42+
|------------------|-----------------------------------------------------------------|
43+
| `--host-id` | Unique identifier for the InfluxDB Core server node. Required. |
44+
| `--node-id` | Unique identifier for the node within an Enterprise cluster. |
4645
| `--object-store` | Backend storage type for metadata and WAL files (e.g., `file`). |
47-
| `--data-dir` | Path to the directory for data storage. |
46+
| `--data-dir` | Path to the directory for data storage. |
4847

49-
# How to use this image
48+
# How to use this image
5049

5150
## Start InfluxDB 3 Core
5251

@@ -99,6 +98,7 @@ Then, generate an admin token:
9998
```bash
10099
docker exec -it influxdb3-enterprise influxdb3 create token --admin
101100
```
101+
102102
Use the token from the output to create a database.
103103

104104
```bash
@@ -120,11 +120,12 @@ docker run -d --name influxdb3-core \
120120
quay.io/influxdb/influxdb3:latest \
121121
serve --host-id my-influxdb-node --object-store file --data-dir /var/lib/influxdb3
122122
```
123+
123124
This command:
124125

125-
- Creates or reuses a Docker volume named `influxdb3-data`.
126-
- Maps the default InfluxDB port (`8086`) to your local machine.
127-
- Starts the InfluxDB server with a required host ID and object store configuration.
126+
- Creates or reuses a Docker volume named `influxdb3-data`.
127+
- Maps the default InfluxDB port (`8086`) to your local machine.
128+
- Starts the InfluxDB server with a required host ID and object store configuration.
128129

129130
### Using a local host directory
130131

@@ -138,12 +139,11 @@ docker run -d --name influxdb3-core \
138139
serve --host-id my-influxdb-node --object-store file --data-dir /var/lib/influxdb3
139140
```
140141

141-
This mounts a local folder named `influxdb3-data` in your current working directory. Ensure that this directory exists and has appropriate write permissions.
142-
142+
This mounts a local folder named `influxdb3-data` in your current working directory. Ensure that this directory exists and has appropriate write permissions.
143143

144144
# InfluxDB v2
145145

146-
## How to use the InfluxDB v2 Docker image
146+
## How to use the InfluxDB v2 Docker image
147147

148148
Use the official [InfluxDB v2 Docker image](https://hub.docker.com/_/influxdb) to start an instance for development or testing.
149149

@@ -165,7 +165,7 @@ For more information, see the [InfluxDB v2 Docker documentation](https://docs.in
165165

166166
# InfluxDB v1
167167

168-
## How to use the InfluxDB v1 Docker image
168+
## How to use the InfluxDB v1 Docker image
169169

170170
Use the official [InfluxDB v1 Docker image](https://hub.docker.com/_/influxdb) to start a basic instance for development or testing:
171171

@@ -178,5 +178,3 @@ docker run -d -p 8086:8086 \
178178
This command maps port `8086` and mounts your current directory to persist data.
179179

180180
For more information, see the [InfluxDB v1 Docker documentation](https://docs.influxdata.com/influxdb/v1/).
181-
182-

0 commit comments

Comments
 (0)