kptfileutil

Documentation

Index

• func CheckKptfileVersion(content []byte, path string) error
• func ReadFile(dir string) (kptfile.KptFile, error)
• func ReadFileStrict(pkgPath string) (kptfile.KptFile, error)
• func ValidateInventory(inv *kptfile.Inventory) (bool, error)
• func WriteFile(dir string, k kptfile.KptFile) error
• type UnknownKptfileVersionError
  • func (e *UnknownKptfileVersionError) Error() string

Functions

func CheckKptfileVersion

func CheckKptfileVersion(content []byte, path string) error

CheckKptfileVersion checks that the KRM provided KRM resource uses the correct group, version and kind for this version of kpt.

func ReadFile

func ReadFile(dir string) (kptfile.KptFile, error)

ReadFile reads the KptFile in the given directory

func ReadFileStrict

func ReadFileStrict(pkgPath string) (kptfile.KptFile, error)

ReadFileStrict reads a Kptfile for a package and validates that it contains required Upstream fields.

func ValidateInventory

func ValidateInventory(inv *kptfile.Inventory) (bool, error)

ValidateInventory returns true and a nil error if the passed inventory is valid; otherwise, false and the reason the inventory is not valid is returned. A valid inventory must have a non-empty namespace, name, and id.

func WriteFile

func WriteFile(dir string, k kptfile.KptFile) error

Types

type UnknownKptfileVersionError

type UnknownKptfileVersionError struct {
	PkgPath  string
	RepoSpec *git.RepoSpec
	Version  string
}

UnknownKptfileVersionError is returned when kpt encounters a Kptfile that uses an unsupported version of the Kptfile resource.

func (*UnknownKptfileVersionError) Error

func (e *UnknownKptfileVersionError) Error() string