job

Documentation

Index

• type Plugin
  • func NewPlugin(namespace string, dfn plugin.Definition, cfg *plugin.WorkerConfig) *Plugin
  • func (p *Plugin) Cleanup(kubeclient kubernetes.Interface)
  • func (p *Plugin) ExpectedResults(nodes []v1.Node) []plugin.ExpectedResult
  • func (p *Plugin) GetName() string
  • func (p *Plugin) GetPodSpec() *v1.PodSpec
  • func (p *Plugin) GetResultType() string
  • func (p *Plugin) GetSessionID() string
  • func (p *Plugin) Monitor(kubeclient kubernetes.Interface, _ []v1.Node, resultsCh chan<- *plugin.Result)
  • func (p *Plugin) Run(kubeclient kubernetes.Interface) error

Types

type Plugin

type Plugin struct {
	Name       string
	PodSpec    *v1.PodSpec          `json:"spec"`
	Config     *plugin.WorkerConfig `json:"config"`
	Namespace  string
	UUID       gouuid.UUID
	ResultType string
	// contains filtered or unexported fields
}

Plugin is a plugin driver that dispatches a single pod to the given kubernetes cluster

func NewPlugin

func NewPlugin(namespace string, dfn plugin.Definition, cfg *plugin.WorkerConfig) *Plugin

NewPlugin creates a new DaemonSet plugin from the given Plugin Definition and sonobuoy master address

func (*Plugin) Cleanup

func (p *Plugin) Cleanup(kubeclient kubernetes.Interface)

Cleanup cleans up the k8s Job and ConfigMap created by this plugin instance

func (*Plugin) ExpectedResults

func (p *Plugin) ExpectedResults(nodes []v1.Node) []plugin.ExpectedResult

ExpectedResults returns the list of results expected for this plugin. Since a Job only launches one pod, only one result type is expected.

func (*Plugin) GetName

func (p *Plugin) GetName() string

GetName returns the name of this Job plugin

func (*Plugin) GetPodSpec

func (p *Plugin) GetPodSpec() *v1.PodSpec

GetPodSpec returns the pod spec for this Job

func (*Plugin) GetResultType

func (p *Plugin) GetResultType() string

GetResultType returns the ResultType for this plugin (to adhere to plugin.Interface)

func (*Plugin) GetSessionID

func (p *Plugin) GetSessionID() string

GetSessionID returns a unique identifier for this dispatcher, used for tagging objects and cleaning them up later

func (*Plugin) Monitor

func (p *Plugin) Monitor(kubeclient kubernetes.Interface, _ []v1.Node, resultsCh chan<- *plugin.Result)

Monitor adheres to plugin.Interface by ensuring the pod created by the job doesn't have any urecoverable failures.

func (*Plugin) Run

func (p *Plugin) Run(kubeclient kubernetes.Interface) error

Run dispatches worker pods according to the Job's configuration.