Merge pull request #6203 from influxdata/fix-influxdb3-docker

fix(influxdb3): correct Docker environment variable and compose examp…

Author: jstirnaman

compose.yaml

@@ -349,6 +349,7 @@ services:
       - --data-dir=/var/lib/influxdb3/data
       - --plugin-dir=/var/lib/influxdb3/plugins
     environment:
+      - INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=${INFLUXDB3_ENTERPRISE_LICENSE_EMAIL}
       - INFLUXDB3_AUTH_TOKEN=/run/secrets/influxdb3-enterprise-admin-token
     volumes:
       - type: bind 

content/influxdb3/enterprise/admin/license.md

@@ -154,7 +154,7 @@ existing license if it's still valid.
 2.  When starting the {{< product-name >}} server, provide the license file
     path using one of the following methods:
 
-    - Use the the [`--license-file`](/influxdb3/enterprise/reference/config-options/#license-file)
+    - Use the [`--license-file`](/influxdb3/enterprise/reference/config-options/#license-file)
       option with the `influxdb3 serve` command
     - Set the `INFLUXDB3_ENTERPRISE_LICENSE_FILE` environment variable.
 
@@ -225,25 +225,29 @@ services:
     image: influxdb:3-enterprise
     ports:
       - 8181:8181
-    # In the following command, replace INFLUXDB3_LICENSE_EMAIL with your email address.
-    # Alternatively, pass the `INFLUXDB3_LICENSE_EMAIL` environment variable or
+    # In the following command, replace INFLUXDB3_ENTERPRISE_LICENSE_EMAIL with your email address.
+    # Alternatively, pass the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable or
     # store the email address in a compose CLI .env file.
     command:
       - influxdb3
       - serve
       - --node-id=node0
       - --cluster-id=cluster0
       - --object-store=file
-      - --data-dir=/var/lib/influxdb3
+      - --data-dir=/var/lib/influxdb3/data
       - --plugin-dir=/var/lib/influxdb3/plugins
     environment:
-      - INFLUXDB3_LICENSE_EMAIL=${EMAIL_ADDRESS}
+      - INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=${EMAIL_ADDRESS}
     volumes:
-      - type: bind 
+      - type: bind
+        # Path to store data on your host system
         source: ~/.influxdb3/data
-        target: /var/lib/influxdb3
-      - type: bind 
+        # Path to store data in the container
+        target: /var/lib/influxdb3/data
+      - type: bind
+        # Path to store plugins on your host system
         source: ~/.influxdb3/plugins
+        # Path to store plugins in the container
         target: /var/lib/influxdb3/plugins
 ```
 {{% /code-placeholders %}}

content/shared/influxdb3-get-started/setup.md

@@ -133,7 +133,7 @@ data to the local file system, mount a volume for the object store--for example,
 provide the following options with your `docker run` command:
 
 - `--volume /path/on/host:/path/in/container`: Mounts a directory from your file system to the container
-- `--object-store file --data-dir /path/in/container`: Use the volume mount for object storage
+- `--object-store file --data-dir /path/in/container`: Uses the volume for object storage
 
 {{% show-in "enterprise" %}}
 <!--pytest.mark.skip-->
@@ -174,66 +174,81 @@ docker run -it \
 
 {{% /expand %}}
 {{% expand "Docker compose with a mounted file system object store" %}}
+Open `compose.yaml` for editing and add a `services` entry for
+   {{% product-name %}}--for example:
 {{% show-in "enterprise" %}}
-1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}.
-   --for example:
-   
-   ```yaml
-   # compose.yaml
-   services:
-     influxdb3-{{< product-key >}}:
-       container_name: influxdb3-{{< product-key >}}
-       image: influxdb:3-{{< product-key >}}
-       ports:
-         - 8181:8181 
-       command:
-         - influxdb3
-         - serve
-         - --node-id=node0
-         - --cluster-id=cluster0
-         - --object-store=file
-         - --data-dir=/var/lib/influxdb3
-         - --plugin-dir=/var/lib/influxdb3-plugins
-       environment:
-         - INFLUXDB3_LICENSE_EMAIL=EMAIL_ADDRESS
-   ```
-   _Replace `EMAIL_ADDRESS` with your email address to bypass the email prompt
+```yaml
+# compose.yaml
+services:
+  influxdb3-{{< product-key >}}:
+    image: influxdb:3-{{< product-key >}}
+    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
+        # Path to store data on your host system
+        source: ~/.influxdb3/data
+        # Path to store data in the container
+        target: /var/lib/influxdb3/data
+      - type: bind
+        # Path to store plugins on your host system
+        source: ~/.influxdb3/plugins
+        # Path to store plugins in the container
+        target: /var/lib/influxdb3/plugins
+```
+   Replace `EMAIL_ADDRESS` with your email address to bypass the email prompt
    when generating a trial or at-home license. For more information, see [Manage your
-   {{% product-name %}} license](/influxdb3/version/admin/license/)_.
+   {{% product-name %}} license](/influxdb3/version/admin/license/).
 {{% /show-in %}}
 {{% show-in "core" %}}
-1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}--for example:
-
-   ```yaml
-   # compose.yaml
-   services:
-     influxdb3-{{< product-key >}}:
-       container_name: influxdb3-{{< product-key >}}
-       image: influxdb:3-{{< product-key >}}
-       ports:
-         - 8181:8181
-       command:
-         - influxdb3
-         - serve
-         - --node-id=node0
-         - --object-store=file
-         - --data-dir=/var/lib/influxdb3
-         - --plugin-dir=/var/lib/influxdb3-plugins
-   ```
+```yaml
+# compose.yaml
+services:
+  influxdb3-{{< product-key >}}:
+    image: influxdb:3-{{< product-key >}}
+    ports:
+      - 8181: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
+        # Path to store data on your host system
+        source: ~/.influxdb3/data
+        # Path to store data in the container
+        target: /var/lib/influxdb3/data
+      - type: bind
+        # Path to store plugins on your host system
+        source: ~/.influxdb3/plugins
+        # Path to store plugins in the container
+        target: /var/lib/influxdb3/plugins
+```
 {{% /show-in %}}
 
-2. Use the Docker Compose CLI to start the server.
-
-   Optional: to make sure you have the latest version of the image before you
-   start the server, run `docker compose pull`.
+Use the Docker Compose CLI to start the server--for example:
 
-   <!--pytest.mark.skip-->
-   ```bash
-   docker compose pull && docker compose run influxdb3-{{< product-key >}}
-   ```
+<!--pytest.mark.skip-->
+```bash
+docker compose pull && docker compose up influxdb3-{{< product-key >}}
+```
 
-InfluxDB 3 starts in a container with host port `8181` mapped to container port
-`8181`, the `influxdb3` server default for HTTP connections.
+The command pulls the latest {{% product-name %}} Docker image and starts
+`influxdb3` in a container with host port `8181` mapped to container port
+`8181`, the server default for HTTP connections.
 
 > [!Tip]
 > #### Custom port mapping
@@ -244,18 +259,6 @@ InfluxDB 3 starts in a container with host port `8181` mapped to container port
 > For more information about mapping your container port to a specific host port, see the
 > Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/).
 
-> [!Note]
-> #### Stopping an InfluxDB 3 container
->
-> To stop a running InfluxDB 3 container, find and terminate the process or container--for example:
->
-> <!--pytest.mark.skip-->
-> ```bash
-> docker container ls --filter "name=influxdb3"
-> docker kill <CONTAINER_ID>
-> ```
->
-> _Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container._
 {{% /expand %}}
 {{% expand "S3 object storage" %}}
 
@@ -377,7 +380,7 @@ InfluxDB 3 Enterprise licenses:
 >
 > To generate the trial or home license in Docker, bypass the email prompt.
 > The first time you start a new instance, provide your email address with the
-> `--license-email` option or the `INFLUXDB3_LICENSE_EMAIL` environment variable.
+> `--license-email` option or the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable.
 >
 > _Currently, if you use Docker and enter your email address in the prompt, a bug may
 > prevent the container from generating the license ._