stack

Documentation

Overview

Package stack provides types and helpers for cloud stacks.

Index

• Constants
• type FilterStatus
  • func NewStatusFilter(str string) (FilterStatus, error)
  • func (f FilterStatus) Is(status Status) bool
  • func (f FilterStatus) String() string
• type Status
  • func NewStatus(str string) Status
  • func (s Status) Is(filter FilterStatus) bool
  • func (s Status) MarshalJSON() ([]byte, error)
  • func (s Status) String() string
  • func (s *Status) UnmarshalJSON(b []byte) error
  • func (s Status) Validate() error

Constants

const (
	// ErrInvalidStatus represents an invalid stack status error.
	ErrInvalidStatus errors.Kind = "invalid stack status"

	// ErrInvalidFilterStatus represents an invalid filter stack status error.
	ErrInvalidFilterStatus errors.Kind = "invalid filter stack status"
)

const AnyTarget = ""

AnyTarget is the empty deployment target filter that includes any target.

Types

type FilterStatus

type FilterStatus Status

FilterStatus represents a filter for stack statuses.

const (
	// UnhealthyFilter status is used for filtering not Ok status.
	UnhealthyFilter FilterStatus = FilterStatus(Drifted | Failed)

	// HealthyFilter status is used for filtering healthy statuses. Just [OK] for now.
	HealthyFilter FilterStatus = FilterStatus(OK)

	// AllFilter filters for any stacks statuses.
	AllFilter FilterStatus = HealthyFilter | UnhealthyFilter
	// NoFilter disables the filtering for statuses.
	NoFilter FilterStatus = 0
)

func NewStatusFilter

func NewStatusFilter(str string) (FilterStatus, error)

NewStatusFilter creates a new filter for stack statuses.

func (FilterStatus) Is

func (f FilterStatus) Is(status Status) bool

Is tells if the filter matches the provided status.

func (FilterStatus) String

func (f FilterStatus) String() string

type Status

type Status uint8

Status of a stack.

const (
	// OK status is used when the stack ran successfully.
	OK Status = 1 << iota
	// Drifted status is used when a stack definition is different from that of the current status.
	Drifted
	// Failed status indicates the deployment of the stack failed.
	Failed
	// Unrecognized indicates any status returned from TMC but still not recognized by the client.
	Unrecognized
)

func NewStatus

func NewStatus(str string) Status

NewStatus creates a new stack status from a string.

func (Status) Is

func (s Status) Is(filter FilterStatus) bool

Is tells if status matches the provided filter.

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

MarshalJSON implements the Marshaller interface.

func (Status) String

func (s Status) String() string

String representation of the status.

func (*Status) UnmarshalJSON

func (s *Status) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals stack status from JSONs.

func (Status) Validate

func (s Status) Validate() error

Validate the status.