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

https://github.com/replicatedhq/terraform-provider-replicated


https://github.com/replicatedhq/terraform-provider-replicated

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

# Terraform Provider Replicated

## Using the provider

### Provider configuration

```hcl
terraform {
required_providers {
replicated = {
source = "registry.terraform.io/replicatedhq/replicated"
}
}
}

provider "replicated" {
api_token = "your api token"
}

```

### Resource configuration

```hcl
resource "replicated_cluster" "tf_cluster" {
distribution = "kind"
wait_duration = "10m"
ttl = "30m"
instance_type = "r1.large"
}
```

## Requirements

- [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0
- [Go](https://golang.org/doc/install) >= 1.19

## Building The Provider

1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go `install` command:

```shell
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`.

## Developing the Provider

If you wish to work on the provider, you'll first need [Go](http://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`.

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.

```shell
make testacc
```