README.md

tfe-drift

Introduction

Automated Terraform Cloud/Enterprise drift detection.

Features

• Automate the execution of drift detection plans.
• Limit executed drift detection plans (used to avoid long plan queues with available workers).
• Sort drift detection plans by previous detections age.
• Filter drift detections by workspace.
• Ignore if drift detection plan not required (already running, executed recently...)
• Result of the detection plans summary as output to automate with other apps.
• Two running modes: controller mode (intervals), single run (for CI and crons).
• Easy to automate with CI (It comes with a ready to use Github action).
• Prometheus metrics exporter for drift detections (in controller mode).
• Compatible with Terraform Cloud and Terraform Enterprise.
• Easy and simple to use.

Getting started

2 variables are required by default:

• Terraform cloud/enterprise API token: Use --tfe-token or TFE_DRIFT_TFE_TOKEN env var.
• Terraform cloud/enterprise organization: Use --tfe-organization or TFE_DRIFT_TFE_ORGANIZATION env var.

Single run mode

tfe-drift run --limit-max-plans 5

Controller mode

tfe-drift controller --limit-max-plans 5

Install

Binary

Get the binary from the releases.

Docker

You can use the released docker images.

docker run --rm -it -e TFE_DRIFT_TFE_TOKEN=${TFE_DRIFT_TFE_TOKEN} ghcr.io/slok/tfe-drift:latest run --help

Usage

Controller

If you want to let tfe-drift run as a long-running process triggering drift-detections at regular intervals, use controller mode.

tfe-drift controller --detect-interval 5m --limit-max-plan 1

Single run with github actions

You can use tfe-drift github action

name: drift-detection

on:
  schedule:
    - cron:  '0 * * * *' # Every hour.

jobs:
  drift-detection:
    runs-on: ubuntu-latest
    steps:
      - uses: slok/tfe-drift-action@v0.3.0
        id: tfe-drift
        with:
          tfe-token: ${{ secrets.TFE_TOKEN }}
          tfe-org: slok
          limit-max-plans: 3 # Avoid queuing lots of speculative plans.
          not-before: 24h # A drift detection per day it's enough.

Github action will write a job summary with the executed drift detections results:

Use cases

Execute single run in dry run mode to see what would be the workspaces affected:

tfe-drift run --dry-run

Execute single run with safe defaults and get the result output in JSON:

tfe-drift run -o json

Execute single run limiting to a max of 2 executed plans, ignore workspace drift detections that have been already executed in the last 2h, and exclude dns workspace:

tfe-drift run --exclude dns --not-before 2h --limit-max-plan 2

Execute the controller with an interval of 5m with a limit of 1 on the workspaces labelled with enable-drift-detection:

tfe-drift controller --detect-interval 5m --limit-max-plan 1 --include-tag enable-drift-detection

Execute the controller as only prometheus metrics exporter:

tfe-drift controller --disable-drift-detector

Metrics

As an example lets use this alerting rule query that alerts on drifts happened in the last half hour:

max by (organization_name, workspace_name, run_url) (
    (
        tfe_drift_workspace_drift_detection_state{state="drift"} > 0
      and on (workspace_name)
        (time() - tfe_drift_workspace_drift_detection_create) < 1800
    )
  * on (workspace_name) group_right ()
    tfe_drift_workspace_info
)

Explanation:

• tfe_drift_workspace_drift_detection_state{state="drift"} > 0: Give me the workspaces that are in drift state (we could ask also for drift_plan_error).
• (time() - tfe_drift_workspace_drift_detection_create) < 1800: Give me the workspaces that had a drift detection in the last 30m.
• * on (workspace_name) group_right () tfe_drift_workspace_info: Add all the labels to the workspaces that meet the previous queries (state and recently drift detection).
• max by (organization_name, workspace_name, run_url): We only want those 3 labels, so we drop them by using aggregation (we could use, min, sum... doesn't matter as we don't use the value).

F.A.Q

How is a drift detection executed?

It's a terraform speculative plan using the configured latest terraform workspace source code (normally main branch on the specified repository and directory).

How does it work?

When tfe-drift is executed it runs with an specific identifier (--app-id, by default tfe-drift).

All the drift detections that tfe-drift runs using TFE API, will be identified by this ID on the plan message.

From now on, it will use this ID to get the workspaces drift detection plans and use these information to decide the result or if needs to run again or not on next executions.

If the executed drift detection terraform plan has changes, its a drift!

Why? Hashicorp recently announced Drift detection

Terraform cloud offers it's own drift detector(Looks awesome!), however, this feature it's not available for non "Business" tiers.

Why limit the plans?

Sometimes Terraform cloud execution workers are busy or you have a few of them (even 1!). To avoid filling a huge queue with drift detections and block Terraform cloud usage... you can use the limit pattern:

