resource

Documentation

Overview

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

Index

• type Factory
  • func NewFactory(kf ifc.KunstructuredFactory) *Factory
  • func (rf *Factory) FromBytes(in []byte) (*Resource, error)
  • func (rf *Factory) FromKunstructured(u ifc.Kunstructured) *Resource
  • func (rf *Factory) FromMap(m map[string]interface{}) *Resource
  • func (rf *Factory) FromMapAndOption(m map[string]interface{}, args *types.GeneratorArgs, ...) *Resource
  • func (rf *Factory) FromMapWithName(n string, m map[string]interface{}) *Resource
  • func (rf *Factory) FromMapWithNamespace(n string, m map[string]interface{}) *Resource
  • func (rf *Factory) FromMapWithNamespaceAndName(ns string, n string, m map[string]interface{}) *Resource
  • func (rf *Factory) Hasher() ifc.KunstructuredHasher
  • func (rf *Factory) MakeConfigMap(kvLdr ifc.KvLoader, options *types.GeneratorOptions, args *types.ConfigMapArgs) (*Resource, error)
  • func (rf *Factory) MakeSecret(kvLdr ifc.KvLoader, options *types.GeneratorOptions, args *types.SecretArgs) (*Resource, error)
  • func (rf *Factory) SliceFromBytes(in []byte) ([]*Resource, error)
  • func (rf *Factory) SliceFromPatches(ldr ifc.Loader, paths []types.PatchStrategicMerge) ([]*Resource, error)
• type ResCtx
• type ResCtxMatcher
• type Resource
  • func (r *Resource) AddNamePrefix(p string)
  • func (r *Resource) AddNameSuffix(s string)
  • func (r *Resource) AppendRefBy(id resid.ResId)
  • func (r *Resource) AppendRefVarName(variable types.Var)
  • func (r *Resource) AsYAML() ([]byte, error)
  • func (r *Resource) Behavior() types.GenerationBehavior
  • func (r *Resource) CurId() resid.ResId
  • func (r *Resource) DeepCopy() *Resource
  • func (r *Resource) Equals(o *Resource) bool
  • func (r *Resource) GetNamePrefixes() []string
  • func (r *Resource) GetNameSuffixes() []string
  • func (r *Resource) GetNamespace() string
  • func (r *Resource) GetOriginalName() string
  • func (r *Resource) GetOriginalNs() string
  • func (r *Resource) GetOutermostNamePrefix() string
  • func (r *Resource) GetOutermostNameSuffix() string
  • func (r *Resource) GetRefBy() []resid.ResId
  • func (r *Resource) GetRefVarNames() []string
  • func (r *Resource) InSameKustomizeCtx(rctxm ResCtxMatcher) bool
  • func (r *Resource) KunstructEqual(o *Resource) bool
  • func (r *Resource) Merge(other *Resource)
  • func (r *Resource) NeedHashSuffix() bool
  • func (r *Resource) OrgId() resid.ResId
  • func (r *Resource) OutermostPrefixSuffixEquals(o ResCtx) bool
  • func (r *Resource) PrefixesSuffixesEquals(o ResCtx) bool
  • func (r *Resource) ReferencesEqual(o *Resource) bool
  • func (r *Resource) Replace(other *Resource)
  • func (r *Resource) SetOptions(o *types.GenArgs)
  • func (r *Resource) String() string

Types

type Factory

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

Factory makes instances of Resource.

func NewFactory

func NewFactory(kf ifc.KunstructuredFactory) *Factory

NewFactory makes an instance of Factory.

func (*Factory) FromBytes

func (rf *Factory) FromBytes(in []byte) (*Resource, error)

FromBytes unmarshals bytes into one Resource.

func (*Factory) FromKunstructured

func (rf *Factory) FromKunstructured(u ifc.Kunstructured) *Resource

FromKunstructured returns a new instance of Resource.

func (*Factory) FromMap

func (rf *Factory) FromMap(m map[string]interface{}) *Resource

FromMap returns a new instance of Resource.

func (*Factory) FromMapAndOption

func (rf *Factory) FromMapAndOption(
	m map[string]interface{}, args *types.GeneratorArgs, option *types.GeneratorOptions) *Resource

FromMapAndOption returns a new instance of Resource with given options.

func (*Factory) FromMapWithName

func (rf *Factory) FromMapWithName(n string, m map[string]interface{}) *Resource

FromMapWithName returns a new instance with the given "original" name.

func (*Factory) FromMapWithNamespace

func (rf *Factory) FromMapWithNamespace(n string, m map[string]interface{}) *Resource

FromMapWithNamespace returns a new instance with the given "original" namespace.

func (*Factory) FromMapWithNamespaceAndName

func (rf *Factory) FromMapWithNamespaceAndName(ns string, n string, m map[string]interface{}) *Resource

FromMapWithNamespaceAndName returns a new instance with the given "original" namespace.

func (*Factory) Hasher

func (rf *Factory) Hasher() ifc.KunstructuredHasher

func (*Factory) MakeConfigMap

func (rf *Factory) MakeConfigMap(
	kvLdr ifc.KvLoader,
	options *types.GeneratorOptions,
	args *types.ConfigMapArgs) (*Resource, error)

MakeConfigMap makes an instance of Resource for ConfigMap

func (*Factory) MakeSecret

func (rf *Factory) MakeSecret(
	kvLdr ifc.KvLoader,
	options *types.GeneratorOptions,
	args *types.SecretArgs) (*Resource, error)

MakeSecret makes an instance of Resource for Secret

func (*Factory) SliceFromBytes

