Răsfoiți Sursa

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
Jason Stirnaman 2 luni în urmă
părinte
comite
8b61d34a69
3 a modificat fișierele cu 53 adăugiri și 178 ștergeri
  1. 53 51
      influxdb/content.md
  2. 0 7
      influxdb/variant-data.md
  3. 0 120
      influxdb/variant-meta.md

+ 53 - 51
influxdb/content.md

@@ -4,102 +4,104 @@
 
 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.
 
-## Quick Start
+## Start InfluxDB 3 Core
 
-Use InfluxDB 3 Core, the latest InfluxDB OSS:
+%%COMPOSE%%
+
+Alternatively, you can use the following command to start InfluxDB 3 Core:
+
+```bash
+docker run --rm -p 8181:8181 \
+  -v $PWD/data:/var/lib/influxdb3/data \
+  -v $PWD/plugins:/var/lib/influxdb3/plugins \
+  %%IMAGE%%:3-core influxdb3 serve \
+    --node-id=my-node-0 \
+    --object-store=file \
+    --data-dir=/var/lib/influxdb3/data \
+    --plugin-dir=/var/lib/influxdb3/plugins
+```
+
+InfluxDB 3 Core starts with:
+
+-	Data persistence at `/var/lib/influxdb3/data`
+-	Python processing engine enabled with plugin directory
+-	HTTP API listening on port `8181`
+
+### Using InfluxDB 3 Core
 
-```console
-docker run -d -p 8181:8181 %%IMAGE%%:3-core
+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.
+
+### Recommended tools for InfluxDB 3 Core
+
+Use the following tools with InfluxDB 3 Core:
+
+-	**[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)
+-	**[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)
+-	**[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.
+
+### Customize server options
+
+Customize your instance with available [server options](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/):
+
+```bash
+   docker run --rm %%IMAGE%%:3-core influxdb3 serve --help
 ```
 
-Available OSS tags:
+## Available InfluxDB variants
 
 -	`%%IMAGE%%:3-core` - **Latest InfluxDB OSS** (InfluxDB 3 Core)
 -	`%%IMAGE%%:2` - Previous generation OSS (InfluxDB v2)
 -	`%%IMAGE%%:1.11` - InfluxDB v1
 
-## Available Versions
-
-#### InfluxDB 3 Core (`%%IMAGE%%:3-core`) - Latest OSS
+### InfluxDB 3 Core (`%%IMAGE%%:3-core`) - Latest OSS
 
--	**Latest generation** with the InfluxDB 3 storage engine, Apache Arrow, and DataFusion SQL
+-	**Latest generation** using object storage with the InfluxDB 3 storage engine, Apache Arrow, and DataFusion SQL
 -	Sub-10ms queries and unlimited cardinality
 -	Supports SQL and InfluxQL queries
 -	Includes Python processing engine
 -	Designed for real-time monitoring and recent data
--	Includes v1 compatibility API for writing and querying data
--	Includes v2 compatibility API for writing data
+-	Includes InfluxDB v1 and v2 compatibility APIs
 
-#### InfluxDB v2 (`%%IMAGE%%:2`)
+### InfluxDB v2 (`%%IMAGE%%:2`)
 
 -	Built on the TSM storage engine
 -	Supports Flux query language
 -	Integrated UI and dashboards
 -	Includes v1 compatibility API that supports InfluxQL
 
-#### InfluxDB v1 (`%%IMAGE%%:1.11`)
+### InfluxDB v1 (`%%IMAGE%%:1.11`)
 
 -	Built on the TSM storage engine
 -	Original version with InfluxQL query language
 -	Proven stability for existing deployments
 
-### Enterprise Editions (License Required)
+### InfluxDB 3 Enterprise (license required) (`%%IMAGE%%:3-enterprise`)
 
-#### InfluxDB 3 Enterprise (`%%IMAGE%%:3-enterprise`)
-
--	Adds unlimited data retention, compaction, clustering, and high availability to InfluxDB 3 Core
+Adds unlimited data retention, compaction, clustering, and high availability to InfluxDB 3 Core.
 
 For setup instructions, see the [InfluxDB 3 Enterprise installation documentation](https://docs.influxdata.com/influxdb3/enterprise/install/).
 
-#### InfluxDB v1 Enterprise
+### InfluxDB v1 Enterprise (license required)
 
 -	`%%IMAGE%%:1.11-data` - Data nodes for clustering
 -	`%%IMAGE%%:1.11-meta` - Meta nodes for cluster coordination (port 8091)
 
 For setup instructions, see the [InfluxDB v1 Enterprise Docker documentation](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/docker/).
 
-## Version Compatibility
+## Version compatibility
 
-### Migration Paths
+### Migration paths
 
 To migrate from v1 or v2 to InfluxDB 3:
 
 1.	Dual-write new data to v1/v2 and InfluxDB 3.
 2.	Query historical data from v1/v2 and write it to InfluxDB 3. *InfluxDB 3 Enterprise is recommended for historical query capability.*
 
-## Using InfluxDB 3 Core (Latest OSS)
-
-### Start InfluxDB 3 Core
-
-%%COMPOSE%%
-
-The example `compose.yaml` starts InfluxDB 3 Core on port 8181 with:
-
--	Data persistence at `/var/lib/influxdb3`
--	Plugin directory for Python processing engine
--	Object storage configured (default: file)
-
-### Get Started Using InfluxDB 3
-
-After starting your InfluxDB 3 server:
-
--	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.
--	Use the [InfluxDB 3 Explorer UI](https://docs.influxdata.com/influxdb3/explorer/) to write data, create dashboards, explore metrics, and manage databases
-
-### InfluxDB 3 Server Options
-
-Customize your deployment with available [server options](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/):
-
-```bash
-# View all available options
-docker run --rm %%IMAGE%%:3-core influxdb3 serve --help
-```
-
 ## Using InfluxDB v2
 
 *InfluxDB v2 is a previous version. Consider InfluxDB 3 Core for new deployments.*
 
-### Start InfluxDB v2
+Enter the following command to start InfluxDB v2 initialized with custom configuration:
 
 ```bash
 docker run -d -p 8086:8086 \
