Repository files navigation

Terraform provider forCoder.

• Go
• Terraform

We recommend usingnix to manage your development environment. If you havenix installed, you can runnix develop to enter a shell with all the necessary dependencies.

Alternatively, you can install the dependencies manually.

Follow the instructions outlined in theTerraform documentationto setup your local Terraform to use your local version rather than the registry version.

1. Create a file named.terraformrc in your$HOME directory

2. Add the following content:

   provider_installation {# Override the coder/coder provider to use your local versiondev_overrides {"coder/coder" ="/path/to/terraform-provider-coder"     }# For all other providers, install them directly from their origin provider# registries as normal. If you omit this, Terraform will _only_ use# the dev_overrides block, and so no other providers will be available.direct {} }

3. (optional, but recommended) Validate your configuration:

   1. Create a newmain.tf file and include:

   terraform {required_providers {coder={            source="coder/coder"        }    }}

   2. Runterraform init and observe a warning likeWarning: Provider development overrides are in effect

4. Rungo build -o terraform-provider-coder to build the provider binary, which Terraform will try locate and execute

5. All local Terraform runs will now use your local provider!

6. NOTE: we vendor in this provider intogithub.com/coder/coder, so if you're testing with a local clone then you should also rungo mod edit -replace github.com/coder/terraform-provider-coder=/path/to/terraform-provider-coder in your clone.

To run Terraform acceptance tests, runmake testacc. This will test the provider against the locally installed version of Terraform.

Note: ourCI workflow runs a test matrix against multiple Terraform versions.

The tests under the./integration directory perform the following steps:

• Build the local version of the provider,
• Run an in-memory Coder instance with a specified version,
• Validate the behaviour of the local provider against that specific version of Coder.

To run these integration tests locally:

1. Pull the version of the Coder image you wish to test:

     docker pull ghcr.io/coder/coder:main-x.y.z-devel-abcd1234

2. RunCODER_VERSION=main-x.y.z-devel-abcd1234 make test-integration.

Note: you can specifyCODER_IMAGE if the Coder image you wish to test is hosted somewhere other thanghcr.io/coder/coder.For example,CODER_IMAGE=example.com/repo/coder CODER_VERSION=foobar make test-integration.