kubemanifest

Documentation

Index

• func KubeObjectToApplyYAML(data runtime.Object) (string, error)
• func MapEtcHosts(pod *v1.Pod, container *v1.Container, readOnly bool)
• func MarkPodAsClusterCritical(pod *v1.Pod)
• func MarkPodAsCritical(pod *v1.Pod)
• func MarkPodAsNodeCritical(pod *v1.Pod)
• type HostPathMapping
  • func AddHostPathMapping(pod *v1.Pod, container *v1.Container, name, path string) *HostPathMapping
  • func (m *HostPathMapping) WithHostPath(p string) *HostPathMapping
  • func (m *HostPathMapping) WithReadWrite() *HostPathMapping
  • func (m *HostPathMapping) WithType(t v1.HostPathType) *HostPathMapping
• 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 (m *Object) IsEmptyObject() bool
  • func (m *Object) Kind() string
  • 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)
• type ObjectList
  • func LoadObjectsFrom(contents []byte) (ObjectList, error)
  • func (l ObjectList) ToYAML() ([]byte, error)
• type Visitor

Functions

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 MapEtcHosts

func MapEtcHosts(pod *v1.Pod, container *v1.Container, readOnly bool)

MapEtcHosts maps the /etc/hosts file into the pod (useful for gossip DNS)

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 HostPathMapping

type HostPathMapping struct {
	VolumeMount *v1.VolumeMount
	Volume      *v1.Volume
}

HostPathMapping allows fluent construction of a hostpath mount

func AddHostPathMapping

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

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 (*HostPathMapping) WithHostPath

func (m *HostPathMapping) WithHostPath(p string) *HostPathMapping

WithHostPath changes the hostpath path

func (*HostPathMapping) WithReadWrite

func (m *HostPathMapping) WithReadWrite() *HostPathMapping

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

func (*HostPathMapping) WithType

func (m *HostPathMapping) WithType(t v1.HostPathType) *HostPathMapping

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) 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) 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)

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
}