operations

package
v0.9.1-beta.26 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 20, 2024 License: AGPL-3.0 Imports: 52 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	OpsReasonForSkipSwitchover = "SkipSwitchover"

	KBSwitchoverCandidateInstanceForAnyPod = "*"

	KBJobTTLSecondsAfterFinished  = 5
	KBSwitchoverJobLabelKey       = "kubeblocks.io/switchover-job"
	KBSwitchoverJobLabelValue     = "kb-switchover-job"
	KBSwitchoverJobNamePrefix     = "kb-switchover-job"
	KBSwitchoverJobContainerName  = "kb-switchover-job-container"
	KBSwitchoverCheckJobKey       = "CheckJob"
	KBSwitchoverCheckRoleLabelKey = "CheckRoleLabel"

	KBSwitchoverCandidateName = "KB_SWITCHOVER_CANDIDATE_NAME"
	KBSwitchoverCandidateFqdn = "KB_SWITCHOVER_CANDIDATE_FQDN"

	// KBSwitchoverReplicationPrimaryPodIP and the others Replication and Consensus switchover constants will be deprecated in the future, use KBSwitchoverLeaderPodIP instead.
	KBSwitchoverReplicationPrimaryPodIP   = "KB_REPLICATION_PRIMARY_POD_IP"
	KBSwitchoverReplicationPrimaryPodName = "KB_REPLICATION_PRIMARY_POD_NAME"
	KBSwitchoverReplicationPrimaryPodFqdn = "KB_REPLICATION_PRIMARY_POD_FQDN"
	KBSwitchoverConsensusLeaderPodIP      = "KB_CONSENSUS_LEADER_POD_IP"
	KBSwitchoverConsensusLeaderPodName    = "KB_CONSENSUS_LEADER_POD_NAME"
	KBSwitchoverConsensusLeaderPodFqdn    = "KB_CONSENSUS_LEADER_POD_FQDN"

	KBSwitchoverLeaderPodIP   = "KB_LEADER_POD_IP"
	KBSwitchoverLeaderPodName = "KB_LEADER_POD_NAME"
	KBSwitchoverLeaderPodFqdn = "KB_LEADER_POD_FQDN"
)

switchover constants

View Source 
const (
	// VolumeExpansionTimeOut volume expansion timeout.
	VolumeExpansionTimeOut = 30 * time.Minute
)

Variables

This section is empty.

Functions

func DequeueOpsRequestInClusterAnnotation added in v0.8.0 

func DequeueOpsRequestInClusterAnnotation(ctx context.Context, cli client.Client, opsRes *OpsResource) error

DequeueOpsRequestInClusterAnnotation when OpsRequest.status.phase is Succeeded or Failed we should remove the OpsRequest Annotation of cluster, then unlock cluster

func GetOpsRecorderFromSlice 

func GetOpsRecorderFromSlice(opsRequestSlice []appsv1alpha1.OpsRecorder,
	opsRequestName string) (int, appsv1alpha1.OpsRecorder)

GetOpsRecorderFromSlice gets OpsRequest recorder from slice by target cluster phase

func PatchClusterNotFound 

func PatchClusterNotFound(ctx context.Context, cli client.Client, opsRes *OpsResource) error

PatchClusterNotFound patches ClusterNotFound condition to the OpsRequest.status.conditions.

func PatchOpsHandlerNotSupported added in v0.8.0 

func PatchOpsHandlerNotSupported(ctx context.Context, cli client.Client, opsRes *OpsResource) error

PatchOpsHandlerNotSupported patches OpsNotSupported condition to the OpsRequest.status.conditions.

func PatchOpsStatus 

func PatchOpsStatus(ctx context.Context,
	cli client.Client,
	opsRes *OpsResource,
	phase appsv1alpha1.OpsPhase,
	condition ...*metav1.Condition) error

PatchOpsStatus patches OpsRequest.status

func PatchOpsStatusWithOpsDeepCopy added in v0.6.0 

func PatchOpsStatusWithOpsDeepCopy(ctx context.Context,
	cli client.Client,
	opsRes *OpsResource,
	opsRequestDeepCopy *appsv1alpha1.OpsRequest,
	phase appsv1alpha1.OpsPhase,
	condition ...*metav1.Condition) error

PatchOpsStatusWithOpsDeepCopy patches OpsRequest.status with the deepCopy opsRequest.

Types

type BackupOpsHandler added in v0.7.0 

type BackupOpsHandler struct{}

func (BackupOpsHandler) Action added in v0.7.0 

func (b BackupOpsHandler) Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

Action implements the backup action. It will create a backup resource for cluster.

func (BackupOpsHandler) ActionStartedCondition added in v0.7.0 

func (b BackupOpsHandler) ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error)

ActionStartedCondition the started condition when handling the backup request.

func (BackupOpsHandler) ReconcileAction added in v0.7.0 

func (b BackupOpsHandler) ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error)

