app

package
v1.30.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2024 License: Apache-2.0 Imports: 46 Imported by: 2

Documentation

Overview

Package app does all of the work necessary to configure and run a Kubernetes app process.

Package app does all of the work necessary to configure and run a Kubernetes app process.

Index

Constants

This section is empty.

Variables

View Source
var BeRegistered = gcustom.MakeMatcher(func(actualCalls []GRPCCall) (bool, error) {
	for _, call := range actualCalls {
		if call.FullMethod == "/pluginregistration.Registration/NotifyRegistrationStatus" &&
			call.Err == nil {
			return true, nil
		}
	}
	return false, nil
}).WithMessage("contain successful NotifyRegistrationStatus call")

BeRegistered checks that plugin registration has completed.

View Source
var NodePrepareResourceCalled = gcustom.MakeMatcher(func(actualCalls []GRPCCall) (bool, error) {
	for _, call := range actualCalls {
		if strings.HasSuffix(call.FullMethod, "/NodePrepareResource") && call.Err == nil {
			return true, nil
		}
	}
	return false, nil
}).WithMessage("contain NodePrepareResource call")

NodePrepareResouceCalled checks that NodePrepareResource API has been called

View Source
var NodePrepareResourcesCalled = gcustom.MakeMatcher(func(actualCalls []GRPCCall) (bool, error) {
	for _, call := range actualCalls {
		if strings.HasSuffix(call.FullMethod, "/NodePrepareResources") && call.Err == nil {
			return true, nil
		}
	}
	return false, nil
}).WithMessage("contain NodePrepareResources call")

NodePrepareResoucesCalled checks that NodePrepareResources API has been called

Functions

func NewCommand

func NewCommand() *cobra.Command

NewCommand creates a *cobra.Command object with default parameters.

Types

type AllocateWrapperType

type AllocateWrapperType func(ctx context.Context, claimAllocations []*controller.ClaimAllocation,
	selectedNode string,
	handler func(ctx context.Context,
		claimAllocations []*controller.ClaimAllocation,
		selectedNode string),
)

type ClaimID

type ClaimID struct {
	Name string
	UID  string
}

ClaimID contains both claim name and UID to simplify debugging. The namespace is not included because it is random in E2E tests and the UID is sufficient to make the ClaimID unique.

type ExampleController

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

func NewController

func NewController(clientset kubernetes.Interface, resources Resources) *ExampleController

func (*ExampleController) Allocate

func (c *ExampleController) Allocate(ctx context.Context, claimAllocations []*controller.ClaimAllocation, selectedNode string)

func (*ExampleController) Deallocate

func (*ExampleController) GetClaimParameters

func (c *ExampleController) GetClaimParameters(ctx context.Context, claim *resourcev1alpha2.ResourceClaim, class *resourcev1alpha2.ResourceClass, classParameters interface{}) (interface{}, error)

func (*ExampleController) GetClassParameters

func (c *ExampleController) GetClassParameters(ctx context.Context, class *resourcev1alpha2.ResourceClass) (interface{}, error)

func (*ExampleController) GetNumAllocations

func (c *ExampleController) GetNumAllocations() int64

GetNumAllocations returns the number of times that a claim was allocated. Idempotent calls to Allocate that do not need to allocate the claim again do not contribute to that counter.

func (*ExampleController) GetNumDeallocations

func (c *ExampleController) GetNumDeallocations() int64

GetNumDeallocations returns the number of times that a claim was allocated. Idempotent calls to Allocate that do not need to allocate the claim again do not contribute to that counter.

func (*ExampleController) Run

func (c *ExampleController) Run(ctx context.Context, workers int)

func (*ExampleController) UnsuitableNodes

func (c *ExampleController) UnsuitableNodes(ctx context.Context, pod *v1.Pod, claims []*controller.ClaimAllocation, potentialNodes []string) (finalErr error)

type ExamplePlugin

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

func StartPlugin

func StartPlugin(ctx context.Context, cdiDir, driverName string, nodeName string, fileOps FileOperations, opts ...kubeletplugin.Option) (*ExamplePlugin, error)

StartPlugin sets up the servers that are necessary for a DRA kubelet plugin.

func (*ExamplePlugin) Block added in v1.28.0

func (ex *ExamplePlugin) Block()

Block sets a flag to block Node[Un]PrepareResources to emulate time consuming or stuck calls

func (*ExamplePlugin) GetGRPCCalls added in v1.28.0

func (ex *ExamplePlugin) GetGRPCCalls() []GRPCCall

func (*ExamplePlugin) GetPreparedResources

func (ex *ExamplePlugin) GetPreparedResources() []ClaimID

func (*ExamplePlugin) IsRegistered

func (ex *ExamplePlugin) IsRegistered() bool

func (*ExamplePlugin) NodeListAndWatchResources added in v1.30.0

func (*ExamplePlugin) NodePrepareResource

NodePrepareResource ensures that the CDI file for the claim exists. It uses a deterministic name to simplify NodeUnprepareResource (no need to remember or discover the name) and idempotency (when called again, the file simply gets written again).

func (*ExamplePlugin) NodePrepareResources added in v1.28.0

func (*ExamplePlugin) NodeUnprepareResource

NodeUnprepareResource removes the CDI file created by NodePrepareResource. It's idempotent, therefore it is not an error when that file is already gone.

func (*ExamplePlugin) NodeUnprepareResources added in v1.28.0

func (*ExamplePlugin) Stop

func (ex *ExamplePlugin) Stop()

stop ensures that all servers are stopped and resources freed.

type FileOperations

type FileOperations struct {
	// Create must overwrite the file.
	Create func(name string, content []byte) error

	// Remove must remove the file. It must not return an error when the
	// file does not exist.
	Remove func(name string) error

	// NumResourceInstances determines whether the plugin reports resources
	// instances and how many. A negative value causes it to report "not implemented"
	// in the NodeListAndWatchResources gRPC call.
	NumResourceInstances int
}

FileOperations defines optional callbacks for handling CDI files and some other configuration.

type GRPCCall added in v1.28.0

type GRPCCall struct {
	// FullMethod is the fully qualified, e.g. /package.service/method.
	FullMethod string

	// Request contains the parameters of the call.
	Request interface{}

	// Response contains the reply of the plugin. It is nil for calls that are in progress.
	Response interface{}

	// Err contains the error return value of the plugin. It is nil for calls that are in progress or succeeded.
	Err error
}

type Resources

type Resources struct {
	DriverName         string
	DontSetReservedFor bool
	NodeLocal          bool
	// Nodes is a fixed list of node names on which resources are
	// available. Mutually exclusive with NodeLabels.
	Nodes []string
	// NodeLabels are labels which determine on which nodes resources are
	// available. Mutually exclusive with Nodes.
	NodeLabels     labels.Set
	MaxAllocations int
	Shareable      bool

	// AllocateWrapper, if set, gets called for each Allocate call.
	AllocateWrapper AllocateWrapperType
}

func (Resources) AllNodes added in v1.29.0

func (r Resources) AllNodes(nodeLister listersv1.NodeLister) []string

func (Resources) NewAllocation added in v1.29.0

func (r Resources) NewAllocation(node string, data []byte) *resourcev1alpha2.AllocationResult

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL