resmap

Documentation

Overview

Package resmap implements a map from ResId to Resource that tracks all resources in a kustomization.

Index

• func NewResourceSliceFromPatches(loader loader.Loader, paths []patch.PatchStrategicMerge) ([]*resource.Resource, error)
• type IdSlice
  • func (a IdSlice) Len() int
  • func (a IdSlice) Less(i, j int) bool
  • func (a IdSlice) Swap(i, j int)
• type ResMap
  • func MergeWithOverride(maps ...ResMap) (ResMap, error)
  • func MergeWithoutOverride(maps ...ResMap) (ResMap, error)
  • func NewResMapFromConfigMapArgs(f *configmapandsecret.ConfigMapFactory, cmArgsList []types.ConfigMapArgs) (ResMap, error)
  • func NewResMapFromFiles(loader loader.Loader, paths []string) (ResMap, error)
  • func NewResMapFromSecretArgs(f *configmapandsecret.SecretFactory, secretList []types.SecretArgs) (ResMap, error)
  • func (m ResMap) DeepCopy() ResMap
  • func (m ResMap) DemandOneMatchForId(inputId resource.ResId) (*resource.Resource, bool)
  • func (m ResMap) EncodeAsYaml() ([]byte, error)
  • func (m ResMap) ErrorIfNotEqual(m2 ResMap) error
  • func (m ResMap) FilterBy(inputId resource.ResId) ResMap
  • func (m ResMap) FindByGVKN(inputId resource.ResId) []resource.ResId

Functions

func NewResourceSliceFromPatches

func NewResourceSliceFromPatches(
	loader loader.Loader, paths []patch.PatchStrategicMerge) ([]*resource.Resource, error)

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

Types

type IdSlice

type IdSlice []resource.ResId

IdSlice implements the sort interface.

func (IdSlice) Len

func (a IdSlice) Len() int

func (IdSlice) Less

func (a IdSlice) Less(i, j int) bool

func (IdSlice) Swap

func (a IdSlice) Swap(i, j int)

type ResMap

type ResMap map[resource.ResId]*resource.Resource

ResMap is a map from ResId to Resource.

func MergeWithOverride

func MergeWithOverride(maps ...ResMap) (ResMap, error)

MergeWithOverride combines multiple ResMap instances, allowing and sometimes demanding certain collisions and skipping nil maps. In case if all of the maps are nil, an empty ResMap is returned. When looping over the instances to combine them, if a resource id for resource X is found to be already in the combined map, then the behavior field for X must be BehaviorMerge or BehaviorReplace. If X is not in the map, then it's behavior cannot be merge or replace.

func MergeWithoutOverride

func MergeWithoutOverride(maps ...ResMap) (ResMap, error)

MergeWithoutOverride combines multiple ResMap instances, failing on key collision and skipping nil maps. In case if all of the maps are nil, an empty ResMap is returned.

func NewResMapFromConfigMapArgs

func NewResMapFromConfigMapArgs(
	f *configmapandsecret.ConfigMapFactory,
	cmArgsList []types.ConfigMapArgs) (ResMap, error)

NewResMapFromConfigMapArgs returns a Resource slice given a configmap metadata slice from kustomization file.

func NewResMapFromFiles

func NewResMapFromFiles(loader loader.Loader, paths []string) (ResMap, error)

NewResMapFromFiles returns a ResMap given a resource path slice.

func NewResMapFromSecretArgs

func NewResMapFromSecretArgs(
	f *configmapandsecret.SecretFactory,
	secretList []types.SecretArgs) (ResMap, error)

NewResMapFromSecretArgs takes a SecretArgs slice, generates secrets from each entry, and accumulates them in a ResMap.

func (ResMap) DeepCopy

func (m ResMap) DeepCopy() ResMap

DeepCopy clone the resmap into a new one

func (ResMap) DemandOneMatchForId

func (m ResMap) DemandOneMatchForId(inputId resource.ResId) (*resource.Resource, bool)

DemandOneMatchForId find the matched resource by Group/Version/Kind and Name

func (ResMap) EncodeAsYaml

func (m ResMap) EncodeAsYaml() ([]byte, error)

EncodeAsYaml encodes a ResMap to YAML; encoded objects separated by `---`.

func (ResMap) ErrorIfNotEqual

func (m ResMap) ErrorIfNotEqual(m2 ResMap) error

ErrorIfNotEqual returns error if maps are not equal.

func (ResMap) FilterBy

func (m ResMap) FilterBy(inputId resource.ResId) ResMap

FilterBy returns a ResMap containing ResIds with the same namespace and nameprefix with the inputId

func (ResMap) FindByGVKN

func (m ResMap) FindByGVKN(inputId resource.ResId) []resource.ResId

FindByGVKN find the matched ResIds by Group/Version/Kind and Name