filters

Documentation

Index

• func FieldPath(p string, data map[string]string) ([]string, error)
• func FilterAll(f yaml.Filter) kio.Filter
• func FilterOne(f kio.Filter) yaml.Filter
• func Flatten(schema *spec.Schema) kio.Filter
• func Has(functions ...yaml.Filter) yaml.Filter
• func InstallOrder() kio.Filter
• func SetNamespace(namespace string) yaml.Filter
• func SetPath(p string, v *yaml.RNode) yaml.Filter
• func SetValues(nameValue []string, forceString bool) yaml.Filter
• func SortByKind(priority []string) kio.Filter
• func UninstallOrder() kio.Filter
• func WithContext(ctx context.Context, f ContextFilterFunc) yaml.Filter
• type ApplicationFilter
  • func (f *ApplicationFilter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error)
• type ContextFilterFunc
• type Pipeline
  • func (p *Pipeline) Read() ([]*yaml.RNode, error)
• type ResourceMetaFilter
  • func (f *ResourceMetaFilter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error)
• type WorkloadFilter
  • func (f *WorkloadFilter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error)

Functions

func FieldPath

func FieldPath(p string, data map[string]string) ([]string, error)

FieldPath evaluates a path template using the supplied context and then splits it into individual path segments (honoring escaped delimiters).

func FilterAll

func FilterAll(f yaml.Filter) kio.Filter

FilterAll is similar to `kio.FilterAll` except instead of evaluating for side effects, only the non-nil nodes returned by the filter are preserved.

func FilterOne

func FilterOne(f kio.Filter) yaml.Filter

FilterOne is the opposite of kio.FilterAll, useful if you have a filter that is optimized for filtering batches of nodes, but you just need to call `Pipe` on a single node.

func Flatten

func Flatten(schema *spec.Schema) kio.Filter

Flatten never returns more than a single node, every other node is merged into that first node using the supplied schema

func Has

func Has(functions ...yaml.Filter) yaml.Filter

Has is similar to `yaml.Tee` except it only produces a result if the supplied functions evaluate to a non-nil result.

func InstallOrder

func InstallOrder() kio.Filter

InstallOrder returns a filter that sorts nodes in the order in which they should be created in a cluster. This uses the Helm ordering which is more complete than the Kustomize ordering.

func SetNamespace

func SetNamespace(namespace string) yaml.Filter

SetNamespace is like `SetK8sNamespace` except it skips cluster scoped resources.

func SetPath

func SetPath(p string, v *yaml.RNode) yaml.Filter

SetPath returns a filter that sets the node value at the specified path. Note that this path uses "." separators rather then "/".

func SetValues

func SetValues(nameValue []string, forceString bool) yaml.Filter

SetValues returns a filter that sets the supplied "path=value" specifications onto incoming nodes. Use forceString to bypass tagging the node values.

func SortByKind

func SortByKind(priority []string) kio.Filter

SortByKind returns a filter that sorts nodes based on the supplied list of kinds.

func UninstallOrder

func UninstallOrder() kio.Filter

UninstallOrder returns a filter that sorts nodes in the order in which they should be deleted from a cluster. This is not directly the reverse of the installation order.

func WithContext

func WithContext(ctx context.Context, f ContextFilterFunc) yaml.Filter

WithContext binds a context to a context filter function.

Types

type ApplicationFilter

type ApplicationFilter struct {
	// Flag indicating if this filter should act as a pass-through.
	Enabled bool
	// Flag indicating we should show resources which do not belong to an application.
	ShowUnownedResources bool
	// The ordered names of the labels that contains the application name, default is "app.kubernetes.io/name, k8s-app, app".
	ApplicationNameLabels []string
	// The name of the label that contains the application instance name, default is "app.kubernetes.io/instance".
	ApplicationInstanceLabel string
}

ApplicationFilter produces applications based on the observed resources.

func (*ApplicationFilter) Filter

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

Filter keeps all the application resources and creates application resources for all other nodes that are not associated with an application.

type ContextFilterFunc

type ContextFilterFunc func(context.Context, *yaml.RNode) (*yaml.RNode, error)

ContextFilterFunc is a context-aware YAML filter function.

type Pipeline

type Pipeline struct {
	Inputs                []kio.Reader
	Filters               []kio.Filter
	ContinueOnEmptyResult bool
}

Pipeline wraps a KYAML pipeline but doesn't allow writers: instead the resulting resource nodes are returned directly. This is useful for applying filters to readers in memory. A pipeline can also be used as a reader in larger pipelines.

func (*Pipeline) Read

func (p *Pipeline) Read() ([]*yaml.RNode, error)

Execute this pipeline, returning the resulting resource nodes directly.

type ResourceMetaFilter

type ResourceMetaFilter struct {
	// Regular expression matching the group.
	Group string `json:"group,omitempty" yaml:"group,omitempty"`
	// Regular expression matching the version.
	Version string `json:"version,omitempty" yaml:"version,omitempty"`
	// Regular expression matching the kind.
	Kind string `json:"kind,omitempty" yaml:"kind,omitempty"`
	// Regular expression matching the namespace.
	Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
	// Regular expression matching the name.
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
	// Kubernetes selector matching labels.
	LabelSelector string `json:"labelSelector,omitempty" yaml:"labelSelector,omitempty"`
	// Kubernetes selector matching annotations
	AnnotationSelector string `json:"annotationSelector,omitempty" yaml:"annotationSelector,omitempty"`
}

ResourceMetaFilter filters nodes based on their resource metadata using regular expressions or Kubernetes selectors.

func (*ResourceMetaFilter) Filter

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

type WorkloadFilter

type WorkloadFilter struct {
	// Flag indicating if this filter should act as a pass-through.
	Enabled bool
	// Secondary filter which can be optionally used to accept non-workload resources.
	NonWorkloadFilter *ResourceMetaFilter
}

WorkloadFilter keeps only workload resources, i.e. those that directly or indirectly own pods. For this filter to work, all intermediate resources must be present and must have owner metadata specified.

func (*WorkloadFilter) Filter

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

Filter keeps all the workload resources.