scope

Documentation

Index

• type ClusterProfileScope
  • func NewClusterProfileScope(params ClusterProfileScopeParams) (*ClusterProfileScope, error)
  • func (s *ClusterProfileScope) Close(ctx context.Context) error
  • func (s *ClusterProfileScope) ControllerName() string
  • func (s *ClusterProfileScope) GetSelector() string
  • func (s *ClusterProfileScope) IsContinuousSync() bool
  • func (s *ClusterProfileScope) IsDryRunSync() bool
  • func (s *ClusterProfileScope) IsOneTimeSync() bool
  • func (s *ClusterProfileScope) Name() string
  • func (s *ClusterProfileScope) PatchObject(ctx context.Context) error
  • func (s *ClusterProfileScope) SetMatchingClusterRefs(matchingClusters []corev1.ObjectReference)
• type ClusterProfileScopeParams
• type ClusterSummaryScope
  • func NewClusterSummaryScope(params ClusterSummaryScopeParams) (*ClusterSummaryScope, error)
  • func (s *ClusterSummaryScope) Close(ctx context.Context) error
  • func (s *ClusterSummaryScope) IsContinuousSync() bool
  • func (s *ClusterSummaryScope) IsDryRunSync() bool
  • func (s *ClusterSummaryScope) IsOneTimeSync() bool
  • func (s *ClusterSummaryScope) Name() string
  • func (s *ClusterSummaryScope) Namespace() string
  • func (s *ClusterSummaryScope) PatchObject(ctx context.Context) error
  • func (s *ClusterSummaryScope) SetFailureMessage(featureID configv1alpha1.FeatureID, failureMessage *string)
  • func (s *ClusterSummaryScope) SetFailureReason(featureID configv1alpha1.FeatureID, failureReason *string)
  • func (s *ClusterSummaryScope) SetFeatureStatus(featureID configv1alpha1.FeatureID, status configv1alpha1.FeatureStatus, ...)
  • func (s *ClusterSummaryScope) SetLastAppliedTime(featureID configv1alpha1.FeatureID, lastAppliedTime *metav1.Time)
• type ClusterSummaryScopeParams

Types

type ClusterProfileScope

type ClusterProfileScope struct {
	logr.Logger

	ClusterProfile *configv1alpha1.ClusterProfile
	// contains filtered or unexported fields
}

ClusterProfileScope defines the basic context for an actuator to operate upon.

func NewClusterProfileScope

func NewClusterProfileScope(params ClusterProfileScopeParams) (*ClusterProfileScope, error)

NewClusterProfileScope creates a new ClusterProfile Scope from the supplied parameters. This is meant to be called for each reconcile iteration.

func (*ClusterProfileScope) Close

func (s *ClusterProfileScope) Close(ctx context.Context) error

Close closes the current scope persisting the clusterprofile configuration and status.

func (*ClusterProfileScope) ControllerName

func (s *ClusterProfileScope) ControllerName() string

ControllerName returns the name of the controller that created the ClusterProfileScope.

func (*ClusterProfileScope) GetSelector

func (s *ClusterProfileScope) GetSelector() string

GetSelector returns the ClusterSelector

func (*ClusterProfileScope) IsContinuousSync

func (s *ClusterProfileScope) IsContinuousSync() bool

IsContinuousSync returns true if ClusterProfile is set to keep updating workload cluster

func (*ClusterProfileScope) IsDryRunSync

func (s *ClusterProfileScope) IsDryRunSync() bool

IsDryRunSync returns true if ClusterProfile sync mod is set to dryRun

func (*ClusterProfileScope) IsOneTimeSync

func (s *ClusterProfileScope) IsOneTimeSync() bool

IsOneTimeSync returns true if ClusterProfile sync mod is set to one time

func (*ClusterProfileScope) Name

func (s *ClusterProfileScope) Name() string

Name returns the ClusterProfile name.

