flight

Documentation

Index

• Constants
• func Namespace() string
• func Release() string
• type Resource
• type Stage
  • func (stage Stage) MarshalJSON() ([]byte, error)
• type Stages
• type Status

Constants

const AnnotationOverrideFlight = "overrides.yoke.cd/flight"

Functions

func Namespace

func Namespace() string

Namespace is a convenience function for fetching the namespace within the context of an executing flight. This will generally be the -namespace flag passed to "yoke takeoff"

func Release

func Release() string

Release is convenience for fetching the release name within the context of an executing flight. This will generally be the name of release passed to "yoke takeoff"

Types

type Resource

type Resource interface {
	GroupVersionKind() schema.GroupVersionKind
}

Resource is a best effort attempt at capturing the set of types that are kubernetes resources. K8s resource embed the metav1.TypeMeta struct and thus expose this method; unstructured.Unstructured objects also expose it.

Having this type allows us to not fallback to using `any` when building our flight implementations.

type Stage

type Stage []Resource

Stage represents a single deployment stage. A stage is a valid flight output.

func (Stage) MarshalJSON

func (stage Stage) MarshalJSON() ([]byte, error)

MarshalJSON implements custom JSON marshalling for flight stages. It allows stages to have resources written as nil instead of omitting them entirely. To support this convenience, a stage filters out nil values before serializing its content.

type Stages

type Stages []Stage

Stages is an ordered list of stages. Yoke will apply each stage one by one. Stages is a valid flight output.

type Status

type Status struct {
	// Status represents the state of the resource. Typical values are: InProgress, Ready, Error, Terminating.
	Status string `json:"status,omitempty"`
	// Msg is a human readable message describing the status or error if any.
	Msg string `json:"msg,omitempty"`
}

Status is a basic status representation used for Flights by the ATC as well as for Airways.