constant

Documentation

Index

• Constants

Constants

const (
	// config keys used in viper, DON'T refactor the value without careful inspections
	CfgKeyServerInfo                    = "_KUBE_SERVER_INFO"
	CfgKeyCtrlrMgrNS                    = "CM_NAMESPACE"
	CfgKeyCtrlrMgrAffinity              = "CM_AFFINITY"
	CfgKeyCtrlrMgrNodeSelector          = "CM_NODE_SELECTOR"
	CfgKeyCtrlrMgrTolerations           = "CM_TOLERATIONS"
	CfgKeyCtrlrReconcileRetryDurationMS = "CM_RECON_RETRY_DURATION_MS"       // accept time
	CfgKeyBackupPVCName                 = "BACKUP_PVC_NAME"                  // the global pvc name which persistent volume claim to store the backup data
	CfgKeyBackupPVCInitCapacity         = "BACKUP_PVC_INIT_CAPACITY"         // the init capacity of pvc for creating the pvc, e.g. 10Gi.
	CfgKeyBackupPVCStorageClass         = "BACKUP_PVC_STORAGE_CLASS"         // the pvc storage class name.
	CfgKeyBackupPVCCreatePolicy         = "BACKUP_PVC_CREATE_POLICY"         // the pvc create policy. support "IfNotPresent" or "Never"
	CfgKeyBackupPVConfigmapName         = "BACKUP_PV_CONFIGMAP_NAME"         // the configmap name which contains a persistentVolume template.
	CfgKeyBackupPVConfigmapNamespace    = "BACKUP_PV_CONFIGMAP_NAMESPACE"    // the configmap namespace which contains a persistentVolume template.
	CfgRecoverVolumeExpansionFailure    = "RECOVER_VOLUME_EXPANSION_FAILURE" // refer to feature gates RecoverVolumeExpansionFailure of k8s.

	// addon config keys
	CfgKeyAddonJobTTL        = "ADDON_JOB_TTL"
	CfgAddonJobImgPullPolicy = "ADDON_JOB_IMAGE_PULL_POLICY"
)

const (
	ConnCredentialPlaceHolder       = "$(CONN_CREDENTIAL_SECRET_NAME)"
	KBCompNamePlaceHolder           = "$(KB_COMP_NAME)"
	KBClusterNamePlaceHolder        = "$(KB_CLUSTER_NAME)"
	KBClusterCompNamePlaceHolder    = "$(KB_CLUSTER_COMP_NAME)"
	KBClusterUIDPostfix8PlaceHolder = "$(KB_CLUSTER_UID_POSTFIX_8)"
)

const (
	KBToolsImage      = "KUBEBLOCKS_TOOLS_IMAGE"
	KBImagePullPolicy = "KUBEBLOCKS_IMAGE_PULL_POLICY"
)

