fix(docker): v1 and v2 with Docker: env, links, alt_links, formatting

pull/6222/head
Jason Stirnaman 2025-07-15 10:51:44 -05:00
parent b64e83a44e
commit 8567423938
4 changed files with 74 additions and 39 deletions

View File

@ -8,6 +8,10 @@ menu:
parent: Install
related:
- /enterprise_influxdb/v1/introduction/installation/docker/docker-troubleshooting/
alt_links:
core: /influxdb3/core/get-started/setup/
enterprise: /influxdb3/enterprise/get-started/setup/
v2: /influxdb/v2/install/use-docker-compose/
---
InfluxDB v1 Enterprise provides Docker images for both meta nodes and data nodes to simplify cluster deployment and management.
@ -18,6 +22,14 @@ Using Docker allows you to quickly set up and run InfluxDB Enterprise clusters w
> You must have a valid license to run InfluxDB Enterprise.
> Contact <sales@influxdata.com> for licensing information or obtain a 14-day demo license via the [InfluxDB Enterprise portal](https://portal.influxdata.com/users/new).
- [Docker image variants](#docker-image-variants)
- [Requirements](#requirements)
- [Set up an InfluxDB Enterprise cluster with Docker](#set-up-an-influxdb-enterprise-cluster-with-docker)
- [Configuration options](#configuration-options)
- [Exposing ports](#exposing-ports)
- [Persistent data storage](#persistent-data-storage)
- [Next steps](#next-steps)
## Docker image variants
InfluxDB Enterprise provides two specialized Docker images:
@ -35,15 +47,23 @@ InfluxDB Enterprise provides two specialized Docker images:
## Set up an InfluxDB Enterprise cluster with Docker
### 1. Create a Docker network
1. [Create a Docker network](#create-a-docker-network)
2. [Start meta nodes](#start-meta-nodes)
3. [Configure meta nodes to know each other](#configure-meta-nodes-to-know-each-other)
4. [Start data nodes](#start-data-nodes)
5. [Add data nodes to the cluster](#add-data-nodes-to-the-cluster)
6. [Verify the cluster](#verify-the-cluster)
7. [Stop and restart InfluxDB v1 Enterprise Containers](#stop-and-restart-influxdb-v1-enterprise-containers)
Create a custom Docker network to allow communication between meta and data nodes:
### Create a Docker network
```bash
docker network create influxdb
```
Create a custom Docker network to allow communication between meta and data nodes:
### 2. Start meta nodes
```bash
docker network create influxdb
```
### Start meta nodes
Start three meta nodes using the `influxdb:meta` image.
Each meta node requires a unique hostname and the Enterprise license key:
@ -74,7 +94,7 @@ docker run -d \
influxdb:meta
```
### 3. Configure meta nodes to know each other
### Configure meta nodes to know each other
From the first meta node, add the other meta nodes to the cluster:
@ -88,7 +108,7 @@ docker exec influxdb-meta-0 \
influxd-ctl add-meta influxdb-meta-2:8091
```
### 4. Start data nodes
### Start data nodes
Start two or more data nodes using the `influxdb:data` image:
@ -110,7 +130,7 @@ docker run -d \
influxdb:data
```
### 5. Add data nodes to the cluster
### Add data nodes to the cluster
From the first meta node, register each data node with the cluster:
@ -124,7 +144,7 @@ docker exec influxdb-meta-0 \
influxd-ctl add-data influxdb-data-1:8088
```
### 6. Verify the cluster
### Verify the cluster
Check that all nodes are properly added to the cluster:

View File

@ -16,12 +16,26 @@ related:
- /influxdb/v1/administration/config/, Configure InfluxDB OSS v1
alt_links:
core: /influxdb3/core/install/
enterprise: /influxdb3/enterprise/install/
v2: /influxdb/v2/install/use-docker-compose/
---
Install and run InfluxDB OSS v1.x using Docker containers.
This guide covers Docker installation, configuration, and initialization options.
- [Install and run InfluxDB](#install-and-run-influxdb)
- [Pull the InfluxDB v1.x image](#pull-the-influxdb-v1x-image)
- [Start InfluxDB](#start-influxdb)
- [Configure InfluxDB](#configure-influxdb)
- [Using environment variables](#using-environment-variables)
- [Using a configuration file](#using-a-configuration-file)
- [Initialize InfluxDB](#initialize-influxdb)
- [Automatic initialization (for development)](#automatic-initialization-for-development)
- [Custom initialization scripts](#custom-initialization-scripts)
- [Access the InfluxDB CLI](#access-the-influxdb-cli)
- [Next steps](#next-steps)
## Install and run InfluxDB
### Pull the InfluxDB v1.x image

View File

@ -17,18 +17,22 @@ Use the automated upgrade process built into the [InfluxDB 2.x Docker image](htt
to update InfluxDB 1.x Docker deployments to InfluxDB 2.x.
- [Upgrade requirements](#upgrade-requirements)
- [InfluxDB 2.x initialization credentials](#influxdb-2x-initialization-credentials)
- [File system mounts](#file-system-mounts)
- [Upgrade initialization mode](#upgrade-initialization-mode)
- [Minimal upgrade](#minimal-upgrade)
- [Upgrade with a custom InfluxDB 1.x configuration file](#upgrade-with-a-custom-influxdb-1-x-configuration-file)
- [Upgrade with a custom InfluxDB 1.x configuration file](#upgrade-with-a-custom-influxdb-1x-configuration-file)
- [Upgrade with custom paths](#upgrade-with-custom-paths)
- [Use new InfluxDB tools](#use-new-influxdb-tools)
- [Migrate continuous queries to tasks](#migrate-continuous-queries-to-tasks)
- [Use the interactive InfluxQL shell](#use-the-interactive-influxql-shell)
{{% note %}}
#### Export continuous queries before upgrading
The automated upgrade process **does not** migrate InfluxDB 1.x continuous queries (CQs)
to InfluxDB 2.x tasks (the 2.x equivalent). Export all of your CQs before upgrading to InfluxDB 2.x.
For information about exporting and migrating CQs to tasks, see
[Migrate continuous queries to tasks](/influxdb/v2/upgrade/v1-to-v2/migrate-cqs/).
{{% /note %}}
> [!Note]
> #### Export continuous queries before upgrading
> The automated upgrade process **does not** migrate InfluxDB 1.x continuous queries (CQs)
> to InfluxDB 2.x tasks (the 2.x equivalent). Export all of your CQs before upgrading to InfluxDB 2.x.
> For information about exporting and migrating CQs to tasks, see
> [Migrate continuous queries to tasks](/influxdb/v2/upgrade/v1-to-v2/migrate-cqs/).
## Upgrade requirements
InfluxDB 2.x provides a 1.x compatibility API, but expects a different storage layout on disk.
@ -253,21 +257,8 @@ docker run -p 8086:8086 \
<!--------------------------- END USE 2.x DEFAULTS ---------------------------->
{{< /tabs-wrapper >}}
## Use new InfluxDB tools
Once upgraded, use InfluxDB {{< current-version >}} tools to work with your time series data.
- [Migrate continuous queries to tasks](#migrate-continuous-queries-to-tasks)
- [Use the interactive InfluxQL shell](#use-the-interactive-influxql-shell)
### Migrate continuous queries to tasks
InfluxDB {{< current-version >}} replaces continuous queries with **tasks**.
By default, the upgrade process writes all continuous queries to `~/continuous_queries.txt`.
To convert continuous queries to InfluxDB tasks, see
[Migrate continuous queries to tasks](/influxdb/v2/upgrade/v1-to-v2/migrate-cqs/).
### Use the interactive InfluxQL shell
## Use the interactive InfluxQL shell
The InfluxDB {{< current-version >}} `influx` CLI includes an interactive **InfluxQL shell** for executing InfluxQL queries.
The InfluxDB {{< current-version >}} Docker image includes the `influx` CLI.

View File

@ -9,21 +9,31 @@ weight: 2
influxdb/v2/tags: [install]
related:
- /influxdb/v2/install/
- /influxdb/v2/install/upgrade/v1-to-v2/docker/
- /influxdb/v2/reference/cli/influx/auth/
- /influxdb/v2/reference/cli/influx/config/
- /influxdb/v2/reference/cli/influx/
- /influxdb/v2/admin/tokens/
alt_links:
v1: /influxdb/v1/introduction/install/docker/
core: /influxdb3/core/get-started/setup/
enterprise: /influxdb3/enterprise/get-started/setup/
---
Use Docker Compose to install and set up InfluxDB v2, the time series platform
is purpose-built to collect, store, process and visualize metrics and events.
purpose-built to collect, store, process and visualize metrics and events.
When you use Docker Compose to create an InfluxDB container, you can use
Compose [`secrets`](https://docs.docker.com/compose/use-secrets/) to control
access to sensitive credentials such as username, password, and token and
prevent leaking them in your `docker inspect` output.
- [Set up using Docker Compose secrets](#set-up-using-docker-compose-secrets)
- [Run InfluxDB CLI commands in a container](#run-influxdb-cli-commands-in-a-container)
- [Manage files in mounted volumes](#manage-files-in-mounted-volumes)
## Set up using Docker Compose secrets
> [!Tip]
> When you use Docker Compose to create an InfluxDB container, you can use
> Compose [`secrets`](https://docs.docker.com/compose/use-secrets/) to control
> access to sensitive credentials such as username, password, and token and
> prevent leaking them in your `docker inspect` output.
The `influxdb` Docker image provides the following environment
variables to use with Compose `secrets`:
@ -37,8 +47,6 @@ variables to use with Compose `secrets`:
[Operator token](/influxdb/v2/admin/tokens/#operator-token).
If you don't specify an initial token, InfluxDB generates one for you.
## Set up using Docker Compose secrets
Follow steps to set up and run InfluxDB using Docker Compose and `secrets`:
1. If you haven't already, install
@ -83,6 +91,8 @@ Follow steps to set up and run InfluxDB using Docker Compose and `secrets`:
influxdb2-config:
```
_For more information about initialization environment variables, see the [upgrade guide](/influxdb/v2/install/upgrade/v1-to-v2/docker/)._
3. For each secret in `compose.yaml`, create a file that contains the secret
value--for example: