infra

package

v1.4.8 Latest Latest Go to latest Published: Sep 23, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/nself-org/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package infra provides a thin wrapper around the Terraform CLI for provisioning nSelf infrastructure via provider-specific modules (B51/B52).

Status: PLANNED — deferred. Requires UD-12 minor release approval. Terraform modules live in terraform/modules/<provider>/ at the repo root.

Index ¶

Variables
func Apply(ctx context.Context, opts ApplyOptions) error
func Destroy(ctx context.Context, provider Provider, domain, modulesDir string, ...) error
func Plan(ctx context.Context, opts PlanOptions) error
type ApplyOptions
type PlanOptions
type Provider

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrTerraformNotFound = fmt.Errorf("infra: terraform binary not found; install from https://developer.hashicorp.com/terraform")

ErrTerraformNotFound is returned when the terraform binary is not in PATH.

View Source

var ValidProviders = map[Provider]bool{
	ProviderAWS:          true,
	ProviderGCP:          true,
	ProviderAzure:        true,
	ProviderHetzner:      true,
	ProviderDigitalOcean: true,
	ProviderLinode:       true,
}

ValidProviders is the set of supported providers.

Functions ¶

func Apply ¶

func Apply(ctx context.Context, opts ApplyOptions) error

Apply runs `terraform apply` for the given provider module.

func Destroy ¶

func Destroy(ctx context.Context, provider Provider, domain, modulesDir string, autoApprove bool) error

Destroy runs `terraform destroy` for the given provider module.

func Plan ¶

func Plan(ctx context.Context, opts PlanOptions) error

Plan runs `terraform plan` for the given provider module.

Types ¶

type ApplyOptions ¶

type ApplyOptions struct {
	PlanOptions
	AutoApprove bool
	// Vars is an optional map of additional Terraform variables passed as
	// -var=key=value flags. These are appended after the domain var so they
	// can override or extend module defaults (e.g. location, server_type).
	Vars map[string]string
}

ApplyOptions holds parameters for terraform apply.

type PlanOptions ¶

type PlanOptions struct {
	Provider    Provider
	Domain      string
	StateBucket string
	ModulesDir  string // defaults to terraform/modules/<provider>
}

PlanOptions holds parameters for terraform plan.

type Provider ¶

type Provider string

Provider is a cloud provider supported by the Terraform modules.

const (
	ProviderAWS          Provider = "aws"
	ProviderGCP          Provider = "gcp"
	ProviderAzure        Provider = "azure"
	ProviderHetzner      Provider = "hetzner"
	ProviderDigitalOcean Provider = "do"
	ProviderLinode       Provider = "linode"
)

Source Files ¶

View all Source files

terraform.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL