Terraform provider for Forgeplane

The Forgeplane Terraform provider is intended to manage Forgeplane platform resources as code with Terraform or OpenTofu. Its source is maintained separately from the coordinator and this documentation site.

Availability

The provider is currently source-only and unreleased. The private repository has no published tags, GitHub releases, public Terraform Registry entry, or documented provider-mirror installation contract. It is not an anonymous public download, and this page is not an installation guide.

• Private provider source — access required
• Request Forgeplane private beta access

Do not assume that repository access makes terraform init or tofu init able to resolve the provider. Before use, obtain an explicit supported binary, version, checksum, and Terraform/OpenTofu resolver or mirror configuration from the Forgeplane beta program. Until that contract exists, treat the provider source as an engineering reference only.

Configure the provider

The provider accepts two configuration values:

• endpoint: the Forgeplane HTTP endpoint. It defaults to http://localhost:8080 when no value or FORGEPLANE_ENDPOINT is set. The endpoint must include a URL scheme and host.
• api_key: the Forgeplane API key. It can also be supplied through FORGEPLANE_API_KEY. The provider treats it as sensitive and requires a non-empty value when it creates the API client.

Keep the key in Terraform input handling or your CI secret store. Do not commit it to .tf files, plan output, or a repository.

variable "forgeplane_endpoint" {
  type        = string
  description = "Forgeplane API endpoint"
}

variable "forgeplane_api_key" {
  type        = string
  sensitive   = true
  description = "Forgeplane API key"
}

provider "forgeplane" {
  endpoint = var.forgeplane_endpoint
  api_key  = var.forgeplane_api_key
}

The provider sends the key as X-API-Key. Direct REST clients use the same header; see Authentication for the platform authentication boundary.

Before a first plan

The configuration above becomes usable only after the beta program supplies a supported provider artifact and resolver or mirror contract.

1. Confirm private beta access and obtain the exact provider binary, version, checksum, and installation configuration.
2. Verify that the supplied provider build is compatible with the deployed coordinator release.
3. Configure the endpoint and API key through provider variables or the documented environment variables.
4. Define only resources confirmed by the supplied provider build.
5. Run terraform init or tofu init with the supplied resolver or mirror configuration, then verify the selected provider version and checksum.
6. Run terraform plan or tofu plan and review the proposed platform changes.
7. Apply only after checking the plan, the target organization/team scope, and the identity’s permissions.

The current source implements platform resources such as teams, projects, environments, templates, connections, service accounts, webhooks, and drift monitors. Generated data sources also expose read-only platform and run information. Source coverage is not a published compatibility promise; check the exact beta artifact and coordinator combination before use.

Troubleshooting

• A missing or empty API key fails provider configuration. Check api_key and FORGEPLANE_API_KEY without printing the value.
• An endpoint without a scheme or host is invalid. Use a complete URL such as https://forgeplane.example/.
• A valid key can still receive an authorization failure. Check organization membership, team scope, and the required action permissions in Permissions and roles.
• Provider source and coordinator releases are independent. Confirm the exact beta artifact and coordinator compatibility before upgrading either side.

The provider manages Forgeplane control-plane resources. It does not replace the coordinator’s worker scheduling, approval policy, run execution, or managed-state contracts.