This repository contains the Terraform provider "Swiss Army Knife" (SAK). This provider aims to enhance the Terraform development experience by offering a collection of utilities and helpers. Currently it's a function-only provider.
- Clone the repository
- Enter the repository directory
- Build the provider using the Go
installcommand:
go installThis 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:
go get github.com/author/dependency
go mod tidyThen commit the changes to go.mod and go.sum.
This provider offers a collection of utilities to enhance your Terraform workflow.
Documentation for each function can be found in the docs/ directory and on the Terraform Registry page.
Example usage:
terraform {
required_providers {
sak = {
source = "serpro69/sak"
version = "0.1.0"
}
}
}
provider "sak" {
# The provider currently does not have any configuration options
}
output "timestamp" {
value = provider::sak::rfc3339_parse("2023-07-25T23:43:16Z")
}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.
Set dev_overrides for the provider installation in ~/.terraformrc:
provider_installation {
dev_overrides {
"serpro69/sak" = "/Users/sergio/go/bin"
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}To generate or update documentation, run make 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