package app
import "k8s.io/kubernetes/test/e2e/dra/test-driver/app"
Package app does all of the work necessary to configure and run a Kubernetes app process.
Index ¶
- Variables
- func NewCommand() *cobra.Command
- type ClaimID
- type Device
- type ExamplePlugin
- func StartPlugin(ctx context.Context, cdiDir, driverName string, kubeClient kubernetes.Interface, nodeName string, fileOps FileOperations, opts ...kubeletplugin.Option) (*ExamplePlugin, error)
- func (ex *ExamplePlugin) BlockNodePrepareResources() func()
- func (ex *ExamplePlugin) BlockNodeUnprepareResources() func()
- func (ex *ExamplePlugin) CountCalls(methodSuffix string) int
- func (ex *ExamplePlugin) GetGRPCCalls() []GRPCCall
- func (ex *ExamplePlugin) GetPreparedResources() []ClaimID
- func (ex *ExamplePlugin) IsRegistered() bool
- func (ex *ExamplePlugin) PrepareResourceClaims(ctx context.Context, claims []*resourceapi.ResourceClaim) (map[types.UID]kubeletplugin.PrepareResult, error)
- func (ex *ExamplePlugin) SetNodePrepareResourcesFailureMode() func()
- func (ex *ExamplePlugin) SetNodeUnprepareResourcesFailureMode() func()
- func (ex *ExamplePlugin) Stop()
- func (ex *ExamplePlugin) UnprepareResourceClaims(ctx context.Context, claims []kubeletplugin.NamespacedObject) (map[types.UID]error, error)
- func (ex *ExamplePlugin) UpdateStatus(ctx context.Context, resourceClaim *resourceapi.ResourceClaim) (*resourceapi.ResourceClaim, error)
- type FileOperations
- type GRPCCall
Variables ¶
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.
var NodePrepareResourcesFailed = 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 unsuccessful NodePrepareResources call")
NodePrepareResoucesFailed checks that NodePrepareResources API has been called and returned an error
var NodePrepareResourcesSucceeded = gcustom.MakeMatcher(func(actualCalls []GRPCCall) (bool, error) { for _, call := range actualCalls { if strings.HasSuffix(call.FullMethod, "/NodePrepareResources") && call.Response != nil && call.Err == nil { return true, nil } } return false, nil }).WithMessage("contain successful NodePrepareResources call")
NodePrepareResoucesSucceeded checks that NodePrepareResources API has been called and succeeded
var NodeUnprepareResourcesFailed = gcustom.MakeMatcher(func(actualCalls []GRPCCall) (bool, error) { for _, call := range actualCalls { if strings.HasSuffix(call.FullMethod, "/NodeUnprepareResources") && call.Err != nil { return true, nil } } return false, nil }).WithMessage("contain unsuccessful NodeUnprepareResources call")
NodeUnprepareResoucesFailed checks that NodeUnprepareResources API has been called and returned an error
var NodeUnprepareResourcesSucceeded = gcustom.MakeMatcher(func(actualCalls []GRPCCall) (bool, error) { for _, call := range actualCalls { if strings.HasSuffix(call.FullMethod, "/NodeUnprepareResources") && call.Response != nil && call.Err == nil { return true, nil } } return false, nil }).WithMessage("contain successful NodeUnprepareResources call")
NodeUnprepareResoucesSucceeded checks that NodeUnprepareResources API has been called and succeeded
Functions ¶
func NewCommand ¶
NewCommand creates a *cobra.Command object with default parameters.
Types ¶
type ClaimID ¶
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 Device ¶
type ExamplePlugin ¶
type ExamplePlugin struct {
// contains filtered or unexported fields
}
func StartPlugin ¶
func StartPlugin(ctx context.Context, cdiDir, driverName string, kubeClient kubernetes.Interface, nodeName string, fileOps FileOperations, opts ...kubeletplugin.Option) (*ExamplePlugin, error)
StartPlugin sets up the servers that are necessary for a DRA kubelet plugin.
func (*ExamplePlugin) BlockNodePrepareResources ¶
func (ex *ExamplePlugin) BlockNodePrepareResources() func()
BlockNodePrepareResources locks blockPrepareResourcesMutex and returns unlocking function for it
func (*ExamplePlugin) BlockNodeUnprepareResources ¶
func (ex *ExamplePlugin) BlockNodeUnprepareResources() func()
BlockNodeUnprepareResources locks blockUnprepareResourcesMutex and returns unlocking function for it
func (*ExamplePlugin) CountCalls ¶
func (ex *ExamplePlugin) CountCalls(methodSuffix string) int
CountCalls counts GRPC calls with the given method suffix.
func (*ExamplePlugin) GetGRPCCalls ¶
func (ex *ExamplePlugin) GetGRPCCalls() []GRPCCall
func (*ExamplePlugin) GetPreparedResources ¶
func (ex *ExamplePlugin) GetPreparedResources() []ClaimID
func (*ExamplePlugin) IsRegistered ¶
func (ex *ExamplePlugin) IsRegistered() bool
func (*ExamplePlugin) PrepareResourceClaims ¶
func (ex *ExamplePlugin) PrepareResourceClaims(ctx context.Context, claims []*resourceapi.ResourceClaim) (map[types.UID]kubeletplugin.PrepareResult, error)
func (*ExamplePlugin) SetNodePrepareResourcesFailureMode ¶
func (ex *ExamplePlugin) SetNodePrepareResourcesFailureMode() func()
SetNodePrepareResourcesFailureMode sets the failure mode for NodePrepareResources call and returns a function to unset the failure mode
func (*ExamplePlugin) SetNodeUnprepareResourcesFailureMode ¶
func (ex *ExamplePlugin) SetNodeUnprepareResourcesFailureMode() func()
SetNodeUnprepareResourcesFailureMode sets the failure mode for NodeUnprepareResources call and returns a function to unset the failure mode
func (*ExamplePlugin) Stop ¶
func (ex *ExamplePlugin) Stop()
Stop ensures that all servers are stopped and resources freed.
func (*ExamplePlugin) UnprepareResourceClaims ¶
func (ex *ExamplePlugin) UnprepareResourceClaims(ctx context.Context, claims []kubeletplugin.NamespacedObject) (map[types.UID]error, error)
func (*ExamplePlugin) UpdateStatus ¶
func (ex *ExamplePlugin) UpdateStatus(ctx context.Context, resourceClaim *resourceapi.ResourceClaim) (*resourceapi.ResourceClaim, error)
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 // NumDevices determines whether the plugin reports devices // and how many. It reports nothing if negative. NumDevices int // Pre-defined devices, with each device name mapped to // the device attributes. Not used if NumDevices >= 0. Devices map[string]map[resourceapi.QualifiedName]resourceapi.DeviceAttribute }
FileOperations defines optional callbacks for handling CDI files and some other configuration.
type GRPCCall ¶
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 }
Source Files ¶
cdi.go gomega.go kubeletplugin.go server.go
- Version
- v1.33.0 (latest)
- Published
- Apr 23, 2025
- Platform
- linux/amd64
- Imports
- 39 packages
- Last checked
- 3 hours ago –
Tools for package owners.