controllers

Documentation

Overview

Package controllers contains code common for the device plugin controllers.

Index

• Variables
• func SetupWithManager(mgr ctrl.Manager, controller DevicePluginController, ...) error
• func SuffixedName(base, suffix string) string
• func UpgradeImages(ctx context.Context, image *string, initimage *string) (upgrade bool)
• type DefaultServiceAccountFactory
  • func (d *DefaultServiceAccountFactory) NewSharedClusterRoleBinding() *rbacv1.ClusterRoleBinding
  • func (d *DefaultServiceAccountFactory) NewSharedServiceAccount() *v1.ServiceAccount
  • func (d *DefaultServiceAccountFactory) PluginMayRequireSharedObjects() bool
  • func (d *DefaultServiceAccountFactory) PluginRequiresSharedObjects(ctx context.Context, client client.Client) bool
• type DevicePluginController
• type SharedObjectsFactory

Variables

var (
	ImageMinVersion = versionutil.MustParseSemantic("0.29.0")
)

Functions

func SetupWithManager

func SetupWithManager(mgr ctrl.Manager, controller DevicePluginController, apiGVString, pluginKind, ownerKey string) error

SetupWithManager sets up a reconciler for a given device plugin controller.

func SuffixedName

func SuffixedName(base, suffix string) string

Combine base and suffix with a dash.

func UpgradeImages

func UpgradeImages(ctx context.Context, image *string, initimage *string) (upgrade bool)

Types

type DefaultServiceAccountFactory

type DefaultServiceAccountFactory struct{}

DefaultServiceAccountFactory is an empty ServiceAccountFactory. "default" will be used for the service account then.

func (*DefaultServiceAccountFactory) NewSharedClusterRoleBinding

func (d *DefaultServiceAccountFactory) NewSharedClusterRoleBinding() *rbacv1.ClusterRoleBinding

func (*DefaultServiceAccountFactory) NewSharedServiceAccount

func (d *DefaultServiceAccountFactory) NewSharedServiceAccount() *v1.ServiceAccount

func (*DefaultServiceAccountFactory) PluginMayRequireSharedObjects

func (d *DefaultServiceAccountFactory) PluginMayRequireSharedObjects() bool

func (*DefaultServiceAccountFactory) PluginRequiresSharedObjects

func (d *DefaultServiceAccountFactory) PluginRequiresSharedObjects(ctx context.Context, client client.Client) bool

type DevicePluginController

type DevicePluginController interface {
	SharedObjectsFactory
	CreateEmptyObject() (devicePlugin client.Object)
	NewDaemonSet(devicePlugin client.Object) *apps.DaemonSet
	UpdateDaemonSet(client.Object, *apps.DaemonSet) (updated bool)
	UpdateStatus(client.Object, *apps.DaemonSet, []string) (updated bool, err error)
	Upgrade(ctx context.Context, obj client.Object) (upgrade bool)
}

DevicePluginController provides functionality for manipulating actual device plugin CRD objects.

type SharedObjectsFactory

type SharedObjectsFactory interface {
	// Indicates if plugin will ever require shared objects. Not all plugins do.
	PluginMayRequireSharedObjects() bool
	// Indicates if plugin currently require shared objects.
	PluginRequiresSharedObjects(ctx context.Context, client client.Client) bool
	NewSharedServiceAccount() *v1.ServiceAccount
	NewSharedClusterRoleBinding() *rbacv1.ClusterRoleBinding
}

SharedObjectsFactory provides functions for creating service account and cluster rule binding objects. Note that the rbac Role can be generated from kubebuilder:rbac comment (some examples above), which is the reason why this interface does not yet have a NewRole function.