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

https://github.com/mathiaspius/terraform-provider-zfs


https://github.com/mathiaspius/terraform-provider-zfs

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

# ZFS Terraform Provider.

This is an absolutely zero-guarantee provider. It's primarily used by myself to manage ZFS datasets on a server I own, and therefore the functionality included is limited to what I actually need myself.

... I also have a profound hatred for Go as a language, so expect absolutely awful code within.

## Requirements

- [Terraform](https://www.terraform.io/downloads.html) >= 0.13.x
- [Go](https://golang.org/doc/install) >= 1.15

## Building The Provider

1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go `install` command:
```sh
$ 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:

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

## 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.

```sh
$ make testacc
```