deployment

Documentation

Overview

Package deployment provides types and helpers for cloud deployments.

Index

• Constants
• type Status
  • func NewStatus(str string) (Status, error)
  • func (s Status) IsFinalState() 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 deployment status error.
	ErrInvalidStatus errors.Kind = "invalid deployment status"
)

Types

type Status

type Status uint8

Status of a stack or deployment

const (
	OK       Status = 1 << iota // OK status is used when the stack ran successfully.
	Pending                     // Pending is a temporary status set when the deployment is about to commence.
	Running                     // Running is a temporary status as part of an still ongoing deployment.
	Failed                      // Failed status indicates the deployment of the stack failed.
	Canceled                    // Canceled indicates the deployment of the stack was canceled.

)

func NewStatus

func NewStatus(str string) (Status, error)

NewStatus creates a new stack status from a string.

func (Status) IsFinalState

func (s Status) IsFinalState() bool

IsFinalState tells if the status is a final deployment state. The deployment state is a finite state machine where final states can be only OK, Failed or Canceled.

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.