Limit per execution and schedule multiple tfe-drift runs over the day. The result would be the same as without limiting except blocking your Terraform cloud workers for hours: At the end of the day, all your workspaces have been checked.

How does tfe-drift schedule drift detections?

Using a combination of different strategies:

• Don't run already running/queued drift detection runs.
• Don't run the workspaces where the drift detections has been executed in the last T time (e.g: 12h).
• Prioritizing the workspaces with oldest drift detections or without previous ones.

Single run VS controller modes

Single run

Single run is perfect for CI and crons, if you don't have a runtime to run it or you have a simple use case (e.g: few workspaces), this is the mode for you, however, take into account that you will depend on a second system that will schedule the drift-detection runs. Also if you pay for CI minutes, this may be more expensive.

• Pros:
  • Doesn't require a runtime, CI can be used.
• Cons:
  • Pricing (may be expensive).
  • Lack of small time scheduling (Depends on the CI/cron system).

Controller

If you have a cluster or a place that you can deploy long-running apps without hassle, the controller mode could be better, as you can schedule faster and smaller drift-detections (every 5m, limit of 1).

• Pros:
  • Smaller drift-detection intervals.
  • Out of the box Prometheus metrics.
• Cons:
  • Requires a runtime.

Mix

Regarding the metrics, although the controller mode is the one that runs a prometheus exporter to get information for the drift detections, this can be run without the drift-detector by using --disable-drift-detector. So someone could run the drift-detections with the CI using single runs, and then setup the controller mode to run as a only metrics-exporter.

This use case is not very common, although may be useful in some cases.

Can be used with CI and crons (e.g: github action)?

You should! :) You even have a ready to use github action.

It has been designed with that in mind:

Having a cron job that executes tfe-drift regularly (e.g 1h) with a limited number of plans at the same time.

At the end of the day, all your workspaces should have been checked. tfe-drift will handle the scheduling logic so it's safe to be run at regular intervals.

It will return a json output summary so you can use it to notify or extend with other CI steps or actions.

Exit codes?

• 0: If everything is as it should.
• 1: If there was an error executing tfe-drift.
• 2: If there was any drift.
• 3: If there was any error on a drift detection plan.

Optionally you can disable 2 and 3 exit codes in case you want to handle the drif/detection errors with the JSON summary by pipelining other applications or scripting.

Output formats?

By default, only the logger information will be written, however you can use -o to select an output format, the ones available are:

• json: Non-indenten JSON.
• pretty-json: Indented JSON.

Result JSON format?

Look at this example:

{
        "workspaces": {
                "wk1": {
                        "name": "wk1",
                        "id": "ws-RAB2YhfV7mpXUTW1",
                        "tags": [
                                "t1"
                        ],
                        "drift_detection_run_id": "run-BQHxAamo7pSi1iMf",
                        "drift_detection_run_url": "https://app.terraform.io/app/user1/workspaces/wk1/runs/run-BQHxAamo7pSi1iMf",
                        "drift": false,
                        "drift_detection_plan_error": false,
                        "ok": true
                },
                "wk2": {
                        "name": "wk2",
                        "id": "ws-vz46xzDKYWpfa5o8",
                        "tags": [
                                "t1",
                                "t4"
                        ],
                        "drift_detection_run_id": "run-8AgmNBY2MfKeyjGt",
                        "drift_detection_run_url": "https://app.terraform.io/app/user1/workspaces/wk2/runs/run-8AgmNBY2MfKeyjGt",
                        "drift": false,
                        "drift_detection_plan_error": false,
                        "ok": true
                },
                "wk3": {
                        "name": "wk3",
                        "id": "ws-qaCmR6EL8fujrxxY",
                        "tags": [
                                "t2",
                                "t3"
                        ],
                        "drift_detection_run_id": "run-ndhST1LXMh7tn3L5",
                        "drift_detection_run_url": "https://app.terraform.io/app/user1/workspaces/wk3/runs/run-ndhST1LXMh7tn3L5",
                        "drift": true,
                        "drift_detection_plan_error": false,
                        "ok": false
                },
                "wk4": {
                        "name": "wk4",
                        "id": "ws-df3PN4CX3grHghE9",
                        "tags": [
                                "t1",
                                "t3"
                        ],
                        "drift_detection_run_id": "run-Nwy7911XPX4qcwWu",
                        "drift_detection_run_url": "https://app.terraform.io/app/user1/workspaces/wk4/runs/run-Nwy7911XPX4qcwWu",
                        "drift": false,
                        "drift_detection_plan_error": false,
                        "ok": true
                }
        },
        "drift": true,
        "drift_detection_plan_error": false,
        "ok": false,
        "created_at": "2022-11-14T17:59:55.946884748Z"
}