karmada

Documentation

Index

• Constants
• type Action
• type Controller
  • func (ctrl *Controller) Reconcile(ctx context.Context, req controllerruntime.Request) (controllerruntime.Result, error)
  • func (ctrl *Controller) SetupWithManager(mgr controllerruntime.Manager) error
• type Planner
  • func NewPlannerFor(karmada *operatorv1alpha1.Karmada, c client.Client, config *rest.Config) (*Planner, error)
  • func (p *Planner) Execute() error

Constants

const (
	// ControllerName is the controller name that will be used when reporting events and metrics.
	ControllerName = "karmada-operator-controller"

	// ControllerFinalizerName is the name of the karmada controller finalizer
	ControllerFinalizerName = "operator.karmada.io/finalizer"

	// DisableCascadingDeletionLabel is the label that determine whether to perform cascade deletion
	DisableCascadingDeletionLabel = "operator.karmada.io/disable-cascading-deletion"

	// ValidationErrorReason is the reason for a validation error
	ValidationErrorReason = "ValidationError"
)

Types

type Action

type Action string

Action is an intention corresponding karmada resource modification

const (
	// InitAction represents init karmada instance
	InitAction Action = "init"
	// DeInitAction represents delete karmada instance
	DeInitAction Action = "deInit"
)

type Controller

type Controller struct {
	client.Client
	Config        *rest.Config
	EventRecorder record.EventRecorder
}

Controller controls the Karmada resource.

func (*Controller) Reconcile

func (ctrl *Controller) Reconcile(ctx context.Context, req controllerruntime.Request) (controllerruntime.Result, error)

Reconcile performs a full reconciliation for the object referred to by the Request. The Controller will requeue the Request to be processed again if an error is non-nil or Result.Requeue is true, otherwise upon completion it will remove the work from the queue.

func (*Controller) SetupWithManager

func (ctrl *Controller) SetupWithManager(mgr controllerruntime.Manager) error

SetupWithManager creates a controller and register to controller manager.

type Planner

type Planner struct {
	client.Client
	// contains filtered or unexported fields
}

Planner represents a planner to build a job workflow and startup it. the karmada resource change and enqueue is corresponded to an action. it will create different job workflow according to action.

func NewPlannerFor

func NewPlannerFor(karmada *operatorv1alpha1.Karmada, c client.Client, config *rest.Config) (*Planner, error)

NewPlannerFor creates planner, it will recognize the karmada resource action and create different job.

func (*Planner) Execute

func (p *Planner) Execute() error

Execute starts a job workflow. if the workflow is error, TODO: the karmada resource will requeue and reconcile