Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/influxdb3/enterprise/admin/license.md

12 KiB
Raw Permalink Blame History

title description menu weight related
Manage your InfluxDB 3 Enterprise license {{< product-name >}} licenses authorize the use of the {{< product-name >}} software. Learn how licenses work, how to activate and renew licenses, and more.
influxdb3_enterprise
name parent
Manage your license Administer InfluxDB
101
/influxdb3/enterprise/reference/cli/influxdb3/serve/

{{< product-name >}} licenses authorize the use of the {{< product-name >}} software and apply to a single cluster. Licenses are primarily based on the number of CPUs InfluxDB can use, but there are other limitations depending on the license type.

License feature comparison

The following {{< product-name >}} license types are available:

  • Trial: 30-day trial license with full access to {{< product-name >}} capabilities.
  • At-Home: For at-home hobbyist use with limited access to {{< product-name >}} capabilities.
  • Commercial: Commercial license with full access to {{< product-name >}} capabilities.
Features Trial At-Home Commercial
CPU Core Limit 256 2 Per contract
Expiration 30 days Never Per contract
Multi-node {{% icon "check" "v2" %}} {{% icon "check" "v2" %}}
Commercial use {{% icon "check" "v2" %}} {{% icon "check" "v2" %}}

{{% caption %}} All other {{< product-name >}} features are available to all licenses. {{% /caption %}}

CPU limit

Each {{< product-name >}} license limits the number of CPUs InfluxDB can use. The CPU limit is per cluster, not per machine. A cluster may consist of multiple nodes that share the available CPU limit.

For example, you can purchase a 32-CPU Commercial license and set up an {{< product-name >}} cluster with the following:

  • 3 × writer nodes, each with 4 CPUs (12 total)
  • 1 × compactor node with 8 CPUs
  • 3 × query nodes, each with 4 CPUs (12 total)

With the {{< product-name >}} Commercial license, CPU cores are purchased in batches of 8, 16, 32, 64, or 128 cores.

CPU accounting

CPU cores are determined by whatever the operating system of the host machine reports as its core count. {{< product-name >}} does not differentiate between physical and virtual CPU cores.

[!Note] If using Linux, InfluxDB uses whatever cgroup CPU accounting is active--for example: cpuset or cpu.shares.

Activate a license

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

  1. Use the influxdb3 serve command 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, include options to 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. This ensures that the container can generate the license file after you verify your email address. See the Docker Compose example.

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 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 license email option.

See examples to 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 address with the license server. To use your existing license--for example, if you deleted your license file--provide your email address using one of the following methods:

  • Use the --license-email option with the influxdb3 serve command
  • Set the INFLUXDB3_ENTERPRISE_LICENSE_EMAIL environment variable

InfluxDB validates your email address with the license server and uses your existing license if it's still valid.

Activate a commercial license

  1. Contact InfluxData Sales to obtain an {{< product-name >}} Commercial license. Provide the following:

    • Cluster UUID
    • Object Store Info

    [!Note] This information is provided in the output of the {{< product-name >}} server if you try to start the server without a valid license.

    InfluxData will provide you with a commercial license file. The license file is a JWT file that contains the license information.

  2. When starting the {{< product-name >}} server, provide the license file path using one of the following methods:

    • Use the --license-file option with the influxdb3 serve command
    • Set the INFLUXDB3_ENTERPRISE_LICENSE_FILE environment variable.

License detection

{{% product-name %}} checks for a license file in the following order:

  1. The license file path provided with the --license-file option

  2. The license file path provided with the INFLUXDB3_ENTERPRISE_LICENSE_FILE environment variable

  3. The default license path:

    /<OBJECT_STORE>/<CLUSTER_ID>/commercial_license

  4. A trial or at-home license stored in the default location

    /<OBJECT_STORE>/<CLUSTER_ID>/trial_or_home_license

  5. The license email provided with the --license-email option

  6. The license email provided with the INFLUXDB3_ENTERPRISE_LICENSE_EMAIL environment variable

  7. If no license is found, the server won't start

Start the server with your license email

{{< code-tabs-wrapper >}} {{% code-tabs %}} influxdb3 options Environment variables Docker compose {{% /code-tabs %}} {{% code-tab-content %}}

influxdb3 serve \
--cluster-id cluster01 \
--node-id node01 \
--license-email example@email.com \
# ...

{{% /code-tab-content %}} {{% code-tab-content %}}

INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=example@email.com

influxdb3 serve \
--cluster-id cluster01 \
--node-id node01 \
# ...

{{% /code-tab-content %}} {{% code-tab-content %}}

{{% code-placeholders "${EMAIL_ADDRESS}" %}}

# 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_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
      - --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

{{% /code-placeholders %}} Replace {{% code-placeholder-key %}}${EMAIL_ADDRESS}{{% /code-placeholder-key %}} with your email address or a variable from your Compose .env file.

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}

Start the server with your license file

{{< code-tabs-wrapper >}} {{% code-tabs %}} influxdb3 options Environment variables {{% /code-tabs %}} {{% code-tab-content %}}

influxdb3 serve \
--cluster-id cluster01 \
--node-id node01 \
--license-file /path/to/license-file.jwt \
# ...

{{% /code-tab-content %}} {{% code-tab-content %}}

INFLUXDB3_ENTERPRISE_LICENSE_FILE=/path/to/license-file.jwt

influxdb3 serve \
--cluster-id cluster01 \
--node-id node01 \
# ...

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}

For more information about influxdb3 serve options, see the CLI reference.

Renew a license

To renew an {{< product-name >}} Commercial license, contact InfluxData Sales.

Expiration behavior

When your {{< product-name >}} license expires, the following occurs:

  • Write requests continue to be accepted and processed.
  • Compactions continue to optimize persisted data.
  • Query requests return an error.
  • If the {{< product-name >}} server stops, it will not restart without a valid, non-expired license.