Install

The provider is not on the public Terraform Registry. Build terraform-provider-platform from this repository and point Terraform or OpenTofu at that binary.

The plugin address is registry.terraform.io/cloud/platform.

Build

Needs Go 1.25+. From the repository root:

make build-tf

That writes bin/terraform-provider-platform. Do not rename the file — Terraform and OpenTofu look up the provider by that name.

Local override

dev_overrides skips the registry and loads the binary from bin/.

macOS

Terraform reads ~/.terraformrc. OpenTofu reads ~/.tofurc. Use the same block in either file.

provider_installation {
  dev_overrides {
    "registry.terraform.io/cloud/platform" = "/ABS/PATH/TO/THIS/REPO/bin"
  }
  direct {}
}

Replace /ABS/PATH/TO/THIS/REPO with the checkout path. Apple Silicon and Intel both work after make build-tf on that machine.

Linux

Terraform reads ~/.terraformrc. OpenTofu reads ~/.tofurc. Use the same block in either file.

provider_installation {
  dev_overrides {
    "registry.terraform.io/cloud/platform" = "/ABS/PATH/TO/THIS/REPO/bin"
  }
  direct {}
}

Replace /ABS/PATH/TO/THIS/REPO with the checkout path.

Windows

Terraform reads %APPDATA%\terraform.rc. OpenTofu reads %APPDATA%\tofu.rc. Use the same block in either file.

provider_installation {
  dev_overrides {
    "registry.terraform.io/cloud/platform" = "C:\\ABS\\PATH\\TO\\THIS\\REPO\\bin"
  }
  direct {}
}

Replace the path with the checkout. Build with make build-tf (or go build -o bin/terraform-provider-platform ./provider-terraform) from a developer prompt that has Go on PATH.

With dev_overrides in place, version in required_providers is ignored.

terraform {
  required_providers {
    platform = {
      source = "cloud/platform"
    }
  }
}

provider "platform" {
  endpoint = "127.0.0.1:9090"
  token    = var.platform_token
  app      = "app_default"
}

Set PLATFORM_TOKEN (or pass token) before terraform apply / tofu apply. The apiserver must be reachable on the gRPC endpoint.