terraform

Documentation

Index

• Variables
• func FormatDiagnostic(diag *tfjson.Diagnostic) string
• func Install(ctx context.Context, log slog.Logger, dir string, wantVersion *version.Version) (string, error)
• func Serve(ctx context.Context, options *ServeOptions) error
• type ServeOptions
• type State
  • func ConvertState(modules []*tfjson.StateModule, rawGraph string, rawParameterNames []string) (*State, error)

Variables

var (
	// TerraformVersion is the version of Terraform used internally
	// when Terraform is not available on the system.
	// NOTE: Keep this in sync with the version in scripts/Dockerfile.base.
	TerraformVersion = version.Must(version.NewVersion("1.3.4"))
)

Functions

func FormatDiagnostic

func FormatDiagnostic(diag *tfjson.Diagnostic) string

func Install

func Install(ctx context.Context, log slog.Logger, dir string, wantVersion *version.Version) (string, error)

Install implements a thread-safe, idempotent Terraform Install operation.

func Serve

func Serve(ctx context.Context, options *ServeOptions) error

Serve starts a dRPC server on the provided transport speaking Terraform provisioner.

Types

type ServeOptions

type ServeOptions struct {
	*provisionersdk.ServeOptions

	// BinaryPath specifies the "terraform" binary to use.
	// If omitted, the $PATH will attempt to find it.
	BinaryPath string
	// CachePath must not be used by multiple processes at once.
	CachePath string
	Logger    slog.Logger

	// ExitTimeout defines how long we will wait for a running Terraform
	// command to exit (cleanly) if the provision was stopped. This only
	// happens when the command is still running after the provision
	// stream is closed. If the provision is canceled via RPC, this
	// timeout will not be used.
	//
	// This is a no-op on Windows where the process can't be interrupted.
	//
	// Default value: 5 minutes.
	ExitTimeout time.Duration
}

type State

type State struct {
	Resources        []*proto.Resource
	Parameters       []*proto.RichParameter
	GitAuthProviders []string
}

func ConvertState

func ConvertState(modules []*tfjson.StateModule, rawGraph string, rawParameterNames []string) (*State, error)

ConvertState consumes Terraform state and a GraphViz representation produced by `terraform graph` to produce resources consumable by Coder. nolint:gocyclo