constants

Documentation

Index

• Constants
• type AggregationLevel
• type MessageCompressionType

Constants

const (
	// AnnotationMCHPause sits in MulticlusterGlobalHub annotations
	// to identify if the MulticlusterGlobalHub is paused or not
	AnnotationMGHPause = "mgh-pause"
	// AnnotationMGHSkipDBInit skips database initialization, used for dev/test
	AnnotationMGHSkipDBInit = "mgh-skip-database-init"
	// AnnotationImageRepo sits in MulticlusterGlobalHub annotations
	// to identify a custom image repository to use
	AnnotationImageRepo = "mgh-image-repository"
	// AnnotationImageOverridesCM sits in MulticlusterGlobalHub annotations
	// to identify a custom configmap containing image overrides
	AnnotationImageOverridesCM = "mgh-image-overrides-cm"
	// AnnotationMGHSchedulerInterval sits in MulticlusterGlobalHub annotations
	// to identify the scheduler interval for moving policy compliance history
	// valid value can be "month, week, day, hour, minute, second"
	AnnotationMGHSchedulerInterval = "mgh-scheduler-interval"
	// MGHOperandImagePrefix ...
	MGHOperandImagePrefix = "RELATED_IMAGE_"
)

annotations for MGH CR

const (
	LocalClusterName = "local-cluster"

	OpenshiftMarketPlaceNamespace = "openshift-marketplace"
	ACMSubscriptionPublicSource   = "redhat-operators"
	ACMSubscriptionPrivateSource  = "acm-custom-registry"
	ACMPackageManifestName        = "advanced-cluster-management"
	MCEPackageManifestName        = "multicluster-engine"
)

hub installation constants

const (
	GHClusterManagementAddonName = "multicluster-global-hub-controller"
	GHManagedClusterAddonName    = "multicluster-global-hub-controller"
)

global hub agent constants

const (
	GHManagerDeploymentName = "multicluster-global-hub-manager"
	GHGrafanaDeploymentName = "multicluster-global-hub-grafana"
)

global hub names

const (
	GHTransportSecretName = "multicluster-global-hub-transport" // #nosec G101
	GHStorageSecretName   = "multicluster-global-hub-storage"   // #nosec G101
)

global hub transport and storage secret names

const (
	// AnnotationAddonHostingClusterName is the annotation for indicating the hosting cluster name in the addon
	AnnotationAddonHostingClusterName = "addon.open-cluster-management.io/hosting-cluster-name"
	// AnnotationClusterHostingClusterName is the annotation for indicating the hosting cluster name in the cluster
	AnnotationClusterHostingClusterName        = "import.open-cluster-management.io/hosting-cluster-name"
	AnnotationClusterDeployMode                = "import.open-cluster-management.io/klusterlet-deploy-mode"
	AnnotationClusterKlusterletDeployNamespace = "import.open-cluster-management.io/klusterlet-namespace"
	ClusterDeployModeHosted                    = "Hosted"
	ClusterDeployModeDefault                   = "Default"

	// GHAgentDeployModeLabelKey is to indicate which deploy mode the agent is installed.
	GHAgentDeployModeLabelKey = "global-hub.open-cluster-management.io/agent-deploy-mode"
	// GHAgentDeployModeHosted is to install agent in Hosted mode
	GHAgentDeployModeHosted = "Hosted"
	// GHAgentDeployModeDefault is to install agent in Default mode
	GHAgentDeployModeDefault = "Default"
	// GHAgentDeployModeNone is to not install agent
	GHAgentDeployModeNone   = "None"
	GHAgentInstallNamespace = "open-cluster-management-agent-addon"

	// GHAgentInstallACMHubLabelKey is to indicate whether to install ACM hub on the agent
	GHAgentACMHubInstallLabelKey = "global-hub.open-cluster-management.io/hub-cluster-install"
)

const (
	// ControllerLeaderElectionConfig allows customizing LeaseDuration, RenewDeadline and RetryPeriod
	// for operator, manager and agent via the ConfigMap
	ControllerLeaderElectionConfig = "controller-leader-election-configmap"
)

Types

type AggregationLevel

type AggregationLevel string

AggregationLevel specifies the level of aggregation leaf hubs should do before sending the information Enum=full;minimal

const (
	// FullAggregation is an AggregationLevel
	FullAggregation AggregationLevel = "full"
	// MinimalAggregation is an AggregationLevel
	MinimalAggregation AggregationLevel = "minimal"
)

type MessageCompressionType

type MessageCompressionType string

MessageCompressionType specifies the compression type of transport message between global hub and regional hubs Enum=gzip;no-op

const (
	// GzipCompressType is an MessageCompressionType
	GzipCompressType MessageCompressionType = "gzip"
	// NoopCompressType is an MessageCompressionType
	NoopCompressType MessageCompressionType = "no-op"
)