ReconcileAction implements the backup reconcile action. It will check the backup status and update the OpsRequest status. If the backup is completed, it will return OpsSuccess If the backup is failed, it will return OpsFailed

func (BackupOpsHandler) SaveLastConfiguration added in v0.7.0 

func (b BackupOpsHandler) SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

SaveLastConfiguration records last configuration to the OpsRequest.status.lastConfiguration

type ComponentOpsInterface added in v0.9.0 

type ComponentOpsInterface interface {
	GetComponentName() string
}

type CustomOpsHandler added in v0.8.0 

type CustomOpsHandler struct{}

func (CustomOpsHandler) Action added in v0.8.0 

func (c CustomOpsHandler) Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

func (CustomOpsHandler) ActionStartedCondition added in v0.8.0 

func (c CustomOpsHandler) ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error)

ActionStartedCondition the started condition when handling the stop request.

func (CustomOpsHandler) ReconcileAction added in v0.8.0 

func (c CustomOpsHandler) ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error)

ReconcileAction will be performed when action is done and loops till OpsRequest.status.phase is Succeed/Failed. the Reconcile function for stop opsRequest.

func (CustomOpsHandler) SaveLastConfiguration added in v0.8.0 

func (c CustomOpsHandler) SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

SaveLastConfiguration records last configuration to the OpsRequest.status.lastConfiguration

type DataScriptOpsHandler added in v0.6.0 

type DataScriptOpsHandler struct {
}

DataScriptOpsHandler handles DataScript operation, it is more like a one-time command operation.

func (DataScriptOpsHandler) Action added in v0.6.0 

func (o DataScriptOpsHandler) Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error

Action implements OpsHandler.Action It will create a job to execute the script. It will fail fast if the script is not valid, or the target pod is not found.

func (DataScriptOpsHandler) ActionStartedCondition added in v0.6.0 

func (o DataScriptOpsHandler) ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error)

func (DataScriptOpsHandler) ReconcileAction added in v0.6.0 

func (o DataScriptOpsHandler) ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error)

ReconcileAction implements OpsHandler.ReconcileAction It will check the job status, and update the opsRequest status. If the job is neither completed nor failed, it will retry after 1 second. If the job is completed, it will return OpsSucceedPhase If the job is failed, it will return OpsFailedPhase.

func (DataScriptOpsHandler) SaveLastConfiguration added in v0.6.0 

func (o DataScriptOpsHandler) SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error

type ExposeOpsHandler 

type ExposeOpsHandler struct {
}

func (ExposeOpsHandler) Action 

func (e ExposeOpsHandler) Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

func (ExposeOpsHandler) ActionStartedCondition 

func (e ExposeOpsHandler) ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error)

func (ExposeOpsHandler) ReconcileAction 

func (e ExposeOpsHandler) ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error)

func (ExposeOpsHandler) SaveLastConfiguration 

func (e ExposeOpsHandler) SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error

type OpsBehaviour 

type OpsBehaviour struct {
	FromClusterPhases []appsv1alpha1.ClusterPhase

	// ToClusterPhase indicates that the cluster will enter this phase during the operation.
	// All opsRequest with ToClusterPhase are mutually exclusive.
	ToClusterPhase appsv1alpha1.ClusterPhase

	// CancelFunc this function defines the cancel action and does not patch/update the opsRequest by client-go in here.
	// only update the opsRequest object, then opsRequest controller will update uniformly.
	CancelFunc func(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error

	// IsClusterCreation indicates whether the opsRequest will create a new cluster.
	IsClusterCreation bool

	// QueueByCluster indicates that the operation is queued for execution within the cluster-wide scope.
	QueueByCluster bool

	// QueueWithSelf indicates that the operation is queued for execution within opsType scope.
	QueueBySelf bool

	OpsHandler OpsHandler
}

type OpsHandler 

type OpsHandler interface {
	// Action The action duration should be short. if it fails, it will be reconciled by the OpsRequest controller.
	// Do not patch OpsRequest status in this function with k8s client, just modify the status of ops.
	// The opsRequest controller will patch it to the k8s apiServer.
	Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error

	// ReconcileAction loops till the operation is completed.
	// return OpsRequest.status.phase and requeueAfter time.
	ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error)

	// ActionStartedCondition appends to OpsRequest.status.conditions when start performing Action function
	ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error)

	// SaveLastConfiguration saves last configuration to the OpsRequest.status.lastConfiguration,
	// and this method will be executed together when opsRequest in running.
	SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error
}

type OpsManager 

type OpsManager struct {
	OpsMap map[appsv1alpha1.OpsType]OpsBehaviour
}

func GetOpsManager 

func GetOpsManager() *OpsManager

func (*OpsManager) Do 

func (opsMgr *OpsManager) Do(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*ctrl.Result, error)

Do the entry function for handling OpsRequest

func (*OpsManager) Reconcile 

