diff --git a/influxdb/compose.yaml b/influxdb/compose.yaml new file mode 100755 index 000000000000..dc448a1b8b2f --- /dev/null +++ b/influxdb/compose.yaml @@ -0,0 +1,45 @@ +# compose.yaml +name: influxdb3 +services: + influxdb3-core: + container_name: influxdb3-core + image: influxdb:3-core + ports: + - 8282:8181 + command: + - influxdb3 + - serve + - --node-id=node0 + - --object-store=file + - --data-dir=/var/lib/influxdb3/data + - --plugin-dir=/var/lib/influxdb3/plugins + volumes: + - type: bind + source: ~/.influxdb3/core/data + target: /var/lib/influxdb3/data + - type: bind + source: ~/.influxdb3/core/plugins + target: /var/lib/influxdb3/plugins + influxdb3-enterprise: + container_name: influxdb3-enterprise + image: influxdb:3-enterprise + ports: + - 8181:8181 + command: + - influxdb3 + - serve + - --node-id=node0 + - --cluster-id=cluster0 + - --object-store=file + - --data-dir=/var/lib/influxdb3/data + - --plugin-dir=/var/lib/influxdb3/plugins + environment: + - INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=EMAIL_ADDRESS + volumes: + - type: bind + source: ~/.influxdb3/enterprise/data + target: /var/lib/influxdb3/data + - type: bind + source: ~/.influxdb3/enterprise/plugins + target: /var/lib/influxdb3/plugins + diff --git a/influxdb/content.md b/influxdb/content.md old mode 100644 new mode 100755 index e94ab3d60fae..4945ec27de9f --- a/influxdb/content.md +++ b/influxdb/content.md @@ -1,643 +1,262 @@ # What is 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. - -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/). - -For more information, visit https://influxdata.com. - %%LOGO%% -# How to use this image for InfluxDB v2 - -**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. - -## Start InfluxDB v2 and set up with the UI, CLI, or API - -To start an InfluxDB v2 container, enter the following command: - -```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 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. -- `$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 +**This README covers all currently supported versions of InfluxDB:** -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: `influxdb:3-core` +- InfluxDB 3 Enterprise: `influxdb:3-enterprise` +- InfluxDB v2: `influxdb:2` +- InfluxDB v1: `influxdb:1.11` +- InfluxDB Enterprise v1: `influxdb:1.11-data` and `influxdb:1.11-meta` -- **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. +Find a specific InfluxDB version below for startup examples and links to full documentation. -- **Set up InfluxDB from inside the container**: Use `docker exec` to run the `influx` CLI installed in the container--for example: +## How to use InfluxDB 3 images - ```bash - docker exec influxdb2 influx setup \ - --username $USERNAME \ - --password $PASSWORD \ - --org $ORGANIZATION \ - --bucket $BUCKET \ - --force - ``` +InfluxDB 3 is the latest version and features Apache Arrow, DataFusion SQL, and object storage for sub-10ms queries and unlimited cardinality. The InfluxDB 3 Core and InfluxDB 3 Enterprise editions both support SQL and InfluxQL queries, include the Python processing engine, and work with the InfluxDB 3 Explorer UI. -See the [`influx setup` documentation](https://docs.influxdata.com/influxdb/v2/reference/cli/influx/setup/) for the full list of options. +- **Core** (free, open source): For real-time monitoring and recent data +- **Enterprise**: Adds historical data, clustering, HA, and security. Includes 30-day trial. -*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.* +### Pull the Image -## Start InfluxDB v2 with automated setup +Pull the official Docker image for InfluxDB 3 Core or InfluxDB 3 Enterprise: -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: +**InfluxDB 3 Core:** ```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 +docker pull influxdb:3-core ``` -Replace the following with your own values: - -- `$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) - -*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.* - -### Automated setup options - -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: - -- `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. - -The following example shows how to pass values for all initial setup options: +**InfluxDB 3 Enterprise:** ```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 pull influxdb:3-enterprise ``` -*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: +### Start InfluxDB 3 -- `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` +%%COMPOSE%% -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: +The example `compose.yaml` defines services for InfluxDB 3 Core and InfluxDB 3 Enterprise, including file system volumes for data persistence. You can customize the example to suit your needs, such as changing the node ID or object store type (for example, `s3`). -```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} -``` - -Then, run the following command to start and set up InfluxDB using custom scripts: +**InfluxDB 3 Core:** ```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 +docker compose run influxdb3-core ``` -> #### 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) +**InfluxDB 3 Enterprise:** - - `/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. - -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: +\***License key for Enterprise**: InfluxDB 3 Enterprise requires a license key. In the example, configure your email address to start the free 30-day trial. For more options, see the [InfluxDB 3 Enterprise licensing documentation](https://docs.influxdata.com/influxdb3/enterprise/admin/license/).\* ```bash -docker run -p 8086:8086 \ - -v influxdb:/var/lib/influxdb \ - %%IMAGE%%:1.8 +docker compose run influxdb3-enterprise ``` -To upgrade this deployment to InfluxDB 2.x, stop the running InfluxDB 1.x container, and then run the following command: +... via `docker` CLI -```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 -``` +Use the following commands to start InfluxDB 3 Core or InfluxDB 3 Enterprise using the Docker CLI: -#### Upgrade InfluxDB 1.x: custom configuration - -Assume you've been running an InfluxDB 1.x deployment with customized configuration (`/etc/influxdb/influxdb.conf`): - -```bash -docker run -p 8086:8086 \ - -v influxdb:/var/lib/influxdb \ - -v "$PWD/influxdb.conf:/etc/influxdb/influxdb.conf" \ - %%IMAGE%%:1.8 -``` - -To upgrade this deployment to InfluxDB 2.x, stop the running InfluxDB 1.x container, and then run the following command: +**InfluxDB 3 Core:** ```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 +docker run -d --name influxdb3-core \ + --publish 8181:8181 \ + --volume /path/on/host:/path/in/container \ + influxdb:3-core influxdb3 serve \ + --node-id node0 \ + --object-store file \ + --data-dir /path/in/container ``` -#### Upgrade InfluxDB 1.x: custom data and configuration paths +**InfluxDB 3 Enterprise:** -Assume you've been running an InfluxDB 1.x deployment with data and configuration mounted at custom paths: +\***License key for Enterprise**: InfluxDB 3 Enterprise requires a license key. In the example, configure your email address to start the free 30-day trial. For more options, see the [InfluxDB 3 Enterprise licensing documentation](https://docs.influxdata.com/influxdb3/enterprise/admin/license/).\* ```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 +docker run -d --name influxdb3-enterprise \ + --publish 8181:8181 \ + --volume /path/on/host:/path/in/container \ + influxdb:3-enterprise influxdb3 serve \ + --node-id node0 \ + --cluster-id cluster0 \ + --object-store file \ + --data-dir /path/in/container \ + --license-email EMAIL_ADDRESS ``` -Before you upgrade to InfluxDB v2, decide whether to keep using your custom paths or to use the InfluxDB v2 defaults. +For more information about server options, access the documentation: -To use InfluxDB v2 defaults, stop the running InfluxDB 1.x container, and then run the following command: +- [InfluxDB 3 Core `serve` command](https://docs.influxdata.com/influxdb3/core/reference/clis/influxdb3/serve/) ```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 +docker run --rm influxdb:3-core influxdb3 serve --help ``` -To use your custom paths instead of InfluxDB v2 default paths, run the following command: +- [InfluxDB 3 Enterprise `serve` command](https://docs.influxdata.com/influxdb3/enterprise/reference/clis/influxdb3/serve/) ```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 run --rm influxdb:3-enterprise influxdb3 serve --help ``` -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: +### Get started using InfluxDB 3 -#### Update the mount to use the InfluxDB default +After you have started your InfluxDB 3 server, follow the step-by-step guides to create an auth token and database, and write, query, and process data in InfluxDB 3: -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: +- [Get started with InfluxDB 3 Core](https://docs.influxdata.com/influxdb3/core/get-started/) +- [Get started with InfluxDB 3 Enterprise](https://docs.influxdata.com/influxdb3/enterprise/get-started/) +- Use the [InfluxDB 3 Explorer UI](https://docs.influxdata.com/influxdb3/explorer/) to write data, create dashboards, explore metrics, and manage your databases. -```bash -# quay.io InfluxDB 2.x container -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: +### How to use the InfluxDB v2 image -```bash -# Docker Hub InfluxDB 2.x container -docker run -p 8086:8086 \ - -v "$PWD:/var/lib/influxdb2" \ - %%IMAGE%%:2 -``` +*InfluxDB v2 is an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.* -#### 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: +Run [InfluxDB v2](https://docs.influxdata.com/influxdb/v2/) using the Docker CLI with the following command: ```bash -# quay.io-hosted InfluxDB 2.x -docker run -p 8086:8086 \ - -v "$PWD:/root/.influxdbv2" \ - quay.io/influxdb/influxdb:v2.0.3 +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 ``` -Use this command to start an InfluxDB v2 Docker Hub container: +After the container starts, visit [http://localhost:8086](http://localhost:8086) in your browser to view the UI. -```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 -``` +For detailed instructions, see the [InfluxDB v2 Docker Compose documentation](https://docs.influxdata.com/influxdb/v2/install/use-docker-compose/). -# How to use this image for InfluxDB v1 +For more information about `DOCKER_INFLUXDB_INIT_*` environment variables, see the [InfluxDB v2 upgrade documentation](https://docs.influxdata.com/influxdb/v2/install/upgrade/v1-to-v2/docker/). -Use the InfluxDB Docker Hub image to run and set up an [InfluxDB 1.x](https://docs.influxdata.com/influxdb/v1/) container. +## How to use the InfluxDB v1 Docker image -## Running the container +*InfluxDB v1 is an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.* -To start an InfluxDB 1.x container, enter the following command: +Run [InfluxDB v1](https://docs.influxdata.com/influxdb/v1/) using the Docker CLI: ```bash -docker run -p 8086:8086 \ - -v "$PWD:/var/lib/influxdb" \ - %%IMAGE%%:1.8 +docker run -d -p 8086:8086 \ + -v $PWD:/var/lib/influxdb \ + influxdb:1.11 ``` -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. +This command maps port `8086` and mounts your current directory to persist data. -## Configure InfluxDB v1 in a container +For more information, see the [InfluxDB v1 Docker documentation](https://docs.influxdata.com/influxdb/v1/introduction/install/docker/). -To configure InfluxDB v1 in a container, use a configuration file or environment variables. +## How to use the InfluxDB Enterprise v1 Docker image -### Use a configuration file +*InfluxDB Enterprise v1 is an earlier version of InfluxDB Enterprise. InfluxDB 3 Enterprise is the latest stable version.* -To customize and mount a configuration file, do the following: +Use the official `influxdb:meta` and `influxdb:data` Docker images to deploy and manage an InfluxDB v1 Enterprise cluster. A valid license is required. -1. Output the current server configuration to a file in the mounted configuration directory--for example: +### Start InfluxDB v1 Enterprise Cluster - ```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). - - ```bash - docker run -p 8086:8086 \ - -v "$PWD/influxdb.conf:/etc/influxdb/influxdb.conf:ro" \ - %%IMAGE%%:1.8 -config /etc/influxdb/influxdb.conf - ``` - - Replace `$PWD` with the host directory where you want to store the configuration file. - -### 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. +Create a custom Docker network for node communication: ```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 +docker network create influxdb ``` -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: +Start three meta nodes (each with a unique hostname and license key): ```bash -docker run -p 8086:8086 -p 2003:2003 \ - -e INFLUXDB_GRAPHITE_ENABLED=true \ - %%IMAGE%%:1.8 +# Meta node 0 +docker run -d \ + --name=influxdb-meta-0 \ + --network=influxdb \ + -h influxdb-meta-0 \ + -e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \ + influxdb:meta + +# Meta node 1 +docker run -d \ + --name=influxdb-meta-1 \ + --network=influxdb \ + -h influxdb-meta-1 \ + -e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \ + influxdb:meta + +# Meta node 2 +docker run -d \ + --name=influxdb-meta-2 \ + --network=influxdb \ + -h influxdb-meta-2 \ + -e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \ + influxdb:meta ``` -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: +Join meta nodes into the cluster: ```bash -curl -G http://localhost:8086/query --data-urlencode "q=CREATE DATABASE mydb" +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 ``` -Inserting into the DB: +Start data nodes: ```bash -curl -i -XPOST 'http://localhost:8086/write?db=mydb' --data-binary 'cpu_load_short,host=server01,region=us-west value=0.64 1434055562000000000' +# Data node 0 +docker run -d \ + --name=influxdb-data-0 \ + --network=influxdb \ + -h influxdb-data-0 \ + -e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \ + influxdb:data + +# Data node 1 +docker run -d \ + --name=influxdb-data-1 \ + --network=influxdb \ + -h influxdb-data-1 \ + -e INFLUXDB_ENTERPRISE_LICENSE_KEY=your-license-key \ + influxdb:data ``` -Read more about this in the [official documentation](https://docs.influxdata.com/influxdb/latest/guides/writing_data/). - -## CLI / SHELL - -Start the container: +Add data nodes to the cluster: ```bash -docker run --name=influxdb -d -p 8086:8086 %%IMAGE%%:1.8 +docker exec influxdb-meta-0 influxd-ctl add-data influxdb-data-0:8088 +docker exec influxdb-meta-0 influxd-ctl add-data influxdb-data-1:8088 ``` -Run the influx client in this container: +Verify cluster status: ```bash -docker exec -it influxdb influx +docker exec influxdb-meta-0 influxd-ctl show ``` -Or run the influx client in a separate container: - -```bash -docker run --rm --link=influxdb -it %%IMAGE%%:1.8 influx -host influxdb -``` - -## 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. - -#### INFLUXDB_ADMIN_USER - -The name of the admin user to be created. If this is unset, no admin user is created. +This displays all registered data and meta nodes. -#### INFLUXDB_ADMIN_PASSWORD +### Stop InfluxDB v1 Enterprise Containers -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. +To stop individual containers: -#### 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. +```bash +docker stop influxdb-meta-0 +docker stop influxdb-meta-1 +docker stop influxdb-meta-2 +docker stop influxdb-data-0 +docker stop influxdb-data-1 +``` -### Manually Initialize InfluxDB v1 +### Restart Containers -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: +To restart stopped containers: ```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 start influxdb-meta-0 +docker start influxdb-meta-1 +docker start influxdb-meta-2 +docker start influxdb-data-0 +docker start influxdb-data-1 ``` -The command creates the following: - -- a database named `db0` -- an admin user `admin` with the password `supersecretpassword` -- a `telegraf` user with the password `secretpassword` - -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 Enterprise documentation](https://docs.influxdata.com/enterprise_influxdb/v1/introduction/installation/docker/). diff --git a/influxdb/get-help.md b/influxdb/get-help.md new file mode 100755 index 000000000000..ab1d9d0e956f --- /dev/null +++ b/influxdb/get-help.md @@ -0,0 +1 @@ +[InfluxDB Discord Server](https://discord.gg/9zaNCW2PRT) *(preferred for **InfluxDB 3 Core**, **InfluxDB 3 Enterprise**)*, [InfluxDB Community Slack](https://influxdata.com/slack) *(preferred for **InfluxDB v2**, **v1**)\* diff --git a/influxdb/github-repo b/influxdb/github-repo old mode 100644 new mode 100755 diff --git a/influxdb/license.md b/influxdb/license.md old mode 100644 new mode 100755 diff --git a/influxdb/logo.png b/influxdb/logo.png old mode 100644 new mode 100755 diff --git a/influxdb/metadata.json b/influxdb/metadata.json old mode 100644 new mode 100755 index 3d3937b21fb1..56ca576ac81a --- a/influxdb/metadata.json +++ b/influxdb/metadata.json @@ -1,7 +1,9 @@ { "hub": { "categories": [ - "databases-and-storage" + "data-science", + "databases-and-storage", + "internet-of-things" ] } } diff --git a/influxdb/variant-data.md b/influxdb/variant-data.md old mode 100644 new mode 100755 diff --git a/influxdb/variant-meta.md b/influxdb/variant-meta.md old mode 100644 new mode 100755