Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xinau/terraform-provider-cue

Terraform provider for generating JSON documents with CUE.
https://github.com/xinau/terraform-provider-cue

cue cuelang terraform terraform-provider

Last synced: 3 months ago
JSON representation

Terraform provider for generating JSON documents with CUE.

Awesome Lists containing this project

README

        

# Terraform Provider CUE

Terraform provider for generating JSON documents with
[CUE](https://cuelang.org/).

## Documentation

The documentation for the CUE provider is available on the [Terraform
Registry](https://registry.terraform.io/providers/xinau/cue/latest/docs).

## Versions

The following table displays the CUE version the provider uses.

| Terraform Provider | CUE |
|--------------------|--------|
| v0.2.0 | v0.4.3 |
| v0.1.0 | v0.4.1 |

## Requirements

* [Terraform](https://www.terraform.io/downloads.html) >= 1.0
* [Go](https://golang.org/doc/install) >= 1.18

## Building the Provider

To build the provider, you'll need to clone the repository and execute the Go
`install` command from inside the repository's directory.

```bash
go install
```

## Using the provider

The provider can be used by adding it to the [provider
requirements](https://developer.hashicorp.com/terraform/language/providers/requirements).

```terraform
terraform {
required_providers {
cue = {
source = "xinau/cue"
}
}
}
```

If you wish to use a local provider binary instead, it will need to added to the
[development overrides](https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers).

```terraform
provider_installation {
dev_overrides {
"xinau/cue" = "/home/developer/go/bin/terraform-provider-cue"
}

direct {}
}
```

## Developing the Provider

If you wish to work on the provider, you'll first need
[Go](https://www.golang.org) installed on your machine (see
[Requirements](#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`.

## LICENSE

This project is under [MPL-2.0 license](./LICENSE).