drain

Documentation

Overview

Package drain is a generated GoMock package.

Package drain is a generated GoMock package.

Index

• type DrainStrategy
• type DrainStrategyResult
• type MockDrainStrategy
  • func NewMockDrainStrategy(ctrl *gomock.Controller) *MockDrainStrategy
  • func (m *MockDrainStrategy) EXPECT() *MockDrainStrategyMockRecorder
  • func (m *MockDrainStrategy) Execute(arg0 *v1.Node, arg1 logr.Logger) (*DrainStrategyResult, error)
  • func (m *MockDrainStrategy) IsValid(arg0 *v1.Node, arg1 logr.Logger) (bool, error)
• type MockDrainStrategyMockRecorder
  • func (mr *MockDrainStrategyMockRecorder) Execute(arg0, arg1 any) *gomock.Call
  • func (mr *MockDrainStrategyMockRecorder) IsValid(arg0, arg1 any) *gomock.Call
• type MockTimedDrainStrategy
  • func NewMockTimedDrainStrategy(ctrl *gomock.Controller) *MockTimedDrainStrategy
  • func (m *MockTimedDrainStrategy) EXPECT() *MockTimedDrainStrategyMockRecorder
  • func (m *MockTimedDrainStrategy) GetDescription() string
  • func (m *MockTimedDrainStrategy) GetName() string
  • func (m *MockTimedDrainStrategy) GetStrategy() DrainStrategy
  • func (m *MockTimedDrainStrategy) GetWaitDuration() time.Duration
• type MockTimedDrainStrategyMockRecorder
  • func (mr *MockTimedDrainStrategyMockRecorder) GetDescription() *gomock.Call
  • func (mr *MockTimedDrainStrategyMockRecorder) GetName() *gomock.Call
  • func (mr *MockTimedDrainStrategyMockRecorder) GetStrategy() *gomock.Call
  • func (mr *MockTimedDrainStrategyMockRecorder) GetWaitDuration() *gomock.Call
• type NodeDrain
  • func (nd *NodeDrain) GetExpectedDrainDuration() time.Duration
  • func (nd *NodeDrain) GetTimeOutDuration() time.Duration
• type NodeDrainStrategy
  • func NewNodeDrainStrategy(c client.Client, cfg *NodeDrain, ts []TimedDrainStrategy, ...) (NodeDrainStrategy, error)
• type NodeDrainStrategyBuilder
  • func NewBuilder() NodeDrainStrategyBuilder
• type TimedDrainStrategy

Types

type DrainStrategy

type DrainStrategy interface {
	Execute(*corev1.Node, logr.Logger) (*DrainStrategyResult, error)
	IsValid(*corev1.Node, logr.Logger) (bool, error)
}

DrainStrategy enables implementation for a DrainStrategy

type DrainStrategyResult

type DrainStrategyResult struct {
	Message     string
	HasExecuted bool
}

DrainStrategyResult holds fields illustrating a drain strategies result

type MockDrainStrategy

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

MockDrainStrategy is a mock of DrainStrategy interface.

func NewMockDrainStrategy

func NewMockDrainStrategy(ctrl *gomock.Controller) *MockDrainStrategy

NewMockDrainStrategy creates a new mock instance.

func (*MockDrainStrategy) EXPECT

func (m *MockDrainStrategy) EXPECT() *MockDrainStrategyMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockDrainStrategy) Execute

func (m *MockDrainStrategy) Execute(arg0 *v1.Node, arg1 logr.Logger) (*DrainStrategyResult, error)

Execute mocks base method.

func (*MockDrainStrategy) IsValid

func (m *MockDrainStrategy) IsValid(arg0 *v1.Node, arg1 logr.Logger) (bool, error)

IsValid mocks base method.

type MockDrainStrategyMockRecorder

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

MockDrainStrategyMockRecorder is the mock recorder for MockDrainStrategy.

func (*MockDrainStrategyMockRecorder) Execute

func (mr *MockDrainStrategyMockRecorder) Execute(arg0, arg1 any) *gomock.Call

Execute indicates an expected call of Execute.

func (*MockDrainStrategyMockRecorder) IsValid

func (mr *MockDrainStrategyMockRecorder) IsValid(arg0, arg1 any) *gomock.Call

IsValid indicates an expected call of IsValid.

type MockTimedDrainStrategy

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

MockTimedDrainStrategy is a mock of TimedDrainStrategy interface.

