Set up InfluxDB Clustered
InfluxDB Clustered is currently only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.
As you get started with this tutorial, do the following to make sure everything you need is in place.
- Install and configure your InfluxDB cluster
- Download, install, and configure the influxctl CLI
- Create a database
- Create a database token
- Configure authentication credentials
Install and configure your InfluxDB cluster
InfluxDB Clustered installation instructions are coming soon.
Download, install, and configure the influxctl CLI
provides a simple way to manage your InfluxDB cluster from a
command line. It lets you perform administrative tasks such as managing
databases and tokens.
Create a connection profile and provide your InfluxDB Clustered connection credentials.
influxctlCLI uses connection profiles to connect to and authenticate with your InfluxDB cluster.
Create a file named
config.tomlat the following location depending on your operating system.
Operating system Default profile configuration file path Linux
If stored at a non-default location, include the
--configflag with each
influxctlcommand and provide the path to your profile configuration file.
Copy and paste the sample configuration profile code into your
config.tomland replace the following with your InfluxDB Clustered credentials:
PORT: the port to use to access your InfluxDB cluster
OAUTH_CLIENT_ID: the client URL of your OAuth2 provider (for example:
OAUTH_DEVICE_ID: the device URL of your OAuth2 provider (for example:
[[profile]] name = "default" product = "clustered" host = "cluster-host.com" port = "PORT" [profile.auth.oauth2] client_id = "OAUTH_CLIENT_ID" scopes = [""] token_url = "OAUTH_TOKEN_URL" device_url = "OAUTH_DEVICE_URL"
For detailed information about
influxctl profiles, see
Configure connection profiles.
Create a database
influxctl database create command
to create a database. You can use an existing database or create a new one
specifically for this getting started tutorial.
Examples in this getting started tutorial assume a database named “get-started”.
Authenticate with your cluster
The first time you run an
influxctl CLI command, you are directed
to login to your OAuth provider. Once logged in, your OAuth provider issues
a short-lived (1 hour) management token for the
influxctl CLI that grants
administrative access to your InfluxDB cluster.
Provide the following:
- Database name.
- Optional: Database retention period as a duration value. If no retention period is specified, the default is infinite.
influxctl database create --retention-period1yget-started
Create a database token
influxctl token create command
to create a database token with read and write permissions for your database.
Provide the following:
- Permission grants
--read-database: Grants read access to a database
--write-databaseGrants write access to a database
- Token description
influxctl token create \ --read-databaseget-started\ --write-databaseget-started\ "Read/write token forget-starteddatabase"
The command returns the token ID and the token string. Store the token string in a safe place. You’ll need it later. This is the only time the token string is available in plain text.
Store secure tokens in a secret store
Token strings are returned only on token creation. We recommend storing database tokens in a secure secret store. For example, see how to authenticate Telegraf using tokens in your OS secret store.
Configure authentication credentials
Code samples in later sections assume you assigned the token string to an
INFLUX_TOKEN environment variable–for example:
$env:INFLUX_TOKEN = "DATABASE_TOKEN"
set INFLUX_TOKEN=DATABASE_TOKEN# Make sure to include a space character at the end of this command.
DATABASE_TOKEN with your database token string.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.