package
0.35.0-0.rc.0
Repository: https://github.com/upbound/up.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

BuildPath builds a path for a compiled Crossplane package.
FindXpkgInDir finds compiled Crossplane packages in a directory.
FriendlyID builds a valid DNS label string made up of the name of a package and its image digest.
IsComposition checks that an object is a Composition.
IsConfiguration checks that an object is a Configuration meta type.
IsCRD checks that an object is a CustomResourceDefinition.
IsFunction checks that an object is a Function meta type.
IsMutatingWebhookConfiguration checks that an object is a MutatingWebhookConfiguration.
IsProvider checks that an object is a Provider meta type.
IsValidatingWebhookConfiguration checks that an object is a MutatingWebhookConfiguration.
IsXRD checks that an object is a CompositeResourceDefinition.
Label constructs a specially formated label using the annotationKey.
Layer creates a v1.Layer that represetns the layer contents for the xpkg and adds a corresponding label to the image Config for the layer.
New returns a new Builder.
NewConfigurationLinter is a convenience function for creating a package linter for configurations.
NewFileWriter returns a new Writer.
NewFunctionLinter is a convenience function for creating a package linter for functions.
NewProviderLinter is a convenience function for creating a package linter for providers.
OneMeta checks that there is only one meta object in the package.
PackageValidSemver checks that the package uses valid semver ranges.
ReplaceExt replaces the file extension of the given path.
SkipContains supplies a FilterFn that skips paths that contain the give pattern.
ToDNSLabel converts the string to a valid DNS label.
ValidDep --.
WithController sets the controller image that should serve as the base for the package.
WithFileBody specifies the file body that is used to populate the new meta file.
WithFs specifies the afero.Fs that is being used.
WithRoot specifies the root for the new package.

# Constants

AnnotationKey is the key value for xpkg annotations.
Configuration represents a configuration package.
ExamplesAnnotation is the annotation value used for the examples.yaml layer.
JSONStreamFile is the name of the file in local Crossplane package that contains the JSON stream representation of the Crossplane package.
MetaFile is the name of a Crossplane package metadata file.
PackageAnnotation is the annotation value used for the package.yaml layer.
Provider represents a provider package.
No description provided by the author
StreamFile is the name of the file in a Crossplane package image that contains its YAML stream.
StreamFileMode determines the permissions on the stream file.
XpkgExamplesFile is the name of the file in a Crossplane package image that contains the examples YAML stream.
XpkgExtension is the extension for compiled Crossplane packages.
XpkgMatchPattern is the match pattern for identifying compiled Crossplane packages.

# Structs

No description provided by the author
Builder defines an xpkg Builder.
Image wraps a v1.Image and extends it with ImageMeta.
ImageMeta contains metadata information about the Package Image.
InitContext defines the details we're interested in for populating a meta file.
Writer defines a writer that is used for creating package meta files.

# Type aliases

A BuildOpt modifies how a package is built.
Option modifies the Writer.
Package represents the types of packages we support.