Envbuilder

Author: mafredri

.gitignore

@@ -33,3 +33,5 @@ website/vendor
 
 # Keep windows files with windows line endings
 *.winfile eol=crlf
+
+terraform-provider-envbuilder

CHANGELOG.md

@@ -1,6 +1,19 @@
 default: testacc
 
+test: testacc
+
 # Run acceptance tests
 .PHONY: testacc
 testacc:
 	TF_ACC=1 go test ./... -v $(TESTARGS) -timeout 120m
+
+fmt: examples/*/*.tf
+	terraform fmt -recursive
+
+gen:
+	go generate
+
+build: terraform-provider-envbuilder
+
+terraform-provider-envbuilder: internal/provider/*.go main.go
+	CGO_ENABLED=0 go build .

GNUmakefile

@@ -1,23 +1,11 @@
-# Terraform Provider Scaffolding (Terraform Plugin Framework)
+# terraform-provider-envbuilder
 
-_This template repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework). The template repository built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk) can be found at [terraform-provider-scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding). See [Which SDK Should I Use?](https://developer.hashicorp.com/terraform/plugin/framework-benefits) in the Terraform documentation for additional information._
-
-This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
-
-- A resource and a data source (`internal/provider/`),
-- Examples (`examples/`) and generated documentation (`docs/`),
-- Miscellaneous meta files.
-
-These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the [HashiCorp Developer](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework) platform. _Terraform Plugin Framework specific guides are titled accordingly._
-
-Please see the [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for how to create a new repository from this template on GitHub.
-
-Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://developer.hashicorp.com/terraform/registry/providers/publishing) so that others can use it.
+The `terraform-provider-envbuilder` is a Terraform provider that acts as a helper for setting up [`envbuilder`](https://envbuilder.sh) environments.
 
 ## Requirements
 
 - [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0
-- [Go](https://golang.org/doc/install) >= 1.21
+- [Go](https://golang.org/doc/install) >= 1.22
 
 ## Building The Provider
 
@@ -29,20 +17,6 @@ Once you've written your provider, you'll want to [publish it on the Terraform R
 go install
 ```
 
-## Adding Dependencies
-
-This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
-Please see the Go documentation for the most up to date information about using Go modules.
-
-To add a new dependency `github.com/author/dependency` to your Terraform provider:
-
-```shell
-go get github.com/author/dependency
-go mod tidy
-```
-
-Then commit the changes to `go.mod` and `go.sum`.
-
 ## Using the provider
 
 Fill this in for each provider

README.md

@@ -0,0 +1,52 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "envbuilder_cached_image Data Source - envbuilder"
+subcategory: ""
+description: |-
+  The cached image data source can be used to retrieve a cached image produced by envbuilder.
+---
+
+# envbuilder_cached_image (Data Source)
+
+The cached image data source can be used to retrieve a cached image produced by envbuilder.
+
+## Example Usage
+
+```terraform
+data "envbuilder_cached_image" "example" {
+  builder_image = "ghcr.io/coder/envbuilder:latest"
+  git_url       = "https://github.com/coder/envbuilder-starter-devcontainer"
+  cache_repo    = "localhost:5000/local/test-cache"
+  extra_env = {
+    "ENVBUILDER_VERBOSE" : "true"
+  }
+}
+
+resource "docker_container" "container" {
+  image = envbuilder_cached_image.example.image
+  env   = data.envbuilder_image.cached.env
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `builder_image` (String) The builder image URL to use if the cache does not exist.
+- `cache_repo` (String) The name of the container registry to fetch the cache image from.
+- `git_url` (String) The URL of a Git repository containing a Devcontainer or Docker image to clone.
+
+### Optional
+
+- `cache_ttl_days` (Number) The number of days to use cached layers before expiring them. Defaults to 7 days.
+- `extra_env` (Map of String) Extra environment variables to set for the container. This may include evbuilder options.
+- `git_password` (String, Sensitive) The password to use for Git authentication. This is optional.
+- `git_username` (String) The username to use for Git authentication. This is optional.
+
+### Read-Only
+
+- `env` (List of String) Computed envbuilder configuration to be set for the container.
+- `exists` (Boolean) Whether the cached image was exists or not for the given config.
+- `id` (String) Cached image identifier
+- `image` (String) Outputs the cached image URL if it exists, otherwise the builder image URL is output instead.

docs/data-sources/cached_image.md

@@ -1,26 +1,20 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding Provider"
+page_title: "envbuilder Provider"
 subcategory: ""
 description: |-
   
 ---
 
-# scaffolding Provider
+# envbuilder Provider
 
 
 
 ## Example Usage
 
 ```terraform
-provider "scaffolding" {
-  # example configuration here
-}
+provider "envbuilder" {}
 ```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
-
-### Optional
-
-- `endpoint` (String) Example provider attribute

docs/data-sources/example.md

@@ -0,0 +1,13 @@
+data "envbuilder_cached_image" "example" {
+  builder_image = "ghcr.io/coder/envbuilder:latest"
+  git_url       = "https://github.com/coder/envbuilder-starter-devcontainer"
+  cache_repo    = "localhost:5000/local/test-cache"
+  extra_env = {
+    "ENVBUILDER_VERBOSE" : "true"
+  }
+}
+
+resource "docker_container" "container" {
+  image = envbuilder_cached_image.example.image
+  env   = data.envbuilder_image.cached.env
+}

docs/functions/example.md

@@ -1,3 +1 @@
-provider "scaffolding" {
-  # example configuration here
-}
+provider "envbuilder" {}

docs/index.md

@@ -1,6 +1,6 @@
-module github.com/hashicorp/terraform-provider-scaffolding-framework
+module github.com/mafredri/terraform-provider-envbuilder
 
-go 1.21
+go 1.22
 
 require (
 	github.com/hashicorp/terraform-plugin-docs v0.19.4