status

Documentation

Index

• Constants
• func SetPropagationStatus(fedObject *unstructured.Unstructured, reason AggregateReason, ...) (bool, error)
• type AggregateReason
• type CollectedPropagationStatus
• type ConditionType
• type GenericClusterStatus
• type GenericCondition
• type GenericFederatedStatus
• type GenericPropagationStatus
• type PropagationStatus
• type PropagationStatusMap

Constants

const (
	ClusterPropagationOK PropagationStatus = ""
	WaitingForRemoval    PropagationStatus = "WaitingForRemoval"

	// Cluster-specific errors
	ClusterNotReady        PropagationStatus = "ClusterNotReady"
	CachedRetrievalFailed  PropagationStatus = "CachedRetrievalFailed"
	ComputeResourceFailed  PropagationStatus = "ComputeResourceFailed"
	ApplyOverridesFailed   PropagationStatus = "ApplyOverridesFailed"
	CreationFailed         PropagationStatus = "CreationFailed"
	UpdateFailed           PropagationStatus = "UpdateFailed"
	DeletionFailed         PropagationStatus = "DeletionFailed"
	LabelRemovalFailed     PropagationStatus = "LabelRemovalFailed"
	RetrievalFailed        PropagationStatus = "RetrievalFailed"
	AlreadyExists          PropagationStatus = "AlreadyExists"
	FieldRetentionFailed   PropagationStatus = "FieldRetentionFailed"
	VersionRetrievalFailed PropagationStatus = "VersionRetrievalFailed"
	ClientRetrievalFailed  PropagationStatus = "ClientRetrievalFailed"

	// Operation timeout errors
	CreationTimedOut     PropagationStatus = "CreationTimedOut"
	UpdateTimedOut       PropagationStatus = "UpdateTimedOut"
	DeletionTimedOut     PropagationStatus = "DeletionTimedOut"
	LabelRemovalTimedOut PropagationStatus = "LabelRemovalTimedOut"

	AggregateSuccess       AggregateReason = ""
	ClusterRetrievalFailed AggregateReason = "ClusterRetrievalFailed"
	ComputePlacementFailed AggregateReason = "ComputePlacementFailed"
	CheckClusters          AggregateReason = "CheckClusters"
	NamespaceNotFederated  AggregateReason = "NamespaceNotFederated"

	PropagationConditionType ConditionType = "Propagation"
)

Functions

func SetPropagationStatus

func SetPropagationStatus(fedObject *unstructured.Unstructured, reason AggregateReason, collectedStatus CollectedPropagationStatus) (bool, error)

SetPropagationStatus sets the conditions and clusters fields of the federated resource's object map from the provided reason and collected propagation status. Returns a boolean indication of whether status should be written to the API.

Types

type AggregateReason

type AggregateReason string

type CollectedPropagationStatus

type CollectedPropagationStatus struct {
	StatusMap        PropagationStatusMap
	ResourcesUpdated bool
}

type ConditionType

type ConditionType string

type GenericClusterStatus

type GenericClusterStatus struct {
	Name   string            `json:"name"`
	Status PropagationStatus `json:"status,omitempty"`
}

type GenericCondition

type GenericCondition struct {
	// Type of cluster condition
	Type ConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status apiv1.ConditionStatus `json:"status"`
	// Last time reconciliation resulted in an error or the last time a
	// change was propagated to member clusters.
	// +optional
	LastUpdateTime string `json:"lastUpdateTime,omitempty"`
	// Last time the condition transit from one status to another.
	// +optional
	LastTransitionTime string `json:"lastTransitionTime,omitempty"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason AggregateReason `json:"reason,omitempty"`
}

type GenericFederatedStatus

type GenericFederatedStatus struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Status *GenericPropagationStatus `json:"status,omitempty"`
}

type GenericPropagationStatus

type GenericPropagationStatus struct {
	Conditions []*GenericCondition    `json:"conditions,omitempty"`
	Clusters   []GenericClusterStatus `json:"clusters,omitempty"`
}

type PropagationStatus

type PropagationStatus string

type PropagationStatusMap

type PropagationStatusMap map[string]PropagationStatus