diff --git a/.template-helpers/arches.sh b/.template-helpers/arches.sh index 4baf2fd659b6..9d2765820622 100755 --- a/.template-helpers/arches.sh +++ b/.template-helpers/arches.sh @@ -1,4 +1,4 @@ -#!/bin/bash +#!/opt/homebrew/bin/bash set -Eeuo pipefail repo="${1:-}" diff --git a/.template-helpers/generate-dockerfile-links-partial.sh b/.template-helpers/generate-dockerfile-links-partial.sh index 126fcbea3920..2b04d5357744 100755 --- a/.template-helpers/generate-dockerfile-links-partial.sh +++ b/.template-helpers/generate-dockerfile-links-partial.sh @@ -1,4 +1,4 @@ -#!/bin/bash +#!/opt/homebrew/bin/bash set -Eeuo pipefail repo="${1:-}" diff --git a/.template-helpers/variant.sh b/.template-helpers/variant.sh index dd802ec5c82d..72bfafad3e96 100755 --- a/.template-helpers/variant.sh +++ b/.template-helpers/variant.sh @@ -1,4 +1,4 @@ -#!/bin/bash +#!/opt/homebrew/bin/bash set -eo pipefail repo="$1" diff --git a/influxdb/README.md b/influxdb/README.md index 42e1545d9884..08e2fc855058 100644 --- a/influxdb/README.md +++ b/influxdb/README.md @@ -24,33 +24,33 @@ WARNING: # Supported tags and respective `Dockerfile` links -- [`1.11`, `1.11.8`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.11/Dockerfile) +- [`1.11`, `1.11.8`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.11/Dockerfile) -- [`1.11-alpine`, `1.11.8-alpine`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.11/alpine/Dockerfile) +- [`1.11-alpine`, `1.11.8-alpine`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.11/alpine/Dockerfile) -- [`1.10-data`, `1.10.8-data`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.10/data/Dockerfile) +- [`1.10-data`, `1.10.8-data`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.10/data/Dockerfile) -- [`1.10-data-alpine`, `1.10.8-data-alpine`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.10/data/alpine/Dockerfile) +- [`1.10-data-alpine`, `1.10.8-data-alpine`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.10/data/alpine/Dockerfile) -- [`1.10-meta`, `1.10.8-meta`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.10/meta/Dockerfile) +- [`1.10-meta`, `1.10.8-meta`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.10/meta/Dockerfile) -- [`1.10-meta-alpine`, `1.10.8-meta-alpine`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.10/meta/alpine/Dockerfile) +- [`1.10-meta-alpine`, `1.10.8-meta-alpine`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.10/meta/alpine/Dockerfile) -- [`1.11-data`, `1.11.8-data`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.11/data/Dockerfile) +- [`1.11-data`, `1.11.8-data`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.11/data/Dockerfile) -- [`1.11-data-alpine`, `1.11.8-data-alpine`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.11/data/alpine/Dockerfile) +- [`1.11-data-alpine`, `1.11.8-data-alpine`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.11/data/alpine/Dockerfile) -- [`1.11-meta`, `1.11.8-meta`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.11/meta/Dockerfile) +- [`1.11-meta`, `1.11.8-meta`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.11/meta/Dockerfile) -- [`1.11-meta-alpine`, `1.11.8-meta-alpine`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/1.11/meta/alpine/Dockerfile) +- [`1.11-meta-alpine`, `1.11.8-meta-alpine`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/1.11/meta/alpine/Dockerfile) -- [`2`, `2.7`, `2.7.12`, `latest`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/2.7/Dockerfile) +- [`2`, `2.7`, `2.7.12`, `latest`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/2.7/Dockerfile) -- [`2-alpine`, `2.7-alpine`, `2.7.11-alpine`, `alpine`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/2.7/alpine/Dockerfile) +- [`2-alpine`, `2.7-alpine`, `2.7.11-alpine`, `alpine`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/2.7/alpine/Dockerfile) -- [`3-core`, `3.1-core`, `3.1.0-core`, `core`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/3.1-core/Dockerfile) +- [`3-core`, `3.2-core`, `3.2.0-core`, `core`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/3.2-core/Dockerfile) -- [`3-enterprise`, `3.1-enterprise`, `3.1.0-enterprise`, `enterprise`](https://github.com/influxdata/influxdata-docker/blob/063caa0d729da41b70760c8f7362345f1bb79779/influxdb/3.1-enterprise/Dockerfile) +- [`3-enterprise`, `3.2-enterprise`, `3.2.0-enterprise`, `enterprise`](https://github.com/influxdata/influxdata-docker/blob/abb94994d78be45ccaa56282f36c36ad16bd5a5e/influxdb/3.2-enterprise/Dockerfile) # Quick reference (cont.) diff --git a/influxdb/compose.yaml b/influxdb/compose.yaml new file mode 100644 index 000000000000..429c09c87461 --- /dev/null +++ b/influxdb/compose.yaml @@ -0,0 +1,15 @@ +# compose.yaml +services: + influxdb3-core: + container_name: influxdb3-core + image: influxdb:3-core + ports: + - 8181:8181 + command: + - influxdb3 + - serve + - --node-id=node0 + - --object-store=file + - --data-dir=/var/lib/influxdb3 + - --plugin-dir=/var/lib/influxdb3-plugins + diff --git a/influxdb/content.md b/influxdb/content.md index e94ab3d60fae..750d9ac3901a 100644 --- a/influxdb/content.md +++ b/influxdb/content.md @@ -1,643 +1,221 @@ -# What is InfluxDB? +**This README covers all currently supported versions of InfluxDB:** -InfluxDB is the time series data platform designed to handle high write and query workloads. Using InfluxDB, you can collect, store, and process large amounts of timestamped data, including metrics and events for use cases such as DevOps monitoring, application metrics, IoT sensors, and event monitoring. +- **InfluxDB 3** (Core and Enterprise) +- **InfluxDB v2** +- **InfluxDB v1** -Use the InfluxDB Docker Hub image to write, query, and process time series data in [InfluxDB v2](https://docs.influxdata.com/influxdb/v2/) or [InfluxDB v1](https://docs.influxdata.com/influxdb/v1/). +Scroll to the appropriate section below for Docker setup instructions, configuration flags, and usage examples. -For more information, visit https://influxdata.com. +# InfluxDB Docker Image Overview %%LOGO%% -# How to use this image for InfluxDB v2 +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: -**Quick start**: See the guide to [Install InfluxDB v2 for Docker](https://docs.influxdata.com/influxdb/v2/install/?t=Docker) and get started using InfluxDB v2. +- Monitoring infrastructure and applications +- Collecting data from IoT devices +- Storing log and event data -## Start InfluxDB v2 and set up with the UI, CLI, or API +InfluxDB offers multiple versions and deployment options to meet diverse technical and operational requirements. -To start an InfluxDB v2 container, enter the following command: +## InfluxDB 3 -```bash -docker run \ - -p 8086:8086 \ - -v "$PWD/data:/var/lib/influxdb2" \ - -v "$PWD/config:/etc/influxdb2" \ - %%IMAGE%%:2 -``` - -Replace the following with your own values: +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. -- `$PWD/data`: A host directory to mount at the container's [InfluxDB data directory](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) path -- `$PWD/config`: A host directory to mount at the container's [InfluxDB configuration directory](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) path +InfluxDB 3 comes in two editions: -After the container starts, the InfluxDB UI and API are accessible at http://localhost:8086 on the host. You're ready to set up an initial admin user, token, and bucket from outside or inside the container--choose one of the following: +- **InfluxDB 3 Core**: A free, open source version of the new engine for local development and prototyping. +- **InfluxDB 3 Enterprise**: A production-grade, scalable time series database that includes support for clustering, security, and enterprise features. -- **Set up InfluxDB from outside the container**: [Set up InfluxDB](https://docs.influxdata.com/influxdb/v2/get-started/setup/) from the host or network using the InfluxDB UI, `influx` CLI, or HTTP API. +**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/). -- **Set up InfluxDB from inside the container**: Use `docker exec` to run the `influx` CLI installed in the container--for example: +For full documentation, visit the [InfluxDB 3 documentation site](https://docs.influxdata.com) - ```bash - docker exec influxdb2 influx setup \ - --username $USERNAME \ - --password $PASSWORD \ - --org $ORGANIZATION \ - --bucket $BUCKET \ - --force - ``` +## Docker Images -See the [`influx setup` documentation](https://docs.influxdata.com/influxdb/v2/reference/cli/influx/setup/) for the full list of options. +Use the official images hosted on Quay.io: -*If you run setup from within the container, InfluxDB stores `influx` CLI [connection configurations](/influxdb/v2/reference/cli/influx/#provide-required-authentication-credentials) in the container's `/etc/influxdb2/influx-configs` file.* +- **Core:** `quay.io/influxdb/influxdb3:latest` +- **Enterprise:** `quay.io/influxdb/influxdb3-enterprise:latest` -## Start InfluxDB v2 with automated setup +## Parameter glossary -To start and set up InfluxDB v2 with a single command, specify `-e DOCKER_INFLUXDB_INIT_MODE=setup` and `-e DOCKER_INFLUXDB_INIT_` environment variables for the initial user, password, bucket, and organization--for example: - -```bash -docker run -d -p 8086:8086 \ - -v "$PWD/data:/var/lib/influxdb2" \ - -v "$PWD/config:/etc/influxdb2" \ - -e DOCKER_INFLUXDB_INIT_MODE=setup \ - -e DOCKER_INFLUXDB_INIT_USERNAME= \ - -e DOCKER_INFLUXDB_INIT_PASSWORD= \ - -e DOCKER_INFLUXDB_INIT_ORG= \ - -e DOCKER_INFLUXDB_INIT_BUCKET= \ - %%IMAGE%%:2 -``` +| Parameter | Description | +|------------------|-----------------------------------------------------------------| +| `--host-id` | Unique identifier for the InfluxDB Core server node. Required. | +| `--node-id` | Unique identifier for the node within an Enterprise cluster. | +| `--object-store` | Backend storage type for metadata and WAL files (e.g., `file`). | +| `--data-dir` | Path to the directory for data storage. | -Replace the following with your own values: +# How to use this image -- `$PWD/data`: A host directory to mount at the container's [InfluxDB data directory](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) path -- `$PWD/config`: A host directory to mount at the container's [InfluxDB configuration directory](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) path -- ``: A name for your initial admin [user](https://docs.influxdata.com/influxdb/v2/admin/users/) -- ``: A password for your initial admin [user](https://docs.influxdata.com/influxdb/v2/admin/users/) -- ``: A name for your initial [organization](https://docs.influxdata.com/influxdb/v2/admin/organizations/) -- ``: A name for your initial [bucket](https://docs.influxdata.com/influxdb/v2/admin/buckets/) (database) +## Start InfluxDB 3 Core -*If you run setup from within the container, InfluxDB stores `influx` CLI [connection configurations](/influxdb/v2/reference/cli/influx/#provide-required-authentication-credentials) in the container's `/etc/influxdb2/influx-configs` file.* +Run InfluxDB 3 Core using either Docker Compose or the CLI. -### Automated setup options +### Docker Compose -In setup mode (`DOCKER_INFLUXDB_INIT_MODE=setup`) or upgrade mode (`DOCKER_INFLUXDB_INIT_MODE=upgrade`), you can specify the following Docker-specific environment variables to provide initial setup values: +Create a `compose.yml` file with the configuration: -- `DOCKER_INFLUXDB_INIT_USERNAME`: A name for your initial admin [user](https://docs.influxdata.com/influxdb/v2/admin/users/). -- `DOCKER_INFLUXDB_INIT_PASSWORD`: A password for your initial admin [user](https://docs.influxdata.com/influxdb/v2/admin/users/). -- `DOCKER_INFLUXDB_INIT_ORG`: A name for your initial [organization](https://docs.influxdata.com/influxdb/v2/admin/organizations/). -- `DOCKER_INFLUXDB_INIT_BUCKET`: A name for your initial [bucket](https://docs.influxdata.com/influxdb/v2/admin/buckets/). -- Optional: `DOCKER_INFLUXDB_INIT_RETENTION`: A [duration](https://docs.influxdata.com/influxdb/v2/reference/glossary/#duration) to use as the initial bucket's [retention period](https://docs.influxdata.com/influxdb/v2/reference/internals/data-retention/#bucket-retention-period). Default: `0` (infinite; doesn't delete data). -- Optional: `DOCKER_INFLUXDB_INIT_ADMIN_TOKEN`: A string value to set for the [Operator token](https://docs.influxdata.com/influxdb/v2/admin/tokens/#operator-token). Default: a generated token. +%%COMPOSE%% -The following example shows how to pass values for all initial setup options: +Start the container by using the following command: ```bash -docker run -d -p 8086:8086 \ - -v "$PWD/data:/var/lib/influxdb2" \ - -v "$PWD/config:/etc/influxdb2" \ - -e DOCKER_INFLUXDB_INIT_MODE=setup \ - -e DOCKER_INFLUXDB_INIT_USERNAME=my-user \ - -e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \ - -e DOCKER_INFLUXDB_INIT_ORG=my-org \ - -e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \ - -e DOCKER_INFLUXDB_INIT_RETENTION=1w \ - -e DOCKER_INFLUXDB_INIT_ADMIN_TOKEN=my-super-secret-auth-token \ - %%IMAGE%%:2 +docker compose pull && docker compose run influxdb3-core ``` -*To upgrade from InfluxDB 1.x to InfluxDB 2.x, see the **Upgrading from InfluxDB 1.x** section below.\* - -With InfluxDB set up and running, see the [Get started](https://docs.influxdata.com/influxdb/v2/get-started/) tutorial to create tokens and write and query data. - -### Custom Initialization Scripts - -In `setup` mode (`DOCKER_INFLUXDB_INIT_MODE=setup`) or `upgrade` mode (`DOCKER_INFLUXDB_INIT_MODE=upgrade`), the InfluxDB Docker Hub image supports running custom initialization scripts. After the setup process completes, scripts are executed in lexical sort order by name. - -For the container to run scripts, they must: - -- Be mounted in the container's `/docker-entrypoint-initdb.d` directory -- Be named using the `.sh` file name extension -- Be executable by the user running the `docker run` command--for example, to allow the current use to execute a script with `docker run`: - - ```bash - chmod +x ./scripts/ - ``` - -> #### Grant permissions to mounted files -> -> By default, Docker runs containers using the user and group IDs of the user executing the `docker run` command. When files are bind-mounted into the container, Docker preserves the user and group ownership from the host system. - -The image exports a number of variables into the environment before executing scripts. The following variables are available for you to use in your scripts: - -- `INFLUX_CONFIGS_PATH`: Path to the `influx` CLI connection configurations file written by `setup`/`upgrade` -- `INFLUX_HOST`: URL to the `influxd` instance running `setup`/`upgrade` -- `DOCKER_INFLUXDB_INIT_USER_ID`: ID of the initial admin user created by `setup`/`upgrade` -- `DOCKER_INFLUXDB_INIT_ORG_ID`: ID of the initial organization created by `setup`/`upgrade` -- `DOCKER_INFLUXDB_INIT_BUCKET_ID`: ID of the initial bucket created by `setup`/`upgrade` - -For example, to grant an InfluxDB 1.x client *write* permission to your initial bucket, create a `$PWD/scripts/setup-v1.sh` file that contains the following: +Stop your container by using following command: ```bash -#!/bin/bash -set -e - -influx v1 dbrp create \ - --bucket-id ${DOCKER_INFLUXDB_INIT_BUCKET_ID} \ - --db ${V1_DB_NAME} \ - --rp ${V1_RP_NAME} \ - --default \ - --org ${DOCKER_INFLUXDB_INIT_ORG} - -influx v1 auth create \ - --username ${V1_AUTH_USERNAME} \ - --password ${V1_AUTH_PASSWORD} \ - --write-bucket ${DOCKER_INFLUXDB_INIT_BUCKET_ID} \ - --org ${DOCKER_INFLUXDB_INIT_ORG} +docker container ls --filter "name=influxdb3" +docker kill ``` -Then, run the following command to start and set up InfluxDB using custom scripts: - -```bash -docker run -p 8086:8086 \ - -v "$PWD/data:/var/lib/influxdb2" \ - -v "$PWD/config:/etc/influxdb2" \ - -v "$PWD/scripts:/docker-entrypoint-initdb.d" \ - -e DOCKER_INFLUXDB_INIT_MODE=setup \ - -e DOCKER_INFLUXDB_INIT_USERNAME=my-user \ - -e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \ - -e DOCKER_INFLUXDB_INIT_ORG=my-org \ - -e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \ - -e V1_DB_NAME=v1-db \ - -e V1_RP_NAME=v1-rp \ - -e V1_AUTH_USERNAME=v1-user \ - -e V1_AUTH_PASSWORD=v1-password \ - %%IMAGE%%:2 -``` - -> #### Automated setup and upgrade ignored if already setup -> -> Automated `setup`, `upgrade`, and custom initialization scripts won't run if an existing `influxd.bolt` boltdb file from a previous setup is found in the configured data directory. -> -> This behavior allows for the InfluxDB container to reboot post-setup and avoid overwriting migrated data, `DB is already set up` errors, and errors from non-idempotent script commands. - -## Access InfluxDB v2 file system and ports - -When starting an InfluxDB container, we recommend the following for easy access to your data, configurations, and InfluxDB v2 instance: - -- Publish the container's `8086` port to make the InfluxDB [UI](https://docs.influxdata.com/influxdb/v2/get-started/#influxdb-user-interface-ui) and [HTTP API](https://docs.influxdata.com/influxdb/v2/reference/api/) accessible from the host system. -- Use Docker [Volumes](https://docs.docker.com/storage/volumes/) or [Bind mounts](https://docs.docker.com/storage/bind-mounts/) to persist InfluxDB [data and configuration directories](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) outside of containers. - -### Default file system and networking ports - -For InfluxDB v2, the InfluxDB Docker Hub image uses the following default ports and file system paths: - -- TCP port `8086`: the default port for the InfluxDB [UI](https://docs.influxdata.com/influxdb/v2/get-started/#influxdb-user-interface-ui) and [HTTP API](https://docs.influxdata.com/influxdb/v2/reference/api/). To specify a different port or address, use the [`http-bind-address` configuration option](https://docs.influxdata.com/influxdb/v2/reference/config-options/#http-bind-address). -- `/var/lib/influxdb2/`: the [InfluxDB data directory](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) - - - `/engine/`: Default InfluxDB [Storage engine path](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/#engine-path) - - `influxd.bolt`: Default [Bolt path](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/#bolt-path) - - `influxd.sqlite`: Default [SQLite path](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/#sqlite-path) - -- `/etc/influxdb2`: the [InfluxDB configuration directory](https://docs.influxdata.com/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) - - - `/etc/influxdb2/configs`: `influx` CLI connection configurations file - - `/etc/influxdb2/influx-configs`: `influx` CLI connection configurations file, *if you run setup from within the container* - - Optional: `/etc/influxdb2/config.[yml, json, toml]`: Your customized InfluxDB [configuration options](https://docs.influxdata.com/influxdb/v2/reference/config-options/) file - -### Configure InfluxDB v2 in a container - -To customize InfluxDB, specify [server configuration options](https://docs.influxdata.com/influxdb/v2/reference/config-options/#configuration-options) in a configuration file, environment variables, or command line flags. - -#### Use a configuration file - -To customize and mount an InfluxDB configuration file, do the following: - -1. If you haven't already, [set up InfluxDB](https://docs.influxdata.com/influxdb/v2/get-started/setup/) to initialize an API [Operator token](https://docs.influxdata.com/influxdb/v2/admin/tokens/#operator-token). You'll need the Operator token in the next step. +### Docker CLI -2. Run the `influx server-config` CLI command to output the current server configuration to a file in the mounted configuration directory--for example, enter the following command to use the container's `influx` CLI and default Operator token: - - ```bash - docker exec -it influxdb2 influx server-config > "$PWD/config/config.yml" - ``` - -Replace `$PWD/config/` with the host directory that you mounted at the container's `/etc/influxdb2` InfluxDB configuration directory path. - -1. Edit the `config.yml` file to customize [server configuration options](https://docs.influxdata.com/influxdb/v2/reference/config-options/#configuration-options). -2. Restart the container. - - ```bash - docker restart influxdb2 - ``` - -#### Use environment variables and command line flags - -To override specific [configuration options](https://docs.influxdata.com/influxdb/v2/reference/config-options/#configuration-options), use environment variables or command line flags. - -- Pass `INFLUXD_` environment variables to Docker to override the configuration file--for example: - - ```bash - docker run -p 8086:8086 \ - -e INFLUXD_STORAGE_WAL_FSYNC_DELAY=15m \ - influxdb:2 - ``` - -- Pass `influxd` command line flags to override environment variables and the configuration file--for example: - - ```bash - docker run -p 8086:8086 \ - %%IMAGE%%:2 --storage-wal-fsync-delay=15m - ``` - -To learn more, see [InfluxDB configuration options](https://docs.influxdata.com/influxdb/v2/reference/config-options). - -### Upgrading from InfluxDB 1.x - -InfluxDB 2.x provides a [1.x-compatible API](https://docs.influxdata.com/influxdb/v2/reference/api/influxdb-1x/), but expects a different storage layout on disk. To account for these differences, the InfluxDB Docker Hub image provides an `upgrade` feature that migrates 1.x data and configuration to 2.x before starting the `influxd` server. - -The automated upgrade process creates the following in the InfluxDB v2 container: - -- an initial admin user -- an initial organization -- an initial bucket -- InfluxDB v2 data files (the default path is `/var/lib/influxdb2`) -- InfluxDB v2 configuration files (the default path is `/etc/influxdb2`) - -*Mount volumes at both paths to avoid losing data.* - -To run the automated upgrade, specify the following when you start the container: - -- InfluxDB v2 initialization environment variables: - - - `DOCKER_INFLUXDB_INIT_MODE=upgrade` - - `DOCKER_INFLUXDB_INIT_USERNAME`: A name for the initial admin [user](https://docs.influxdata.com/influxdb/v2/admin/users/) - - `DOCKER_INFLUXDB_INIT_PASSWORD`: A password for the initial admin [user](https://docs.influxdata.com/influxdb/v2/admin/users/) - - `DOCKER_INFLUXDB_INIT_ORG`: A name for the initial [organization](https://docs.influxdata.com/influxdb/v2/admin/organizations/) - - `DOCKER_INFLUXDB_INIT_BUCKET`: A name for the initial [bucket](https://docs.influxdata.com/influxdb/v2/admin/buckets/) - - Optional: `DOCKER_INFLUXDB_INIT_RETENTION`: A [duration](https://docs.influxdata.com/influxdb/v2/reference/glossary/#duration) for the bucket [retention period](https://docs.influxdata.com/influxdb/v2/reference/internals/data-retention/#bucket-retention-period). Default: `0` (infinite; doesn't delete data) - - Optional: `DOCKER_INFLUXDB_INIT_ADMIN_TOKEN`: A value to set for the [Operator token](https://docs.influxdata.com/influxdb/v2/admin/tokens/#operator-token). Default: generates a token. - -- 1.x data and configuration paths: - - - A 1.x data volume, specified by the `DOCKER_INFLUXDB_INIT_UPGRADE_V1_DIR` environment variable or mounted at `/var/lib/influxdb` - - Optional: a 1.x custom configuration file, specified by the `DOCKER_INFLUXDB_INIT_UPGRADE_V1_CONFIG` environment variable or mounted at `/etc/influxdb/influxdb.conf` - -The upgrade process searches for mounted 1.x data and configuration paths in the following order of precedence: - -1. A configuration file referenced by the `DOCKER_INFLUXDB_INIT_UPGRADE_V1_CONFIG` environment variable -2. A data directory referenced by the `DOCKER_INFLUXDB_INIT_UPGRADE_V1_DIR` environment variable -3. A configuration file mounted at `/etc/influxdb/influxdb.conf` -4. A data directory mounted at `/var/lib/influxdb` - -> #### Automated setup and upgrade ignored if already setup -> -> Automated `setup`, `upgrade`, and custom initialization scripts won't run if an existing `influxd.bolt` boltdb file from a previous setup is found in the configured data directory. -> -> This behavior allows for the InfluxDB container to reboot post-setup and avoid overwriting migrated data, `DB is already set up` errors, and errors from non-idempotent script commands. - -#### Upgrade InfluxDB 1.x: default data path and configuration - -Assume you've been running a minimal InfluxDB 1.x deployment: +Run this command to start the InfluxDB 3 Core container: ```bash -docker run -p 8086:8086 \ - -v influxdb:/var/lib/influxdb \ - %%IMAGE%%:1.8 +docker run -d --name influxdb3-core \ + -p 8086:8086 \ + quay.io/influxdb/influxdb3:latest \ + serve --host-id my-influxdb-node --object-store file --data-dir /var/lib/influxdb3 ``` -To upgrade this deployment to InfluxDB 2.x, stop the running InfluxDB 1.x container, and then run the following command: +Once the container is running, generate an admin token: ```bash -docker run -p 8086:8086 \ - -v influxdb:/var/lib/influxdb \ - -v influxdb2:/var/lib/influxdb2 \ - -e DOCKER_INFLUXDB_INIT_MODE=upgrade \ - -e DOCKER_INFLUXDB_INIT_USERNAME=my-user \ - -e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \ - -e DOCKER_INFLUXDB_INIT_ORG=my-org \ - -e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \ - %%IMAGE%%:2 +docker exec -it influxdb3-core influxdb3 generate token --admin ``` -#### Upgrade InfluxDB 1.x: custom configuration - -Assume you've been running an InfluxDB 1.x deployment with customized configuration (`/etc/influxdb/influxdb.conf`): +Use the token to create a database: ```bash -docker run -p 8086:8086 \ - -v influxdb:/var/lib/influxdb \ - -v "$PWD/influxdb.conf:/etc/influxdb/influxdb.conf" \ - %%IMAGE%%:1.8 +docker exec -it influxdb3-core influxdb3 create database my_db --token YOUR_ADMIN_TOKEN ``` -To upgrade this deployment to InfluxDB 2.x, stop the running InfluxDB 1.x container, and then run the following command: +To check the server health: ```bash -docker run -p 8086:8086 \ - -v influxdb:/var/lib/influxdb \ - -v influxdb2:/var/lib/influxdb2 \ - -v influxdb2-config:/etc/influxdb2 \ - -v "$PWD/influxdb.conf:/etc/influxdb/influxdb.conf" \ - -e DOCKER_INFLUXDB_INIT_MODE=upgrade \ - -e DOCKER_INFLUXDB_INIT_USERNAME=my-user \ - -e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \ - -e DOCKER_INFLUXDB_INIT_ORG=my-org \ - -e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \ - %%IMAGE%%:2 +curl localhost:8086/health ``` -#### Upgrade InfluxDB 1.x: custom data and configuration paths - -Assume you've been running an InfluxDB 1.x deployment with data and configuration mounted at custom paths: +## Start InfluxDB 3 Enterprise -```bash -docker run -p 8086:8086 \ - -v influxdb:/root/influxdb/data \ - -v "$PWD/influxdb.conf:/root/influxdb/influxdb.conf" \ - %%IMAGE%%:1.8 -config /root/influxdb/influxdb.conf -``` +InfluxDB 3 Enterprise supports clustered deployments and advanced features. To start a local standalone Enterprise container for testing, provide your license key as an environment variable. -Before you upgrade to InfluxDB v2, decide whether to keep using your custom paths or to use the InfluxDB v2 defaults. +### Docker Compose -To use InfluxDB v2 defaults, stop the running InfluxDB 1.x container, and then run the following command: +Create a `compose.yml` file with the following configuration: -```bash -docker run -p 8086:8086 \ - -v influxdb:/root/influxdb/data \ - -v influxdb2:/var/lib/influxdb2 \ - -v influxdb2-config:/etc/influxdb2 \ - -v "$PWD/influxdb.conf:/root/influxdb/influxdb.conf" \ - -e DOCKER_INFLUXDB_INIT_MODE=upgrade \ - -e DOCKER_INFLUXDB_INIT_USERNAME=my-user \ - -e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \ - -e DOCKER_INFLUXDB_INIT_ORG=my-org \ - -e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \ - -e DOCKER_INFLUXDB_INIT_UPGRADE_V1_CONFIG=/root/influxdb/influxdb.conf \ - %%IMAGE%%:2 -``` +%%COMPOSE%% -To use your custom paths instead of InfluxDB v2 default paths, run the following command: +Start your container: ```bash -docker run -p 8086:8086 \ - -v influxdb:/root/influxdb/data \ - -v influxdb2:/root/influxdb2/data \ - -v influxdb2-config:/etc/influxdb2 \ - -v "$PWD/influxdb.conf:/root/influxdb/influxdb.conf" \ - -e DOCKER_INFLUXDB_INIT_MODE=upgrade \ - -e DOCKER_INFLUXDB_INIT_USERNAME=my-user \ - -e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \ - -e DOCKER_INFLUXDB_INIT_ORG=my-org \ - -e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \ - -e DOCKER_INFLUXDB_INIT_UPGRADE_V1_CONFIG=/root/influxdb/influxdb.conf \ - -e DOCKER_INFLUXDB_CONFIG_PATH=/root/influxdb2/config.toml \ - -e DOCKER_INFLUXDB_BOLT_PATH=/root/influxdb2/influxdb.bolt \ - -e DOCKER_INFLUXDB_ENGINE_PATH=/root/influxdb2/engine \ - %%IMAGE%%:2 +docker compose pull && docker compose run influxdb3-enterprise ``` -To learn more about the upgrade process, see the [v1-to-v2 upgrade guide](https://docs.influxdata.com/influxdb/v2.0/upgrade/v1-to-v2/). - -### Upgrading from quay.io-hosted InfluxDB 2.x image - -Early Docker builds of InfluxDB 2.x were hosted at `quay.io/influxdb/influxdb` and contained the `influx` and `influxd` binaries without any default configuration or helper scripts. By default, the `influxd` process stored data in `/root/.influxdbv2`. - -Starting with `v2.0.4`, we restored the InfluxDB Docker Hub build, which defaults to storing data in `/var/lib/influxdb2`. If you upgrade directly from `quay.io/influxdb/influxdb` to `influxdb:2.0.4` using the default settings, InfluxDB won't be able to find your existing data files. - -To avoid this problem when migrating from `quay.io/influxdb/influxdb` to `influxdb:2.0`, choose one of the following: - -#### Update the mount to use the InfluxDB default +## Docker with mounted file style object store -To use the InfluxDB Docker Hub data path, start a container that mounts your data volume into `/var/lib/influxdb2`--for example, if you used the following command to start the InfluxDB quay.io container: +Run this command to start the InfluxDB 3 Enterprise container ```bash -# quay.io InfluxDB 2.x container -docker run -p 8086:8086 \ - -v "$PWD:/root/.influxdbv2" \ - quay.io/influxdb/influxdb:v2.0.3 +docker run -d --name influxdb3-enterprise -p 8086:8086 \ + -v $PWD/plugins:/plugins \ + -v $PWD/data:/var/lib/influxdb3 \ + -e INFLUX_LICENSE_KEY="YOUR_LICENSE_KEY" \ + influxdb:enterprise serve \ + --cluster-id cluster1 \ + --node-id node1 \ + --plugin-dir /plugins \ + --object-store file \ + --data-dir /var/lib/influxdb3 ``` -Use this command to start an InfluxDB v2 Docker Hub container: +Then, generate an admin token: ```bash -# Docker Hub InfluxDB 2.x container -docker run -p 8086:8086 \ - -v "$PWD:/var/lib/influxdb2" \ - %%IMAGE%%:2 +docker exec -it influxdb3-enterprise influxdb3 create token --admin ``` -#### Configure InfluxDB to use the container home directory - -To continue using the `/root/.influxdbv2` data path, customize storage path configuration options ([bolt-path](https://docs.influxdata.com/influxdb/v2/reference/config-options/#bolt-path), [engine-path](https://docs.influxdata.com/influxdb/v2/reference/config-options/#engine-path), [sqlite-path](https://docs.influxdata.com/influxdb/v2/reference/config-options/#sqlite-path)) configuration options for your InfluxDB Docker Hub container--for example, if you used the following command to start the InfluxDB quay.io container: - -```bash -# quay.io-hosted InfluxDB 2.x -docker run -p 8086:8086 \ - -v "$PWD:/root/.influxdbv2" \ - quay.io/influxdb/influxdb:v2.0.3 -``` - -Use this command to start an InfluxDB v2 Docker Hub container: +Use the token from the output to create a database. ```bash -docker run -p 8086:8086 \ - -e INFLUXD_BOLT_PATH=/root/.influxdbv2/influxd.bolt \ - -e INFLUXD_ENGINE_PATH=/root/.influxdbv2/engine \ - -v "$PWD:/root/.influxdbv2" \ - %%IMAGE%%:2 +docker exec -it influxdb3-enterprise influxdb3 create database enterprise_db --token ``` -# How to use this image for InfluxDB v1 +## Mount data to persist across restarts -Use the InfluxDB Docker Hub image to run and set up an [InfluxDB 1.x](https://docs.influxdata.com/influxdb/v1/) container. +To retain data across container restarts, mount a Docker volume or bind a local directory. Be sure to include the required `serve` command and storage configuration. -## Running the container +### Using a Docker volume -To start an InfluxDB 1.x container, enter the following command: +To persist data using a Docker-managed volume, run the following command: ```bash -docker run -p 8086:8086 \ - -v "$PWD:/var/lib/influxdb" \ - %%IMAGE%%:1.8 +docker run -d --name influxdb3-core \ + -v influxdb3-data:/var/lib/influxdb3 \ + -p 8086:8086 \ + quay.io/influxdb/influxdb3:latest \ + serve --host-id my-influxdb-node --object-store file --data-dir /var/lib/influxdb3 ``` -The command passes the following arguments: - -- `-p 8086:8086`: Exposes the InfluxDB [HTTP API](https://docs.influxdata.com/influxdb/v2/reference/api/) on host port `8086`. -- `-v $PWD:/var/lib/influxdb`: Mounts the host's `$PWD` directory to the [InfluxDB data directory](https://docs.influxdata.com/influxdb/v1/concepts/file-system-layout/) to persist data outside the container. - -Replace `$PWD` with the host directory where you want InfluxDB to store data. - -*Use Docker [Volumes](https://docs.docker.com/storage/volumes/) or [Bind mounts](https://docs.docker.com/storage/bind-mounts/) to persist InfluxDB [data and configuration directories](https://docs.influxdata.com/influxdb/v1/concepts/file-system-layout/).* - -## Networking ports - -InfluxDB uses the following networking ports: - -- TCP port `8086`: the default port for the [HTTP API](https://docs.influxdata.com/influxdb/v1/tools/api/) -- TCP port `2003`: the port for the Graphite protocol (if enabled) - -Using the `docker run` [`-P, --publish-all` flag](https://docs.docker.com/reference/cli/docker/container/run/#publish-all) exposes the InfluxDB HTTP API to the host. - -## Configure InfluxDB v1 in a container - -To configure InfluxDB v1 in a container, use a configuration file or environment variables. - -### Use a configuration file - -To customize and mount a configuration file, do the following: - -1. Output the current server configuration to a file in the mounted configuration directory--for example: - - ```bash - docker run --rm %%IMAGE%%:1.8 influxd config > influxdb.conf - ``` - -2. Edit the `influxdb.conf` file to customize [server configuration options](https://docs.influxdata.com/influxdb/v2/reference/config-options/#configuration-options). +This command: - ```bash - docker run -p 8086:8086 \ - -v "$PWD/influxdb.conf:/etc/influxdb/influxdb.conf:ro" \ - %%IMAGE%%:1.8 -config /etc/influxdb/influxdb.conf - ``` +- Creates or reuses a Docker volume named `influxdb3-data`. +- Maps the default InfluxDB port (`8086`) to your local machine. +- Starts the InfluxDB server with a required host ID and object store configuration. - Replace `$PWD` with the host directory where you want to store the configuration file. +### Using a local host directory -### Use environment variables - -Pass [`INFLUXDB_` environment variables](https://docs.influxdata.com/influxdb/v1/administration/config/#environment-variables) to override specific InfluxDB v1 configuration options. An environment variable overrides the equivalent option in the configuration file. - -```bash -docker run -p 8086:8086 \ - -e INFLUXDB_REPORTING_DISABLED=true \ - -e INFLUXDB_META_DIR=/path/to/metadir \ - -e INFLUXDB_DATA_QUERY_LOG_ENABLED=false \ - %%IMAGE%%:1.8 -``` - -Learn more about [configuring InfluxDB v1](https://docs.influxdata.com/influxdb/v1.8/administration/config/). - -## Graphite - -InfluxDB supports the Graphite line protocol, but the service and ports are not exposed by default. To run InfluxDB with Graphite support enabled, you can either use a configuration file or set the appropriate environment variables. Run InfluxDB with the default Graphite configuration: - -```bash -docker run -p 8086:8086 -p 2003:2003 \ - -e INFLUXDB_GRAPHITE_ENABLED=true \ - %%IMAGE%%:1.8 -``` - -See the [README on GitHub](https://github.com/influxdata/influxdb/blob/master/services/graphite/README.md) for more detailed documentation to set up the Graphite service. In order to take advantage of graphite templates, you should use a configuration file by outputting a default configuration file using the steps above and modifying the `[[graphite]]` section. - -## InfluxDB v1 HTTP API - -Creating a DB named mydb: +To persist data in a local directory on your host, use the following command: ```bash -curl -G http://localhost:8086/query --data-urlencode "q=CREATE DATABASE mydb" +docker run -d --name influxdb3-core \ + -v $PWD/influxdb3-data:/var/lib/influxdb3 \ + -p 8086:8086 \ + quay.io/influxdb/influxdb3:latest \ + serve --host-id my-influxdb-node --object-store file --data-dir /var/lib/influxdb3 ``` -Inserting into the DB: +This mounts a local folder named `influxdb3-data` in your current working directory. Ensure that this directory exists and has appropriate write permissions. -```bash -curl -i -XPOST 'http://localhost:8086/write?db=mydb' --data-binary 'cpu_load_short,host=server01,region=us-west value=0.64 1434055562000000000' -``` - -Read more about this in the [official documentation](https://docs.influxdata.com/influxdb/latest/guides/writing_data/). +# InfluxDB v2 -## CLI / SHELL +## How to use the InfluxDB v2 Docker image -Start the container: +Use the official [InfluxDB v2 Docker image](https://hub.docker.com/_/influxdb) to start an instance for development or testing. ```bash -docker run --name=influxdb -d -p 8086:8086 %%IMAGE%%:1.8 -``` - -Run the influx client in this container: - -```bash -docker exec -it influxdb influx -``` - -Or run the influx client in a separate container: - -```bash -docker run --rm --link=influxdb -it %%IMAGE%%:1.8 influx -host influxdb +docker run -d -p 8086:8086 \ + -v $PWD/data:/var/lib/influxdb2 \ + -v $PWD/config:/etc/influxdb2 \ + -e DOCKER_INFLUXDB_INIT_MODE=setup \ + -e DOCKER_INFLUXDB_INIT_USERNAME=my-user \ + -e DOCKER_INFLUXDB_INIT_PASSWORD=my-password \ + -e DOCKER_INFLUXDB_INIT_ORG=my-org \ + -e DOCKER_INFLUXDB_INIT_BUCKET=my-bucket \ + influxdb:2 ``` -## InfluxDB v1 database initialization - -### Not recommended for production - -We **don't** recommend using initialization options for InfluxDB v1 production scenarios, but they're useful when running standalone instances for testing. - -The InfluxDB Docker Hub image lets you set initialization options when creating an InfluxDB v1 container. - -The database initialization script is only called when running `influxd`; it isn't executed by any other program. - -### Environment variables - -During the InfluxDB v1 set up process, the InfluxDB image uses environment variables to automatically configure some server options. You can override the following environment variables to customize set up options. - -#### INFLUXDB_DB - -Automatically initializes a database with the name of this environment variable. - -#### INFLUXDB_HTTP_AUTH_ENABLED - -Enables authentication. Either this must be set or `auth-enabled = true` must be set within the configuration file for any authentication-related options below to work. +After the container starts, go to `http://localhost:8086` to access the UI. -#### INFLUXDB_ADMIN_USER +For more information, see the [InfluxDB v2 Docker documentation](https://docs.influxdata.com/influxdb/v2/install/?t=docker). -The name of the admin user to be created. If this is unset, no admin user is created. +# InfluxDB v1 -#### INFLUXDB_ADMIN_PASSWORD +## How to use the InfluxDB v1 Docker image -The password for the admin user configured with `INFLUXDB_ADMIN_USER`. If this is unset, a random password is generated and printed to standard out. - -#### INFLUXDB_USER - -The name of a user to be created with no privileges. If `INFLUXDB_DB` is set, this user will be granted read and write permissions for that database. - -#### INFLUXDB_USER_PASSWORD - -The password for the user configured with `INFLUXDB_USER`. If this is unset, a random password is generated and printed to standard out. - -#### INFLUXDB_READ_USER - -The name of a user to be created with read privileges on `INFLUXDB_DB`. If `INFLUXDB_DB` is not set, this user will have no granted permissions. - -#### INFLUXDB_READ_USER_PASSWORD - -The password for the user configured with `INFLUXDB_READ_USER`. If this is unset, a random password is generated and printed to standard out. - -#### INFLUXDB_WRITE_USER - -The name of a user to be created with write privileges on `INFLUXDB_DB`. If `INFLUXDB_DB` is not set, this user will have no granted permissions. - -#### INFLUXDB_WRITE_USER_PASSWORD - -The password for the user configured with `INFLUXDB_WRITE_USER`. If this is unset, a random password is generated and printed to standard out. - -### Initialization Files - -If the Docker image finds any files with the extensions `.sh` or `.iql` inside of the `/docker-entrypoint-initdb.d` folder, it will execute them. The order they are executed in is determined by the shell. This is usually alphabetical order. - -### Manually Initialize InfluxDB v1 - -To manually initialize an InfluxDB v1 database, use `docker run` to call the `/init-influxdb.sh` script directly. The script takes the same initialization options as the `influxd run` command--for example: +Use the official [InfluxDB v1 Docker image](https://hub.docker.com/_/influxdb) to start a basic instance for development or testing: ```bash -docker run --rm \ - -e INFLUXDB_DB=db0 \ - -e INFLUXDB_ADMIN_USER=admin \ - -e INFLUXDB_ADMIN_PASSWORD=supersecretpassword \ - -e INFLUXDB_USER=telegraf -e \ - -e INFLUXDB_USER_PASSWORD=secretpassword \ - -v "$PWD:/var/lib/influxdb" \ - %%IMAGE%%:1.8 /init-influxdb.sh +docker run -d -p 8086:8086 \ + -v $PWD:/var/lib/influxdb \ + influxdb:1.8 ``` -The command creates the following: - -- a database named `db0` -- an admin user `admin` with the password `supersecretpassword` -- a `telegraf` user with the password `secretpassword` +This command maps port `8086` and mounts your current directory to persist data. -The `--rm` flag causes Docker to exit and delete the container after the script runs. The data and configuration files created during initialization remain in the mounted volume (the host's `$PWD` directory). +For more information, see the [InfluxDB v1 Docker documentation](https://docs.influxdata.com/influxdb/v1/).