meta

Documentation

Index

• func GetPodSpec(obj runtime.Object) (*kapi.PodSpec, *field.Path, error)
• func GetPodSpecV1(obj runtime.Object) (*kapiv1.PodSpec, *field.Path, error)
• func GetTemplateMetaObject(obj runtime.Object) (metav1.Object, bool)
• func HasPodSpec(gr schema.GroupResource) (schema.GroupKind, bool)
• type AnnotationAccessor
  • func GetAnnotationAccessor(obj runtime.Object) (AnnotationAccessor, bool)
• type ContainerMutator
• type ImageReferenceMutateFunc
• type ImageReferenceMutator
  • func GetImageReferenceMutator(obj runtime.Object) (ImageReferenceMutator, error)
• type PodSpecReferenceMutator
  • func GetPodSpecReferenceMutator(obj runtime.Object) (PodSpecReferenceMutator, error)

Functions

func GetPodSpec

func GetPodSpec(obj runtime.Object) (*kapi.PodSpec, *field.Path, error)

GetPodSpec returns a mutable pod spec out of the provided object, including a field path to the field in the object, or an error if the object does not contain a pod spec. This only returns internal objects.

func GetPodSpecV1

func GetPodSpecV1(obj runtime.Object) (*kapiv1.PodSpec, *field.Path, error)

GetPodSpecV1 returns a mutable pod spec out of the provided object, including a field path to the field in the object, or an error if the object does not contain a pod spec. This only returns pod specs for v1 compatible objects.

func GetTemplateMetaObject

func GetTemplateMetaObject(obj runtime.Object) (metav1.Object, bool)

GetTemplateMetaObject returns a mutable metav1.Object interface for the template the object contains, or false if no such object is available.

func HasPodSpec

func HasPodSpec(gr schema.GroupResource) (schema.GroupKind, bool)

HasPodSpec returns true if the resource is known to have a pod spec.

Types

type AnnotationAccessor

type AnnotationAccessor interface {
	// Annotations returns a map representing annotations. Not mutable.
	Annotations() map[string]string
	// SetAnnotations sets representing annotations onto the object.
	SetAnnotations(map[string]string)
	// TemplateAnnotations returns a map representing annotations on a nested template in the object. Not mutable.
	// If no template is present bool will be false.
	TemplateAnnotations() (map[string]string, bool)
	// SetTemplateAnnotations sets annotations on a nested template in the object.
	// If no template is present bool will be false.
	SetTemplateAnnotations(map[string]string) bool
}

func GetAnnotationAccessor

func GetAnnotationAccessor(obj runtime.Object) (AnnotationAccessor, bool)

GetAnnotationAccessor returns an accessor for the provided object or false if the object does not support accessing annotations.

type ContainerMutator

type ContainerMutator interface {
	GetName() string
	GetImage() string
	SetImage(image string)
}

type ImageReferenceMutateFunc

type ImageReferenceMutateFunc func(ref *kapi.ObjectReference) error

ImageReferenceMutateFunc is passed a reference representing an image, and may alter the Name, Kind, and Namespace fields of the reference. If an error is returned the object may still be mutated under the covers.

type ImageReferenceMutator

type ImageReferenceMutator interface {
	// Mutate invokes fn on every image reference in the object. If fn returns an error,
	// a field.Error is added to the list to be returned. Mutate does not terminate early
	// if errors are detected.
	Mutate(fn ImageReferenceMutateFunc) field.ErrorList
}

func GetImageReferenceMutator

func GetImageReferenceMutator(obj runtime.Object) (ImageReferenceMutator, error)

GetImageReferenceMutator returns a mutator for the provided object, or an error if no such mutator is defined.

type PodSpecReferenceMutator

type PodSpecReferenceMutator interface {
	GetContainerByIndex(init bool, i int) (ContainerMutator, bool)
	GetContainerByName(name string) (ContainerMutator, bool)
	Path() *field.Path
}

func GetPodSpecReferenceMutator

func GetPodSpecReferenceMutator(obj runtime.Object) (PodSpecReferenceMutator, error)

GetPodSpecReferenceMutator returns a mutator for the provided object, or an error if no such mutator is defined.