Skip to content

Commit

Permalink
some basic docs (#4)
Browse files Browse the repository at this point in the history 
* some basic docs

* increase timeout
  • Loading branch information
Jack Lindamood authored Sep 7, 2022
1 parent 263790f commit 3202a3d
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 53 deletions.
1 change: 1 addition & 0 deletions .github/workflows/build.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ jobs:
uses: golangci/golangci-lint-action@v2
with:
version: latest
args: "--timeout 5m"
- name: Build
run: go build -mod=readonly ./cmd/atlantis-drift-detection/main.go
- name: Verify
Expand Down
66 changes: 66 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,68 @@
# atlantis-drift-detection
Detect terraform drift in atlantis

# What it does

The general workflow of this repository is:
1. Check out a mono repo of terraform code
2. Find an atlantis.yaml file inside the repository
3. Use atlantis to run /plan on each project in the atlantis.yaml file
4. For each project with drift
1. Trigger a github workflow that can resolve the drift
2. Comment the existance of the drift in slack
5. For each project directory in the atlantis.yamnl
1. Run workspace list
2. If any workspace isn't tracked by atlantis, notify slack

There is an optional flag to cache drift results inside DynamoDB so we don't check the same directory twice in a short period of time.

# Use as a github action

```yaml
name: Drift detection
on:
workflow_dispatch:
jobs:
drift:
name: detects drift
runs-on: [self-hosted]
steps:
- name: detect drift
uses: cresta/atlantis-drift-detection@v0.0.7
env:
ATLANTIS_HOST: atlantis.atlantis.svc.cluster.local
ATLANTIS_TOKEN: ${{ secrets.ATLANTIS_TOKEN }}
REPO: cresta/terraform-monorepo
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
DYNAMODB_TABLE: atlantis-drift-detection
WORKFLOW_OWNER: cresta
WORKFLOW_REPO: terraform-monorepo
WORKFLOW_ID: force_terraform_workflow.yaml
WORKFLOW_REF: master
GITHUB_APP_ID: 123456
GITHUB_INSTALLATION_ID: 123456
GITHUB_PEM_KEY: ${{ secrets.PR_CREATOR_PEM }}
CACHE_VALID_DURATION: 168h
```
# Configuration
| Environment Variable | Description | Required | Default | Example |
|--------------------------|----------------------------------------------------------------------------------|----------|----------------------------|---------------------------------------------------------------------|
| `REPO` | The github repo to check | Yes | | `cresta/terraform-monorepo` |
| `ATLANTIS_HOST` | The Hostname of the Atlantis server | Yes | | `atlantis.example.com` |
| `ATLANTIS_TOKEN` | The Atlantis API token | Yes | | `1234567890` |
| `WORKFLOW_OWNER` | The github owner of the workflow to trigger on drift | No | | `cresta` |
| `WORKFLOW_REPO` | The github repo of the workflow to trigger on drift | No | | `atlantis-drift-detection` |
| `WORKFLOW_ID` | The ID of the workflow to trigger on drift | No | | `drift.yaml` |
| `WORKFLOW_REF` | The git ref to trigger the workflow on | No | | `master` |
| `DIRECTORY_WHITELIST` | A comma separated list of directories to check | No | | `terraform,modules` |
| `SLACK_WEBHOOK_URL` | The Slack webhook URL to post updates to | No | | `https://hooks.slack.com/services/1234567890/1234567890/1234567890` |
| `SKIP_WORKSPACE_CHECK` | Skip checking if the workspace have drifted | No | `false` | `true` |
| `PARALLEL_RUNS` | The number of parallel runs to use | No | `1` | `10` |
| `DYNAMODB_TABLE` | The name of the DynamoDB table to use for caching results | No | `atlantis-drift-detection` | `atlantis-drift-detection` |
| `CACHE_VALID_DURATION` | The duration that previous results are still valid | No | `24h` | `180h` |
| `GITHUB_APP_ID` | An application ID to use for github API calls | No | | `123123` |
| `GITHUB_INSTALLATION_ID` | An application install ID to use for github API calls | No | | `123123` |
| `GITHUB_PEM_KEY` | A GitHub PEM key of an application, used to authenticate the app for API calls | No | | `1231DEADBEAF....` |
54 changes: 1 addition & 53 deletions action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,58 +3,6 @@ description: 'Some automation to detect drift inside atlantis via the remote /pl
branding:
icon: 'activity'
color: 'blue'
inputs:
atlantisHost:
description: 'Atlantis hostname with protocol. Example: "https://atlantis.company.com'
required: true
atlantisToken:
description: 'Atlantis API token'
required: true
repo:
description: 'Repository to check'
required: true
slackWebhookURL:
description: 'Slack webhook URL to send notifications to'
required: false
skipWorkspaceCheck:
description: 'If true, skip the workspace/ls check'
required: false
default: "false"
parallelRuns:
description: 'If set, will run this many parallel plan/init commands'
required: false
default: "1"
directoryWhitelist:
description: 'If set, will only run for this directory'
required: false
dynamodbTable:
description: 'If set, will cache results in dynamodb'
required: false
workflowOwner:
description: 'If set, will run this workflow on drifts. Example: "cresta"'
required: false
workflowRepo:
description: 'If set, will run this workflow on drifts. Example: "terraform-repo"'
required: false
workflowId:
description: 'If set, will run this workflow on drifts. Example: "drift.yaml"'
required: false
workflowRef:
description: 'If set, will run this workflow on this branch. Example: "master"'
required: false
runs:
using: 'docker'
image: 'Dockerfile'
env:
ATLANTIS_HOST: ${{ inputs.atlantisHost }}
ATLANTIS_TOKEN: ${{ inputs.atlantisToken }}
REPO: ${{ inputs.repo }}
SLACK_WEBHOOK_URL: ${{ inputs.slackWebhookURL }}
SKIP_WORKSPACE_CHECK: ${{ inputs.skipWorkspaceCheck }}
DIRECTORY_WHITELIST: ${{ inputs.directoryWhitelist }}
PARALLEL_RUNS: ${{ inputs.parallelRuns }}
DYNAMODB_TABLE: ${{ inputs.dynamodbTable }}
WORKFLOW_OWNER: ${{ inputs.workflowOwner }}
WORKFLOW_REPO: ${{ inputs.workflowRepo }}
WORKFLOW_ID: ${{ inputs.workflowId }}
WORKFLOW_REF: ${{ inputs.workflowRef }}
image: 'Dockerfile'

0 comments on commit 3202a3d

Please sign in to comment.