pkg

package
v1.0.0-beta.64.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 5, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Overview

Package pkg defines the concept of a kpt package.

Package pkg contains utility functions for packages

Index

Constants

View Source 
const CurDir = "."
View Source 
const ParentDir = ".."

Variables

View Source 
var MatchAllKRM = append([]string{kptfilev1.KptFileName}, kio.MatchAll...)

MatchAllKRM represents set of glob pattern to match all KRM resources including Kptfile.

Functions

func ClearInternalAnnotations 

func ClearInternalAnnotations(annotations map[string]string)

func CopyPackage 

func CopyPackage(src, dst string, copyRootKptfile bool, matcher SubpackageMatcher) error

CopyPackage copies the content of a single package from src to dst. If includeSubpackages is true, it will copy resources belonging to any subpackages.

func DecodeRGFile 

func DecodeRGFile(in io.Reader) (*rgfilev1alpha1.ResourceGroup, error)

DecodeRGFile converts a string reader into structured a ResourceGroup object.

func Exists 

func Exists(path string) (bool, error)

Exists returns true if a file or directory exists on the provided path, and false otherwise.

func FindSubpackagesForPaths 

func FindSubpackagesForPaths(matcher SubpackageMatcher, recurse bool, pkgPaths ...string) ([]string, error)

FindSubpackagesForPaths traverses the provided package paths and finds all subpackages using the provided pkgLocatorFunc

func FormatPackage 

func FormatPackage(pkgPath string)

FormatPackage formats resources and meta-resources in the package and all its subpackages

func GetPkgPathAnnotation 

func GetPkgPathAnnotation(rn *yaml.RNode) (string, error)

GetPkgPathAnnotation returns the package path annotation on a given resource.

func ImageBaseName 

func ImageBaseName(fullName string) string

ImageBaseName extracts the "base name" from a full/partial image repository name

TODO: This probably already exist somewhere

func IsPackageDir 

func IsPackageDir(fsys filesys.FileSystem, path string) (bool, error)

IsPackageDir checks if there exists a Kptfile on the provided path, i.e. whether the provided path is the root of a package.

func IsPackageUnfetched 

func IsPackageUnfetched(path string) (bool, error)

IsPackageUnfetched returns true if a package has Upstream information, but no UpstreamLock. For local packages that doesn't have Upstream information, it will always return false. If a Kptfile is not found on the provided path, an error will be returned.

func PipelineStepNameOrImage 

func PipelineStepNameOrImage(name, image string) string

PipelineStepNameOrImage returns the name if it's not empty or extracts the base name of the image

func ReadRGFile 

func ReadRGFile(pkgPath, rgfile string) (*rgfilev1alpha1.ResourceGroup, error)

ReadRGFile reads the resourcegroup inventory in the given pkg.

func RemovePackageContent 

func RemovePackageContent(path string, removeRootKptfile bool) error

func RemovePkgPathAnnotation 

func RemovePkgPathAnnotation(rn *yaml.RNode) error

RemovePkgPathAnnotation removes the package path on a given resource.

func RemoveStaleItems 

func RemoveStaleItems(org, src, dst string, _ bool, _ SubpackageMatcher) error

RemoveStaleItems removes files and directories from the dst package that were present in the org package, but are not present in the src package. It does not remove the root Kptfile of the dst package.

func RootPkgFirstSorter 

func RootPkgFirstSorter(paths []string) func(i, j int) bool

RootPkgFirstSorter returns a "less" function that can be used with the sort.Slice function to correctly sort package paths so parent packages are always before subpackages.

func RoundTripKptfilesInPkg 

func RoundTripKptfilesInPkg(pkgPath string) error

RoundTripKptfilesInPkg reads and writes all Kptfiles in the package including subpackages. This is used to format Kptfiles in the order of go structures TODO: phanimarupaka remove this method after addressing https://github.com/kptdev/kpt/issues/2052

func SetPkgPathAnnotation 

func SetPkgPathAnnotation(rn *yaml.RNode, pkgPath types.UniquePath) error

SetPkgPathAnnotation sets package path on a given resource.

func SubPkgFirstSorter 

func SubPkgFirstSorter(paths []string) func(i, j int) bool

SubPkgFirstSorter returns a "less" function that can be used with the sort.Slice function to correctly sort package paths so subpackages are always before parent packages.

func Subpackages 

func Subpackages(fsys filesys.FileSystem, rootPath string, matcher SubpackageMatcher, recursive bool) ([]string, error)

Subpackages returns a slice of paths to any subpackages of the provided path. The matcher parameter decides the types of subpackages should be considered(ALL/LOCAL/REMOTE/NONE), and the recursive parameter determines if only direct subpackages are considered. All returned paths will be relative to the provided rootPath. The top level package is not considered a subpackage. If the provided path doesn't exist, an empty slice will be returned. Symlinks are ignored. TODO: For now this accepts the path as a string type. See if we can leverage the package type here.

func WalkPackage 

func WalkPackage(src string, c func(string, os.FileInfo, error) error) error

WalkPackage walks the package defined at src and provides a callback for every folder and file. Any subpackages and the .git folder are excluded.

Types

type InvInfoInvalid 

type InvInfoInvalid struct{}

func (*InvInfoInvalid) Error 

func (e *InvInfoInvalid) Error() string

type MultipleInventoryInfoError 

type MultipleInventoryInfoError struct{}

