Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reulan/clairvoyance
Drift detection and reporting for Terraform.
https://github.com/reulan/clairvoyance
cookiecutter-golang detection drift terraform terraform-exec
Last synced: 3 months ago
JSON representation
Drift detection and reporting for Terraform.
- Host: GitHub
- URL: https://github.com/reulan/clairvoyance
- Owner: reulan
- License: mit
- Created: 2020-05-08T05:18:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-25T06:43:01.000Z (over 3 years ago)
- Last Synced: 2024-05-28T01:04:12.977Z (6 months ago)
- Topics: cookiecutter-golang, detection, drift, terraform, terraform-exec
- Language: Go
- Homepage:
- Size: 94.7 KB
- Stars: 26
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clairvoyance
Drift detection and reporting for Terraform.
THIS TOOL IS A WORK IN PROGRESS AND MAY NOT WORK AS DESCRIBED BELOW
When ready for production use stable binaries will be released as GitHub versions and correlated docker tags will be available to pull from the specified registry.
## Overview
Currently, the `clairvoyance` software does the following:
- Allows running of Terraform commands for specified working directory.
- Show the statefile information and if any changes are detected.
- Reporting to standard output as a table
- Terraform Report stats (added/changed/deleted, total projects, versions, etc)
- Clarivoyance metadata (how long it takes for a plan or report to be completed + app metrics)
In the future I would like to support:
- Identifies installed version of Terraform or installs specified version.
- Planning multiple states across backends
- Terraform project detection (local file, atlantis.yaml, Terraform Cloud workspaces)
- Generate HCL code suggestions
- Report to other mediums (Discord, Slack, IRC, email)
### Preview (Screenshots + Video)
#### Hashicorp Holiday Hackstravaganza
This screenshot comes from my [submission and work done for the HashiCorp Holiday Hackstravaganza](https://discuss.hashicorp.com/t/team-reulan/19347):
[Hackathon Presentation](https://www.youtube.com/watch?v=p5ozPq2QEZE)
#### HashiTalks 2021
[Terraform Drift Detection and Reporting](https://www.hashicorp.com/resources/terraform-drift-detection-reporting)
## Project setup
Ensure Golang is installed and configured.
### Setting Environment variables
The following environment variables will need to be set for `clairvoyance` to run:
- `CLAIRVOYANCE_TERRAFORM_VERSION` (version of Terraform to use)
- `CLAIRVOYANCE_PROJECT_DIR` (path to terraform service to plan) // where directories containing .*tf files will be cloned
- `DISCORD_WEBHOOK_CHANNEL` (just a string, typically the discord channel name. e.x. `#clairvoyance`)
- `DISCORD_WEBHOOK_SECRET`
The Discord secret expects to contain everything after the webhooks route:
`https://discordapp.com/api/webhooks/$DISCORD_WEBHOOK_SECRET`
### Locally building an image
To reinitialize the modules and recreate the dependency tree the following can be done:
- `make deps`
- `make check-env-vars` (in order to see if you have properly configured your system to work with clairvoyance.)
### Setup Terraform Version via Binary (optional)
In order for `clairvoyance` to run, a path to a Terraform binary must be specified.
Currently the application will look in it's own directory at the `./tfinstall` directory.
```
make tfinstall
```
This will dowload the version assocaited with `CLAIRVOYANCE_TERRAFORM_VERSION`.
If `make tfinstall` is not used, then Clarivoyance will fall back to the binary specified on `/usr/bin/terraform`.
### Build and Run
When a report is generated via `make`, the binary will be build before executed.
```
make report-stdout
OR
make report-discord
```
These commands are wrappers around the CLI tool, examples:
- `clairvoyance report
- `clairvoyance report --output discord
## Development
### Update Version
Modify `version/version.go` and add a major, minor or patch version based off contributions.
### Notable packages
Packages can be downloaded from public GitHub repositories, like so:
`go get https://github.com/$USER/$REPO`
Modules that are intended to be used are documented below.
- [hclwrite](https://github.com/hashicorp/hcl/tree/v2.0.0/hclwrite) - write HCL on the fly
- [terrafmt](https://github.com/terrycain/terrafmt) - format the HCL output, if live update is used
- [terraform-exec](https://github.com/kmoe/terraform-exec) - so we can init/plan/apply via the Terraform CLI programmatically.
- [tfvar](https://github.com/shihanng/tfvar) - programatic definition and generation of variables based on user input
## Additional information
This repository was bootstrapped with [cookiecutter-golang](https://github.com/lacion/cookiecutter-golang).