chore(enterprise3): Strongly recommend to provide the email address when using Docker, especially Docker Compose, in order for license generation to complete:
- Install Enterprise - Admin license - If only one pagination button (prev or next), allow it to fill the width. - Combines core and enterprise install into a shared page.pull/6139/head
Jason Stirnaman
parent
b45b1177c1
commit
7d6ae51183
|
|
@ -34,5 +34,10 @@
|
|||
vertical-align: middle;
|
||||
}
|
||||
}
|
||||
|
||||
// Remove max-width when only one button is present
|
||||
&:only-child {
|
||||
max-width: none;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
25
compose.yaml
25
compose.yaml
|
|
@ -311,6 +311,31 @@ services:
|
|||
- --log-filter=debug
|
||||
- --object-store=file
|
||||
- --data-dir=/var/lib/influxdb3
|
||||
influxdb3-enterprise:
|
||||
container_name: influxdb3-enterprise
|
||||
image: influxdb:3-enterprise
|
||||
ports:
|
||||
- 8181:8181
|
||||
# Change the INFLUXDB3_LICENSE_EMAIL environment variable to your email address. You can also set it in a `.env` file in the same directory as this compose file. Docker Compose automatically loads the .env file.
|
||||
# The license email option is only used the first time you run the container; you can't change the license email after the first run.
|
||||
# The server stores the license in the data directory in the object store and the license is associated with the cluster ID and email.
|
||||
command:
|
||||
- influxdb3
|
||||
- serve
|
||||
- --node-id=node0
|
||||
- --cluster-id=cluster0
|
||||
- --log-filter=debug
|
||||
- --object-store=file
|
||||
- --data-dir=/var/lib/influxdb3
|
||||
- --plugin-dir=/var/lib/influxdb3/plugins
|
||||
- --license-email=${INFLUXDB3_LICENSE_EMAIL}
|
||||
volumes:
|
||||
- type: bind
|
||||
source: docker/influxdb3/data
|
||||
target: /var/lib/influxdb3
|
||||
- type: bind
|
||||
source: docker/influxdb3/plugins
|
||||
target: /var/lib/influxdb3-plugins
|
||||
telegraf-pytest:
|
||||
container_name: telegraf-pytest
|
||||
image: influxdata/docs-pytest
|
||||
|
|
|
|||
|
|
@ -6,205 +6,9 @@ menu:
|
|||
name: Install InfluxDB 3 Core
|
||||
weight: 2
|
||||
influxdb3/core/tags: [install]
|
||||
source: /shared/influxdb3/install.md
|
||||
alt_links:
|
||||
v1: /influxdb/v1/introduction/install/
|
||||
---
|
||||
|
||||
- [System Requirements](#system-requirements)
|
||||
- [Quick install](#quick-install)
|
||||
- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries)
|
||||
- [Docker image](#docker-image)
|
||||
|
||||
## System Requirements
|
||||
|
||||
#### Operating system
|
||||
|
||||
{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**.
|
||||
|
||||
#### Object storage
|
||||
|
||||
A key feature of InfluxDB 3 is its use of object storage to store time series
|
||||
data in Apache Parquet format. You can choose to store these files on your local
|
||||
file system. Performance on your local filesystem will likely be better, but
|
||||
object storage has the advantage of not running out of space and being accessible
|
||||
by other systems over the network. {{< product-name >}} natively supports Amazon S3,
|
||||
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/).
|
||||
|
||||
## Quick install
|
||||
|
||||
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-{{< product-key >}}-binaries).
|
||||
|
||||
1. Use the following command to download and install the appropriate
|
||||
{{< product-name >}} package on your local machine:
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
|
||||
&& sh install_influxdb3.sh
|
||||
```
|
||||
|
||||
2. Verify that installation completed successfully:
|
||||
|
||||
```bash
|
||||
influxdb3 --version
|
||||
```
|
||||
|
||||
> [!Note]
|
||||
>
|
||||
> #### influxdb3 not found
|
||||
>
|
||||
> If your system can't locate your `influxdb3` binary, `source` your
|
||||
> current shell configuration file (`.bashrc`, `.zshrc`, etc.).
|
||||
>
|
||||
> {{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
[.bashrc](#)
|
||||
[.zshrc](#)
|
||||
{{% /code-tabs %}}
|
||||
{{% code-tab-content %}}
|
||||
```bash
|
||||
source ~/.bashrc
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
source ~/.zshrc
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{< /code-tabs-wrapper >}}
|
||||
|
||||
## Download {{% product-name %}} binaries
|
||||
|
||||
{{< tabs-wrapper >}}
|
||||
{{% tabs %}}
|
||||
[Linux](#)
|
||||
[macOS](#)
|
||||
[Windows](#)
|
||||
{{% /tabs %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!-------------------------------- BEGIN LINUX -------------------------------->
|
||||
|
||||
- [{{< product-name >}} • Linux (AMD64, x86_64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256)
|
||||
|
||||
- [{{< product-name >}} • Linux (ARM64, AArch64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256)
|
||||
|
||||
<!--------------------------------- END LINUX --------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!-------------------------------- BEGIN MACOS -------------------------------->
|
||||
|
||||
- [{{< product-name >}} • macOS (Silicon, ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256)
|
||||
|
||||
> [!Note]
|
||||
> macOS Intel builds are coming soon.
|
||||
|
||||
<!--------------------------------- END MACOS --------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!------------------------------- BEGIN WINDOWS ------------------------------->
|
||||
|
||||
- [{{< product-name >}} • Windows (AMD64, x86_64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256)
|
||||
|
||||
<!-------------------------------- END WINDOWS -------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{< /tabs-wrapper >}}
|
||||
|
||||
## Docker image
|
||||
|
||||
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
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
docker pull influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
Docker automatically pulls the appropriate image for your system architecture.
|
||||
|
||||
To specify the system architecture, use platform-specific tags--for example:
|
||||
|
||||
```bash
|
||||
# For x86_64/AMD64
|
||||
docker pull \
|
||||
--platform linux/amd64 \
|
||||
influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
```bash
|
||||
# For ARM64
|
||||
docker pull \
|
||||
--platform linux/arm64 \
|
||||
influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
> [!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: influxdb:3-{{< product-key >}}
|
||||
ports:
|
||||
- 8181:8181
|
||||
command:
|
||||
- influxdb3
|
||||
- serve
|
||||
- --node-id=node0
|
||||
- --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`.
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```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:
|
||||
>
|
||||
> <!--pytest.mark.skip-->
|
||||
> ```bash
|
||||
> ps -ef | grep influxdb3
|
||||
> kill -9 <PROCESS_ID>
|
||||
> ```
|
||||
>
|
||||
> 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" >}}
|
||||
<!--SOURCE content/shared/influxdb3/install.md -->
|
||||
|
|
@ -73,22 +73,49 @@ physical and virtual CPU cores.
|
|||
|
||||
## Activate a license
|
||||
|
||||
Each {{< product-name >}} license must be activated, but the process of activating
|
||||
the license depends on the license type:
|
||||
Each {{< product-name >}} license must be activated when you start the server,
|
||||
but the process of activating the license depends on the license type:
|
||||
|
||||
- [Activate a trial or at-home license](#activate-a-trial-or-at-home-license)
|
||||
- [Activate a commercial license](#activate-a-commercial-license)
|
||||
|
||||
### Activate a trial or at-home license
|
||||
|
||||
When starting the {{< product-name >}} server, it asks what type of
|
||||
license you would like to use.
|
||||
Select `trial` or `home` and provide your
|
||||
email address.
|
||||
The server auto-generates and stores your license.
|
||||
1. Use the [`influxdb3 serve` command](/influxdb3/enterprise/reference/cli/influxdb3/serve/) to start the server.
|
||||
If the server doesn't find a license file or email address, the server prompts you
|
||||
to enter your email address.
|
||||
If you're [activating a trial or home license with Docker](#activate-a-trial-or-home-license-with-docker), include options to [skip the email prompt](#skip-the-email-prompt).
|
||||
2. The server prompts you to select a license type. Select `trial` or `home`.
|
||||
3. In the verification email from {{% product-name %}},
|
||||
click the button to verify your email address.
|
||||
|
||||
After you verify your email address, {{% product-name %}} auto-generates a
|
||||
license (associated with your cluster and email address) and stores the license
|
||||
file in your object store.
|
||||
The license file is a JWT file that contains the license information.
|
||||
|
||||
> [!Important]
|
||||
> #### Activate a trial or home license with Docker
|
||||
>
|
||||
> If you're starting a new {{% product-name %}} server in a Docker container, you must
|
||||
> use one of the methods to [skip the email prompt](#skip-the-email-prompt).
|
||||
> This ensures that the container can generate the license file after you
|
||||
> verify your email address.
|
||||
> See the [Docker Compose example](?t=Docker+compose#activate-a-trial-or-home-license-with-docker).
|
||||
|
||||
#### Skip the email prompt
|
||||
|
||||
To skip the email prompt when starting the server, you can provide your email
|
||||
address using one of the following methods:
|
||||
|
||||
- Use the [`--license-email`](/influxdb3/enterprise/reference/config-options/#license-email) option with the `influxdb3 serve` command
|
||||
- Set the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` environment variable
|
||||
|
||||
If the server finds a valid license file in your object store, it ignores the
|
||||
the license email option.
|
||||
|
||||
See examples to [start the server with your license email](#start-the-server-with-your-license-email).
|
||||
|
||||
#### Use an existing trial or at-home license
|
||||
|
||||
When you activate a trial or at-home license, InfluxDB registers your email
|
||||
|
|
@ -153,12 +180,13 @@ existing license if it's still valid.
|
|||
environment variable
|
||||
7. If no license is found, the server won't start
|
||||
|
||||
#### Example: Start the {{% product-name %}} server with your license email:
|
||||
### Start the server with your license email
|
||||
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
[influxdb3 options](#)
|
||||
[Environment variables](#)
|
||||
[Docker compose](#example-activate-trial-or-home-with-compose)
|
||||
{{% /code-tabs %}}
|
||||
{{% code-tab-content %}}
|
||||
<!------------------------ BEGIN INFLUXDB3 CLI OPTIONS ------------------------>
|
||||
|
|
@ -185,9 +213,42 @@ influxdb3 serve \
|
|||
```
|
||||
<!------------------------- END ENVIRONMENT VARIABLES ------------------------->
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
<!------------------------ BEGIN DOCKER COMPOSE ------------------------>
|
||||
```yaml
|
||||
# compose.yaml
|
||||
name: data-crunching-stack
|
||||
services:
|
||||
influxdb3-enterprise:
|
||||
container_name: influxdb3-enterprise
|
||||
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
|
||||
# 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
|
||||
- --plugin-dir=/var/lib/influxdb3/plugins
|
||||
- --license-email=INFLUXDB3_LICENSE_EMAIL
|
||||
volumes:
|
||||
- type: bind
|
||||
source: ~/.influxdb3/data
|
||||
target: /var/lib/influxdb3
|
||||
- type: bind
|
||||
source: ~/.influxdb3/plugins
|
||||
target: /var/lib/influxdb3/plugins
|
||||
```
|
||||
<!------------------------- END DOCKER COMPOSE ------------------------->
|
||||
{{% /code-tab-content %}}
|
||||
{{< /code-tabs-wrapper >}}
|
||||
|
||||
#### Example: Start the {{% product-name %}} server with your license file:
|
||||
### Start the server with your license file
|
||||
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
|
|
|
|||
|
|
@ -6,206 +6,9 @@ menu:
|
|||
name: Install InfluxDB 3 Enterprise
|
||||
weight: 2
|
||||
influxdb3/enterprise/tags: [install]
|
||||
source: /shared/influxdb3/install.md
|
||||
alt_links:
|
||||
v1: /influxdb/v1/introduction/install/
|
||||
---
|
||||
|
||||
- [System Requirements](#system-requirements)
|
||||
- [Quick install](#quick-install)
|
||||
- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries)
|
||||
- [Docker image](#docker-image)
|
||||
|
||||
## System Requirements
|
||||
|
||||
#### Operating system
|
||||
|
||||
{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**.
|
||||
|
||||
#### Object storage
|
||||
|
||||
A key feature of InfluxDB 3 is its use of object storage to store time series
|
||||
data in Apache Parquet format. You can choose to store these files on your local
|
||||
file system. Performance on your local filesystem will likely be better, but
|
||||
object storage has the advantage of not running out of space and being accessible
|
||||
by other systems over the network. {{< product-name >}} natively supports Amazon S3,
|
||||
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/).
|
||||
|
||||
## Quick install
|
||||
|
||||
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-{{< product-key >}}-binaries).
|
||||
|
||||
1. Use the following command to download and install the appropriate
|
||||
{{< product-name >}} package on your local machine:
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
|
||||
&& sh install_influxdb3.sh enterprise
|
||||
```
|
||||
|
||||
2. Verify that installation completed successfully:
|
||||
|
||||
```bash
|
||||
influxdb3 --version
|
||||
```
|
||||
|
||||
> [!Note]
|
||||
>
|
||||
> #### influxdb3 not found
|
||||
>
|
||||
> If your system can't locate your `influxdb3` binary, `source` your
|
||||
> current shell configuration file (`.bashrc`, `.zshrc`, etc.).
|
||||
>
|
||||
> {{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
[.bashrc](#)
|
||||
[.zshrc](#)
|
||||
{{% /code-tabs %}}
|
||||
{{% code-tab-content %}}
|
||||
```bash
|
||||
source ~/.bashrc
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
source ~/.zshrc
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{< /code-tabs-wrapper >}}
|
||||
|
||||
## Download {{% product-name %}} binaries
|
||||
|
||||
{{< tabs-wrapper >}}
|
||||
{{% tabs %}}
|
||||
[Linux](#)
|
||||
[macOS](#)
|
||||
[Windows](#)
|
||||
{{% /tabs %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!-------------------------------- BEGIN LINUX -------------------------------->
|
||||
|
||||
- [{{< product-name >}} • Linux (AMD64, x86_64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256)
|
||||
|
||||
- [{{< product-name >}} • Linux (ARM64, AArch64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256)
|
||||
|
||||
<!--------------------------------- END LINUX --------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!-------------------------------- BEGIN MACOS -------------------------------->
|
||||
|
||||
- [{{< product-name >}} • macOS (Silicon, ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256)
|
||||
|
||||
> [!Note]
|
||||
> macOS Intel builds are coming soon.
|
||||
|
||||
<!--------------------------------- END MACOS --------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!------------------------------- BEGIN WINDOWS ------------------------------->
|
||||
|
||||
- [{{< product-name >}} • Windows (AMD64, x86_64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256)
|
||||
|
||||
<!-------------------------------- END WINDOWS -------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{< /tabs-wrapper >}}
|
||||
|
||||
## Docker image
|
||||
|
||||
Use the `influxdb:3-{{< 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
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
docker pull influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
Docker automatically pulls the appropriate image for your system architecture.
|
||||
|
||||
To specify the system architecture, use platform-specific tags--for example:
|
||||
|
||||
```bash
|
||||
# For x86_64/AMD64
|
||||
docker pull \
|
||||
--platform linux/amd64 \
|
||||
influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
```bash
|
||||
# For ARM64
|
||||
docker pull \
|
||||
--platform linux/arm64 \
|
||||
influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
> [!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: influxdb:3-{{< product-key >}}
|
||||
ports:
|
||||
- 9999:9999
|
||||
command:
|
||||
- influxdb3
|
||||
- serve
|
||||
- --node-id=node0
|
||||
- --cluster-id=cluster0
|
||||
- --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`.
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```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:
|
||||
>
|
||||
> <!--pytest.mark.skip-->
|
||||
> ```bash
|
||||
> ps -ef | grep influxdb3
|
||||
> kill -9 <PROCESS_ID>
|
||||
> ```
|
||||
>
|
||||
> 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" >}}
|
||||
<!--SOURCE - content/shared/influxdb3/install.md -->
|
||||
|
|
|
|||
|
|
@ -383,7 +383,7 @@ InfluxDB 3 Enterprise licenses authorize the use of the InfluxDB 3 Enterprise so
|
|||
- **At-Home**: For at-home hobbyist use with limited access to InfluxDB 3 Enterprise capabilities.
|
||||
- **Commercial**: Commercial license with full access to InfluxDB 3 Enterprise capabilities.
|
||||
|
||||
You can learn more on managing your InfluxDB 3 Enterprise license on the [Manage your license](https://docs.influxdata.com/influxdb3/enterprise/admin/license/) page.
|
||||
For more information, see how to [Manage your license](/influxdb3/enterprise/admin/license/).
|
||||
{{% /show-in %}}
|
||||
|
||||
### Authentication and authorization
|
||||
|
|
|
|||
|
|
@ -0,0 +1,239 @@
|
|||
<!-- Comment: This file is used to generate the InfluxDB 3 install page. -->
|
||||
- [System Requirements](#system-requirements)
|
||||
- [Quick install](#quick-install)
|
||||
- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries)
|
||||
- [Docker image](#docker-image)
|
||||
|
||||
## System Requirements
|
||||
|
||||
#### Operating system
|
||||
|
||||
{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**.
|
||||
|
||||
#### Object storage
|
||||
|
||||
A key feature of InfluxDB 3 is its use of object storage to store time series
|
||||
data in Apache Parquet format. You can choose to store these files on your local
|
||||
file system. Performance on your local filesystem will likely be better, but
|
||||
object storage has the advantage of not running out of space and being accessible
|
||||
by other systems over the network. {{< product-name >}} natively supports Amazon S3,
|
||||
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/).
|
||||
|
||||
## Quick install
|
||||
|
||||
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-{{< product-key >}}-binaries).
|
||||
|
||||
1. Use the following command to download and install the appropriate
|
||||
{{< product-name >}} package on your local machine:
|
||||
{{% show-in "enterprise" %}}
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
|
||||
&& sh install_influxdb3.sh {{% product-key %}}
|
||||
```
|
||||
{{% /show-in %}}
|
||||
{{% show-in "core" %}}
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
|
||||
&& sh install_influxdb3.sh
|
||||
```
|
||||
{{% /show-in %}}
|
||||
|
||||
2. Verify that installation completed successfully:
|
||||
|
||||
```bash
|
||||
influxdb3 --version
|
||||
```
|
||||
|
||||
> [!Note]
|
||||
>
|
||||
> #### influxdb3 not found
|
||||
>
|
||||
> If your system can't locate your `influxdb3` binary, `source` your
|
||||
> current shell configuration file (`.bashrc`, `.zshrc`, etc.).
|
||||
>
|
||||
> {{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
[.bashrc](#)
|
||||
[.zshrc](#)
|
||||
{{% /code-tabs %}}
|
||||
{{% code-tab-content %}}
|
||||
```bash
|
||||
source ~/.bashrc
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
source ~/.zshrc
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{< /code-tabs-wrapper >}}
|
||||
|
||||
## Download {{% product-name %}} binaries
|
||||
|
||||
{{< tabs-wrapper >}}
|
||||
{{% tabs %}}
|
||||
[Linux](#)
|
||||
[macOS](#)
|
||||
[Windows](#)
|
||||
{{% /tabs %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!-------------------------------- BEGIN LINUX -------------------------------->
|
||||
|
||||
- [{{< product-name >}} • Linux (AMD64, x86_64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256)
|
||||
|
||||
- [{{< product-name >}} • Linux (ARM64, AArch64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256)
|
||||
|
||||
<!--------------------------------- END LINUX --------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!-------------------------------- BEGIN MACOS -------------------------------->
|
||||
|
||||
- [{{< product-name >}} • macOS (Silicon, ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256)
|
||||
|
||||
> [!Note]
|
||||
> macOS Intel builds are coming soon.
|
||||
|
||||
<!--------------------------------- END MACOS --------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!------------------------------- BEGIN WINDOWS ------------------------------->
|
||||
|
||||
- [{{< product-name >}} • Windows (AMD64, x86_64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip)
|
||||
•
|
||||
[sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256)
|
||||
|
||||
<!-------------------------------- END WINDOWS -------------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{< /tabs-wrapper >}}
|
||||
|
||||
## Docker image
|
||||
|
||||
Use the `influxdb:3-{{< 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
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
docker pull influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
Docker automatically pulls the appropriate image for your system architecture.
|
||||
|
||||
To specify the system architecture, use platform-specific tags--for example:
|
||||
|
||||
```bash
|
||||
# For x86_64/AMD64
|
||||
docker pull \
|
||||
--platform linux/amd64 \
|
||||
influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
```bash
|
||||
# For ARM64
|
||||
docker pull \
|
||||
--platform linux/arm64 \
|
||||
influxdb:3-{{< product-key >}}
|
||||
```
|
||||
|
||||
> [!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
|
||||
|
||||
{{% show-in "enterprise" %}}
|
||||
1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}.
|
||||
To generate a trial or at-home license for {{% product-name %}} when using Docker, you must pass the `--license-email` option or the `INFLUXDB3_LICENSE_EMAIL` environment variable the first time you start the server--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
|
||||
- --plugins-dir=/var/lib/influxdb3-plugins
|
||||
- --license-email=${INFLUXDB3_LICENSE_EMAIL}
|
||||
```
|
||||
{{% /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
|
||||
- --plugins-dir=/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`.
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```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 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.
|
||||
|
||||
{{% show-in "enterprise" %}}
|
||||
{{< page-nav next="/influxdb3/enterprise/get-started/" nextText="Get started with InfluxDB 3 Enterprise" >}}
|
||||
{{% /show-in %}}
|
||||
{{% show-in "core" %}}
|
||||
{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}}
|
||||
{{% /show-in %}}
|
||||
Loading…
Reference in New Issue