const (
	APIGroup = "kubeblocks.io"

	AppName = "kubeblocks"

	// K8s recommonded and well-known label and annotation keys
	AppInstanceLabelKey  = "app.kubernetes.io/instance"
	AppNameLabelKey      = "app.kubernetes.io/name"
	AppManagedByLabelKey = "app.kubernetes.io/managed-by"
	RegionLabelKey       = "topology.kubernetes.io/region"
	ZoneLabelKey         = "topology.kubernetes.io/zone"

	// kubeblocks.io labels
	ClusterDefLabelKey              = "clusterdefinition.kubeblocks.io/name"
	KBAppComponentLabelKey          = "apps.kubeblocks.io/component-name"
	KBAppComponentDefRefLabelKey    = "apps.kubeblocks.io/component-def-ref"
	ConsensusSetAccessModeLabelKey  = "cs.apps.kubeblocks.io/access-mode"
	AppConfigTypeLabelKey           = "apps.kubeblocks.io/config-type"
	WorkloadTypeLabelKey            = "apps.kubeblocks.io/workload-type"
	VolumeClaimTemplateNameLabelKey = "vct.kubeblocks.io/name"
	RoleLabelKey                    = "kubeblocks.io/role"              // RoleLabelKey consensusSet and replicationSet role label key
	BackupProtectionLabelKey        = "kubeblocks.io/backup-protection" // BackupProtectionLabelKey Backup delete protection policy label
	AddonNameLabelKey               = "extensions.kubeblocks.io/addon-name"
	ClusterAccountLabelKey          = "account.kubeblocks.io/name"
	VolumeTypeLabelKey              = "kubeblocks.io/volume-type"
	KBManagedByKey                  = "apps.kubeblocks.io/managed-by" // KBManagedByKey marks resources that auto created during operation
	ClassProviderLabelKey           = "class.kubeblocks.io/provider"
	BackupToolTypeLabelKey          = "kubeblocks.io/backup-tool-type"
	BackupTypeLabelKeyKey           = "dataprotection.kubeblocks.io/backup-type"
	AddonProviderLableKey           = "kubeblocks.io/provider" // AddonProviderLableKey marks the addon provider

	// kubeblocks.io annotations
	OpsRequestAnnotationKey                     = "kubeblocks.io/ops-request" // OpsRequestAnnotationKey OpsRequest annotation key in Cluster
	ReconcileAnnotationKey                      = "kubeblocks.io/reconcile"   // ReconcileAnnotationKey Notify k8s object to reconcile
	RestartAnnotationKey                        = "kubeblocks.io/restart"     // RestartAnnotationKey the annotation which notices the StatefulSet/DeploySet to restart
	SnapShotForStartAnnotationKey               = "kubeblocks.io/snapshot-for-start"
	RestoreFromBackUpAnnotationKey              = "kubeblocks.io/restore-from-backup" // RestoreFromBackUpAnnotationKey specifies the component to recover from the backup.
	ClusterSnapshotAnnotationKey                = "kubeblocks.io/cluster-snapshot"    // ClusterSnapshotAnnotationKey saves the snapshot of cluster.
	LeaderAnnotationKey                         = "cs.apps.kubeblocks.io/leader"
	ComponentReplicasAnnotationKey              = "apps.kubeblocks.io/component-replicas" // ComponentReplicasAnnotationKey specifies the number of pods in replicas
	BackupPolicyTemplateAnnotationKey           = "apps.kubeblocks.io/backup-policy-template"
	LastAppliedClusterAnnotationKey             = "apps.kubeblocks.io/last-applied-cluster"
	HaltRecoveryAllowInconsistentCVAnnotKey     = "clusters.apps.kubeblocks.io/allow-inconsistent-cv"
	HaltRecoveryAllowInconsistentResAnnotKey    = "clusters.apps.kubeblocks.io/allow-inconsistent-resource"
	DefaultBackupPolicyAnnotationKey            = "dataprotection.kubeblocks.io/is-default-policy"          // DefaultBackupPolicyAnnotationKey specifies the default backup policy.
	DefaultBackupPolicyTemplateAnnotationKey    = "dataprotection.kubeblocks.io/is-default-policy-template" // DefaultBackupPolicyTemplateAnnotationKey specifies the default backup policy template.
	BackupDataPathPrefixAnnotationKey           = "dataprotection.kubeblocks.io/path-prefix"                // BackupDataPathPrefixAnnotationKey specifies the backup data path prefix.
	RestoreFromTimeAnnotationKey                = "kubeblocks.io/restore-from-time"                         // RestoreFromTimeAnnotationKey specifies the time to recover from the backup.
	RestoreFromSrcClusterAnnotationKey          = "kubeblocks.io/restore-from-source-cluster"               // RestoreFromSrcClusterAnnotationKey specifies the source cluster to recover from the backup.
	DefaultClusterVersionAnnotationKey          = "kubeblocks.io/is-default-cluster-version"                // DefaultClusterVersionAnnotationKey specifies the default cluster version.
	ReconfigureRefAnnotationKey                 = "dataprotection.kubeblocks.io/reconfigure-ref"
	LastAppliedOpsCRAnnotationKey               = "config.kubeblocks.io/last-applied-ops-name"
	LastAppliedConfigAnnotationKey              = "config.kubeblocks.io/last-applied-configuration"
	DisableUpgradeInsConfigurationAnnotationKey = "config.kubeblocks.io/disable-reconfigure"
	UpgradePolicyAnnotationKey                  = "config.kubeblocks.io/reconfigure-policy"
	UpgradeRestartAnnotationKey                 = "config.kubeblocks.io/restart"
	KBParameterUpdateSourceAnnotationKey        = "config.kubeblocks.io/reconfigure-source"

	// kubeblocks.io well-known finalizers
	DBClusterFinalizerName = "cluster.kubeblocks.io/finalizer"

	// ConfigurationTplLabelPrefixKey clusterVersion or clusterdefinition using tpl
	ConfigurationTplLabelPrefixKey         = "config.kubeblocks.io/tpl"
	ConfigurationConstraintsLabelPrefixKey = "config.kubeblocks.io/constraints"

	// CMConfigurationTypeLabelKey configmap is config template type, e.g: "tpl", "instance"
	CMConfigurationTypeLabelKey            = "config.kubeblocks.io/config-type"
	CMConfigurationTemplateNameLabelKey    = "config.kubeblocks.io/config-template-name"
	CMConfigurationConstraintsNameLabelKey = "config.kubeblocks.io/config-constraints-name"
	CMInsConfigurationHashLabelKey         = "config.kubeblocks.io/config-hash"

	// CMConfigurationSpecProviderLabelKey is ComponentConfigSpec name
	CMConfigurationSpecProviderLabelKey = "config.kubeblocks.io/config-spec"

	// CMConfigurationCMKeysLabelKey Specify keys
	CMConfigurationCMKeysLabelKey = "config.kubeblocks.io/configmap-keys"

	// CMInsLastReconfigurePhaseKey defines the current phase
	CMInsLastReconfigurePhaseKey = "config.kubeblocks.io/last-applied-reconfigure-phase"

	// CMInsEnableRerenderTemplateKey is used to enable rerender template
	CMInsEnableRerenderTemplateKey = "config.kubeblocks.io/enable-rerender"

	// configuration finalizer
	ConfigurationTemplateFinalizerName = "config.kubeblocks.io/finalizer"

	// ClassAnnotationKey is used to specify the class of components
	ClassAnnotationKey = "cluster.kubeblocks.io/component-class"
)

