variable

Documentation

Overview

Package variable manages terraform workspace variables

Index

• Constants
• Variables
• func NewService(opts Options) *service
• func WriteTerraformVars(dir string, vars []*Variable) error
• type Client
  • func (c *Client) ListVariables(ctx context.Context, workspaceID string) ([]*Variable, error)
• type CreateVariableOptions
• type Options
• type Service
• type UpdateVariableOptions
• type Variable
  • func NewTestVariable(t *testing.T, workspaceID string, opts CreateVariableOptions) *Variable
  • func NewVariable(workspaceID string, opts CreateVariableOptions) (*Variable, error)
  • func (v *Variable) LogValue() slog.Value
  • func (v *Variable) Update(opts UpdateVariableOptions) error
• type VariableCategory
  • func VariableCategoryPtr(v VariableCategory) *VariableCategory
• type VariableService

Constants

const (
	// https://developer.hashicorp.com/terraform/cloud-docs/workspaces/variables/managing-variables#character-limits
	VariableDescriptionMaxChars = 512
	VariableKeyMaxChars         = 128
	VariableValueMaxKB          = 256 // 256*1024 bytes

	CategoryTerraform VariableCategory = "terraform"
	CategoryEnv       VariableCategory = "env"
)

Variables

var (
	ErrVariableDescriptionMaxExceeded = fmt.Errorf("maximum variable description size (%d chars) exceeded", VariableDescriptionMaxChars)
	ErrVariableKeyMaxExceeded         = fmt.Errorf("maximum variable key size (%d chars) exceeded", VariableKeyMaxChars)
	ErrVariableValueMaxExceeded       = fmt.Errorf("maximum variable value size of %d KB exceeded", VariableValueMaxKB)
)

Functions

func NewService

func NewService(opts Options) *service

func WriteTerraformVars

func WriteTerraformVars(dir string, vars []*Variable) error

WriteTerraformVars writes workspace variables to a file named terraform.tfvars located in the given path. If the file already exists it'll be appended to.

Types

type Client

type Client struct {
	internal.JSONAPIClient
}

func (*Client) ListVariables

func (c *Client) ListVariables(ctx context.Context, workspaceID string) ([]*Variable, error)

type CreateVariableOptions

type CreateVariableOptions struct {
	Key         *string
	Value       *string
	Description *string
	Category    *VariableCategory
	Sensitive   *bool
	HCL         *bool
}

type Options

type Options struct {
	WorkspaceAuthorizer internal.Authorizer
	WorkspaceService    workspace.Service

	*sql.DB
	html.Renderer
	logr.Logger
}

type Service

type Service interface {
	CreateVariable(ctx context.Context, workspaceID string, opts CreateVariableOptions) (*Variable, error)
	ListVariables(ctx context.Context, workspaceID string) ([]*Variable, error)
	GetVariable(ctx context.Context, variableID string) (*Variable, error)
	UpdateVariable(ctx context.Context, variableID string, opts UpdateVariableOptions) (*Variable, error)
	DeleteVariable(ctx context.Context, variableID string) (*Variable, error)
}

type UpdateVariableOptions

type UpdateVariableOptions struct {
	Key         *string
	Value       *string
	Description *string
	Category    *VariableCategory
	Sensitive   *bool
	HCL         *bool
}

type Variable

type Variable struct {
	ID          string
	Key         string
	Value       string
	Description string
	Category    VariableCategory
	Sensitive   bool
	HCL         bool
	WorkspaceID string
}

func NewTestVariable

func NewTestVariable(t *testing.T, workspaceID string, opts CreateVariableOptions) *Variable

func NewVariable

func NewVariable(workspaceID string, opts CreateVariableOptions) (*Variable, error)

func (*Variable) LogValue

func (v *Variable) LogValue() slog.Value

func (*Variable) Update

func (v *Variable) Update(opts UpdateVariableOptions) error

type VariableCategory

type VariableCategory string

VariableCategory is the category of variable

func VariableCategoryPtr

func VariableCategoryPtr(v VariableCategory) *VariableCategory

VariableCategoryPtr returns a pointer to the given category type.

type VariableService

type VariableService = Service