clustereligibility

Documentation

Overview

Package clustereligibility features a scheduler plugin that filters out clusters that are not eligible for resource placement.

Index

• type Option
  • func WithName(name string) Option
• type Plugin
  • func New(opts ...Option) Plugin
  • func (p *Plugin) Filter(_ context.Context, _ framework.CycleStatePluginReadWriter, ...) (status *framework.Status)
  • func (p *Plugin) Name() string
  • func (p *Plugin) SetUpWithFramework(handle framework.Handle)

Types

type Option

type Option func(*pluginOptions)

Option helps set up the plugin.

func WithName

func WithName(name string) Option

WithName sets the name of the plugin.

type Plugin

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

Plugin is the scheduler plugin that performs the cluster eligibility check.

func New

func New(opts ...Option) Plugin

New returns a new Plugin.

func (*Plugin) Filter

func (p *Plugin) Filter(
	_ context.Context,
	_ framework.CycleStatePluginReadWriter,
	_ *placementv1beta1.ClusterSchedulingPolicySnapshot,
	cluster *clusterv1beta1.MemberCluster,
) (status *framework.Status)

Filter allows the plugin to connect to the Filter extension point in the scheduling framework.

func (*Plugin) Name

func (p *Plugin) Name() string

Name returns the name of the plugin.

func (*Plugin) SetUpWithFramework

func (p *Plugin) SetUpWithFramework(handle framework.Handle)

SetUpWithFramework sets up this plugin with a scheduler framework.