const (
	// ReasonNotFoundCR referenced custom resource not found
	ReasonNotFoundCR = "NotFound"
	// ReasonRefCRUnavailable  referenced custom resource is unavailable
	ReasonRefCRUnavailable = "Unavailable"
	// ReasonDeletedCR deleted custom resource
	ReasonDeletedCR = "DeletedCR"
	// ReasonDeletingCR deleting custom resource
	ReasonDeletingCR = "DeletingCR"
	// ReasonCreatedCR created custom resource
	ReasonCreatedCR = "CreatedCR"
	// ReasonRunTaskFailed run task failed
	ReasonRunTaskFailed = "RunTaskFailed"
	// ReasonDeleteFailed delete failed
	ReasonDeleteFailed = "DeleteFailed"
)

const (
	DeploymentKind            = "Deployment"
	StatefulSetKind           = "StatefulSet"
	PodKind                   = "Pod"
	PersistentVolumeClaimKind = "PersistentVolumeClaim"
	CronJobKind               = "CronJob"
	JobKind                   = "Job"
	ReplicaSetKind            = "ReplicaSet"
	VolumeSnapshotKind        = "VolumeSnapshot"
	ServiceKind               = "Service"
	ConfigMapKind             = "ConfigMap"
	DaemonSetKind             = "DaemonSet"
)

const (
	// BackupRetain always retained, unless manually deleted by the user
	BackupRetain = "Retain"

	// BackupRetainUntilExpired retains backup till it expires
	BackupRetainUntilExpired = "RetainUntilExpired"

	// BackupDelete (default) deletes backup immediately when cluster's terminationPolicy is WipeOut
	BackupDelete = "Delete"
)

const (
	// Container port name
	ProbeHTTPPortName         = "probe-http-port"
	ProbeGRPCPortName         = "probe-grpc-port"
	RoleProbeContainerName    = "kb-checkrole"
	StatusProbeContainerName  = "kb-checkstatus"
	RunningProbeContainerName = "kb-checkrunning"

	// the filedpath name used in event.InvolvedObject.FieldPath
	ProbeCheckRolePath    = "spec.containers{" + RoleProbeContainerName + "}"
	ProbeCheckStatusPath  = "spec.containers{" + StatusProbeContainerName + "}"
	ProbeCheckRunningPath = "spec.containers{" + RunningProbeContainerName + "}"

	// KubeBlocksDataNodeLabelKey is the node label key of the built-in data node label
	KubeBlocksDataNodeLabelKey = "kb-data"
	// KubeBlocksDataNodeLabelValue is the node label value of the built-in data node label
	KubeBlocksDataNodeLabelValue = "true"
	// KubeBlocksDataNodeTolerationKey is the taint label key of the built-in data node taint
	KubeBlocksDataNodeTolerationKey = "kb-data"
	// KubeBlocksDataNodeTolerationValue is the taint label value of the built-in data node taint
	KubeBlocksDataNodeTolerationValue = "true"
)

const (
	ConfigSidecarName        = "config-manager"
	ConfigManagerGPRCPortEnv = "CONFIG_MANAGER_GRPC_PORT"
	ConfigManagerLogLevel    = "CONFIG_MANAGER_LOG_LEVEL"

	PodMinReadySecondsEnv = "POD_MIN_READY_SECONDS"
	ConfigTemplateType    = "tpl"
	ConfigInstanceType    = "instance"

	ReconfigureManagerSource  = "manager"
	ReconfigureUserSource     = "ops"
	ReconfigureTemplateSource = "external-template"
)

const (
	AccountNameForSecret   = "username"
	AccountPasswdForSecret = "password"
)

username and password are keys in created secrets for others to refer to.

const DefaultBackupPvcInitCapacity = "20Gi"

const (
	KBPrefix = "KB"
)

const (
	KBReplicationSetPrimaryPodName = "KB_PRIMARY_POD_NAME"
)