pterraform

Documentation

Overview

Package pterraform provides a harness that runs arbitrary terraform on a given path. Subsequent steps are run against arbitrary infrastructure created by the terraform run configured via the terraform output.

Index

• func New(source fs.FS, opts ...Option) (*pterraform, error)
• type Connection
• type ConnectionRetry
• type DockerConnection
• type KubernetesConnection
• type Option
  • func WithVars(vars json.RawMessage) Option
  • func WithWorkspace(workspace string) Option
• type Runner

Functions

func New

func New(source fs.FS, opts ...Option) (*pterraform, error)

Types

type Connection

type Connection struct {
	Kubernetes *KubernetesConnection `json:"kubernetes"`
	Docker     *DockerConnection     `json:"docker"`
	// Retry is the retry configuration for the connection
	Retry *ConnectionRetry `json:"retry"`
	// contains filtered or unexported fields
}

type ConnectionRetry

type ConnectionRetry struct {
	Attempts int     `json:"attempts"`
	Delay    string  `json:"delay"`
	Factor   float64 `json:"factor"`
}

type DockerConnection

type DockerConnection struct {
	Cid            string `json:"cid"`
	Host           string `json:"host"`
	PrivateKeyPath string `json:"private_key_path"`
}

type KubernetesConnection

type KubernetesConnection struct {
	Kubeconfig     string `json:"kubeconfig"`
	KubeconfigPath string `json:"kubeconfig_path"`
	SandboxImage   string `json:"sandbox_image"`
}

type Option

type Option func(*pterraform) error

func WithVars

func WithVars(vars json.RawMessage) Option

func WithWorkspace

func WithWorkspace(workspace string) Option

WithWorkspace sets the path to the terraform workspace to use.

type Runner

type Runner interface {
	Run(ctx context.Context, cmd harness.Command) error
}