Package command contains a builder for creating cobra.Commands based on configuration functions written using the kyaml function framework.

Package main contains an example using the the framework.

Package frameworktestutil contains utilities for testing functions written using the framework.

Package parser contains implementations of the framework.TemplateParser and framework.SchemaParser interfaces.

AnnotationMatcher matches resources that are annotated with all of the provided key-value pairs.

APIVersionMatcher matches resources whose kind is equal to one of the provided values.

ContainerNameMatcher returns a function that returns true if the "name" field of the provided container node matches one of the given container names.

Execute is the entrypoint for invoking configuration functions built with this framework from code.

GVKMatcher matches resources whose API group, version and kind match one of the provided values.

KindMatcher matches resources whose kind is equal to one of the provided values.

LabelMatcher matches resources that are labelled with all of the provided key-value pairs.

LoadFunctionConfig reads a configuration resource from YAML into the provided data structure and then prepares it for use by running defaulting and validation on it, if supported.

MatchAll is a shorthand for building an AndSelector from a list of ResourceMatchers.

MatchAny is a shorthand for building an OrSelector from a list of ResourceMatchers.

NameMatcher matches resources whose metadata.name is equal to one of the provided values.

NamespaceMatcher matches resources whose metadata.namespace is equal to one of the provided values.

SchemaFromFunctionDefinition extracts the schema for a particular GVK from the provided KRMFunctionDefinition Since the relevant fields of KRMFunctionDefinition exactly match the ones in CustomResourceDefinition, this helper can also load CRDs (e.g.

Error indicates the result is an error.

Info indicates the result is an informative message.

Warning indicates the result is a warning.

OrSelector is a kio.Filter that selects resources when that match all of its embedded matchers.

ContainerPatchTemplate defines a patch to be applied to containers.

Field references a field in a resource.

File references a file containing a resource.

KRMFunctionDefinition is metadata that defines a KRM function the same way a CRD defines a custom resource.

OrSelector is a kio.Filter that selects resources when that match at least one of its embedded matchers.

ResourceList is a Kubernetes list type used as the primary data interchange format in the Configuration Functions Specification: https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/docs/api-conventions/functions-spec.md This framework facilitates building functions that receive and emit ResourceLists, as required by the specification.

ResourcePatchTemplate applies a patch to a collection of resources.

ResourceTemplate generates resources from templates.

ResultItem defines a validation result.

Selector matches resources.

SimpleProcessor processes a ResourceList by loading the FunctionConfig into the given Config type and then running the provided Filter on the ResourceList.

TemplatedMetaMapMatcher is a utility type for constructing matchers that compare resource metadata to a map of (possibly templated) key-value pairs.

TemplatedMetaSliceMatcher is a utility type for constructing matchers that compare resource metadata to a slice of (possibly templated) strings.

TemplateProcessor is a ResourceListProcessor based on rendering templates with the data in ResourceList.functionConfig.

VersionedAPIProcessor selects the appropriate kio.Filter based on the ApiVersion and Kind of the ResourceList.functionConfig in the input.

Defaulter is implemented by APIs to have Default invoked.

FilterProvider is implemented by types that provide a way to look up which Filter should be used to process a ResourceList based on the ApiVersion and Kind of the ResourceList.functionConfig in the input.

PatchTemplate is implemented by kio.Filters that work by rendering patches and applying them to the given resource nodes.

ResourceListProcessor is implemented by configuration functions built with this framework to conform to the Configuration Functions Specification: https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/docs/api-conventions/functions-spec.md To invoke a processor, pass it to framework.Execute, which will also handle ResourceList IO.

ResourceMatcher is implemented by types designed for use in or as selectors.

ResourceTemplateMatcher is implemented by ResourceMatcher types that accept text templates as part of their configuration.

ValidationSchemaProvider is implemented by APIs to have the openapi schema provided by Schema() used to validate the input functionConfig before it is parsed into the API's struct.

Validator is implemented by APIs to have Validate invoked.

FilterProviderFunc converts a compatible function to a FilterProvider.

GVKFilterMap is a FilterProvider that resolves Filters through a simple lookup in a map.

ResourceListProcessorFunc converts a compatible function to a ResourceListProcessor.

ResourceMatcherFunc converts a compliant function into a ResourceMatcher.

Severity indicates the severity of the Result.