api

Documentation

Index

• Constants
• type Condition
  • func (in *Condition) DeepCopy() *Condition
  • func (in *Condition) DeepCopyInto(out *Condition)
  • func (c *Condition) GetMessage() string
  • func (c *Condition) GetReason() string
  • func (c *Condition) IsFalse() bool
  • func (c *Condition) IsTrue() bool
  • func (c *Condition) IsUnknown() bool
  • func (c *Condition) String() string
• type ConditionType
• type Conditions
  • func (in Conditions) DeepCopy() Conditions
  • func (in Conditions) DeepCopyInto(out *Conditions)
• type ConditionsAccessor
• type ConditionsManager
  • func NewConditionManager(accessor ConditionsReader, ready ConditionType, dependents ...ConditionType) ConditionsManager
• type ConditionsReader
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)
  • func (s *Status) GetCondition(t ConditionType) *Condition
  • func (s *Status) GetConditions() Conditions
  • func (s *Status) String() string

Constants

const (
	WaitingForDeploymentReason      = "WaitingForDeployment"
	ExternalResourcesNotFoundReason = "ExternalResourcesNotFound"
	DeploymentFailureReason         = "DeploymentFailure"
	DeploymentUnavailableReason     = "DeploymentIsUnavailable"
	RedeploymentExhaustedReason     = "AttemptToRedeployFailed"
	WaitingForPlatformReason        = "WaitingForPlatform"
	BuildFailedReason               = "BuildFailedReason"
	WaitingForBuildReason           = "WaitingForBuild"
	BuildIsRunningReason            = "BuildIsRunning"
	BuildSkippedReason              = "BuildSkipped"
	BuildSuccessfulReason           = "BuildSuccessful"
	BuildMarkedToRestartReason      = "BuildMarkedToRestart"
)

Types

type Condition

type Condition struct {
	// Type condition for the given object
	// +required
	Type ConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	// +required
	Status v1.ConditionStatus `json:"status"`
	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`
	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`
	// A human-readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
}

Condition describes the common structure for conditions in our types +kubebuilder:object:generate=true

func (*Condition) DeepCopy

func (in *Condition) DeepCopy() *Condition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.

func (*Condition) DeepCopyInto

func (in *Condition) DeepCopyInto(out *Condition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Condition) GetMessage

func (c *Condition) GetMessage() string

GetMessage returns a nil save string of Message

func (*Condition) GetReason

func (c *Condition) GetReason() string

GetReason returns a nil save string of Reason

func (*Condition) IsFalse

func (c *Condition) IsFalse() bool

IsFalse is true if the condition is False

func (*Condition) IsTrue

func (c *Condition) IsTrue() bool

IsTrue is true if the condition is True

func (*Condition) IsUnknown

func (c *Condition) IsUnknown() bool

IsUnknown is true if the condition is Unknown

func (*Condition) String

func (c *Condition) String() string

type ConditionType

type ConditionType string

const (
	// RunningConditionType describes the readiness condition of a "live" resource, like the workflow application
	RunningConditionType ConditionType = "Running"
	// SucceedConditionType describes the readiness condition of a static resource, like a platform, a builder, a configuration, etc.
	SucceedConditionType ConditionType = "Succeed"
	// BuiltConditionType describes the condition of a resource that needs to be build.
	BuiltConditionType ConditionType = "Built"
)

type Conditions

type Conditions []Condition

Conditions ... +kubebuilder:object:generate=true

func (Conditions) DeepCopy

func (in Conditions) DeepCopy() Conditions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Conditions.

func (Conditions) DeepCopyInto

func (in Conditions) DeepCopyInto(out *Conditions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConditionsAccessor

type ConditionsAccessor interface {
	ConditionsReader
	GetTopLevelConditionType() ConditionType
	IsReady() bool
	GetTopLevelCondition() *Condition
}

ConditionsAccessor describes access methods that every Status based struct implements.

type ConditionsManager

type ConditionsManager interface {
	ClearCondition(t ConditionType) error
	MarkTrue(t ConditionType)
	MarkTrueWithReason(t ConditionType, reason, messageFormat string, messageA ...interface{})
	MarkUnknown(t ConditionType, reason, messageFormat string, messageA ...interface{})
	MarkFalse(t ConditionType, reason, messageFormat string, messageA ...interface{})
	InitializeConditions()
}

func NewConditionManager

func NewConditionManager(accessor ConditionsReader, ready ConditionType, dependents ...ConditionType) ConditionsManager

type ConditionsReader

type ConditionsReader interface {
	GetConditions() Conditions
	GetCondition(t ConditionType) *Condition
	// contains filtered or unexported methods
}

ConditionsReader gives read capability to Conditions.

type Status

type Status struct {
	// The latest available observations of a resource's current state.
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions Conditions `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
	// The generation observed by the deployment controller.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

Status ... +kubebuilder:object:generate=true

func (*Status) DeepCopy

func (in *Status) DeepCopy() *Status

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Status.

func (*Status) DeepCopyInto

func (in *Status) DeepCopyInto(out *Status)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Status) GetCondition

func (s *Status) GetCondition(t ConditionType) *Condition

GetCondition finds and returns the Condition that matches the ConditionType previously set on Conditions.

func (*Status) GetConditions

func (s *Status) GetConditions() Conditions

func (*Status) String

func (s *Status) String() string