...

Package labels

import "sigs.k8s.io/kustomize/api/filters/labels"
Overview
Index
Examples

Overview ▾

Package labels contains a kio.Filter implementation of the kustomize labels transformer.

type Filter

Filter sets labels.

type Filter struct {
    // Labels is the set of labels to apply to the inputs
    Labels labelMap `yaml:"labels,omitempty"`

    // FsSlice identifies the label fields.
    FsSlice types.FsSlice
    // contains filtered or unexported fields
}

Example

Code:

fss := builtinconfig.MakeDefaultConfig().CommonLabels
err := kio.Pipeline{
    Inputs: []kio.Reader{&kio.ByteReader{Reader: bytes.NewBufferString(`
apiVersion: example.com/v1
kind: Foo
metadata:
  name: instance
---
apiVersion: example.com/v1
kind: Bar
metadata:
  name: instance
`)}},
    Filters: []kio.Filter{Filter{
        Labels: map[string]string{
            "foo": "bar",
        },
        FsSlice: fss,
    }},
    Outputs: []kio.Writer{kio.ByteWriter{Writer: os.Stdout}},
}.Execute()
if err != nil {
    log.Fatal(err)
}

Output:

apiVersion: example.com/v1
kind: Foo
metadata:
  name: instance
  labels:
    foo: bar
---
apiVersion: example.com/v1
kind: Bar
metadata:
  name: instance
  labels:
    foo: bar

func (Filter) Filter

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

func (*Filter) WithMutationTracker

func (f *Filter) WithMutationTracker(callback func(key, value, tag string, node *yaml.RNode))

WithMutationTracker registers a callback which will be invoked each time a field is mutated