kubemanifest

Documentation

Index

• func AddHostPathMapping(pod *v1.Pod, container *v1.Container, name, path string, ...)
• func KubeObjectToApplyYAML(data runtime.Object) (string, error)
• func MarkPodAsClusterCritical(pod *v1.Pod)
• func MarkPodAsCritical(pod *v1.Pod)
• func MarkPodAsNodeCritical(pod *v1.Pod)
• type ContainerVisitorFunction
• type HostPathMappingOption
  • func WithHostPath(p string) HostPathMappingOption
  • func WithMountPath(p string) HostPathMappingOption
  • func WithReadWrite() HostPathMappingOption
  • func WithType(t v1.HostPathType) HostPathMappingOption
• type ImageRemapFunction
• type Object
  • func FromRuntimeObject(obj runtime.Object) (*Object, error)
  • func NewObject(data map[string]interface{}) *Object
  • func (m *Object) APIVersion() string
  • func (m *Object) GetName() string
  • func (m *Object) GetNamespace() string
  • func (o *Object) GroupVersionKind() schema.GroupVersionKind
  • func (m *Object) IsEmptyObject() bool
  • func (m *Object) Kind() string
  • func (m *Object) MarshalJSON() ([]byte, error)
  • func (m *Object) RemapImages(mapper ImageRemapFunction) error
  • func (m *Object) Reparse(obj interface{}, fields ...string) error
  • func (m *Object) Set(newValue interface{}, fieldPath ...string) error
  • func (o *Object) ToUnstructured() *unstructured.Unstructured
  • func (m *Object) ToYAML() ([]byte, error)
  • func (m *Object) VisitContainers(visitorFn ContainerVisitorFunction) error
• type ObjectList
  • func LoadObjectsFrom(contents []byte) (ObjectList, error)
  • func (l ObjectList) ToYAML() ([]byte, error)
• type Visitor

Functions

func AddHostPathMapping

func AddHostPathMapping(pod *v1.Pod, container *v1.Container, name, path string, options ...HostPathMappingOption)

AddHostPathMapping is a helper function for mapping a host path into a container It returns a HostPathMapping for tweaking the defaults (which are notably read-only)

func KubeObjectToApplyYAML

func KubeObjectToApplyYAML(data runtime.Object) (string, error)

KubeObjectToApplyYAML returns the kubernetes object converted to YAML, with "noisy" fields removed.

We remove:

• status (can't be applied, shouldn't be specified)
• metadata.creationTimestamp (can't be applied, shouldn't be specified)

func MarkPodAsClusterCritical

func MarkPodAsClusterCritical(pod *v1.Pod)

MarkPodAsClusterCritical sets the pod priority to system-cluster-critical

func MarkPodAsCritical

func MarkPodAsCritical(pod *v1.Pod)

MarkPodAsCritical adds the required annotations for a pod to be considered critical

func MarkPodAsNodeCritical

func MarkPodAsNodeCritical(pod *v1.Pod)

MarkPodAsNodeCritical sets the pod priority to system-node-critical

Types

type ContainerVisitorFunction

type ContainerVisitorFunction func(container map[string]interface{}) error

type HostPathMappingOption

type HostPathMappingOption func(volumeMount *v1.VolumeMount, volume *v1.Volume)

HostPathMappingOption implements the "functional options pattern" for named variable parameters.

func WithHostPath

func WithHostPath(p string) HostPathMappingOption

WithHostPath changes the host path (the path in the host)

func WithMountPath

func WithMountPath(p string) HostPathMappingOption

WithMountPath changes the mount path (the path in the container)

func WithReadWrite

func WithReadWrite() HostPathMappingOption

WithReadWrite changes the hostpath mapping to be read-write (the default is read-only)

func WithType

func WithType(t v1.HostPathType) HostPathMappingOption

WithType changes the hostpath mount type

type ImageRemapFunction

type ImageRemapFunction func(image string) (string, error)

type Object

type Object struct {
	// contains filtered or unexported fields
}

Object holds arbitrary untyped kubernetes objects; it is used when we don't have the type definitions for them

func FromRuntimeObject

func FromRuntimeObject(obj runtime.Object) (*Object, error)

FromRuntimeObject converts from a runtime.Object.

func NewObject

func NewObject(data map[string]interface{}) *Object

NewObject returns an Object wrapping the provided data

func (*Object) APIVersion

func (m *Object) APIVersion() string

APIVersion returns the apiVersion field of the object, or "" if it cannot be found or is invalid

func (*Object) GetName

func (m *Object) GetName() string

GetName returns the namespace field of the object, or "" if it cannot be found or is invalid

func (*Object) GetNamespace

func (m *Object) GetNamespace() string

GetNamespace returns the namespace field of the object, or "" if it cannot be found or is invalid

func (*Object) GroupVersionKind

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

GroupVersionKind returns the group/version/kind information for the object

func (*Object) IsEmptyObject

func (m *Object) IsEmptyObject() bool

IsEmptyObject checks if the object has no keys set (i.e. `== {}`)

func (*Object) Kind

func (m *Object) Kind() string

Kind returns the kind field of the object, or "" if it cannot be found or is invalid

func (*Object) MarshalJSON

func (m *Object) MarshalJSON() ([]byte, error)

func (*Object) RemapImages

func (m *Object) RemapImages(mapper ImageRemapFunction) error

func (*Object) Reparse

func (m *Object) Reparse(obj interface{}, fields ...string) error

Reparse parses a subfield from an object

func (*Object) Set

func (m *Object) Set(newValue interface{}, fieldPath ...string) error

Set mutates a subfield to the newValue

func (*Object) ToUnstructured

func (o *Object) ToUnstructured() *unstructured.Unstructured

ToUnstructured converts the object to an unstructured.Unstructured

func (*Object) ToYAML

func (m *Object) ToYAML() ([]byte, error)

func (*Object) VisitContainers

func (m *Object) VisitContainers(visitorFn ContainerVisitorFunction) error

type ObjectList

type ObjectList []*Object

ObjectList describes a list of objects, allowing us to add bulk-methods

func LoadObjectsFrom

func LoadObjectsFrom(contents []byte) (ObjectList, error)

LoadObjectsFrom parses multiple objects from a yaml file

func (ObjectList) ToYAML

func (l ObjectList) ToYAML() ([]byte, error)

ToYAML serializes a list of objects back to bytes; it is the opposite of LoadObjectsFrom

type Visitor

type Visitor interface {
	VisitBool(path []string, v bool, mutator func(bool)) error
	VisitString(path []string, v string, mutator func(string)) error
	VisitFloat64(path []string, v float64, mutator func(float64)) error
	VisitMap(path []string, v map[string]interface{}) error
}