images

package

v0.53.0 Latest Latest Go to latest Published: Apr 23, 2025 License: Apache-2.0 Imports: 41 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/zarf-dev/zarf

Links

Open Source Insights

Documentation ¶

Overview ¶

Package images provides functions for building and pushing images.

Index ¶

Constants
func CommonOpts(arch string) []crane.Option
func NoopOpt(*crane.Options)
func OnlyHasImageLayers(manifest ocispec.Manifest) bool
func Ping(ctx context.Context, plainHTTP bool, registryURL string, client *auth.Client) error
func Pull(ctx context.Context, cfg PullConfig) (map[transform.Image]ocispec.Manifest, error)
func Push(ctx context.Context, cfg PushConfig) error
func WithArchitecture(arch string) crane.Option
func WithBasicAuth(username, password string) crane.Option
func WithGlobalInsecureFlag() []crane.Option
func WithPullAuth(ri types.RegistryInfo) crane.Option
func WithPushAuth(ri types.RegistryInfo) crane.Option
type PullConfig
type PushConfig

Constants ¶

View Source

const (
	DockerMediaTypeManifest     = "application/vnd.docker.distribution.manifest.v2+json"
	DockerMediaTypeManifestList = "application/vnd.docker.distribution.manifest.list.v2+json"
)

View Source

const (
	DockerLayer             = "application/vnd.docker.image.rootfs.diff.tar.gzip"
	DockerUncompressedLayer = "application/vnd.docker.image.rootfs.diff.tar"
	DockerForeignLayer      = "application/vnd.docker.image.rootfs.foreign.diff.tar.gzip"
)

Variables ¶

This section is empty.

Functions ¶

func CommonOpts ¶

func CommonOpts(arch string) []crane.Option

CommonOpts returns a set of common options for crane under Zarf.

func NoopOpt ¶

func NoopOpt(*crane.Options)

NoopOpt is a no-op option for crane.

func OnlyHasImageLayers ¶ added in v0.51.0

func OnlyHasImageLayers(manifest ocispec.Manifest) bool

func Ping ¶ added in v0.51.0

func Ping(ctx context.Context, plainHTTP bool, registryURL string, client *auth.Client) error

func Pull ¶

func Pull(ctx context.Context, cfg PullConfig) (map[transform.Image]ocispec.Manifest, error)

Pull pulls all images from the given config.

func Push ¶

func Push(ctx context.Context, cfg PushConfig) error

Push pushes images to a registry.

func WithArchitecture ¶

func WithArchitecture(arch string) crane.Option

WithArchitecture sets the platform option for crane.

This option is actually a slight mis-use of the platform option, as it is setting the architecture only and hard coding the OS to linux.

func WithBasicAuth ¶

func WithBasicAuth(username, password string) crane.Option

WithBasicAuth returns an option for crane that sets basic auth.

func WithGlobalInsecureFlag ¶

func WithGlobalInsecureFlag() []crane.Option

WithGlobalInsecureFlag returns an option for crane that configures insecure based upon Zarf's global --insecure-skip-tls-verify (and --insecure) flags.

func WithPullAuth ¶

func WithPullAuth(ri types.RegistryInfo) crane.Option

WithPullAuth returns an option for crane that sets pull auth from a given registry info.

func WithPushAuth ¶

func WithPushAuth(ri types.RegistryInfo) crane.Option

WithPushAuth returns an option for crane that sets push auth from a given registry info.

Types ¶

type PullConfig ¶

type PullConfig struct {
	OCIConcurrency       int
	DestinationDirectory string
	ImageList            []transform.Image
	Arch                 string
	RegistryOverrides    map[string]string
	CacheDirectory       string
	PlainHTTP            bool
}

PullConfig is the configuration for pulling images.

type PushConfig ¶

type PushConfig struct {
	OCIConcurrency  int
	SourceDirectory string
	ImageList       []transform.Image
	RegistryInfo    types.RegistryInfo
	NoChecksum      bool
	Arch            string
	Retries         int
	PlainHTTP       bool
}

PushConfig is the configuration for pushing images.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cache

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL