codecentric / terraform-provider-leanix

This is a custom Terraform provider to manage LeanIX resources.

Terraform Provider LeanIX

Description

This is a custom Terraform provider to manage LeanIX resources.

Provider Configuration

The LeanIX provider requires a valid LeanIX URL and an API key to authenticate. Please make sure that the API key has the required permissions to manage the resources you want to use. You can either set the URL and API token directly in the provider, or use the environment variables.

terraform {
  required_version = ">= 0.13"

  required_providers {
    leanix = {
      source  = "codecentric/leanix"
      version = "1.0.0"
    }
  }
}

provider "leanix" {
  url         = "https://eu-svc.leanix.net"                        # = LEANIX_URL
  auth_header = "Basic ${base64encode("apitoken:YOUR_API_TOKEN")}" # = LEANIX_AUTH_HEADER
}

Supported Resources

Webhook Subscription

The webhook subscription resource is used to manage webhook subscriptions in LeanIX. For more information please refer to the official webhooks documentation or API reference.

Example

resource "leanix_webhook_subscription" "example" {
  identifier           = "mySubscription"
  ignore_error         = true
  target_url           = "https://company.domain/my-endpoint"
  target_method        = "POST"
  authorization_header = "Basic dXNlcjpwYXNzCg=="
  callback             = "delivery.payload = { payload: \"foo\" };"
  workspace_constraint = "ANY"
  payload_mode         = "WRAPPED_EVENT"
  active               = true
  workspace_id         = "aa32abbf-8093-410d-a090-10c7735952cf"

  tag_set {
    tag {
      value = "pathfinder"
    }
    tag {
      value = "FACT_SHEET_CREATED"
    }
  }

  tag_set {
    tag {
      value = "pathfinder"
    }
    tag {
      value = "FACT_SHEET_UPDATED"
    }
  }
}

Building from Source

1. Install dependencies with go get
2. Execute tests with go test ./...
3. Execute acceptance tests (optional)

   LEANIX_AUTH_HEADER="<leanix_auth_header>" \
   LEANIX_URL="<leanix_url>" \
   TF_ACC=1 \
   go test -v ./...

4. Package provider executable with go build

Release

To release a new version of the provider you need to add a git tag in the form of v${x}.${y}.${z}, e.g. v1.2.3. Pre-release tags are also supported (v1.1.2-rc1, v2.0.0-alpha1).

After pushing the tags the binaries will be built and published automatically as a GitHub release by GitHub Actions.

git checkout master
git pull origin master
git tag -a v2.8.1
git push origin master --tags

Terraform Registry

When publishing the provider on the Terraform Registry the release artifacts are signed with a GPG private key and then validated by Terraform with the public key.

The private key is set as a GitHub secret (GPG_PRIVATE_KEY) with a passphrase (PASSPHRASE). The secrets are stored in the codecentric shared 1Password safe.

To update the GPG public key in the Terraform Registry you need to be owner of the GitHub organisation.