Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

xpkg

package

Go to main page

Versions in this module

v2

v2.4.0-rc.0

May 14, 2026

v2.3.3

Jun 19, 2026

v2.3.2

Jun 8, 2026

v2.3.1

May 22, 2026

v2.3.0

May 14, 2026

Changes in this version

+ const AnnotationKey

+ const ExamplesAnnotation

+ const MetaFile

+ const PackageAnnotation

+ const StreamFile

+ const StreamFileMode

+ const XpkgExamplesFile

+ const XpkgExtension

+ const XpkgMatchPattern

+ func AnnotateLayers(i v1.Image) (v1.Image, error)

+ func BuildMetaScheme() (*runtime.Scheme, error)

+ func BuildObjectScheme() (*runtime.Scheme, error)

+ func BuildPackageRef(source, version string) string

+ func BuildPath(path, name, ext string) string

+ func ExtractPackageYAML(img v1.Image) (io.ReadCloser, error)

+ func FilterAndSortVersions(tags []string) []string

+ func FindXpkgInDir(fs afero.Fs, root string) (string, error)

+ func FriendlyID(name, hash string) string

+ func GzipReadCloser(rc io.ReadCloser) (io.ReadCloser, error)

+ func IsActivationPolicy(o runtime.Object) error

+ func IsCRD(o runtime.Object) error

+ func IsComposition(o runtime.Object) error

+ func IsConfiguration(o runtime.Object) error

+ func IsCronOperation(o runtime.Object) error

+ func IsFunction(o runtime.Object) error

+ func IsMRD(o runtime.Object) error

+ func IsMutatingWebhookConfiguration(o runtime.Object) error

+ func IsOperation(o runtime.Object) error

+ func IsProvider(o runtime.Object) error

+ func IsValidatingWebhookConfiguration(o runtime.Object) error

+ func IsWatchOperation(o runtime.Object) error

+ func IsXRD(o runtime.Object) error

+ func JoinedReadCloser(r io.Reader, c io.Closer) io.ReadCloser

+ func Label(annotation string) string

+ func Layer(r io.Reader, fileName, annotation string, fileSize int64, mode os.FileMode, ...) (v1.Layer, error)

+ func NewConfigurationLinter() parser.Linter

+ func NewFunctionLinter() parser.Linter

+ func NewProviderLinter() parser.Linter

+ func OneMeta(pkg parser.Lintable) error

+ func PackageCrossplaneCompatible(v version.Operations) parser.ObjectLinterFn

+ func PackageValidSemver(o runtime.Object) error

+ func ParseNameFromMeta(fs afero.Fs, path string) (string, error)

+ func ParsePackageSourceFromReference(ref name.Reference) string

+ func ReplaceExt(path, ext string) string

+ func SkipContains(pattern string) parser.FilterFn

+ func TeeReadCloser(r io.ReadCloser, w io.WriteCloser) io.ReadCloser

+ func ToDNSLabel(s string) string

+ func TryConvert(obj runtime.Object, candidates ...conversion.Hub) (runtime.Object, bool)

+ func TryConvertToPkg(obj runtime.Object, candidates ...conversion.Hub) (pkgmetav1.Pkg, bool)

+ type BuildOpt func(*buildOpts)

+ func WithBase(img v1.Image) BuildOpt

+ type Builder struct

+ func New(packageSource, exampleSource parser.Backend, packageParser parser.Parser, ...) *Builder

+ func (b *Builder) Build(ctx context.Context, opts ...BuildOpt) (v1.Image, runtime.Object, error)

+ type CachedClient struct

+ func NewCachedClient(f Fetcher, p parser.Parser, c PackageCache, s ConfigStore, ...) *CachedClient

+ func (c *CachedClient) Get(ctx context.Context, ref string, opts ...GetOption) (*Package, error)

+ func (c *CachedClient) ListVersions(ctx context.Context, source string, opts ...GetOption) ([]string, error)

+ type Client interface

+ Get func(ctx context.Context, ref string, opts ...GetOption) (*Package, error)

+ ListVersions func(ctx context.Context, source string, opts ...GetOption) ([]string, error)

+ type ConfigStore interface

+ ImageVerificationConfigFor func(ctx context.Context, image string) (imageConfig string, iv *v1beta1.ImageVerification, err error)

+ PullSecretFor func(ctx context.Context, image string) (imageConfig, pullSecret string, err error)

+ RewritePath func(ctx context.Context, image string) (imageConfig, newPath string, err error)

+ RuntimeConfigFor func(ctx context.Context, image string) (imageConfig string, runtimeConfig *v1beta1.ImageRuntime, err error)