@@ -121,7 +123,7 @@ For detailed instructions, see the [InfluxDB v2 Docker Compose documentation](ht
 
 *InfluxDB v1 is a previous version. Consider InfluxDB 3 Core for new deployments.*
 
-```console
+```bash
 docker run -d -p 8086:8086 \
   -v $PWD:/var/lib/influxdb \
   %%IMAGE%%:1.11
@@ -132,4 +134,4 @@ This starts InfluxDB v1 with:
 -	HTTP API on port 8086
 -	Data persisted to current directory
 
-For more information, see the [InfluxDB v1 Docker documentation](https://docs.influxdata.com/influxdb/v1/introduction/install/docker/).
+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/).

+ 0 - 7
influxdb/variant-data.md

@@ -1,7 +0,0 @@
-## `%%IMAGE%%:1-data`
-
-*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).*
-
-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.
-
-Refer to the `influxdb:1-meta` variant for directions on how to setup a cluster.

+ 0 - 120
influxdb/variant-meta.md

@@ -1,120 +0,0 @@
-## `%%IMAGE%%:1-meta`
-
-*This image requires a valid license key from InfluxData.* Please visit our [products page](https://www.influxdata.com/products/) to learn more.
-
-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.
-
-### Using this Image
-
-#### Specifying the license key
-
-The license key can be specified using either an environment variable or by overriding the configuration file. If you specify the license key directly, the container needs to be able to access the InfluxData portal.
-
-```console
-docker run -p 8089:8089 -p 8091:8091 \
-      -e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key>
-      %%IMAGE%%:1-meta
-```
-
-#### Running the container
-
-The examples below will use docker's built-in networking capability. If you use the port exposing feature, the host port and the container port need to be the same.
-
-First, create a docker network:
-
-```console
-docker network create influxdb
-```
-
-Start three meta nodes. This is the suggested number of meta nodes. We do not recommend running more or less. If you choose to run more or less, be sure that the number of meta nodes is odd. The hostname must be set on each container to the address that will be used to access the meta node. When using docker networks, the hostname should be made the same as the name of the container.
-
-```console
-docker run -d --name=influxdb-meta-0 --network=influxdb \
-      -h influxdb-meta-0 \
-      -e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
-      %%IMAGE%%:1-meta
-docker run -d --name=influxdb-meta-1 --network=influxdb \
-      -h influxdb-meta-1 \
-      -e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
-      %%IMAGE%%:1-meta
-docker run -d --name=influxdb-meta-2 --network=influxdb \
-      -h influxdb-meta-2 \
-      -e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
-      %%IMAGE%%:1-meta
-```
-
-When setting the hostname, you can use `-h <hostname>` or you can directly set the environment variable using `-e INFLUXDB_HOSTNAME=<hostname>`.
-
-After starting the meta nodes, you need to tell them about each other. Choose one of the meta nodes and run `influxd-ctl` in the container.
-
-```console
-docker exec influxdb-meta-0 \
-      influxd-ctl add-meta influxdb-meta-1:8091
-docker exec influxdb-meta-0 \
-      influxd-ctl add-meta influxdb-meta-2:8091
-```
-
-Or you can just start a single meta node. If you setup a single meta node, you do not need to use `influxd-ctl add-meta`.
-
-```console
-docker run -d --name=influxdb-meta --network=influxdb \
-      -h influxdb-meta \
-      -e INFLUXDB_ENTERPRISE_LICENSE_KEY=<license-key> \
-      %%IMAGE%%:1-meta -single-server
-```
-
-#### Connecting the data nodes
-
-Start the data nodes using `%%IMAGE%%:data` with similar command line arguments to the meta nodes. You can start as many data nodes as are allowed by your license.
-
-```console
-docker run -d --name=influxdb-data-0 --network=influxdb \
-      -h influxdb-data-0 \
-      -e INFLUXDB_LICENSE_KEY=<license-key> \
-      %%IMAGE%%:1-data
-```
-
-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.
-
-```console
-docker exec influxdb-meta-0 \
-      influxd-ctl add-data influxdb-data-0:8088
-```
-
-Perform these same steps for any other data nodes that you want to add.
-
-You can now connect to any of the running data nodes to use your cluster.
-
-See the [influxdb](https://hub.docker.com/_/influxdb/) image documentation for more details on how to use the data node images.
-
-#### Configuration
-
-InfluxDB Meta can be either configured from a config file or using environment variables. To mount a configuration file and use it with the server, you can use this command:
-
-Generate the default configuration file:
-
-```console
-docker run --rm %%IMAGE%%:meta influxd-meta config > influxdb-meta.conf
-```
-
-Modify the default configuration, which will now be available under `$PWD`. Then start the InfluxDB Meta container.
-
-```console
-docker run \
-      -v $PWD/influxdb-meta.conf:/etc/influxdb/influxdb-meta.conf:ro \
-      %%IMAGE%%:1-meta -config /etc/influxdb/influxdb-meta.conf
-```
-
-Modify `$PWD` to the directory where you want to store the configuration file.
-
-For environment variables, the format is `INFLUXDB_$SECTION_$NAME`. All dashes (`-`) are replaced with underscores (`_`). If the variable isn't in a section, then omit that part.
-
-Examples:
-
-```console
-INFLUXDB_REPORTING_DISABLED=true
-INFLUXDB_META_DIR=/path/to/metadir
-INFLUXDB_ENTERPRISE_REGISTRATION_ENABLED=true
-```
-
-For more information, see how to [Install InfluxDB Enterprise meta nodes](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/meta_node_installation/).