Skip to content

xonvanetta/terraform-provider-truenas

Repository files navigation

Terraform Provider Truenas

Truenas provider that will be used to create datasets,shares and more, also to manage truenas settings as services etc.

TODO:

  • Support NFS service config
    • Basic implementation
    • Baisc test
    • Missing MountdPort,RpcstatdPort,RpclockdPort
  • Support Dataset/Volume Basic
    • Basic resource implementation
    • Basic data implementation
    • Baisc test
    • Permissions
    • Encryption
  • Support Shares
    • NFS
      • Basic implementation
      • Tests
    • SMB
      • Basic implementation
      • Tests
  • Users
  • Support Pools (Not knowing if it's a good idea or just rely on first time creation)
  • Everything else from the api..

Requirements

  • Terraform >= 2.x?
  • Go >= 1.16
  • Truenas v2 api (should be installed on vm/bare metal machine)

Building The Provider

  1. Clone the repository
  2. Enter the repository directory
  3. Build the provider using the Go install command:
$ go install

Adding Dependencies

This provider uses Go 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:

$kgo get github.com/author/dependency
$ go mod tidy

Then commit the changes to go.mod and go.sum.

Using the provider

See the examples or check the docs

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine ( see 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.

$ make testacc