work

Documentation

Index

• Constants
• type Applier
• type ApplyAction
• type ApplyWorkReconciler
  • func NewApplyWorkReconciler(hubClient client.Client, spokeDynamicClient dynamic.Interface, ...) *ApplyWorkReconciler
  • func (r *ApplyWorkReconciler) Join(_ context.Context) error
  • func (r *ApplyWorkReconciler) Leave(ctx context.Context) error
  • func (r *ApplyWorkReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ApplyWorkReconciler) SetupWithManager(mgr ctrl.Manager) error
• type ClientSideApplier
  • func (applier *ClientSideApplier) ApplyUnstructured(ctx context.Context, applyStrategy *fleetv1beta1.ApplyStrategy, ...) (*unstructured.Unstructured, ApplyAction, error)
• type ServerSideApplier
  • func (applier *ServerSideApplier) ApplyUnstructured(ctx context.Context, applyStrategy *fleetv1beta1.ApplyStrategy, ...) (*unstructured.Unstructured, ApplyAction, error)

Constants

const (

	// WorkAvailableReason is the reason string of condition when the manifest is available.
	WorkAvailableReason = "WorkAvailable"
	// WorkNotTrackableReason is the reason string of condition when the manifest is already up to date but we don't have
	// a way to track its availabilities.
	WorkNotTrackableReason = "WorkNotTrackable"
	// ManifestApplyFailedReason is the reason string of condition when it failed to apply manifest.
	ManifestApplyFailedReason = "ManifestApplyFailed"
	// ApplyConflictBetweenPlacementsReason is the reason string of condition when the manifest is owned by multiple placements,
	// and they have conflicts.
	ApplyConflictBetweenPlacementsReason = "ApplyConflictBetweenPlacements"
	// ManifestsAlreadyOwnedByOthersReason is the reason string of condition when the manifest is already owned by other
	// non-fleet appliers.
	ManifestsAlreadyOwnedByOthersReason = "ManifestsAlreadyOwnedByOthers"
	// ManifestAlreadyUpToDateReason is the reason string of condition when the manifest is already up to date.
	ManifestAlreadyUpToDateReason = "ManifestAlreadyUpToDate"

	// ManifestNeedsUpdateReason is the reason string of condition when the manifest needs to be updated.
	ManifestNeedsUpdateReason = "ManifestNeedsUpdate"
)

WorkCondition condition reasons

Types

type Applier

type Applier interface {
	ApplyUnstructured(ctx context.Context, applyStrategy *fleetv1beta1.ApplyStrategy, gvr schema.GroupVersionResource, manifestObj *unstructured.Unstructured) (*unstructured.Unstructured, ApplyAction, error)
}

Applier is the interface to apply the resources on the member clusters.

type ApplyAction

type ApplyAction string

ApplyAction represents the action we take to apply the manifest. It is used only internally to track the result of the apply function. +enum

type ApplyWorkReconciler

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

ApplyWorkReconciler reconciles a Work object

func NewApplyWorkReconciler

func NewApplyWorkReconciler(hubClient client.Client, spokeDynamicClient dynamic.Interface, spokeClient client.Client,
	restMapper meta.RESTMapper, recorder record.EventRecorder, concurrency int, workNameSpace string) *ApplyWorkReconciler

func (*ApplyWorkReconciler) Join

func (r *ApplyWorkReconciler) Join(_ context.Context) error

Join starts to reconcile

func (*ApplyWorkReconciler) Leave

func (r *ApplyWorkReconciler) Leave(ctx context.Context) error

Leave start

func (*ApplyWorkReconciler) Reconcile

func (r *ApplyWorkReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile implement the control loop logic for Work object.

func (*ApplyWorkReconciler) SetupWithManager

func (r *ApplyWorkReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager wires up the controller.

type ClientSideApplier

type ClientSideApplier struct {
	HubClient          client.Client
	WorkNamespace      string
	SpokeDynamicClient dynamic.Interface
}

ClientSideApplier applies the manifest to the cluster and fails if the resource already exists.

func (*ClientSideApplier) ApplyUnstructured

func (applier *ClientSideApplier) ApplyUnstructured(ctx context.Context, applyStrategy *fleetv1beta1.ApplyStrategy, gvr schema.GroupVersionResource, manifestObj *unstructured.Unstructured) (*unstructured.Unstructured, ApplyAction, error)

ApplyUnstructured determines if an unstructured manifest object can & should be applied. It first validates the size of the last modified annotation of the manifest, it removes the annotation if the size crosses the annotation size threshold and then creates/updates the resource on the cluster using server side apply instead of three-way merge patch.

type ServerSideApplier

type ServerSideApplier struct {
	HubClient          client.Client
	WorkNamespace      string
	SpokeDynamicClient dynamic.Interface
}

ServerSideApplier applies the manifest to the cluster using server side apply.

func (*ServerSideApplier) ApplyUnstructured

func (applier *ServerSideApplier) ApplyUnstructured(ctx context.Context, applyStrategy *fleetv1beta1.ApplyStrategy, gvr schema.GroupVersionResource, manifestObj *unstructured.Unstructured) (*unstructured.Unstructured, ApplyAction, error)

ApplyUnstructured applies the manifest to the cluster using server side apply according to the given apply strategy.