resource

Documentation

Overview

Package resource implements representations of k8s API resources as "unstructured" objects.

Index

• type GenerationBehavior
  • func NewGenerationBehavior(s string) GenerationBehavior
  • func (b GenerationBehavior) String() string
• type ResId
  • func NewResId(g schema.GroupVersionKind, n string) ResId
  • func (n ResId) Gvk() schema.GroupVersionKind
  • func (n ResId) Name() string
  • func (n ResId) String() string
• type Resource
  • func NewResourceFromMap(m map[string]interface{}) *Resource
  • func NewResourceFromUnstruct(u unstructured.Unstructured) *Resource
  • func NewResourceWithBehavior(obj runtime.Object, b GenerationBehavior) (*Resource, error)
  • func (r *Resource) Behavior() GenerationBehavior
  • func (r *Resource) GetFieldValue(fieldPath string) (string, error)
  • func (r *Resource) Id() ResId
  • func (r *Resource) IsGenerated() bool
  • func (r *Resource) Merge(other *Resource)
  • func (r *Resource) Replace(other *Resource)
  • func (r *Resource) SetBehavior(b GenerationBehavior) *Resource

Types

type GenerationBehavior

type GenerationBehavior int

GenerationBehavior specifies generation behavior of configmaps, secrets and maybe other resources.

const (
	// BehaviorUnspecified is an Unspecified behavior; typically treated as a Create.
	BehaviorUnspecified GenerationBehavior = iota
	// BehaviorCreate makes a new resource.
	BehaviorCreate
	// BehaviorReplace replaces a resource.
	BehaviorReplace
	// BehaviorMerge attempts to merge a new resource with an existing resource.
	BehaviorMerge
)

func NewGenerationBehavior

func NewGenerationBehavior(s string) GenerationBehavior

NewGenerationBehavior converts a string to a GenerationBehavior.

func (GenerationBehavior) String

func (b GenerationBehavior) String() string

String converts a GenerationBehavior to a string.

type ResId

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

ResId conflates GroupVersionKind with a textual name to uniquely identify a kubernetes resource (object).

func NewResId

func NewResId(g schema.GroupVersionKind, n string) ResId

NewResId creates new resource identifier

func (ResId) Gvk

func (n ResId) Gvk() schema.GroupVersionKind

Gvk returns Group/Version/Kind of the resource.

func (ResId) Name

func (n ResId) Name() string

Name returns resource name.

func (ResId) String

func (n ResId) String() string

type Resource

type Resource struct {
	unstructured.Unstructured
	// contains filtered or unexported fields
}

Resource is an "Unstructured" (json/map form) Kubernetes API resource object paired with a GenerationBehavior.

func NewResourceFromMap

func NewResourceFromMap(m map[string]interface{}) *Resource

NewResourceFromMap returns a new instance of Resource.

func NewResourceFromUnstruct

func NewResourceFromUnstruct(u unstructured.Unstructured) *Resource

NewResourceFromUnstruct returns a new instance of Resource.

func NewResourceWithBehavior

func NewResourceWithBehavior(obj runtime.Object, b GenerationBehavior) (*Resource, error)

NewResourceWithBehavior returns a new instance of Resource.

func (*Resource) Behavior

func (r *Resource) Behavior() GenerationBehavior

Behavior returns the behavior for the resource.

func (*Resource) GetFieldValue

func (r *Resource) GetFieldValue(fieldPath string) (string, error)

GetFieldValue returns value at the given fieldpath.

func (*Resource) Id

func (r *Resource) Id() ResId

Id returns the ResId for the resource.

func (*Resource) IsGenerated

func (r *Resource) IsGenerated() bool

IsGenerated checks if the resource is generated from a generator

func (*Resource) Merge

func (r *Resource) Merge(other *Resource)

Merge performs merge with other resource.

func (*Resource) Replace

func (r *Resource) Replace(other *Resource)

Replace performs replace with other resource.

func (*Resource) SetBehavior

func (r *Resource) SetBehavior(b GenerationBehavior) *Resource

SetBehavior changes the resource to the new behavior