driver

Documentation

Index

• func DefaultPodSpec(d string) v1.PodSpec
• type Base
  • func (b *Base) CreateWorkerContainerDefintion(hostname string, cert *tls.Certificate, command, args []string, ...) v1.Container
  • func (b *Base) GetDescription() string
  • func (b *Base) GetDriver() string
  • func (b *Base) GetName() string
  • func (b *Base) GetOrder() int
  • func (b *Base) GetResultFiles() []string
  • func (b *Base) GetResultFormat() string
  • func (b *Base) GetSecretName() string
  • func (b *Base) GetSessionID() string
  • func (b *Base) GetSourceURL() string
  • func (b *Base) MakeTLSSecret(cert *tls.Certificate, ownerPod *v1.Pod) (*v1.Secret, error)
  • func (b *Base) SkipCleanup() bool

Functions

func DefaultPodSpec

func DefaultPodSpec(d string) v1.PodSpec

DefaultPodSpec returns the default pod spec used for the given plugin driver type.

Types

type Base

type Base struct {
	Definition        manifest.Manifest
	SessionID         string
	Namespace         string
	SonobuoyImage     string
	CleanedUp         bool
	ImagePullPolicy   string
	ImagePullSecrets  string
	CustomAnnotations map[string]string
}

Base is the struct that stores state for plugin drivers and contains helper methods.

func (*Base) CreateWorkerContainerDefintion

func (b *Base) CreateWorkerContainerDefintion(hostname string, cert *tls.Certificate, command, args []string, progressPort, resultDir string, pluginEnv []v1.EnvVar) v1.Container

CreateWorkerContainerDefintion creates the container definition to run the Sonobuoy worker for a plugin.

func (*Base) GetDescription

func (b *Base) GetDescription() string

GetDescription returns the human-readable plugin description.

func (*Base) GetDriver

func (b *Base) GetDriver() string

GetDriver returns the Driver for this plugin.

func (*Base) GetName

func (b *Base) GetName() string

GetName returns the name of this Job plugin.

func (*Base) GetOrder

func (b *Base) GetOrder() int

GetOrder returns the order of this Job plugin.

func (*Base) GetResultFiles

func (b *Base) GetResultFiles() []string

GetResultFiles returns the files to be post-processed for this plugin.

func (*Base) GetResultFormat

func (b *Base) GetResultFormat() string

GetResultFormat returns the ResultFormat of this plugin.

func (*Base) GetSecretName

func (b *Base) GetSecretName() string

GetSecretName gets a name for a secret based on the plugin name and session ID.

func (*Base) GetSessionID

func (b *Base) GetSessionID() string

GetSessionID returns the session id associated with the plugin.

func (*Base) GetSourceURL

func (b *Base) GetSourceURL() string

GetSourceURL returns the sourceURL of the plugin.

func (*Base) MakeTLSSecret

func (b *Base) MakeTLSSecret(cert *tls.Certificate, ownerPod *v1.Pod) (*v1.Secret, error)

MakeTLSSecret makes a Kubernetes secret object for the given TLS certificate.

func (*Base) SkipCleanup

func (b *Base) SkipCleanup() bool

SkipCleanup returns whether cleanup for this plugin should be skipped or not.