Documentation

Deploy the InfluxData Platform (TICK stack) in Docker containers

The quickest way to start using the InfluxDB 1.x platform (TICK stack) OSS is to download and deploy the InfluxData Sandbox. The InfluxData Sandbox uses Docker containers to deploy the InfluxData Platform components. The InfluxData Sandbox provides a containerized, ready-to-use TICK stack, built using Docker and Docker Compose, to capture data from your local machine and the Docker containers.

After deploying using the InfluxData Sandbox, you will have the latest versions of:

  • Telegraf
  • InfluxDB OSS
  • Chronograf
  • Kapacitor OSS

The InfluxData Sandbox is not recommended for production use.

Requirements

Download and run the Sandbox

The InfluxData Sandbox is open source and is available for download from Github. To download it, use git to clone the source repository:

# Clone the InfluxData Sandbox from Github
git clone https://github.com/influxdata/sandbox.git

The Sandbox repo includes a sandbox binary used to provision and manage the Sandbox’s containers and data. Run ./sandbox up from inside the sandbox directory to download the necessary images, then build and start all the required Docker containers.

# cd into the sandbox directory
cd sandbox

# Start the sandbox
./sandbox up

Make sure no other instances of TICK stack components are running on your local machine when starting the Sandbox. Otherwise you will run into port conflicts and the Sandbox won’t be able to start properly.

Once started, two tabs will open in your browser:

  1. Chronograf (localhost:8888)
  2. InfluxData Sandbox Documentation (localhost:3010)

Chronograf is the web-based user interface for the TICK stack and can be used to manage the stack. You can use Chronograf to:

Using nightly builds

The ./sandbox up command includes a -nightly option that will pull nightly builds for InfluxDB and Chronograf, giving you the most recent updates and experimental functionality.

Nightly builds are experimental and are not guaranteed to be functional.

./sandbox up -nightly

Interacting with the Sandbox TICK stack

With the Sandbox running, each component of the TICK stack is available to work with. The Sandbox documentation provides tutorials for interacting with each component. The documentation is available at localhost:3010/tutorials (with the Sandbox running) or on Github.

All configuration files, tools, and CLIs needed for managing each component of the TICK stack are included in their respective Docker containers. Tasks outlined throughout the InfluxData documentation can be accomplished using the InfluxData Sandbox.

The ./sandbox enter command opens a console inside the specified container where the project’s configuration files and CLIs are available.

# Pattern
./sandbox enter [ telegraf | influxdb | chronograf | kapacitor ]

# Example: console into the telegraf container
./sandbox enter telegraf

After updating a configuration file in a Sandbox container, use the ./sandbox restart command to restart the containers and apply the updated configuration.


Was this page helpful?

Thank you for your feedback!


Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.