func (opsMgr *OpsManager) Reconcile(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (time.Duration, error)

Reconcile entry function when OpsRequest.status.phase is Running. loops till the operation is completed.

func (*OpsManager) RegisterOps 

func (opsMgr *OpsManager) RegisterOps(opsType appsv1alpha1.OpsType, opsBehaviour OpsBehaviour)

RegisterOps registers operation with OpsType and OpsBehaviour

type OpsResource 

type OpsResource struct {
	OpsDef         *appsv1alpha1.OpsDefinition
	OpsRequest     *appsv1alpha1.OpsRequest
	Cluster        *appsv1alpha1.Cluster
	Recorder       record.EventRecorder
	ToClusterPhase appsv1alpha1.ClusterPhase
}

type RestoreOpsHandler added in v0.8.0 

type RestoreOpsHandler struct{}

func (RestoreOpsHandler) Action added in v0.8.0 

func (r RestoreOpsHandler) Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

Action implements the restore action.

func (RestoreOpsHandler) ActionStartedCondition added in v0.8.0 

func (r RestoreOpsHandler) ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error)

ActionStartedCondition the started condition when handling the restore request.

func (RestoreOpsHandler) ReconcileAction added in v0.8.0 

func (r RestoreOpsHandler) ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error)

ReconcileAction implements the restore action. It will check the cluster status and update the OpsRequest status. If the cluster is running, it will update the OpsRequest status to Complete. If the cluster is failed, it will update the OpsRequest status to Failed. If the cluster is not running, it will update the OpsRequest status to Running.

func (RestoreOpsHandler) SaveLastConfiguration added in v0.8.0 

func (r RestoreOpsHandler) SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsResource *OpsResource) error

SaveLastConfiguration saves last configuration to the OpsRequest.status.lastConfiguration

type StartOpsHandler 

type StartOpsHandler struct{}

func (StartOpsHandler) Action 

func (start StartOpsHandler) Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

Action modifies Cluster.spec.components[*].replicas from the opsRequest

func (StartOpsHandler) ActionStartedCondition 

func (start StartOpsHandler) ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error)

ActionStartedCondition the started condition when handling the start request.

func (StartOpsHandler) ReconcileAction 

func (start StartOpsHandler) ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error)

ReconcileAction will be performed when action is done and loops till OpsRequest.status.phase is Succeed/Failed. the Reconcile function for start opsRequest.

func (StartOpsHandler) SaveLastConfiguration 

func (start StartOpsHandler) SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

SaveLastConfiguration records last configuration to the OpsRequest.status.lastConfiguration

type StopOpsHandler 

type StopOpsHandler struct{}

func (StopOpsHandler) Action 

func (stop StopOpsHandler) Action(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

Action modifies Cluster.spec.components[*].replicas from the opsRequest

func (StopOpsHandler) ActionStartedCondition 

func (stop StopOpsHandler) ActionStartedCondition(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (*metav1.Condition, error)

ActionStartedCondition the started condition when handling the stop request.

func (StopOpsHandler) ReconcileAction 

func (stop StopOpsHandler) ReconcileAction(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) (appsv1alpha1.OpsPhase, time.Duration, error)

ReconcileAction will be performed when action is done and loops till OpsRequest.status.phase is Succeed/Failed. the Reconcile function for stop opsRequest.

func (StopOpsHandler) SaveLastConfiguration 

func (stop StopOpsHandler) SaveLastConfiguration(reqCtx intctrlutil.RequestCtx, cli client.Client, opsRes *OpsResource) error

SaveLastConfiguration records last configuration to the OpsRequest.status.lastConfiguration

type SwitchoverMessage added in v0.6.0 

type SwitchoverMessage struct {
	appsv1alpha1.Switchover
	OldPrimary string
	Cluster    string
}

SwitchoverMessage is the OpsRequest.Status.Condition.Message for switchover.

type WaitForClusterPhaseErr added in v0.6.0 

type WaitForClusterPhaseErr struct {
	// contains filtered or unexported fields
}

func (*WaitForClusterPhaseErr) Error added in v0.6.0 

func (e *WaitForClusterPhaseErr) Error() string

type WorkflowContext added in v0.9.0 

type WorkflowContext struct {
	Cli    client.Client
	OpsRes *OpsResource
	// contains filtered or unexported fields
}

func NewWorkflowContext added in v0.9.0 

func NewWorkflowContext(
	ctx intctrlutil.RequestCtx,
	cli client.Client,
	opsRes *OpsResource) *WorkflowContext

func (*WorkflowContext) Run added in v0.9.0 

func (w *WorkflowContext) Run(compCustomSpec *appsv1alpha1.CustomOpsComponent) (*WorkflowStatus, error)

Run actions execution layer.

type WorkflowStatus added in v0.9.0 

type WorkflowStatus struct {
	IsCompleted    bool
	ExistFailure   bool
	CompletedCount int
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.