diff --git a/content/influxdb3/core/install.md b/content/influxdb3/core/install.md index 449568eb4..8467e6538 100644 --- a/content/influxdb3/core/install.md +++ b/content/influxdb3/core/install.md @@ -1,6 +1,6 @@ --- -title: Install InfluxDB 3 Core -description: Download and install InfluxDB 3 Core. +title: Install {{< product-name >}} +description: Download and install {{< product-name >}}. menu: influxdb3_core: name: Install InfluxDB 3 Core @@ -12,14 +12,14 @@ alt_links: - [System Requirements](#system-requirements) - [Quick install](#quick-install) -- [Download InfluxDB 3 Core binaries](#download-influxdb-3-core-binaries) +- [Download {{< product-name >}} binaries](#download-influxdb-3-{{< product-key >}}-binaries) - [Docker image](#docker-image) ## System Requirements #### Operating system -InfluxDB 3 Core runs on **Linux**, **macOS**, and **Windows**. +{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**. #### Object storage @@ -38,7 +38,7 @@ Use the InfluxDB 3 quick install script to install {{< product-name >}} on **Linux** and **macOS**. > [!Important] -> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-core-binaries). +> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries). 1. Use the following command to download and install the appropriate {{< product-name >}} package on your local machine: @@ -79,7 +79,7 @@ source ~/.zshrc {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -## Download InfluxDB 3 Core binaries +## Download {{< product-name >}} binaries {{< tabs-wrapper >}} {{% tabs %}} @@ -91,13 +91,13 @@ source ~/.zshrc -- [InfluxDB 3 Core • Linux (x86) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-gnu.tar.gz) +- [{{< product-name >}} • Linux (x86) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_x86_64-unknown-linux-gnu.tar.gz) • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-unknown-linux-gnu.tar.gz.sha256) + [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_x86_64-unknown-linux-gnu.tar.gz.sha256) -- [InfluxDB 3 Core • Linux (ARM) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-gnu.tar.gz) +- [{{< product-name >}} • Linux (ARM) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_aarch64-unknown-linux-gnu.tar.gz) • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-unknown-linux-gnu.tar.gz.sha256) + [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_aarch64-unknown-linux-gnu.tar.gz.sha256) @@ -106,9 +106,9 @@ source ~/.zshrc -- [InfluxDB 3 Core • macOS (Silicon)](https://download.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-apple-darwin.tar.gz) +- [{{< product-name >}} • macOS (Silicon)](https://download.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_aarch64-apple-darwin.tar.gz) • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_aarch64-apple-darwin.tar.gz.sha256) + [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_aarch64-apple-darwin.tar.gz.sha256) > [!Note] > macOS Intel builds are coming soon. @@ -120,9 +120,9 @@ source ~/.zshrc -- [InfluxDB 3 Core • Windows (x86)](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-pc-windows-gnu.tar.gz) +- [{{< product-name >}} • Windows (x86)](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_x86_64-pc-windows-gnu.tar.gz) • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-core_x86_64-pc-windows-gnu.tar.gz.sha256) + [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_x86_64-pc-windows-gnu.tar.gz.sha256) @@ -131,7 +131,7 @@ source ~/.zshrc ## Docker image -Use the `influxdb3-core` Docker image to deploy {{< product-name >}} in a +Use the `influxdb3-{{< product-key >}}` Docker image to deploy {{< product-name >}} in a Docker container. The image is available for x86_64 (AMD64) and ARM64 architectures. @@ -139,26 +139,27 @@ The image is available for x86_64 (AMD64) and ARM64 architectures. ```bash -docker pull quay.io/influxdb/influxdb3-core:latest +docker pull quay.io/influxdb/influxdb3-{{< product-key >}}:latest ``` Docker automatically pulls the appropriate image for your system architecture. -You can also explicitly specify the architecture by using platform-specific tags: +To specify the system architecture, use platform-specific tags--for example: ```bash # For x86_64/AMD64 docker pull \ --platform linux/amd64 \ -quay.io/influxdb/influxdb3-core:latest +quay.io/influxdb/influxdb3-{{< product-key >}}:latest ``` ```bash # For ARM64 docker pull \ --platform linux/arm64 \ -quay.io/influxdb/influxdb3-core:latest +quay.io/influxdb/influxdb3-{{< product-key >}}:latest ``` + > [!Note] > 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/). @@ -170,9 +171,9 @@ quay.io/influxdb/influxdb3-core:latest ```yaml # compose.yaml services - influxdb3-core: - container_name: influxdb3-core - image: quay.io/influxdb/influxdb3-{{% product-key %}}:latest + influxdb3-{{< product-key >}}: + container_name: influxdb3-{{< product-key >}} + image: quay.io/influxdb/influxdb3-{{< product-key >}}:latest ports: - 9999:9999 command: @@ -190,7 +191,7 @@ quay.io/influxdb/influxdb3-core:latest ```bash - docker compose pull && docker compose run influxdb3-core + docker compose pull && docker compose run influxdb3-{{< product-key >}} ``` > [!Note] @@ -204,6 +205,6 @@ quay.io/influxdb/influxdb3-core:latest > kill -9 > ``` > -> Currently, a bug prevents using `Ctrl-c` in the terminal to stop an InfluxDB 3 container. +> Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container. {{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}} diff --git a/content/influxdb3/enterprise/install.md b/content/influxdb3/enterprise/install.md index 71626d535..c44604041 100644 --- a/content/influxdb3/enterprise/install.md +++ b/content/influxdb3/enterprise/install.md @@ -1,6 +1,6 @@ --- -title: Install InfluxDB 3 Enterprise -description: Download and install InfluxDB 3 Enterprise. +title: Install {{< product-name >}} +description: Download and install {{< product-name >}}. menu: influxdb3_enterprise: name: Install InfluxDB 3 Enterprise @@ -12,14 +12,14 @@ alt_links: - [System Requirements](#system-requirements) - [Quick install](#quick-install) -- [Download InfluxDB 3 Enterprise binaries](#download-influxdb-3-enterprise-binaries) +- [Download {{< product-name >}} binaries](#download-influxdb-3-{{< product-key >}}-binaries) - [Docker image](#docker-image) ## System Requirements #### Operating system -InfluxDB 3 Enterprise runs on **Linux**, **macOS**, and **Windows**. +{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**. #### Object storage @@ -38,11 +38,11 @@ Use the InfluxDB 3 quick install script to install {{< product-name >}} on **Linux** and **macOS**. > [!Important] -> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-enterprise-binaries). +> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries). 1. Use the following command to download and install the appropriate {{< product-name >}} package on your local machine: - + ```bash curl -O https://www.influxdata.com/d/install_influxdb3.sh \ && sh install_influxdb3.sh enterprise @@ -72,13 +72,14 @@ source ~/.bashrc ``` {{% /code-tab-content %}} {{% code-tab-content %}} + ```bash source ~/.zshrc ``` {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -## Download InfluxDB 3 Enterprise binaries +## Download {{< product-name >}} binaries {{< tabs-wrapper >}} {{% tabs %}} @@ -90,13 +91,13 @@ source ~/.zshrc -- [InfluxDB 3 Enterprise • Linux (x86) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-gnu.tar.gz) +- [{{< product-name >}} • Linux (x86) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_x86_64-unknown-linux-gnu.tar.gz) • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-unknown-linux-gnu.tar.gz.sha256) + [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_x86_64-unknown-linux-gnu.tar.gz.sha256) -- [InfluxDB 3 Enterprise • Linux (ARM) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-gnu.tar.gz) +- [{{< product-name >}} • Linux (ARM) • GNU](https://download.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_aarch64-unknown-linux-gnu.tar.gz) • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-unknown-linux-gnu.tar.gz.sha256) + [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_aarch64-unknown-linux-gnu.tar.gz.sha256) @@ -105,9 +106,9 @@ source ~/.zshrc -- [InfluxDB 3 Enterprise • macOS (Silicon)](https://download.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-apple-darwin.tar.gz) +- [{{< product-name >}} • macOS (Silicon)](https://download.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_aarch64-apple-darwin.tar.gz) • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_aarch64-apple-darwin.tar.gz.sha256) + [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_aarch64-apple-darwin.tar.gz.sha256) > [!Note] > macOS Intel builds are coming soon. @@ -119,9 +120,9 @@ source ~/.zshrc -- [InfluxDB 3 Enterprise • Windows (x86)](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-pc-windows-gnu.tar.gz) +- [{{< product-name >}} • Windows (x86)](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_x86_64-pc-windows-gnu.tar.gz) • - [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-enterprise_x86_64-pc-windows-gnu.tar.gz.sha256) + [sha256](https://dl.influxdata.com/influxdb/snapshots/influxdb3-{{< product-key >}}_x86_64-pc-windows-gnu.tar.gz.sha256) @@ -130,30 +131,80 @@ source ~/.zshrc ## Docker image -Use the `influxdb3-enterprise` Docker image to deploy {{< product-name >}} in a +Use the `influxdb3-{{< product-key >}}` Docker image to deploy {{< product-name >}} in a Docker container. The image is available for x86_64 (AMD64) and ARM64 architectures. +### Use Docker CLI + + ```bash -docker pull quay.io/influxdb/influxdb3-enterprise:latest +docker pull quay.io/influxdb/influxdb3-{{< product-key >}}:latest ``` Docker automatically pulls the appropriate image for your system architecture. -You can also explicitly specify the architecture by using platform-specific tags: +To specify the system architecture, use platform-specific tags--for example: ```bash # For x86_64/AMD64 docker pull \ --platform linux/amd64 \ -quay.io/influxdb/influxdb3-enterprise:latest +quay.io/influxdb/influxdb3-{{< product-key >}}:latest ``` ```bash # For ARM64 docker pull \ --platform linux/arm64 \ -quay.io/influxdb/influxdb3-enterprise:latest +quay.io/influxdb/influxdb3-{{< product-key >}}:latest ``` -{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}} +> [!Note] +> 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/). + +### Use Docker Compose + +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: quay.io/influxdb/influxdb3-{{< product-key >}}:latest + ports: + - 9999:9999 + command: + - serve + - --node-id=node0 + - --log-filter=debug + - --object-store=file + - --data-dir=/var/lib/influxdb3 + ``` + +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`. + + + ```bash + docker compose pull && docker compose run influxdb3-{{< product-key >}} + ``` + +> [!Note] +> #### Stopping an InfluxDB 3 container +> +> To stop a running InfluxDB 3 container, find and terminate the process--for example: +> +> +> ```bash +> ps -ef | grep influxdb3 +> kill -9 +> ``` +> +> Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container. + +{{< page-nav next="/influxdb3/enterprise/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}} diff --git a/layouts/shortcodes/product-key.html b/layouts/shortcodes/product-key.html index 234e245be..631349a46 100644 --- a/layouts/shortcodes/product-key.html +++ b/layouts/shortcodes/product-key.html @@ -1,3 +1,3 @@ {{- $productPathData := findRE "[^/]+.*?" .Page.RelPermalink -}} {{- $currentProduct := index $productPathData 1 -}} -{{ $currentProduct }} +{{ $currentProduct }} \ No newline at end of file