state

package
v0.3.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 23, 2025 License: MPL-2.0 Imports: 32 Imported by: 0

Documentation

Overview

Package state manages terraform state.

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrSerialNotGreaterThanCurrent = errors.New("the serial provided in the state file is not greater than the serial currently known remotely")
	ErrSerialMD5Mismatch           = errors.New("the MD5 hash of the state provided does not match what is currently known for the same serial number")
	ErrUploadNonPending            = errors.New("cannot upload state to a state version with a non-pending status")
)
View Source 
var ErrCurrentVersionDeletionAttempt = errors.New("deleting the current state version is not allowed")

Functions

func NewCommand added in v0.1.9 

func NewCommand(client *otfapi.Client) *cobra.Command

Types

type CLI added in v0.1.9 

type CLI struct {
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	*otfapi.Client
}

func (*Client) Create added in v0.2.2 

func (c *Client) Create(ctx context.Context, opts CreateStateVersionOptions) (*Version, error)

func (*Client) Delete added in v0.2.2 

func (c *Client) Delete(ctx context.Context, svID resource.ID) error

func (*Client) Download added in v0.2.2 

func (c *Client) Download(ctx context.Context, svID resource.ID) ([]byte, error)

func (*Client) DownloadCurrent added in v0.2.2 

func (c *Client) DownloadCurrent(ctx context.Context, workspaceID resource.ID) ([]byte, error)

func (*Client) GetCurrent added in v0.2.2 

func (c *Client) GetCurrent(ctx context.Context, workspaceID resource.ID) (*Version, error)

func (*Client) List added in v0.2.2 

func (c *Client) List(ctx context.Context, workspaceID resource.ID, opts resource.PageOptions) (*resource.Page[*Version], error)

func (*Client) Rollback added in v0.2.2 

func (c *Client) Rollback(ctx context.Context, svID resource.ID) (*Version, error)

type CreateStateVersionOptions 

type CreateStateVersionOptions struct {
	State       []byte      // Terraform state file. Optional.
	WorkspaceID resource.ID // ID of state version's workspace. Required.
	Serial      *int64      // State serial number. Required.
}

CreateStateVersionOptions are options for creating a state version.

type File 

type File struct {
	Version          int
	TerraformVersion string `json:"terraform_version"`
	Serial           int64
	Lineage          string
	Outputs          map[string]FileOutput
	Resources        []Resource
}

File is the terraform state file contents

type FileOutput 

type FileOutput struct {
	Value     json.RawMessage
	Sensitive bool
}

FileOutput is an output in the terraform state file

func (FileOutput) StringValue added in v0.1.3 

func (r FileOutput) StringValue() string

func (FileOutput) Type added in v0.1.3 

func (r FileOutput) Type() (string, error)

Type determines the HCL type of the output value

type Options 

type Options struct {
	logr.Logger
	html.Renderer
	internal.Cache
	*sql.DB
	*tfeapi.Responder
	*surl.Signer

	WorkspaceService *workspace.Service
	Authorizer       *authz.Authorizer
}

type Output 

type Output struct {
	ID             resource.ID
	Name           string
	Type           string
	Value          json.RawMessage
	Sensitive      bool
	StateVersionID resource.ID
}

type Resource added in v0.1.3 

type Resource struct {
	Name        string
	ProviderURI string `json:"provider"`
	Type        string
	Module      string
}

func (Resource) ModuleName added in v0.1.3 

func (r Resource) ModuleName() string

func (Resource) Provider added in v0.1.3 

func (r Resource) Provider() string

Provider extracts the provider from the provider URI

type Service 

type Service struct {
	logr.Logger

	*authz.Authorizer
	// contains filtered or unexported fields
}

Service provides access to state and state versions

func NewService 

func NewService(opts Options) *Service

func (*Service) AddHandlers added in v0.2.2 

func (a *Service) AddHandlers(r *mux.Router)

func (*Service) Create added in v0.2.2 

func (a *Service) Create(ctx context.Context, opts CreateStateVersionOptions) (*Version, error)

func (*Service) Delete added in v0.2.2 

func (a *Service) Delete(ctx context.Context, versionID resource.ID) error

func (*Service) Download added in v0.2.2 

func (a *Service) Download(ctx context.Context, svID resource.ID) ([]byte, error)

func (*Service) DownloadCurrent added in v0.2.2 

func (a *Service) DownloadCurrent(ctx context.Context, workspaceID resource.ID) ([]byte, error)

func (*Service) Get added in v0.2.2 

func (a *Service) Get(ctx context.Context, versionID resource.ID) (*Version, error)

func (*Service) GetCurrent added in v0.2.2 

func (a *Service) GetCurrent(ctx context.Context, workspaceID resource.ID) (*Version, error)

func (*Service) GetOutput added in v0.2.2 

func (a *Service) GetOutput(ctx context.Context, outputID resource.ID) (*Output, error)

func (*Service) List added in v0.2.2 

func (a *Service) List(ctx context.Context, workspaceID resource.ID, opts resource.PageOptions) (*resource.Page[*Version], error)

func (*Service) Rollback added in v0.2.2 

func (a *Service) Rollback(ctx context.Context, versionID resource.ID) (*Version, error)

func (*Service) Upload added in v0.2.2 

func (a *Service) Upload(ctx context.Context, svID resource.ID, state []byte) error

type StateVersionListOptions 

type StateVersionListOptions struct {
	resource.PageOptions
	Organization string `schema:"filter[organization][name],required"`
	Workspace    string `schema:"filter[workspace][name],required"`
}

StateVersionListOptions represents the options for listing state versions.

type Status added in v0.1.15 

type Status string
const (
	Pending   Status = "pending"
	Finalized Status = "finalized"
	Discarded Status = "discarded"
)

type Version 

type Version struct {
	ID          resource.ID        `jsonapi:"primary,state-versions"`
	CreatedAt   time.Time          `jsonapi:"attribute" json:"created-at"`
	Serial      int64              `jsonapi:"attribute" json:"serial"`
	State       []byte             `jsonapi:"attribute" json:"state"`
	Status      Status             `jsonapi:"attribute" json:"status"`
	Outputs     map[string]*Output `jsonapi:"attribute" json:"outputs"`
	WorkspaceID resource.ID        `jsonapi:"attribute" json:"workspace-id"`
}

Version is a specific version of terraform state. It includes important metadata as well as the state file itself.

https://developer.hashicorp.com/terraform/cloud-docs/api-docs/state-versions

func (*Version) File added in v0.1.3 

func (v *Version) File() (*File, error)

func (*Version) LogValue added in v0.1.15 

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

func (*Version) String 

func (v *Version) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.