package suffix

import "sigs.k8s.io/kustomize/api/filters/suffix"

Package suffix contains a kio.Filter implementation of the kustomize SuffixTransformer.

Index

Examples

Types

type Filter 

type Filter struct {
	Suffix string `json:"suffix,omitempty" yaml:"suffix,omitempty"`

	FieldSpec types.FieldSpec `json:"fieldSpec,omitempty" yaml:"fieldSpec,omitempty"`
	// contains filtered or unexported fields
}

Filter applies resource name suffix's using the fieldSpecs

Example

Code:play  

package main

import (
	"bytes"
	"log"
	"os"

	"sigs.k8s.io/kustomize/api/filters/suffix"
	"sigs.k8s.io/kustomize/api/types"
	"sigs.k8s.io/kustomize/kyaml/kio"
)

func main() {
	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{suffix.Filter{
			Suffix: "-baz", FieldSpec: types.FieldSpec{Path: "metadata/name"}}},
		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-baz
---
apiVersion: example.com/v1
kind: Bar
metadata:
  name: instance-baz

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

Source Files

doc.go suffix.go

Version
v0.20.1 (latest)
Published
Jul 23, 2025
Platform
linux/amd64
Imports
6 packages
Last checked
23 hours ago –

Tools for package owners.