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
- type CreateVariableOptions
- type CreateVariableSetOptions
- type Options
- type Service
- type UpdateVariableOptions
- type UpdateVariableSetOptions
- type Variable
- type VariableCategory
- type VariableService
- type VariableSet
- type WorkspaceVariable
Constants ¶
View Source
const ( // https://developer.hashicorp.com/terraform/cloud-docs/workspaces/variables/managing-variables#character-limits VariableDescriptionMaxChars = 512 VariableKeyMaxChars = 128 VariableValueMaxKB = 256 // 256*1024 bytes )
Variables ¶
View Source
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) ErrVariableConflict = errors.New("variable conflicts with another variable with the same name and type") )
Functions ¶
func NewService ¶
func NewService(opts Options) *service
func WriteTerraformVars ¶
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
}
type CreateVariableOptions ¶
type CreateVariableSetOptions ¶ added in v0.1.9
type Service ¶
type Service interface { // ListEffectiveVariables lists the effective variables for a run, i.e. // merging variable sets, workspace variables, and run variables, and // removing those that are overridden according to precedence rules. ListEffectiveVariables(ctx context.Context, runID string) ([]*Variable, error) CreateWorkspaceVariable(ctx context.Context, workspaceID string, opts CreateVariableOptions) (*Variable, error) UpdateWorkspaceVariable(ctx context.Context, variableID string, opts UpdateVariableOptions) (*WorkspaceVariable, error) ListWorkspaceVariables(ctx context.Context, workspaceID string) ([]*Variable, error) GetWorkspaceVariable(ctx context.Context, variableID string) (*WorkspaceVariable, error) DeleteWorkspaceVariable(ctx context.Context, variableID string) (*WorkspaceVariable, error) // contains filtered or unexported methods }
type UpdateVariableOptions ¶
type UpdateVariableSetOptions ¶ added in v0.1.9
type Variable ¶
type VariableCategory ¶
type VariableCategory string
VariableCategory is the category of variable
const ( CategoryTerraform VariableCategory = "terraform" CategoryEnv VariableCategory = "env" )
func VariableCategoryPtr ¶
func VariableCategoryPtr(v VariableCategory) *VariableCategory
VariableCategoryPtr returns a pointer to the given category type.
type VariableService ¶
type VariableService = Service
type VariableSet ¶ added in v0.1.9
type VariableSet struct { ID string Name string Description string Global bool Workspaces []string // workspace IDs Organization string // org name Variables []*Variable }
VariableSet is a set of variables
func (*VariableSet) LogValue ¶ added in v0.1.9
func (s *VariableSet) LogValue() slog.Value
type WorkspaceVariable ¶ added in v0.1.9
Source Files ¶
Click to show internal directories.
Click to hide internal directories.