+ func NewImageConfigStore(client client.Client, namespace string, opts ...ImageConfigStoreOption) ConfigStore

+ type Fetcher interface

+ Fetch func(ctx context.Context, ref name.Reference, secrets ...string) (v1.Image, error)

+ Head func(ctx context.Context, ref name.Reference, secrets ...string) (*v1.Descriptor, error)

+ Tags func(ctx context.Context, ref name.Reference, secrets ...string) ([]string, error)

+ type FetcherOpt func(k *K8sFetcher) error

+ func WithCustomCA(rootCAs *x509.CertPool) FetcherOpt

+ func WithNamespace(ns string) FetcherOpt

+ func WithServiceAccount(sa string) FetcherOpt

+ func WithUserAgent(userAgent string) FetcherOpt

+ type FsPackageCache struct

+ func NewFsPackageCache(dir string, fs afero.Fs) *FsPackageCache

+ func (c *FsPackageCache) Delete(id string) error

+ func (c *FsPackageCache) Get(id string) (io.ReadCloser, error)

+ func (c *FsPackageCache) Has(id string) bool

+ func (c *FsPackageCache) Store(id string, content io.ReadCloser) error

+ type GetConfig struct

+ type GetOption func(*GetConfig)

+ func WithPullPolicy(policy corev1.PullPolicy) GetOption

+ func WithPullSecrets(secrets ...string) GetOption

+ type ImageConfig struct

+ Name string

+ Reason ImageConfigReason

+ type ImageConfigReason string

+ const ImageConfigReasonRewrite

+ const ImageConfigReasonSetPullSecret

+ const ImageConfigReasonVerify

+ func SupportedImageConfigs() []ImageConfigReason

+ type ImageConfigStore struct

+ func (s *ImageConfigStore) ImageVerificationConfigFor(ctx context.Context, image string) (imageConfig string, iv *v1beta1.ImageVerification, err error)

+ func (s *ImageConfigStore) PullSecretFor(ctx context.Context, image string) (imageConfig, pullSecret string, err error)

+ func (s *ImageConfigStore) RewritePath(ctx context.Context, image string) (imageConfig, newPath string, err error)

+ func (s *ImageConfigStore) RuntimeConfigFor(ctx context.Context, image string) (imageConfig string, runtimeConfig *v1beta1.ImageRuntime, err error)

+ type ImageConfigStoreOption func(*ImageConfigStore)

+ type K8sFetcher struct

+ func NewK8sFetcher(client kubernetes.Interface, opts ...FetcherOpt) (*K8sFetcher, error)

+ func (i *K8sFetcher) Fetch(ctx context.Context, ref name.Reference, secrets ...string) (v1.Image, error)

+ func (i *K8sFetcher) Head(ctx context.Context, ref name.Reference, secrets ...string) (*v1.Descriptor, error)

+ func (i *K8sFetcher) Tags(ctx context.Context, ref name.Reference, secrets ...string) ([]string, error)

+ type NopCache struct

+ func NewNopCache() *NopCache

+ func (c *NopCache) Delete(string) error

+ func (c *NopCache) Get(string) (io.ReadCloser, error)

+ func (c *NopCache) Has(string) bool

+ func (c *NopCache) Store(string, io.ReadCloser) error

+ type NopFetcher struct

+ func NewNopFetcher() *NopFetcher

+ func (n *NopFetcher) Fetch(_ context.Context, _ name.Reference, _ ...string) (v1.Image, error)

+ func (n *NopFetcher) Head(_ context.Context, _ name.Reference, _ ...string) (*v1.Descriptor, error)

+ func (n *NopFetcher) Tags(_ context.Context, _ name.Reference, _ ...string) ([]string, error)

+ type Package struct

+ AppliedImageConfigs []ImageConfig

+ Digest string

+ ResolvedSource string

+ ResolvedVersion string

+ Source string

+ Version string

+ func (p *Package) DigestHex() string

+ func (p *Package) GetDependencies() []pkgmetav1.Dependency

+ func (p *Package) GetMeta() pkgmetav1.Pkg

+ func (p *Package) Ref() string

+ func (p *Package) ResolvedRef() string

+ type PackageCache interface

+ Delete func(id string) error

+ Get func(id string) (io.ReadCloser, error)

+ Has func(id string) bool

+ Store func(id string, content io.ReadCloser) error

+ type Validator parser.Linter

+ func NewConfigurationValidator() Validator

+ func NewFunctionValidator() Validator

+ func NewProviderValidator() Validator

v2.3.0-rc.1

May 14, 2026