Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Applier ¶ added in v1.1.0
type Applier interface {
// Apply applies the content referred to by the given descriptor to
// the provided mount. The method of applying is based on the
// implementation and content descriptor. For example, in the common
// case the descriptor is a file system difference in tar format,
// that tar would be applied on top of the mounts.
Apply(ctx context.Context, desc ocispec.Descriptor, mount []mount.Mount, opts ...ApplyOpt) (ocispec.Descriptor, error)
}
Applier allows applying diffs between mounts
type ApplyConfig ¶ added in v1.3.0
type ApplyConfig struct {
}
ApplyConfig is used to hold parameters needed for a apply operation
type ApplyOpt ¶ added in v1.3.0
type ApplyOpt func(*ApplyConfig) error
ApplyOpt is used to configure an Apply operation
type Comparer ¶ added in v1.1.0
type Comparer interface {
// Compare computes the difference between two mounts and returns a
// descriptor for the computed diff. The options can provide
// a ref which can be used to track the content creation of the diff.
// The media type which is used to determine the format of the created
// content can also be provided as an option.
Compare(ctx context.Context, lower, upper []mount.Mount, opts ...Opt) (ocispec.Descriptor, error)
}
Comparer allows creation of filesystem diffs between mounts
type Config ¶
type Config struct {
// MediaType is the type of diff to generate
// Default depends on the differ,
// i.e. application/vnd.oci.image.layer.v1.tar+gzip
MediaType string
// Reference is the content upload reference
// Default will use a random reference string
Reference string
// Labels are the labels to apply to the generated content
Labels map[string]string
}
Config is used to hold parameters needed for a diff operation
type Opt ¶
Opt is used to configure a diff operation
func WithLabels ¶
WithLabels is used to set content labels on the created diff content.
func WithMediaType ¶
WithMediaType sets the media type to use for creating the diff, without specifying the differ will choose a default.
func WithReference ¶
WithReference is used to set the content upload reference used by the diff operation. This allows the caller to track the upload through the content store.