sonobuoy: github.com/vmware-tanzu/sonobuoy/pkg/plugin/manifest Index | Files | Directories

package manifest

import "github.com/vmware-tanzu/sonobuoy/pkg/plugin/manifest"

Index

Package Files

manifest.go serializer.go

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

func ContainerToYAML Uses

func ContainerToYAML(container *v1.Container) (string, error)

ContainerToYAML abuses APIMachinery to directly serialize a container to YAML

type Container Uses

type Container struct {
    corev1.Container
    // contains filtered or unexported fields
}

Container is a thin wrapper around coreV1.Container that supplies DeepCopyObject and GetObjectKind

func (*Container) DeepCopy Uses

func (c *Container) DeepCopy() *Container

DeepCopy wraps Container.DeepCopy, copying the objectKind as well.

func (*Container) DeepCopyObject Uses

func (c *Container) DeepCopyObject() kuberuntime.Object

DeepCopyObject is just DeepCopy, needed for runtime.Object

func (*Container) GetObjectKind Uses

func (c *Container) GetObjectKind() schema.ObjectKind

GetObjectKind returns the underlying objectKind, needed for runtime.Object

func (*Container) GroupVersionKind Uses

func (o *Container) GroupVersionKind() schema.GroupVersionKind

func (*Container) SetGroupVersionKind Uses

func (o *Container) SetGroupVersionKind(gvk schema.GroupVersionKind)

type Manifest Uses

type Manifest struct {
    SonobuoyConfig SonobuoyConfig `json:"sonobuoy-config"`
    Spec           Container      `json:"spec"`
    ExtraVolumes   []Volume       `json:"extra-volumes,omitempty"`
    PodSpec        *PodSpec       `json:"podSpec,omitempty"`
    // contains filtered or unexported fields
}

Manifest is the high-level manifest for a plugin

func (*Manifest) DeepCopyObject Uses

func (m *Manifest) DeepCopyObject() kuberuntime.Object

DeepCopyObject is required by runtime.Object

func (*Manifest) GetObjectKind Uses

func (m *Manifest) GetObjectKind() schema.ObjectKind

GetObjectKind is required by runtime.Object

func (*Manifest) GroupVersionKind Uses

func (o *Manifest) GroupVersionKind() schema.GroupVersionKind

func (*Manifest) SetGroupVersionKind Uses

func (o *Manifest) SetGroupVersionKind(gvk schema.GroupVersionKind)

type PodSpec Uses

type PodSpec struct {
    corev1.PodSpec
    // contains filtered or unexported fields
}

PodSpec is a thin wrapper around coreV1.PodSpec that supplies DeepCopyObject and GetObjectKind

func (*PodSpec) DeepCopy Uses

func (ps *PodSpec) DeepCopy() *PodSpec

DeepCopy wraps PodSpec.DeepCopy, copying the objectKind as well.

func (*PodSpec) DeepCopyObject Uses

func (ps *PodSpec) DeepCopyObject() kuberuntime.Object

DeepCopyObject is just DeepCopy, needed for runtime.Object

func (*PodSpec) GetObjectKind Uses

func (ps *PodSpec) GetObjectKind() schema.ObjectKind

GetObjectKind returns the underlying objectKind, needed for runtime.Object

func (*PodSpec) GroupVersionKind Uses

func (o *PodSpec) GroupVersionKind() schema.GroupVersionKind

func (*PodSpec) SetGroupVersionKind Uses

func (o *PodSpec) SetGroupVersionKind(gvk schema.GroupVersionKind)

type SonobuoyConfig Uses

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"`
    // contains filtered or unexported fields
}

SonobuoyConfig is the Sonobuoy metadata that plugins all supply

func (*SonobuoyConfig) DeepCopy Uses

func (s *SonobuoyConfig) DeepCopy() *SonobuoyConfig

DeepCopy makes a deep copy (needed by DeepCopyObject)

func (*SonobuoyConfig) GroupVersionKind Uses

func (o *SonobuoyConfig) GroupVersionKind() schema.GroupVersionKind

func (*SonobuoyConfig) SetGroupVersionKind Uses

func (o *SonobuoyConfig) SetGroupVersionKind(gvk schema.GroupVersionKind)

type Volume Uses

type Volume struct {
    corev1.Volume
    // contains filtered or unexported fields
}

Volume is a thin wrapper around coreV1.Volume that supplies DeepCopyObject and GetObjectKind

func (*Volume) DeepCopy Uses

func (v *Volume) DeepCopy() *Volume

DeepCopy wraps Volume.DeepCopy, copying the objectKind as well.

func (*Volume) DeepCopyObject Uses

func (v *Volume) DeepCopyObject() kuberuntime.Object

DeepCopyObject is just DeepCopy, needed for runtime.Object

func (*Volume) GetObjectKind Uses

func (v *Volume) GetObjectKind() schema.ObjectKind

GetObjectKind returns the underlying objectKind, needed for runtime.Object

func (*Volume) GroupVersionKind Uses

func (o *Volume) GroupVersionKind() schema.GroupVersionKind

func (*Volume) SetGroupVersionKind Uses

func (o *Volume) SetGroupVersionKind(gvk schema.GroupVersionKind)

Directories

PathSynopsis
helper

Package manifest imports 7 packages (graph) and is imported by 14 packages. Updated 2020-01-17. Refresh now. Tools for package owners.