driftctl/README.md

82 lines
3.5 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">
2021-12-06 16:00:54 +00:00
<img src="https://circleci.com/gh/snyk/driftctl.svg?style=shield"/>
<img src="https://goreportcard.com/badge/github.com/snyk/driftctl"/>
<img src="https://img.shields.io/github/license/snyk/driftctl">
<img src="https://img.shields.io/github/v/release/snyk/driftctl">
<img src="https://img.shields.io/github/go-mod/go-version/snyk/driftctl">
<img src="https://img.shields.io/github/downloads/snyk/driftctl/total.svg"/>
<a href="https://codecov.io/gh/snyk/driftctl">
<img src="https://codecov.io/gh/snyk/driftctl/branch/main/graph/badge.svg?token=8C5R02G5S7"/>
</a>
2021-12-06 16:00:54 +00:00
<img src="https://img.shields.io/docker/pulls/snyk/driftctl"/>
<img src="https://img.shields.io/docker/image-size/snyk/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>
2022-01-04 05:47:17 +00:00
<strong>IaC:</strong> Terraform. <strong>Cloud providers:</strong> AWS, GitHub, Azure, GCP.<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
<details>
<summary>Packaging status</summary>
<a href="https://repology.org/project/driftctl/versions">
<img src="https://repology.org/badge/vertical-allrepos/driftctl.svg" alt="Packaging status">
</a>
</details>
## Why driftctl ?
2020-09-25 19:01:23 +00:00
2021-04-13 13:20:46 +00:00
Infrastructure drift is a blind spot and a source of potential security issues.
2021-11-30 08:59:47 +00:00
Drift can have multiple causes: from team members creating or updating infrastructure through the web console without backporting changes to Terraform, to unexpected actions from authenticated apps and services.
2020-09-25 19:01:23 +00:00
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
2021-04-14 06:20:59 +00:00
Spot discrepancies as they happen: driftctl is a free and open-source CLI that warns of infrastructure drifts and fills in the missing piece in your DevSecOps toolbox.
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
2022-01-04 05:47:17 +00:00
## Links
**[Get Started](https://driftctl.com/product/quick-tutorial/)**
**[Documentation](https://docs.driftctl.com)**
2021-03-01 13:39:04 +00:00
**[Installation](https://docs.driftctl.com/installation)**
**[Discord](https://discord.gg/7zHQ8r2PgP)**
## 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-11-25 16:53:04 +00:00
Build with ❤️️ from 🇫🇷 🇬🇧 🇯🇵 🇬🇷 🇸🇪 🇺🇸 🇷🇪 🇨🇦 🇮🇱
2021-03-17 10:07:45 +00:00
2021-04-13 13:20:46 +00:00
## Helping you get started
2021-03-17 10:07:45 +00:00
2021-04-13 13:20:46 +00:00
We have 30 min slots for 1:1 [tech discussions and overviews](https://calendly.com/stephanejourdan/30min) twice a day to help you get started and collect users feedback.
2021-03-17 10:07:45 +00:00
2021-04-13 13:20:46 +00:00
Feel free to book a slot.
## Security notice
All Terraform state and Terraform files in this repository are for unit test
purposes only. No running code attempts to access these resources (except to
create and destroy them, in the case of acceptance tests). They are just opaque
strings.