func (*ClusterProfileScope) PatchObject

func (s *ClusterProfileScope) PatchObject(ctx context.Context) error

PatchObject persists the feature configuration and status.

func (*ClusterProfileScope) SetMatchingClusterRefs

func (s *ClusterProfileScope) SetMatchingClusterRefs(matchingClusters []corev1.ObjectReference)

SetMatchingClusterRefs sets the feature status.

type ClusterProfileScopeParams

type ClusterProfileScopeParams struct {
	Client         client.Client
	Logger         logr.Logger
	ClusterProfile *configv1alpha1.ClusterProfile
	ControllerName string
}

ClusterProfileScopeParams defines the input parameters used to create a new ClusterProfile Scope.

type ClusterSummaryScope

type ClusterSummaryScope struct {
	logr.Logger

	ClusterProfile *configv1alpha1.ClusterProfile
	ClusterSummary *configv1alpha1.ClusterSummary
	// contains filtered or unexported fields
}

ClusterSummaryScope defines the basic context for an actuator to operate upon.

func NewClusterSummaryScope

func NewClusterSummaryScope(params ClusterSummaryScopeParams) (*ClusterSummaryScope, error)

NewClusterSummaryScope creates a new ClusterSummary Scope from the supplied parameters. This is meant to be called for each reconcile iteration.

func (*ClusterSummaryScope) Close

func (s *ClusterSummaryScope) Close(ctx context.Context) error

Close closes the current scope persisting the clusterprofile configuration and status.

func (*ClusterSummaryScope) IsContinuousSync

func (s *ClusterSummaryScope) IsContinuousSync() bool

IsContinuousSync returns true if ClusterProfile is set to keep updating workload cluster

func (*ClusterSummaryScope) IsDryRunSync

func (s *ClusterSummaryScope) IsDryRunSync() bool

IsDryRunSync returns true if ClusterProfile sync mod is set to dryRun

func (*ClusterSummaryScope) IsOneTimeSync

func (s *ClusterSummaryScope) IsOneTimeSync() bool

IsOneTimeSync returns true if ClusterProfile sync mod is set to one time

func (*ClusterSummaryScope) Name

func (s *ClusterSummaryScope) Name() string

Name returns the ClusterSummary name.

func (*ClusterSummaryScope) Namespace

func (s *ClusterSummaryScope) Namespace() string

Namespace returns the ClusterSummary namespace.

func (*ClusterSummaryScope) PatchObject

func (s *ClusterSummaryScope) PatchObject(ctx context.Context) error

PatchObject persists the cluster configuration and status.

func (*ClusterSummaryScope) SetFailureMessage

func (s *ClusterSummaryScope) SetFailureMessage(featureID configv1alpha1.FeatureID, failureMessage *string)

SetFailureMessage sets the infrastructure status failure message.

func (*ClusterSummaryScope) SetFailureReason

func (s *ClusterSummaryScope) SetFailureReason(featureID configv1alpha1.FeatureID,
	failureReason *string)

SetFailureReason sets the feature status failure reason.

func (*ClusterSummaryScope) SetFeatureStatus

func (s *ClusterSummaryScope) SetFeatureStatus(featureID configv1alpha1.FeatureID,
	status configv1alpha1.FeatureStatus, hash []byte)

SetFeatureStatus sets the feature status.

func (*ClusterSummaryScope) SetLastAppliedTime

func (s *ClusterSummaryScope) SetLastAppliedTime(featureID configv1alpha1.FeatureID,
	lastAppliedTime *metav1.Time)

type ClusterSummaryScopeParams

type ClusterSummaryScopeParams struct {
	Client         client.Client
	Logger         logr.Logger
	ClusterProfile *configv1alpha1.ClusterProfile
	ClusterSummary *configv1alpha1.ClusterSummary
	ControllerName string
}

ClusterSummaryScopeParams defines the input parameters used to create a new ClusterSummary Scope.