Skip to content
Reusable infrastructure modules for running TICK stack on AWS
HCL Shell Go
Branch: master
Clone or download
Latest commit caad556 Jul 11, 2019

README.md

Maintained by Gruntwork.io

TICK Stack AWS Module

This repo contains the official module for deploying the TICK stack on AWS using Terraform and Packer.

TICK multi-cluster architecture

Quick start

If you want to quickly spin up an InfluxDB cluster, you can run the simple example that is in the root of this repo. Check out influxdb-cluster-simple example documentation for instructions.

What's in this repo

This repo has the following folder structure:

  • root: The root folder contains an example of how to deploy InfluxDB as a single-cluster. See influxdb-cluster-simple for the documentation.
  • modules: This folder contains the main implementation code for this Module, broken down into multiple standalone submodules.
  • examples: This folder contains examples of how to use the submodules.
  • test: Automated tests for the submodules and examples.

How to use this repo

The general idea is to:

  • Telegraf

    1. Use the scripts in the install-telegraf modules to create an AMI with Telegraf installed, this AMI will generally be for the Application server.

    2. Configure each application server to execute the run-telegraf script during boot.

  • InfluxDB

    1. Use the scripts in the install-influxdb modules to create an AMI with InfluxDB Enterprise installed.

    2. Deploy the AMI across one or more Auto Scaling Groups (ASG) using the influxdb-cluster module.

    3. Configure each server in the ASGs to execute the run-influxdb script during boot.

    4. Deploy a load balancer in front of the data node ASG.

  • Chronograf

    1. Use the scripts in the install-chronograf modules to create an AMI with Chronograf installed.

    2. Deploy the AMI in a single Auto Scaling Group (ASG) using the chronograf-server module.

    3. Configure the server to execute the run-chronograf script during boot.

    4. Deploy a load balancer in front of the ASG.

  • Kapacitor

    1. Use the scripts in the install-kapacitor modules to create an AMI with Kapacitor installed.

    2. Deploy the AMI in a single Auto Scaling Group (ASG) using the kapacitor-server module.

    3. Configure the server to execute the run-kapacitor script during boot.

    4. Deploy a load balancer in front of the ASG.

See the examples folder for working sample code.

What's a Module?

A Module is a canonical, reusable, best-practices definition for how to run a single piece of infrastructure, such as a database or server cluster. Each Module is written using a combination of Terraform and scripts (mostly bash) and include automated tests, documentation, and examples. It is maintained both by the open source community and companies that provide commercial support.

Instead of figuring out the details of how to run a piece of infrastructure from scratch, you can reuse existing code that has been proven in production. And instead of maintaining all that infrastructure code yourself, you can leverage the work of the Module community to pick up infrastructure improvements through a version number bump.

Who maintains this Module?

This Module is maintained by Gruntwork. If you're looking for help or commercial support, send an email to modules@gruntwork.io. Gruntwork can help with:

  • Setup, customization, and support for this Module.
  • Modules for other types of infrastructure, such as VPCs, Docker clusters, databases, and continuous integration.
  • Modules that meet compliance requirements, such as HIPAA.
  • Consulting & Training on AWS, Terraform, and DevOps.

How do I contribute to this Module?

Contributions are very welcome! Check out the Contribution Guidelines for instructions.

How is this Module versioned?

This Module follows the principles of Semantic Versioning. You can find each new release, along with the changelog, in the Releases Page.

During initial development, the major version will be 0 (e.g., 0.x.y), which indicates the code does not yet have a stable API. Once we hit 1.0.0, we will make every effort to maintain a backwards compatible API and use the MAJOR, MINOR, and PATCH versions on each release to indicate any incompatibilities.

License

This code is released under the Apache 2.0 License. Please see LICENSE and NOTICE for more details.

Copyright © 2018 Gruntwork, Inc.

You can’t perform that action at this time.