Install the InfluxData Sandbox

The InfluxData Sandbox is the quickest way to get the OSS TICK stack up and running and ready for exploration and testing. It uses Docker and Docker Compose to build a containerized, ready-to-use TICK stack preconfigured to capture data from your local machine and the Sandbox’s Docker containers.

The Sandbox is by far the easiest way to build the TICK stack, but it 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 git@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-base user-interface for the TICK stack and is, for many, the primary tool used to manage the stack. It allows you to query and explore data, create Kapacitor alerts, preview data visualizations, build custom dashboards, etc.

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.

This documentation is open source. See a typo? Please, open an issue.

Need help getting up and running? Get Support