Documentation

Index

Constants

View Source
const (
	// DefaultBindTimeoutSeconds defines the default bind timeout in seconds
	DefaultBindTimeoutSeconds = 600
)
View Source
const Name = "VolumeBinding"

    Name is the name of the plugin used in Registry and configurations.

    Variables

    This section is empty.

    Functions

    func New

    func New(plArgs runtime.Object, fh framework.Handle) (framework.Plugin, error)

      New initializes a new plugin and returns it.

      Types

      type VolumeBinding

      type VolumeBinding struct {
      	Binder                               scheduling.SchedulerVolumeBinder
      	PVCLister                            corelisters.PersistentVolumeClaimLister
      	GenericEphemeralVolumeFeatureEnabled bool
      }

        VolumeBinding is a plugin that binds pod volumes in scheduling. In the Filter phase, pod binding cache is created for the pod and used in Reserve and PreBind phases.

        func (*VolumeBinding) Filter

        func (pl *VolumeBinding) Filter(ctx context.Context, cs *framework.CycleState, pod *v1.Pod, nodeInfo *framework.NodeInfo) *framework.Status

          Filter invoked at the filter extension point. It evaluates if a pod can fit due to the volumes it requests, for both bound and unbound PVCs.

          For PVCs that are bound, then it checks that the corresponding PV's node affinity is satisfied by the given node.

          For PVCs that are unbound, it tries to find available PVs that can satisfy the PVC requirements and that the PV node affinity is satisfied by the given node.

          If storage capacity tracking is enabled, then enough space has to be available for the node and volumes that still need to be created.

          The predicate returns true if all bound PVCs have compatible PVs with the node, and if all unbound PVCs can be matched with an available and node-compatible PV.

          func (*VolumeBinding) Name

          func (pl *VolumeBinding) Name() string

            Name returns name of the plugin. It is used in logs, etc.

            func (*VolumeBinding) PreBind

            func (pl *VolumeBinding) PreBind(ctx context.Context, cs *framework.CycleState, pod *v1.Pod, nodeName string) *framework.Status

              PreBind will make the API update with the assumed bindings and wait until the PV controller has completely finished the binding operation.

              If binding errors, times out or gets undone, then an error will be returned to retry scheduling.

              func (*VolumeBinding) PreFilter

              func (pl *VolumeBinding) PreFilter(ctx context.Context, state *framework.CycleState, pod *v1.Pod) *framework.Status

                PreFilter invoked at the prefilter extension point to check if pod has all immediate PVCs bound. If not all immediate PVCs are bound, an UnschedulableAndUnresolvable is returned.

                func (*VolumeBinding) PreFilterExtensions

                func (pl *VolumeBinding) PreFilterExtensions() framework.PreFilterExtensions

                  PreFilterExtensions returns prefilter extensions, pod add and remove.

                  func (*VolumeBinding) Reserve

                  func (pl *VolumeBinding) Reserve(ctx context.Context, cs *framework.CycleState, pod *v1.Pod, nodeName string) *framework.Status

                    Reserve reserves volumes of pod and saves binding status in cycle state.

                    func (*VolumeBinding) Unreserve

                    func (pl *VolumeBinding) Unreserve(ctx context.Context, cs *framework.CycleState, pod *v1.Pod, nodeName string)

                      Unreserve clears assumed PV and PVC cache. It's idempotent, and does nothing if no cache found for the given pod.