Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Decoder kuberuntime.Decoder
Decoder is a runtime.Decoder for Sonobuoy's manifest objects
var Encoder kuberuntime.Encoder
Encoder is a runtime.Encoder for Sonobuoy's manifest objects
var GroupVersion = schema.GroupVersion{Group: "sonobuoy", Version: "v0"}
GroupVersion is the schema groupVersion for Sonobuoy
Functions ¶
Types ¶
type Container ¶
Container is a thin wrapper around coreV1.Container that supplies DeepCopyObject and GetObjectKind
func (*Container) DeepCopyObject ¶
func (c *Container) DeepCopyObject() kuberuntime.Object
DeepCopyObject is just DeepCopy, needed for runtime.Object
func (*Container) GetObjectKind ¶
func (c *Container) GetObjectKind() schema.ObjectKind
GetObjectKind returns the underlying objectKind, needed for runtime.Object
func (*Container) GroupVersionKind ¶
func (o *Container) GroupVersionKind() schema.GroupVersionKind
func (*Container) SetGroupVersionKind ¶
func (o *Container) SetGroupVersionKind(gvk schema.GroupVersionKind)
type Manifest ¶
type Manifest struct {
SonobuoyConfig SonobuoyConfig `json:"sonobuoy-config"`
Spec Container `json:"spec"`
ExtraVolumes []Volume `json:"extra-volumes,omitempty"`
PodSpec *PodSpec `json:"podSpec,omitempty"`
ConfigMap map[string]string `json:"config-map,omitempty"`
// contains filtered or unexported fields
}
Manifest is the high-level manifest for a plugin
func (*Manifest) DeepCopyObject ¶
func (m *Manifest) DeepCopyObject() kuberuntime.Object
DeepCopyObject is required by runtime.Object
func (*Manifest) GetObjectKind ¶
func (m *Manifest) GetObjectKind() schema.ObjectKind
GetObjectKind is required by runtime.Object
func (*Manifest) GroupVersionKind ¶
func (o *Manifest) GroupVersionKind() schema.GroupVersionKind
func (*Manifest) SetGroupVersionKind ¶
func (o *Manifest) SetGroupVersionKind(gvk schema.GroupVersionKind)
type PodSpec ¶ added in v0.15.2
PodSpec is a thin wrapper around coreV1.PodSpec that supplies DeepCopyObject and GetObjectKind
func (*PodSpec) DeepCopy ¶ added in v0.15.2
DeepCopy wraps PodSpec.DeepCopy, copying the objectKind as well.
func (*PodSpec) DeepCopyObject ¶ added in v0.15.2
func (ps *PodSpec) DeepCopyObject() kuberuntime.Object
DeepCopyObject is just DeepCopy, needed for runtime.Object
func (*PodSpec) GetObjectKind ¶ added in v0.15.2
func (ps *PodSpec) GetObjectKind() schema.ObjectKind
GetObjectKind returns the underlying objectKind, needed for runtime.Object
func (*PodSpec) GroupVersionKind ¶ added in v0.15.2
func (o *PodSpec) GroupVersionKind() schema.GroupVersionKind
func (*PodSpec) SetGroupVersionKind ¶ added in v0.15.2
func (o *PodSpec) SetGroupVersionKind(gvk schema.GroupVersionKind)
type SonobuoyConfig ¶
type SonobuoyConfig struct {
// Driver is the way in which this plugin is run. Either 'Job' or 'Daemonset'.
Driver string `json:"driver"`
// Name is the user-facing name for the plugin. It should uniquely identify
// the plugin and is used by the aggregator to track what results should be reported back to it.
PluginName string `json:"plugin-name"`
// SkipCleanup informs Sonobuoy to leave the pods created for this plugin running,
// after the run completes instead of deleting them as part of default, cleanup behavior.
SkipCleanup bool `json:"skip-cleanup,omitempty"`
// ResultFormat specifies the type of results the plugin generates which will inform Sonobuoy what type of
// postprocessing to do on the results.
ResultFormat string `json:"result-format,omitempty"`
// ResultFile, if set, will direct postprocessing to only consider files with this name
// to avoid automatically targeting other files or failing to target this one due to heuristics.
ResultFiles []string `json:"result-files,omitempty"`
// Description is an optional, human-readable description for the plugin.
Description string `json:"description,omitempty"`
// SourceURL is an optional URL which describes the source of the plugin and where updates
// to the plugin source would be kept.
SourceURL string `json:"source-url,omitempty"`
Order int `json:"order,omitempty"`
// contains filtered or unexported fields
}
SonobuoyConfig is the Sonobuoy metadata that plugins all supply
func (*SonobuoyConfig) DeepCopy ¶
func (s *SonobuoyConfig) DeepCopy() *SonobuoyConfig
DeepCopy makes a deep copy (needed by DeepCopyObject)
func (*SonobuoyConfig) GroupVersionKind ¶
func (o *SonobuoyConfig) GroupVersionKind() schema.GroupVersionKind
func (*SonobuoyConfig) SetGroupVersionKind ¶
func (o *SonobuoyConfig) SetGroupVersionKind(gvk schema.GroupVersionKind)
type Volume ¶
Volume is a thin wrapper around coreV1.Volume that supplies DeepCopyObject and GetObjectKind
func (*Volume) DeepCopyObject ¶
func (v *Volume) DeepCopyObject() kuberuntime.Object
DeepCopyObject is just DeepCopy, needed for runtime.Object
func (*Volume) GetObjectKind ¶
func (v *Volume) GetObjectKind() schema.ObjectKind
GetObjectKind returns the underlying objectKind, needed for runtime.Object
func (*Volume) GroupVersionKind ¶
func (o *Volume) GroupVersionKind() schema.GroupVersionKind
func (*Volume) SetGroupVersionKind ¶
func (o *Volume) SetGroupVersionKind(gvk schema.GroupVersionKind)