nameref

Documentation

Overview

Package nameref contains a kio.Filter implementation of the kustomize name reference transformer.

Index

• type Filter
  • func (f Filter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error)

Types

type Filter

type Filter struct {
	// Referrer is the object that refers to something else by a name,
	// a name that this filter seeks to update.
	Referrer *resource.Resource

	// NameFieldToUpdate is the field in the Referrer that holds the
	// name requiring an update.
	NameFieldToUpdate types.FieldSpec `json:"nameFieldToUpdate,omitempty" yaml:"nameFieldToUpdate,omitempty"`

	// Source of the new value for the name (in its name field).
	ReferralTarget resid.Gvk

	// Set of resources to hunt through to find the ReferralTarget.
	ReferralCandidates resmap.ResMap
}

Filter updates a name references.

func (Filter) Filter

func (f Filter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error)

At time of writing, in practice this is called with a slice with only one entry, the node also referred to be the resource in the Referrer field.