From 06efd29e6bc659a82b03a60bdb6db25422494052 Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 20 Jun 2025 07:48:30 -0700 Subject: [PATCH 1/6] docs: Adding data mount prereq --- content/shared/influxdb3/install.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md index a833376d64..980f48a974 100644 --- a/content/shared/influxdb3/install.md +++ b/content/shared/influxdb3/install.md @@ -21,6 +21,28 @@ Azure Blob Storage, and Google Cloud Storage. You can also use many local object storage implementations that provide an S3-compatible API, such as [Minio](https://min.io/). +## Prerequisites + +Before installing InfluxDB 3, complete the following: + +### Prepare a host data directory + +When running InfluxDB 3 in Docker, mount a host directory to `/var/lib/influxdb3` +to persist your data and configuration across container restarts. + +Create a directory and set appropriate permissions: + +```bash +# Create a data directory in your working directory +mkdir -p $PWD/influxdb3-data +``` + +```bash +# Set permissions to allow InfluxDB to write data +chmod 755 $PWD/influxdb3-data +``` +You’ll mount this directory when you start the container. + ## Quick install Use the InfluxDB 3 quick install script to install {{< product-name >}} on From 7cf471e79632739db54066b55491d69b0055bcb3 Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 20 Jun 2025 07:57:57 -0700 Subject: [PATCH 2/6] docs: add tip for mounting /var/lib and setting secure permissions in Docker instructions --- content/shared/influxdb3/install.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md index 980f48a974..81eba610bc 100644 --- a/content/shared/influxdb3/install.md +++ b/content/shared/influxdb3/install.md @@ -184,6 +184,14 @@ influxdb:3-{{< product-key >}} > The {{% product-name %}} Docker image exposes port `8181`, the `influxdb3` server default for HTTP connections. > To map the exposed port to a different port when running a container, see the Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/). +> [!TIP] +> To persist data when running InfluxDB in a Docker container, mount a local directory to `/var/lib/influxdb3` and set secure permissions: +> ```bash +> mkdir -p /var/lib/influxdb3 +> chmod 700 /var/lib/influxdb3 +> ``` +> This ensures InfluxDB can write data and your data stays secure. + ### Use Docker Compose {{% show-in "enterprise" %}} From 65bf63bbbe9a9ab5abc3bb4e564824e54d93a86d Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 20 Jun 2025 08:17:49 -0700 Subject: [PATCH 3/6] docs: minor updates to prereq and removal of tip because it seemed redundant. --- content/shared/influxdb3/install.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md index 81eba610bc..13ec6d8470 100644 --- a/content/shared/influxdb3/install.md +++ b/content/shared/influxdb3/install.md @@ -25,23 +25,32 @@ S3-compatible API, such as [Minio](https://min.io/). Before installing InfluxDB 3, complete the following: -### Prepare a host data directory +### 1. Prepare a host data directory -When running InfluxDB 3 in Docker, mount a host directory to `/var/lib/influxdb3` -to persist your data and configuration across container restarts. +When running InfluxDB 3 in Docker, mount a host directory to `/var/lib/influxdb3` to persist your data and configuration across container restarts. -Create a directory and set appropriate permissions: +> [!Note] +> Instead of using `/var/lib/influxdb3` directly on your host, use a local directory in your current working directory. +> This approach makes it easier to manage and access the files. + +#### Create the directory + +Create a directory ```bash # Create a data directory in your working directory mkdir -p $PWD/influxdb3-data ``` +#### Set permissions + +Set the appropriate permissions so InfluxDB can write data to the directory: + ```bash # Set permissions to allow InfluxDB to write data chmod 755 $PWD/influxdb3-data ``` -You’ll mount this directory when you start the container. +You’ll mount this directory to `/var/lib/influxdb3` when you start the container. ## Quick install @@ -184,14 +193,6 @@ influxdb:3-{{< product-key >}} > The {{% product-name %}} Docker image exposes port `8181`, the `influxdb3` server default for HTTP connections. > To map the exposed port to a different port when running a container, see the Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/). -> [!TIP] -> To persist data when running InfluxDB in a Docker container, mount a local directory to `/var/lib/influxdb3` and set secure permissions: -> ```bash -> mkdir -p /var/lib/influxdb3 -> chmod 700 /var/lib/influxdb3 -> ``` -> This ensures InfluxDB can write data and your data stays secure. - ### Use Docker Compose {{% show-in "enterprise" %}} From 891d8a301d4a280ac3d7bcf5ab71a10201c5db81 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Mon, 23 Jun 2025 07:40:43 -0700 Subject: [PATCH 4/6] Update install.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3/install.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md index 13ec6d8470..7392443a5a 100644 --- a/content/shared/influxdb3/install.md +++ b/content/shared/influxdb3/install.md @@ -29,10 +29,6 @@ Before installing InfluxDB 3, complete the following: When running InfluxDB 3 in Docker, mount a host directory to `/var/lib/influxdb3` to persist your data and configuration across container restarts. -> [!Note] -> Instead of using `/var/lib/influxdb3` directly on your host, use a local directory in your current working directory. -> This approach makes it easier to manage and access the files. - #### Create the directory Create a directory From 499643d2e462b91f366a1274908677ba2d5be48d Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Mon, 23 Jun 2025 07:40:52 -0700 Subject: [PATCH 5/6] Update install.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3/install.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md index 7392443a5a..83ccd7be0a 100644 --- a/content/shared/influxdb3/install.md +++ b/content/shared/influxdb3/install.md @@ -31,7 +31,6 @@ When running InfluxDB 3 in Docker, mount a host directory to `/var/lib/influxdb3 #### Create the directory -Create a directory ```bash # Create a data directory in your working directory From 0fccd249aa630ddf3225542b8a1caa0100958827 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Mon, 23 Jun 2025 07:41:05 -0700 Subject: [PATCH 6/6] Update install.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3/install.md b/content/shared/influxdb3/install.md index 83ccd7be0a..b4ca83ddad 100644 --- a/content/shared/influxdb3/install.md +++ b/content/shared/influxdb3/install.md @@ -39,7 +39,7 @@ mkdir -p $PWD/influxdb3-data #### Set permissions -Set the appropriate permissions so InfluxDB can write data to the directory: +Set the appropriate permissions for InfluxDB to write data to the directory: ```bash # Set permissions to allow InfluxDB to write data