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

https://github.com/squat/terraform-provider-datacrunch

Terraform provider for DataCrunch
https://github.com/squat/terraform-provider-datacrunch

datacrunch terraform terraform-provider

Last synced: 2 months ago
JSON representation

Terraform provider for DataCrunch

Awesome Lists containing this project

README

          

# DataCrunch Terraform Provider

The Terraform provider for DataCrunch enables the declarative management of resources in [DataCrunch](https://datacrunch.io).

[![Build Status](https://github.com/squat/terraform-provider-datacrunch/workflows/CI/badge.svg)](https://github.com/squat/terraform-provider-datacrunch/actions?query=workflow%3ACI)

## SDK Installation

To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.

```hcl
terraform {
required_providers {
datacrunch = {
source = "squat/datacrunch"
version = "0.0.1"
}
}
}

provider "datacrunch" {
# Configuration options
}
```

## SDK Example Usage

### Testing the provider locally

Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.

This also allows for debuggers (e.g. delve) to be attached to the provider.

### Example

```sh
go run main.go --debug
# Copy the TF_REATTACH_PROVIDERS env var
# In a new terminal
cd examples/your-example
TF_REATTACH_PROVIDERS=... terraform init
TF_REATTACH_PROVIDERS=... terraform apply
```

## Available Resources and Operations

Terraform allows you to use local provider builds by setting a `dev_overrides` block in a configuration file called `.terraformrc`. This block overrides all other configured installation methods.

Terraform searches for the `.terraformrc` file in your home directory and applies any configuration settings you set.

```
provider_installation {

dev_overrides {
"squat/datacrunch" = ""
}

# 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 {}
}
```

Your `` may vary depending on how your Go environment variables are configured. Execute `go env GOBIN` to set it, then set the `` to the value returned. If nothing is returned, set it to the default location, `$HOME/go/bin`.

### Generation

This project is generated using [Speakeasy](https://github.com/speakeasy-api/speakeasy).