Documentation
¶
Overview ¶
Package mod changes an image according to the requested modifications.
Index ¶
- func Apply(ctx context.Context, rc *regclient.RegClient, r ref.Ref, opts ...Opts) (ref.Ref, error)
- type Opts
- func WithAnnotation(name, value string) Opts
- func WithAnnotationOCIBase(rBase ref.Ref, dBase digest.Digest) Opts
- func WithBuildArgRm(arg string, value *regexp.Regexp) Opts
- func WithConfigTimestampFromLabel(label string) Opts
- func WithConfigTimestampMax(t time.Time) Opts
- func WithData(maxDataSize int64) Opts
- func WithExposeAdd(port string) Opts
- func WithExposeRm(port string) Opts
- func WithExternalURLsRm() Opts
- func WithFileTarTimeMax(name string, t time.Time) Opts
- func WithLabel(name, value string) Opts
- func WithLabelToAnnotation() Opts
- func WithLayerRmCreatedBy(re regexp.Regexp) Opts
- func WithLayerRmIndex(index int) Opts
- func WithLayerStripFile(file string) Opts
- func WithLayerTimestampFromLabel(label string) Opts
- func WithLayerTimestampMax(t time.Time) Opts
- func WithManifestToDocker() Opts
- func WithManifestToOCI() Opts
- func WithManifestToOCIReferrers() Opts
- func WithRebase() Opts
- func WithRebaseRefs(rOld, rNew ref.Ref) Opts
- func WithVolumeAdd(volume string) Opts
- func WithVolumeRm(volume string) Opts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Opts ¶
type Opts func(*dagConfig, *dagManifest) error
Opts defines options for Apply
func WithAnnotation ¶
WithAnnotation adds an annotation, or deletes it if the value is set to an empty string
func WithAnnotationOCIBase ¶
WithAnnotationOCIBase adds annotations for the base image
func WithBuildArgRm ¶ added in v0.4.2
WithBuildArgRm removes a build arg from the config history
func WithConfigTimestampFromLabel ¶
WithConfigTimestampFromLabel sets the max timestamp in the config to match a label value
func WithConfigTimestampMax ¶
WithConfigTimestampMax sets the max timestamp on any config objects
func WithData ¶
WithData sets the descriptor data field max size. This also strips the data field off descriptors above the max size.
func WithExposeAdd ¶
WithExposeAdd defines an exposed port in the image config
func WithExposeRm ¶
WithExposeRm deletes an exposed from the image config
func WithExternalURLsRm ¶ added in v0.4.3
func WithExternalURLsRm() Opts
WithExternalURLsRm strips external URLs from descriptors and adjusts media type to match
func WithFileTarTimeMax ¶ added in v0.4.4
WithFileTarTimeMax processes a tar file within a layer and rewrites the contents with a max timestamp
func WithLabelToAnnotation ¶
func WithLabelToAnnotation() Opts
WithLabelToAnnotation copies image config labels to manifest annotations
func WithLayerRmCreatedBy ¶
WithLayerRmCreatedBy deletes a layer based on a regex of the created by field in the config history for that layer
func WithLayerRmIndex ¶
WithLayerRmIndex deletes a layer by index. The index starts at 0.
func WithLayerStripFile ¶
WithLayerStripFile removes a file from within the layer tar
func WithLayerTimestampFromLabel ¶
WithLayerTimestampFromLabel sets the max layer timestamp based on a label in the image
func WithLayerTimestampMax ¶
WithLayerTimestampMax ensures no file timestamps are after specified time
func WithManifestToDocker ¶ added in v0.4.8
func WithManifestToDocker() Opts
WithManifestToDocker converts the manifest to Docker schema2 media types
func WithManifestToOCI ¶
func WithManifestToOCI() Opts
WithManifestToOCI converts the manifest to OCI media types
func WithManifestToOCIReferrers ¶ added in v0.4.6
func WithManifestToOCIReferrers() Opts
WithManifestToOCIReferrers converts other referrer types to OCI subject/referrers
func WithRebase ¶ added in v0.4.5
func WithRebase() Opts
func WithRebaseRefs ¶ added in v0.4.5
WithRebaseRefs swaps the base image layers from the old to the new reference
func WithVolumeAdd ¶
WithVolumeAdd defines a volume in the image config
func WithVolumeRm ¶
WithVolumeRm deletes a volume from the image config