MultipleInventoryInfoError is the error returned if there are multiple inventories provided in a stream or package contained with both Kptfile and ResourceGroup objects.

func (*MultipleInventoryInfoError) Error 

func (e *MultipleInventoryInfoError) Error() string

type MultipleKfInv 

type MultipleKfInv struct{}

MultipleKfInv is the error returned if there are multiple inventories provided in a stream or package as ResourceGroup objects.

func (*MultipleKfInv) Error 

func (e *MultipleKfInv) Error() string

type MultipleResourceGroupsError 

type MultipleResourceGroupsError struct{}

MultipleResourceGroupsError is the error returned if there are multiple inventories provided in a stream or package as ResourceGroup objects.

func (*MultipleResourceGroupsError) Error 

func (e *MultipleResourceGroupsError) Error() string

type NoInvInfoError 

type NoInvInfoError struct{}

NoInvInfoError is the error returned if there are no inventory information provided in either a stream or locally.

func (*NoInvInfoError) Error 

func (e *NoInvInfoError) Error() string

type Pkg 

type Pkg struct {

	// UniquePath represents absolute unique OS-defined path to the package directory on the filesystem.
	UniquePath types.UniquePath

	// DisplayPath represents Slash-separated path to the package directory on the filesystem relative
	// to parent directory of root package on which the command is invoked.
	// root package is defined as the package on which the command is invoked by user
	// This is not guaranteed to be unique (e.g. in presence of symlinks) and should only
	// be used for display purposes and is subject to change.
	DisplayPath types.DisplayPath
	// contains filtered or unexported fields
}

Pkg represents a kpt package with a one-to-one mapping to a directory on the local filesystem.

func New 

func New(fs filesys.FileSystem, path string) (*Pkg, error)

New returns a pkg given an absolute OS-defined path. Use ReadKptfile or ReadPipeline on the return value to read meta resources from filesystem.

func (*Pkg) DirectSubpackages 

func (p *Pkg) DirectSubpackages() ([]*Pkg, error)

DirectSubpackages returns subpackages of a pkg. It will return all direct subpackages, i.e. subpackages that aren't nested inside other subpackages under the current package. It will return packages that are nested inside directories of the current package. TODO: This does not support symlinks, so we need to figure out how we should support that with kpt.

func (*Pkg) Kptfile 

func (p *Pkg) Kptfile() (*kptfilev1.KptFile, error)

Kptfile returns the Kptfile meta resource by lazy loading it from the filesytem. A nil value represents an implicit package.

func (*Pkg) LocalInventory 

func (p *Pkg) LocalInventory() (kptfilev1.Inventory, error)

LocalInventory returns the package inventory stored within a package. If more than one, or no inventories are found, an error is returned instead.

func (*Pkg) LocalResources 

func (p *Pkg) LocalResources() (resources []*yaml.RNode, err error)

LocalResources returns resources that belong to this package excluding the subpackage resources.

func (*Pkg) Pipeline 

func (p *Pkg) Pipeline() (*kptfilev1.Pipeline, error)

Pipeline returns the Pipeline section of the pkg's Kptfile. if pipeline is not specified in a Kptfile, it returns Zero value of the pipeline.

func (*Pkg) ReadRGFile 

func (p *Pkg) ReadRGFile(rgfile string) (*rgfilev1alpha1.ResourceGroup, error)

ReadRGFile returns the resourcegroup object by lazy loading it from the filesytem.

func (*Pkg) RelativePathTo 

func (p *Pkg) RelativePathTo(ancestorPkg *Pkg) (string, error)

RelativePathTo returns current package's path relative to a given package. It returns an error if relative path doesn't exist. In a nested package chain, one can use this method to get the relative path of a subpackage relative to an ancestor package up the chain. Example: rel, _ := subpkg.RelativePathTo(rootPkg) The returned relative path is compatible with the target operating system-defined file paths.

func (*Pkg) String 

func (p *Pkg) String() string

String returns the slash-separated relative path to the package.

func (*Pkg) ValidatePipeline 

func (p *Pkg) ValidatePipeline() error

Validates the package pipeline.

type RGError 

type RGError struct {
	Path types.UniquePath
	Err  error
}

RGError is an implementation of the error interface that is returned whenever kpt encounters errors reading a resourcegroup object file.

func (*RGError) Error 

func (rg *RGError) Error() string

func (*RGError) Unwrap 

func (rg *RGError) Unwrap() error

type RemoteKptfileError 

type RemoteKptfileError struct {
	RepoSpec *gitutil.RepoSpec
	Err      error
}

RemoteKptfileError records errors regarding reading or parsing of a Kptfile in a remote repo.

func (*RemoteKptfileError) Error 

func (e *RemoteKptfileError) Error() string

func (*RemoteKptfileError) Unwrap 

func (e *RemoteKptfileError) Unwrap() error

type SubpackageMatcher 

type SubpackageMatcher string

SubpackageMatcher is type for specifying the types of subpackages which should be included when listing them. 

const (
	// All means all types of subpackages will be returned.
	All SubpackageMatcher = "ALL"
	// Local means only local subpackages will be returned.
	Local SubpackageMatcher = "LOCAL"
	// remote means only remote subpackages will be returned.
	Remote SubpackageMatcher = "REMOTE"
	// None means that no subpackages will be returned.
	None SubpackageMatcher = "NONE"
)

Source Files

View all Source files

Directories

Path Synopsis
Package diff contains libraries for diffing packages.
 Package diff contains libraries for diffing packages.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.