https://github.com/mkeeler/terraform-provider-k3d

Terraform Provider for K3D
https://github.com/mkeeler/terraform-provider-k3d

Last synced: 19 days ago
JSON representation

Terraform Provider for K3D

• Host: GitHub
• URL: https://github.com/mkeeler/terraform-provider-k3d
• Owner: mkeeler
• License: mpl-2.0
• Created: 2022-08-10T13:26:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-20T08:11:18.000Z (6 months ago)
• Last Synced: 2024-10-13T01:09:27.528Z (about 1 month ago)
• Language: Go
• Size: 373 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Terraform Provider K3D

## Requirements

- [Terraform](https://www.terraform.io/downloads.html) >= 1.0

- [Go](https://golang.org/doc/install) >= 1.18.0 < 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`.

## Using the provider

```

resource "k3d_cluster" "foo" {

   name = "foo"

   servers = 3

   agents = 2

   expose_api = {

      host = "foo.example.com"

      host_ip = "127.0.0.1"

      host_port = 1234

   }

   network = "my-existing-docker-network"

   image = "latest"

}

```

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

```