Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.28 KB

README.md

File metadata and controls

49 lines (31 loc) · 2.28 KB

terraform-provider-envbuilder

The terraform-provider-envbuilder is a Terraform provider that acts as a helper for setting up envbuilder environments.

It is used to determine if a pre-built image of a dev container built from a given Git repository is present in a given Docker registry. If it is found that building a particular dev container would produce the same image that is already present in the remote registry, then that image can be used to start the container instead, skipping over the build phase.

Note: currently, this provider can only be run on Linux platforms. We are investigating support for other platforms.

Usage

Take a look at the envbuilder_cached_image_resource.tf example for a detailed usage example.

For use with Coder, see the Dev Containers documentation and check out the example templates:

Requirements

Building The Provider

  1. Clone the repository
  2. Enter the repository directory
  3. Build the provider using the Go install command:
go install

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

make testacc