documentation update after user feedback

updated doc following user feedback
main
Stephane Jourdan 2020-12-21 16:59:24 +01:00 committed by GitHub
commit 110813b504
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 4 deletions

View File

@ -45,39 +45,74 @@ driftctl is available on Linux, macOS and Windows.
Binaries are available in the [release page](https://github.com/cloudskiff/driftctl/releases).
#### Docker
```bash
docker run \
-v ~/.aws:/app/.aws:ro \
-v $(pwd)/terraform.tfstate:/app/terraform.tfstate:ro \
-v ~/.driftctl:/app/.driftctl \
-e AWS_REGION=us-east-1 \
-e AWS_PROFILE=cloudskiff \
cloudskiff/driftctl:v0.1.1 scan ## with the same option as the binary version
```
`-v ~/.aws:/app/.aws:ro` mount your .aws containing credentials and profile
`-v $(pwd)/terraform.tfstate:/app/terraform.tfstate:ro` mount your terraform state
`-v ~/.driftctl:/app/.driftctl` to prevent driftctl downloading the provider at each run, mount a directory to persist it
`-e AWS_PROFILE=cloudskiff` export the profile to use in you aws config
`-e AWS_PROFILE=cloudskiff` export the profile to use in your AWS config
`-e AWS_REGION=us-east-1` export the specific AWS region you want to use
`cloudskiff/driftctl:<VERSION_TAG>` run a specific driftctl tagged release
#### Manual
##### Linux
This is an example using `curl`. If you don't have `curl`, install it, or use `wget`.
```bash
# x64
curl https://github.com/cloudskiff/driftctl/releases/latest/download/driftctl_linux_amd64 | sudo tee /usr/local/bin/driftctl
curl -L https://github.com/cloudskiff/driftctl/releases/latest/download/driftctl_linux_amd64 -o driftctl
# x86
curl https://github.com/cloudskiff/driftctl/releases/latest/download/driftctl_linux_386 | sudo tee /usr/local/bin/driftctl
curl -L https://github.com/cloudskiff/driftctl/releases/latest/download/driftctl_linux_386 -o driftctl
```
Make the binary executable:
```bash
chmod +x driftctl
```
Optionally install driftctl to a central location in your `PATH`:
```bash
# use any path that suits you, this is just a standard example. Install sudo if needed.
sudo mv driftctl /usr/local/bin/
```
##### macOS
```bash
# x64
curl https://github.com/cloudskiff/driftctl/releases/latest/download/driftctl_darwin_amd64 | sudo tee /usr/local/bin/driftctl
curl -L https://github.com/cloudskiff/driftctl/releases/latest/download/driftctl_darwin_amd64 -o driftctl
```
Make the binary executable:
```bash
chmod +x driftctl
```
Optionally install driftctl to a central location in your `PATH`:
```bash
# use any path that suits you, this is just a standard example. Install sudo if needed.
sudo mv driftctl /usr/local/bin/
```
##### Windows