driftctl/README.md

64 lines
3.0 KiB
Markdown
Raw Normal View History

<p align="center">
<img width="200" src="https://docs.driftctl.com/img/driftctl_dark.svg" alt="driftctl">
</p>
<p align="center">
2020-12-09 16:01:08 +00:00
<img src="https://circleci.com/gh/cloudskiff/driftctl.svg?style=shield"/>
<img src="https://goreportcard.com/badge/github.com/cloudskiff/driftctl"/>
<img src="https://img.shields.io/github/license/cloudskiff/driftctl">
<img src="https://img.shields.io/github/v/release/cloudskiff/driftctl">
<img src="https://img.shields.io/github/go-mod/go-version/cloudskiff/driftctl">
<img src="https://img.shields.io/github/downloads/cloudskiff/driftctl/total.svg"/>
<img src="https://img.shields.io/bintray/dt/homebrew/bottles/driftctl?label=homebrew"/>
2020-12-09 16:01:08 +00:00
<a href="https://codecov.io/gh/cloudskiff/driftctl">
<img src="https://codecov.io/gh/cloudskiff/driftctl/branch/main/graph/badge.svg?token=8C5R02G5S7"/>
</a>
<img src="https://img.shields.io/docker/pulls/cloudskiff/driftctl"/>
<img src="https://img.shields.io/microbadger/layers/cloudskiff/driftctl"/>
<img src="https://img.shields.io/docker/image-size/cloudskiff/driftctl"/>
2021-01-25 20:52:57 +00:00
<a href="https://discord.gg/NMCBxtD7Nd">
<img src="https://img.shields.io/discord/783720783469871124?color=%237289da&label=discord&logo=discord"/>
</a>
</p>
<p align="center">
2020-12-09 16:20:30 +00:00
Measures infrastructure as code coverage, and tracks infrastructure drift.<br>
<strong>IaC:</strong> Terraform, <strong>Cloud providers:</strong> AWS, GitHub (Azure and GCP on the roadmap for 2021).<br>
:warning: <strong>This tool is still in beta state and will evolve in the future with potential breaking changes</strong> :warning:
</p>
2020-09-25 19:01:23 +00:00
## Why driftctl ?
2020-09-25 19:01:23 +00:00
2020-09-28 14:57:08 +00:00
Infrastructure as code is awesome, but there are too many moving parts: codebase, state file, actual cloud state. Things tend to drift.
2020-09-25 19:01:23 +00:00
Drift can have multiple causes: from developers creating or updating infrastructure through the web console without telling anyone, to uncontrolled updates on the cloud provider side. Handling infrastructure drift vs the codebase can be challenging.
You can't efficiently improve what you don't track. We track coverage for unit tests, why not infrastructure as code coverage?
2020-09-25 19:01:23 +00:00
driftctl tracks how well your IaC codebase covers your cloud configuration. driftctl warns you about drift.
2020-09-25 19:01:23 +00:00
## Features
2020-09-25 19:01:23 +00:00
- **Scan** cloud provider and map resources with IaC code
- Analyze diffs, and warn about drift and unwanted unmanaged resources
2020-09-25 19:01:23 +00:00
- Allow users to **ignore** resources
2020-12-09 16:20:30 +00:00
- Multiple output formats
2020-09-25 19:01:23 +00:00
---
**[Get Started](https://driftctl.com/product/quick-tutorial/)**
**[Documentation](https://docs.driftctl.com)**
**[Discord](https://discord.gg/NMCBxtD7Nd)**
---
## Contribute
To learn more about compiling driftctl and contributing, please refer to the [contribution guidelines](.github/CONTRIBUTING.md) and the [contributing guide](docs/README.md) for technical details.
2021-02-01 13:30:58 +00:00
2021-02-02 18:02:56 +00:00
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification and is brought to you by these [awesome contributors](CONTRIBUTORS.md).
2021-02-09 16:53:06 +00:00
Build with ❤️️ from 🇫🇷 🇯🇵 🇬🇷 🇸🇪 🇺🇸