v1beta1

Documentation

Index

• Constants
• type DependentCondition
  • func (in *DependentCondition) DeepCopy() *DependentCondition
  • func (in *DependentCondition) DeepCopyInto(out *DependentCondition)
  • func (in *DependentCondition) GetAttribute(name string) string
  • func (in *DependentCondition) IsFailed() bool
  • func (in *DependentCondition) IsReady() bool
  • func (in *DependentCondition) SetAttribute(name, value string) string
• type DependentConditionType
• type NameValuePair
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)
  • func (in *Status) GetConditionFor(name string, gvk schema.GroupVersionKind) (existingOrNew *DependentCondition)
  • func (in *Status) GetConditionsWith(gvk schema.GroupVersionKind) []DependentCondition
  • func (in *Status) SetCondition(condition *DependentCondition) (updated bool)
• type StatusAware

Constants

const (
	// See https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/
	NameLabelKey           = "app.kubernetes.io/name"
	VersionLabelKey        = "app.kubernetes.io/version"
	InstanceLabelKey       = "app.kubernetes.io/instance"
	PartOfLabelKey         = "app.kubernetes.io/part-of"
	ComponentLabelKey      = "app.kubernetes.io/component"
	ManagedByLabelKey      = "app.kubernetes.io/managed-by"
	RuntimeLabelKey        = "app.openshift.io/runtime"
	RuntimeVersionLabelKey = "app.openshift.io/version"
)

const (
	// ReasonPending means the entity has been accepted by the system, but it is still being processed. This includes time
	// being instantiated.
	ReasonPending = "Pending"
	// ReasonReady means the entity has been instantiated to a node and all of its dependencies are available. The
	// entity is able to process requests.
	ReasonReady = "Ready"
	// ReasonFailed means that the entity or some of its dependencies have failed and cannot be salvaged without user
	// intervention.
	ReasonFailed = "Failed"
)

Types

type DependentCondition

type DependentCondition struct {
	// Type of the condition.
	Type DependentConditionType `json:"type"`
	// Type of the dependent associated with the condition.
	DependentType schema.GroupVersionKind `json:"dependentType"`
	// Name of the dependent associated with the condition.
	DependentName string `json:"dependentName"`
	// Records the last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime v1.Time `json:"lastTransitionTime,omitempty"`
	// Unique, one-word, CamelCase reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Human-readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
	// Additional information that the condition wishes to convey/record as name-value pairs.
	// +optional
	Attributes []NameValuePair `json:"attributes,omitempty"`
}

DependentCondition contains details for the current condition of the associated DependentResource.

func (*DependentCondition) DeepCopy

func (in *DependentCondition) DeepCopy() *DependentCondition

func (*DependentCondition) DeepCopyInto

func (in *DependentCondition) DeepCopyInto(out *DependentCondition)

func (*DependentCondition) GetAttribute

func (in *DependentCondition) GetAttribute(name string) string

func (*DependentCondition) IsFailed

func (in *DependentCondition) IsFailed() bool

func (*DependentCondition) IsReady

func (in *DependentCondition) IsReady() bool

func (*DependentCondition) SetAttribute

func (in *DependentCondition) SetAttribute(name, value string) string

type DependentConditionType

type DependentConditionType string

DependentConditionType is a valid value for DependentCondition.Type

const (
	// DependentReady means the dependent is able to service requests.
	DependentReady DependentConditionType = "Ready"
	// DependentPending means that the dependent is still processing.
	DependentPending DependentConditionType = "Pending"
	// DependentFailed means that the dependent is in error and probably requires user intervention to get back to working state.
	DependentFailed DependentConditionType = "Failed"
)

These are valid dependent conditions.

type NameValuePair

type NameValuePair struct {
	Name  string `json:"name,omitempty"`
	Value string `json:"value,omitempty"`
}

type Status

type Status struct {
	LastUpdate v1.Time              `json:"lastUpdate,omitempty"`
	Reason     string               `json:"reason,omitempty"`
	Message    string               `json:"message,omitempty"`
	Conditions []DependentCondition `json:"conditions,omitempty"`
}

func (*Status) DeepCopy

func (in *Status) DeepCopy() *Status

func (*Status) DeepCopyInto

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

func (*Status) GetConditionFor

func (in *Status) GetConditionFor(name string, gvk schema.GroupVersionKind) (existingOrNew *DependentCondition)

func (*Status) GetConditionsWith

func (in *Status) GetConditionsWith(gvk schema.GroupVersionKind) []DependentCondition

func (*Status) SetCondition

func (in *Status) SetCondition(condition *DependentCondition) (updated bool)

SetCondition sets the given condition on the Status, returning true if the status has been modified as a result

type StatusAware

type StatusAware interface {
	GetStatus() Status
	SetStatus(status Status)
	Handle(err error) (bool, Status)
}