status

Documentation

Overview

Copyright Contributors to the Open Cluster Management project

Copyright Contributors to the Open Cluster Management project

Copyright Contributors to the Open Cluster Management project

Copyright Contributors to the Open Cluster Management project

Index

• Constants
• func NewCondition(condType bpv1alpha1.MultiClusterEngineConditionType, ...) bpv1alpha1.MultiClusterEngineCondition
• type ClusterManagerStatus
  • func (cms ClusterManagerStatus) GetKind() string
  • func (cms ClusterManagerStatus) GetName() string
  • func (cms ClusterManagerStatus) GetNamespace() string
  • func (cms ClusterManagerStatus) Status(k8sClient client.Client) bpv1alpha1.ComponentCondition
• type DeploymentStatus
  • func (ds DeploymentStatus) GetKind() string
  • func (ds DeploymentStatus) GetName() string
  • func (ds DeploymentStatus) GetNamespace() string
  • func (ds DeploymentStatus) Status(k8sClient client.Client) bpv1alpha1.ComponentCondition
• type StatusReporter
• type StatusTracker
  • func (sm *StatusTracker) AddComponent(sr StatusReporter)
  • func (sm *StatusTracker) AddCondition(c bpv1alpha1.MultiClusterEngineCondition)
  • func (sm *StatusTracker) ReportStatus(mce bpv1alpha1.MultiClusterEngine) bpv1alpha1.MultiClusterEngineStatus
  • func (sm *StatusTracker) Reset(uid string)

Constants

const (
	// ComponentsAvailableReason is when all desired components are running successfully
	ComponentsAvailableReason = "ComponentsAvailable"
	// ComponentsUnavailableReason is when one or more components are in an unready state
	ComponentsUnavailableReason = "ComponentsUnavailable"
	// DeployFailedReason is added when the hub fails to deploy a resource
	DeployFailedReason = "FailedDeployingComponent"
	// DeploySuccessReason is when all component have been deployed
	DeploySuccessReason = "ComponentsDeployed"
	// RequirementsNotMetReason is when there is something missing or misconfigured
	// that is preventing progress
	RequirementsNotMetReason = "RequirementsNotMet"
	// DeleteTimestampReason means the resource is schedule for deletion with a DeletionTimestamp present
	DeleteTimestampReason = "DeletionTimestampPresent"
	// WaitingForResourceReason means the reconciler is waiting on a resource before it can progress
	WaitingForResourceReason = "WaitingForResource"
	// PausedReason is added when the multiclusterengine is paused
	PausedReason = "Paused"
)

Functions

func NewCondition

func NewCondition(condType bpv1alpha1.MultiClusterEngineConditionType, status metav1.ConditionStatus, reason, message string) bpv1alpha1.MultiClusterEngineCondition

NewCondition creates a new condition.

Types

type ClusterManagerStatus

type ClusterManagerStatus struct {
	types.NamespacedName
}

DeploymentStatus fulfills the StatusReporter interface for deployments

func (ClusterManagerStatus) GetKind

func (cms ClusterManagerStatus) GetKind() string

func (ClusterManagerStatus) GetName

func (cms ClusterManagerStatus) GetName() string

func (ClusterManagerStatus) GetNamespace

func (cms ClusterManagerStatus) GetNamespace() string

func (ClusterManagerStatus) Status

func (cms ClusterManagerStatus) Status(k8sClient client.Client) bpv1alpha1.ComponentCondition

Converts a ClusterManager's status to a backplane component status

type DeploymentStatus

type DeploymentStatus struct {
	types.NamespacedName
}

DeploymentStatus fulfills the StatusReporter interface for deployments

func (DeploymentStatus) GetKind

func (ds DeploymentStatus) GetKind() string

func (DeploymentStatus) GetName

func (ds DeploymentStatus) GetName() string

func (DeploymentStatus) GetNamespace

func (ds DeploymentStatus) GetNamespace() string

func (DeploymentStatus) Status

func (ds DeploymentStatus) Status(k8sClient client.Client) bpv1alpha1.ComponentCondition

Converts a deployment's status to a backplane component status

type StatusReporter

type StatusReporter interface {
	GetName() string
	GetNamespace() string
	GetKind() string
	Status(client.Client) bpv1alpha1.ComponentCondition
}

StatusReporter is a resource that can report back a status

type StatusTracker

type StatusTracker struct {
	Client     client.Client
	UID        string
	Components []StatusReporter
	Conditions []bpv1alpha1.MultiClusterEngineCondition
}

func (*StatusTracker) AddComponent

func (sm *StatusTracker) AddComponent(sr StatusReporter)

Adds a StatusReporter to the list of statuses to watch

func (*StatusTracker) AddCondition

func (sm *StatusTracker) AddCondition(c bpv1alpha1.MultiClusterEngineCondition)

func (*StatusTracker) ReportStatus

func (sm *StatusTracker) ReportStatus(mce bpv1alpha1.MultiClusterEngine) bpv1alpha1.MultiClusterEngineStatus

func (*StatusTracker) Reset

func (sm *StatusTracker) Reset(uid string)

Flush out any cached data being tracked, and assigns the tracker to a UID