Set up InfluxDB Cloud Dedicated

As you get started with this tutorial, do the following to make sure everything you need is in place.

• Request an InfluxDB Cloud Dedicated cluster
• Download, install, and configure the influxctl CLI
• Create a database
• Create a database token
• Configure authentication credentials

Request an InfluxDB Cloud Dedicated cluster

Contact the InfluxData Sales team to request an InfluxDB Cloud Dedicated cluster. When your cluster is deployed, your InfluxData account representative provides the following:

• An Auth0 login to authenticate access to your cluster
• Your InfluxDB Cloud Dedicated account ID
• Your InfluxDB Cloud Dedicated cluster ID
• Your InfluxDB Cloud Dedicated cluster URL

Download, install, and configure the influxctl CLI

The influxctl CLI provides a simple way to manage your InfluxDB Cloud Dedicated cluster from a command line. It lets you perform administrative tasks such as managing databases and tokens.

1. Download and install the influxctl CLI.

2. Create a connection profile and provide your InfluxDB Cloud Dedicated connection credentials.

   The influxctl CLI uses connection profiles to connect to and authenticate with your InfluxDB Cloud Dedicated cluster.

   Create a file named config.toml at the following location depending on your operating system.

   Operating system	Default profile configuration file path
   Linux	~/.config/influxctl/config.toml
   macOS	~/Library/Application Support/influxctl/config.toml
   Windows	%APPDATA%\influxctl\config.toml

   If stored at a non-default location, include the --config flag with each influxctl command and provide the path to your profile configuration file.

   Copy and paste the sample configuration profile code into your config.toml and replace the following with your InfluxDB Cloud Dedicated credentials:

   • ACCOUNT_ID: Your account ID
   • CLUSTER_ID: Your cluster ID

[[profile]]
  name = "default"
  product = "dedicated"
  account_id = "
ACCOUNT_ID
"
  cluster_id = "
CLUSTER_ID
"

For detailed information about influxctl profiles, see Configure connection profiles.

Create a database

Use the 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”.

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-period 
1y
 
get-started

Create a database token

Use the 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-database Grants write access to a database
• Token description

influxctl token create \
  --read-database 
get-started
 \
  --write-database 
get-started
 \
  "Read/write token for 
get-started
 database"

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.

Configure authentication credentials

Code samples in later sections assume you assigned the token string to an INFLUX_TOKEN environment variable–for example:

export INFLUX_TOKEN=
DATABASE_TOKEN

$env:INFLUX_TOKEN = "
DATABASE_TOKEN
"

set INFLUX_TOKEN=
DATABASE_TOKEN
 
# Make sure to include a space character at the end of this command.

Replace DATABASE_TOKEN with your database token string.