builtins

Documentation

Index

• Constants
• func AbstractPkgContext() string
• type PackageConfig
• type PackageContextGenerator
  • func (pc *PackageContextGenerator) Process(resourceList *framework.ResourceList) error
  • func (pc *PackageContextGenerator) Run(r io.Reader, w io.Writer) error

Constants

const (
	PkgContextFile = "package-context.yaml"
	PkgContextName = "kptfile.kpt.dev"

	ConfigKeyPackagePath = "package-path"
)

Functions

func AbstractPkgContext

func AbstractPkgContext() string

AbstractPkgContext returns content for package context that contains placeholder value for package name. This will be used to create abstract blueprints.

Types

type PackageConfig

type PackageConfig struct {
	// PackagePath is the path to the package, as determined by the names of the parent packages.
	// The path to a package is the parent package path joined with the package name.
	PackagePath string
}

PackageConfig holds package automatic configuration

type PackageContextGenerator

type PackageContextGenerator struct {
	// PackageConfig contains the package configuration to set.
	PackageConfig *PackageConfig
}

PackageContextGenerator is a built-in KRM function that generates a KRM object that contains package context information that can be used by functions such as `set-namespace` to customize package with minimal configuration.

func (*PackageContextGenerator) Process

func (pc *PackageContextGenerator) Process(resourceList *framework.ResourceList) error

Process implements framework.ResourceListProcessor interface.

func (*PackageContextGenerator) Run

func (pc *PackageContextGenerator) Run(r io.Reader, w io.Writer) error

Run function reads the function input `resourceList` from a given reader `r` and writes the function output to the provided writer `w`. Run implements the function signature defined in sigs.k8s.io/kustomize/kyaml/fn/runtime/runtimeutil/FunctionFilter.Run.