TERRAFORM HONEYCOMBIO REFINERY-STARTER-PACK

This module creates resources like Boards (and someday Triggers and SLOs!) in Honeycomb to help you manage the health of your Refinery cluster

Use

You must have terraform installed. Follow these directions to install for your platform.

You will need a Honeycomb API key with the adequate permissions to create boards, queries etc.. Once you have the API key, you can set it like so:

The minimal config is:

module "explore-honeycombio-refinery-starter-pack" {
  source = "honeycombio/refinery-starter-pack/honeycombio"

  refinery_metrics_dataset = "Refinery Metrics" # Optional: defaults to "Refinery Metrics"
  refinery_logs_dataset = "Refinery Logs" # Optional: defaults to "Refinery Metrics"
  refinery_cluster_name = "Production" # Optional: defaults to "Production"
}

Set the API key used by Terraform setting the HONEYCOMB_API_KEY environment variable.

export HONEYCOMB_API_KEY=$HONEYCOMB_API_KEY

Now you can run terraform plan/apply in sequence.

For more config options, see USAGE.md .

Video Walkthrough

Note: Video is muted by default

HNY-SP-REFOPS.webm

Examples

Examples of use of this module can be found in examples/ . We've provided a build durations exploration example.

Development

Tests

Test cases that run against local code are in tests/ . To set up:

1. Set the API key used by Terraform setting the HONEYCOMB_API_KEY environment variable.

2. terraform plan and terraform apply will now work as expected, as will terraform destroy.

3. Test cases also run as part of the pipeline. See test-terraform-module.yml

Docs

Docs are autogenerated via ./docs.sh, and put in USAGE.md . Please regenerate and commit before merging.

Lints

We use tflint and terraform fmt, and enforce this with a github action.

Contributions

Features, bug fixes and other changes to this module are gladly accepted. Please open issues or a pull request with your change.

All contributions will be released under the Apache License 2.0.