cleanup
parent
db056fd69b
commit
186ab0fe14
66
README.md
66
README.md
|
@ -19,69 +19,3 @@ Cloudskiff tracks how well your IaC codebase covers your cloud configuration. Cl
|
||||||
- Allow users to **ignore** resources
|
- Allow users to **ignore** resources
|
||||||
- **Analyze diff** between consecutive runs, and warn about drift and unwanted unmanaged ressources
|
- **Analyze diff** between consecutive runs, and warn about drift and unwanted unmanaged ressources
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
#### Docker
|
|
||||||
|
|
||||||
```
|
|
||||||
docker run -it cloudskiff/cloudskiff
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Automated installation
|
|
||||||
|
|
||||||
```
|
|
||||||
curl https://cloudskiff.com/install.sh | sudo bash
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Manual installation
|
|
||||||
|
|
||||||
```
|
|
||||||
curl https://xxxx/clouskiff_amd64_linux -O /usb/bin/cloudskiff
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run coverage
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
$ export AWS_ACCESS_KEY_ID=XXXX
|
|
||||||
$ export AWS_SECRET_ACCESS_KEY=XXXX
|
|
||||||
$ export AWS_DEFAULT_REGION=eu-west-1
|
|
||||||
$ cloudskiff run coverage
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run diff from previous run
|
|
||||||
|
|
||||||
```
|
|
||||||
$ export AWS_ACCESS_KEY_ID=XXXX
|
|
||||||
$ export AWS_SECRET_ACCESS_KEY=XXXX
|
|
||||||
$ export AWS_DEFAULT_REGION=eu-west-1
|
|
||||||
$ cloudskiff run diff --previous-state=/my-previous-state.csstate > diff
|
|
||||||
$ cat diff | mail -s devops@foobar.com
|
|
||||||
```
|
|
||||||
|
|
||||||
## CI Integrations
|
|
||||||
|
|
||||||
### Circle CI
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
version: 2.1
|
|
||||||
jobs:
|
|
||||||
tests:
|
|
||||||
steps:
|
|
||||||
- run:
|
|
||||||
name: Run cloudskiff code coverage
|
|
||||||
command: cloudskiff run coverage
|
|
||||||
workflows:
|
|
||||||
push:
|
|
||||||
jobs:
|
|
||||||
- tests:
|
|
||||||
```
|
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
|
|
||||||
- More ressources support
|
|
||||||
- More cloud provider support
|
|
||||||
- ...
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue