Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opentofu/terraform-provider-go
https://github.com/opentofu/terraform-provider-go
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/opentofu/terraform-provider-go
- Owner: opentofu
- License: mpl-2.0
- Created: 2024-04-22T11:27:12.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-09T11:06:00.000Z (9 months ago)
- Last Synced: 2024-05-09T12:27:17.807Z (9 months ago)
- Language: Go
- Size: 45.9 KB
- Stars: 12
- Watchers: 7
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - opentofu/terraform-provider-go - (Go)
README
# terraform-provider-go
This is an experimental OpenTofu function provider based on terraform-plugin-go.
It allows you to write Go helper functions next to your Tofu code, so that you can use them in your Tofu configuration, in a completely type-safe way. The provider is based on [Yaegi](https://github.com/traefik/yaegi), and most of the Go standard library is available.
In OpenTofu 1.7.0-beta1 and upwards you can configure the provider and pass it a Go file to load.
- The package name should be `lib`
- Exported functions need to start with upper-case letters.
- The Tofu-facing name of the function **will be lower-cased**.
- It supports simple types, like strings, integers, floats, and booleans.
- It also supports complex type, like maps, slices, nullable pointers, and structures.
This feature is an experimental preview and is subject to change before the OpenTofu 1.7.0 release.
## Example
```hcl
// main.tf
provider "go" {
go = file("./lib.go")
}
output "test" {
value = provider::go::hello("papaya")
}
```
```go
// lib.go
package lib
func Hello(name string) string {
return "Hello, " + name + "!"
}
```
Output excerpt:
```
Changes to Outputs:
+ test = "Hello, papaya!"
```
## More involved example
```hcl
// main.tf
provider "go" {
go = file("./lib.go")
}
output "test" {
value = provider::go::hello({
name = "papaya",
surname = "bacon",
})
}
```
```go
// lib.go
package lib
import (
"fmt"
)
type Person struct {
// We can let it default to the un-capitalized field name.
Name string
// Or use a struct tag to specify the object field name explicitly.
Surname string `tf:"surname"`
}
func Hello(person Person) string {
return fmt.Sprintf("Hello, %s %s!", person.Name, person.Surname)
}
```
Output excerpt:
```
Changes to Outputs:
+ test = "Hello, papaya bacon!"
```
Moreover, all of this is type-safe and mistakes will be caught by tofu. So passing a number to the function will fail with `object required`, while forgetting e.g. the surname will fail with `attribute "surname" is required`.
## Importing
Here's a snippet to require the provider in your OpenTofu configuration:
```hcl
terraform {
required_providers {
go = {
source = "registry.opentofu.org/opentofu/go"
version = "0.0.1"
}
}
}
```