func NewMockTimedDrainStrategy

func NewMockTimedDrainStrategy(ctrl *gomock.Controller) *MockTimedDrainStrategy

NewMockTimedDrainStrategy creates a new mock instance.

func (*MockTimedDrainStrategy) EXPECT

func (m *MockTimedDrainStrategy) EXPECT() *MockTimedDrainStrategyMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockTimedDrainStrategy) GetDescription

func (m *MockTimedDrainStrategy) GetDescription() string

GetDescription mocks base method.

func (*MockTimedDrainStrategy) GetName

func (m *MockTimedDrainStrategy) GetName() string

GetName mocks base method.

func (*MockTimedDrainStrategy) GetStrategy

func (m *MockTimedDrainStrategy) GetStrategy() DrainStrategy

GetStrategy mocks base method.

func (*MockTimedDrainStrategy) GetWaitDuration

func (m *MockTimedDrainStrategy) GetWaitDuration() time.Duration

GetWaitDuration mocks base method.

type MockTimedDrainStrategyMockRecorder

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

MockTimedDrainStrategyMockRecorder is the mock recorder for MockTimedDrainStrategy.

func (*MockTimedDrainStrategyMockRecorder) GetDescription

func (mr *MockTimedDrainStrategyMockRecorder) GetDescription() *gomock.Call

GetDescription indicates an expected call of GetDescription.

func (*MockTimedDrainStrategyMockRecorder) GetName

func (mr *MockTimedDrainStrategyMockRecorder) GetName() *gomock.Call

GetName indicates an expected call of GetName.

func (*MockTimedDrainStrategyMockRecorder) GetStrategy

func (mr *MockTimedDrainStrategyMockRecorder) GetStrategy() *gomock.Call

GetStrategy indicates an expected call of GetStrategy.

func (*MockTimedDrainStrategyMockRecorder) GetWaitDuration

func (mr *MockTimedDrainStrategyMockRecorder) GetWaitDuration() *gomock.Call

GetWaitDuration indicates an expected call of GetWaitDuration.

type NodeDrain

type NodeDrain struct {
	DisableDrainStrategies   bool     `yaml:"disableDrainStrategies"`
	Timeout                  int      `yaml:"timeOut"`
	ExpectedNodeDrainTime    int      `yaml:"expectedNodeDrainTime" default:"8"`
	IgnoredNamespacePatterns []string `yaml:"ignoredNamespacePatterns"`
}

NodeDrain holds timeout and expected drain time fields required for NodeDrain execution

func (*NodeDrain) GetExpectedDrainDuration

func (nd *NodeDrain) GetExpectedDrainDuration() time.Duration

GetExpectedDrainDuration returns the ExpectedNodeDrainTime field from the NodeDrain object

func (*NodeDrain) GetTimeOutDuration

func (nd *NodeDrain) GetTimeOutDuration() time.Duration

GetTimeOutDuration returns the timout field from the NodeDrain object

type NodeDrainStrategy

type NodeDrainStrategy interface {
	Execute(*corev1.Node, logr.Logger) ([]*DrainStrategyResult, error)
	HasFailed(*corev1.Node, logr.Logger) (bool, error)
}

NodeDrainStrategy enables implementation for a NodeDrainStrategy

func NewNodeDrainStrategy

func NewNodeDrainStrategy(c client.Client, cfg *NodeDrain, ts []TimedDrainStrategy, uc *upgradev1alpha1.UpgradeConfig,
	notifier notifier.Notifier, metricsClient metrics.Metrics) (NodeDrainStrategy, error)

NewNodeDrainStrategy returns a new node drain stategy

type NodeDrainStrategyBuilder

type NodeDrainStrategyBuilder interface {
	NewNodeDrainStrategy(c client.Client, logger logr.Logger, uc *upgradev1alpha1.UpgradeConfig, cfg *NodeDrain) (NodeDrainStrategy, error)
}

NodeDrainStrategyBuilder enables implementation for a NodeDrainStrategyBuilder

func NewBuilder

func NewBuilder() NodeDrainStrategyBuilder

NewBuilder returns a drainStrategyBuilder

type TimedDrainStrategy

type TimedDrainStrategy interface {
	GetWaitDuration() time.Duration
	GetName() string
	GetDescription() string
	GetStrategy() DrainStrategy
}

TimedDrainStrategy enables implementation for a TimedDrainStrategy