func (rf *Factory) SliceFromBytes(in []byte) ([]*Resource, error)

SliceFromBytes unmarshals bytes into a Resource slice.

func (*Factory) SliceFromPatches

func (rf *Factory) SliceFromPatches(
	ldr ifc.Loader, paths []types.PatchStrategicMerge) ([]*Resource, error)

SliceFromPatches returns a slice of resources given a patch path slice from a kustomization file.

type ResCtx

type ResCtx interface {
	AddNamePrefix(p string)
	AddNameSuffix(s string)
	GetOutermostNamePrefix() string
	GetOutermostNameSuffix() string
	GetNamePrefixes() []string
	GetNameSuffixes() []string
}

ResCtx is an interface describing the contextual added kept kustomize in the context of each Resource object. Currently mainly the name prefix and name suffix are added.

type ResCtxMatcher

type ResCtxMatcher func(ResCtx) bool

ResCtxMatcher returns true if two Resources are being modified in the same kustomize context.

type Resource

type Resource struct {
	ifc.Kunstructured
	// contains filtered or unexported fields
}

Resource is map representation of a Kubernetes API resource object paired with a GenerationBehavior.

func (*Resource) AddNamePrefix

func (r *Resource) AddNamePrefix(p string)

Implements ResCtx AddNamePrefix

func (*Resource) AddNameSuffix

func (r *Resource) AddNameSuffix(s string)

Implements ResCtx AddNameSuffix

func (*Resource) AppendRefBy

func (r *Resource) AppendRefBy(id resid.ResId)

AppendRefBy appends a ResId into the refBy list

func (*Resource) AppendRefVarName

func (r *Resource) AppendRefVarName(variable types.Var)

AppendRefVarName appends a name of a var into the refVar list

func (*Resource) AsYAML

func (r *Resource) AsYAML() ([]byte, error)

AsYAML returns the resource in Yaml form. Easier to read than JSON.

func (*Resource) Behavior

func (r *Resource) Behavior() types.GenerationBehavior

Behavior returns the behavior for the resource.

func (*Resource) CurId

func (r *Resource) CurId() resid.ResId

CurId returns a ResId for the resource using the mutable parts of the resource. This should be unique in any ResMap.

func (*Resource) DeepCopy

func (r *Resource) DeepCopy() *Resource

DeepCopy returns a new copy of resource

func (*Resource) Equals

func (r *Resource) Equals(o *Resource) bool

func (*Resource) GetNamePrefixes

func (r *Resource) GetNamePrefixes() []string

Implements ResCtx GetNamePrefixes

func (*Resource) GetNameSuffixes

func (r *Resource) GetNameSuffixes() []string

Implements ResCtx GetNameSuffixes

func (*Resource) GetNamespace

func (r *Resource) GetNamespace() string

GetNamespace returns the namespace the resource thinks it's in.

func (*Resource) GetOriginalName

func (r *Resource) GetOriginalName() string

func (*Resource) GetOriginalNs

func (r *Resource) GetOriginalNs() string

func (*Resource) GetOutermostNamePrefix

func (r *Resource) GetOutermostNamePrefix() string

Implements ResCtx GetOutermostNamePrefix

func (*Resource) GetOutermostNameSuffix

func (r *Resource) GetOutermostNameSuffix() string

Implements ResCtx GetOutermostNameSuffix

func (*Resource) GetRefBy

func (r *Resource) GetRefBy() []resid.ResId

GetRefBy returns the ResIds that referred to current resource

func (*Resource) GetRefVarNames

func (r *Resource) GetRefVarNames() []string

GetRefVarNames returns vars that refer to current resource

func (*Resource) InSameKustomizeCtx

func (r *Resource) InSameKustomizeCtx(rctxm ResCtxMatcher) bool

This is used to compute if a referrer could potentially be impacted by the change of name of a referral.

func (*Resource) KunstructEqual

func (r *Resource) KunstructEqual(o *Resource) bool

func (*Resource) Merge

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

Merge performs merge with other resource.

func (*Resource) NeedHashSuffix

func (r *Resource) NeedHashSuffix() bool

NeedHashSuffix returns true if a resource content hash should be appended to the name of the resource.

func (*Resource) OrgId

func (r *Resource) OrgId() resid.ResId

OrgId returns the original, immutable ResId for the resource. This doesn't have to be unique in a ResMap. TODO: compute this once and save it in the resource.

func (*Resource) OutermostPrefixSuffixEquals

func (r *Resource) OutermostPrefixSuffixEquals(o ResCtx) bool

OutermostPrefixSuffixEquals returns true if both resources outer suffix and prefix matches.

func (*Resource) PrefixesSuffixesEquals

func (r *Resource) PrefixesSuffixesEquals(o ResCtx) bool

PrefixesSuffixesEquals is conceptually doing the same task as OutermostPrefixSuffix but performs a deeper comparison of the suffix and prefix slices.

Important note: The PrefixSuffixTransformer is stacking the prefix values in the reverse order of appearance in the transformed name. For this reason the sameEndingSubarray method is used (as opposed to the sameBeginningSubarray) to compare the prefix slice. In the same spirit, the GetOutermostNamePrefix is using the last element of the nameprefix slice and not the first.

func (*Resource) ReferencesEqual

func (r *Resource) ReferencesEqual(o *Resource) bool

func (*Resource) Replace

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

Replace performs replace with other resource.

func (*Resource) SetOptions

func (r *Resource) SetOptions(o *types.GenArgs)

SetOptions updates the generator options for the resource.

func (*Resource) String

func (r *Resource) String() string

String returns resource as JSON.