imageutil

Documentation

Index

• func BuildImageAltNames(rewrittenImage kustomizetypes.Image) ([]kustomizetypes.Image, error)
• func ChangeImageTag(image string, newTag string) (string, error)
• func DestECImage(destRegistry registrytypes.RegistryOptions, srcImage string) (string, error)
• func DestImage(destRegistry registrytypes.RegistryOptions, srcImage string) (string, error)
• func DestImageFromKustomizeImage(image kustomizetypes.Image) string
• func GetImageName(image string) string
• func GetTag(imageRef string) (string, error)
• func KustomizeImage(destRegistry registrytypes.RegistryOptions, image string) ([]kustomizetypes.Image, error)
• func RewriteDockerArchiveImage(registry registrytypes.RegistryOptions, nameParts []string) (kustomizetypes.Image, error)
• func RewriteDockerRegistryImage(destRegistry registrytypes.RegistryOptions, srcImage string) (*kustomizetypes.Image, error)
• func SanitizeRepo(repo string) string
• func SanitizeTag(tag string) string
• func StripImageTagAndDigest(image string) string
• type EmbeddedClusterArtifactOCIPathOptions
• type OCIArtifactPath
  • func NewEmbeddedClusterOCIArtifactPath(filename string, opts EmbeddedClusterArtifactOCIPathOptions) *OCIArtifactPath
  • func (p *OCIArtifactPath) String() string

Functions

func BuildImageAltNames

func BuildImageAltNames(rewrittenImage kustomizetypes.Image) ([]kustomizetypes.Image, error)

func ChangeImageTag

func ChangeImageTag(image string, newTag string) (string, error)

ChangeImageTag changes the tag of an image to the provided new tag

func DestECImage

func DestECImage(destRegistry registrytypes.RegistryOptions, srcImage string) (string, error)

DestECImage returns the location to push an embedded cluster image to on the dest registry

func DestImage

func DestImage(destRegistry registrytypes.RegistryOptions, srcImage string) (string, error)

DestImage returns the location to push the image to on the dest registry

func DestImageFromKustomizeImage

func DestImageFromKustomizeImage(image kustomizetypes.Image) string

DestImageFromKustomizeImage returns the location to push the image to from a kustomize image type

func GetImageName

func GetImageName(image string) string

GetImageName returns the name of the image without the tag, digest, or registry

func GetTag

func GetTag(imageRef string) (string, error)

GetTag extracts the image tag from an image reference

func KustomizeImage

func KustomizeImage(destRegistry registrytypes.RegistryOptions, image string) ([]kustomizetypes.Image, error)

func RewriteDockerArchiveImage

func RewriteDockerArchiveImage(registry registrytypes.RegistryOptions, nameParts []string) (kustomizetypes.Image, error)

func RewriteDockerRegistryImage

func RewriteDockerRegistryImage(destRegistry registrytypes.RegistryOptions, srcImage string) (*kustomizetypes.Image, error)

func SanitizeRepo

func SanitizeRepo(repo string) string

A valid repo may contain lowercase letters, digits and separators. A separator is defined as a period, one or two underscores, or one or more hyphens. A component may not start or end with a separator. ref: https://docs.docker.com/reference/cli/docker/image/tag/#description

func SanitizeTag

func SanitizeTag(tag string) string

A valid tag must be valid ASCII and can contain lowercase and uppercase letters, digits, underscores, periods, and hyphens. It can't start with a period or hyphen and must be no longer than 128 characters. ref: https://docs.docker.com/reference/cli/docker/image/tag/#description

func StripImageTagAndDigest

func StripImageTagAndDigest(image string) string

StripImageTagAndDigest removes the tag and digest from an image while preserving the original name. This can be helpful because parsing the image as a docker reference can modify the hostname (e.g. adds docker.io/library)

Types

type EmbeddedClusterArtifactOCIPathOptions

type EmbeddedClusterArtifactOCIPathOptions struct {
	RegistryHost      string
	RegistryNamespace string
	ChannelID         string
	UpdateCursor      string
	VersionLabel      string
}

type OCIArtifactPath

type OCIArtifactPath struct {
	Name              string
	RegistryHost      string
	RegistryNamespace string
	Repository        string
	Tag               string
}

func NewEmbeddedClusterOCIArtifactPath

func NewEmbeddedClusterOCIArtifactPath(filename string, opts EmbeddedClusterArtifactOCIPathOptions) *OCIArtifactPath

NewEmbeddedClusterOCIArtifactPath returns the OCI path for an embedded cluster artifact given the artifact filename and details about the configured registry and channel release.

func (*OCIArtifactPath) String

func (p *OCIArtifactPath) String() string