image

Documentation

Index

• Constants
• func CopyAirgapImages(opts imagetypes.ProcessImageOptions, log *logger.CLILogger) error
• func CopyImage(opts types.CopyImageOptions) error
• func CopyImageWithGC(ctx context.Context, destRef, srcRef containerstypes.ImageReference, ...) ([]byte, error)
• func CopyOnlineImages(opts imagetypes.ProcessImageOptions, images []string, ...) error
• func ExtractAppAirgapArchive(archive string, destDir string, excludeImages bool, progressWriter io.Writer) error
• func FindImagesInDir(dir string) ([]string, error)
• func GetMinioImage(clientset kubernetes.Interface, kotsadmNamespace string) (string, error)
• func IsPrivateImage(image string, dockerHubRegistry dockerregistrytypes.RegistryOptions) (bool, error)
• func PushECImagesFromTempRegistry(airgapRootDir string, airgap *kotsv1beta1.Airgap, ...) error
• func PushEmbeddedClusterArtifacts(airgapBundle string, artifactsToPush *kotsv1beta1.EmbeddedClusterArtifacts, ...) error
• func PushImagesFromDockerArchiveBundle(airgapBundle string, options imagetypes.PushImagesOptions) error
• func PushImagesFromDockerArchivePath(airgapRootDir string, options imagetypes.PushImagesOptions) error
• func PushImagesFromTempRegistry(airgapRootDir string, imageList []string, options imagetypes.PushImagesOptions) error
• func RewritePrivateImage(srcRegistry dockerregistrytypes.RegistryOptions, image string, appSlug string) (string, error)
• func TagAndPushImagesFromBundle(airgapBundle string, options imagetypes.PushImagesOptions) error
• func UpdateInstallationImages(opts UpdateInstallationImagesOptions) error
• func WriteProgressLine(progressWriter io.Writer, line string)
• type ProgressImage
• type ProgressReport
• type UpdateInstallationEmbeddedClusterArtifactsOptions
• type UpdateInstallationImagesOptions

Constants

const (
	EmbeddedClusterArtifactType = "application/vnd.embeddedcluster.artifact"
	EmbeddedClusterMediaType    = "application/vnd.embeddedcluster.file"
)

const (
	Minio      = "kotsadm/minio:0.20241107.005220-r0"
	Rqlite     = "kotsadm/rqlite:8.34.0-r0"
	Dex        = "kotsadm/dex:2.41.1-r1"
	Schemahero = "schemahero/schemahero:0.17.12"
	Lvp        = "replicated/local-volume-provider:v0.6.7"
)

Functions

func CopyAirgapImages

func CopyAirgapImages(opts imagetypes.ProcessImageOptions, log *logger.CLILogger) error

CopyAirgapImages pushes images found in the airgap bundle/airgap root to the configured registry.

func CopyImage

func CopyImage(opts types.CopyImageOptions) error

func CopyImageWithGC

func CopyImageWithGC(ctx context.Context, destRef, srcRef containerstypes.ImageReference, options *copy.Options) ([]byte, error)

func CopyOnlineImages

func CopyOnlineImages(opts imagetypes.ProcessImageOptions, images []string, kotsKinds *kotsutil.KotsKinds, license *kotsv1beta1.License, dockerHubRegistryCreds registry.Credentials, log *logger.CLILogger) error

func ExtractAppAirgapArchive

func ExtractAppAirgapArchive(archive string, destDir string, excludeImages bool, progressWriter io.Writer) error

func FindImagesInDir

func FindImagesInDir(dir string) ([]string, error)

func GetMinioImage

func GetMinioImage(clientset kubernetes.Interface, kotsadmNamespace string) (string, error)

MinioImage looks through the nodes in the cluster and finds nodes that have already pulled Minio, and then finds the latest image tag listed

func IsPrivateImage

func IsPrivateImage(image string, dockerHubRegistry dockerregistrytypes.RegistryOptions) (bool, error)

if dockerHubRegistry is provided, its credentials will be used for DockerHub images to increase the rate limit.

func PushECImagesFromTempRegistry

func PushECImagesFromTempRegistry(airgapRootDir string, airgap *kotsv1beta1.Airgap, options imagetypes.PushImagesOptions) error

func PushEmbeddedClusterArtifacts

func PushEmbeddedClusterArtifacts(airgapBundle string, artifactsToPush *kotsv1beta1.EmbeddedClusterArtifacts, opts imagetypes.PushEmbeddedClusterArtifactsOptions) error

func PushImagesFromDockerArchiveBundle

func PushImagesFromDockerArchiveBundle(airgapBundle string, options imagetypes.PushImagesOptions) error

func PushImagesFromDockerArchivePath

func PushImagesFromDockerArchivePath(airgapRootDir string, options imagetypes.PushImagesOptions) error

func PushImagesFromTempRegistry

func PushImagesFromTempRegistry(airgapRootDir string, imageList []string, options imagetypes.PushImagesOptions) error

func RewritePrivateImage

func RewritePrivateImage(srcRegistry dockerregistrytypes.RegistryOptions, image string, appSlug string) (string, error)

func TagAndPushImagesFromBundle

func TagAndPushImagesFromBundle(airgapBundle string, options imagetypes.PushImagesOptions) error

func UpdateInstallationImages

func UpdateInstallationImages(opts UpdateInstallationImagesOptions) error

func WriteProgressLine

func WriteProgressLine(progressWriter io.Writer, line string)

Types

type ProgressImage

type ProgressImage struct {
	// image name and tag, "nginx:latest"
	DisplayName string `json:"displayName"`
	// image upload status: queued, uploading, uploaded, failed
	Status string `json:"status"`
	// error string set when status is failed
	Error string `json:"error"`
	// amount currently uploaded (currently number of layers)
	Current int64 `json:"current"`
	// total amount that needs to be uploaded (currently number of layers)
	Total int64 `json:"total"`
	// time when image started uploading
	StartTime time.Time `json:"startTime"`
	// time when image finished uploading
	EndTime time.Time `json:"endTime"`
}

type ProgressReport

type ProgressReport struct {
	// set to "progressReport"
	Type string `json:"type"`
	// the same progress text that used to be sent in unstructured message
	CompatibilityMessage string `json:"compatibilityMessage"`
	// all images found in archive
	Images []ProgressImage `json:"images"`
}

type UpdateInstallationEmbeddedClusterArtifactsOptions

type UpdateInstallationEmbeddedClusterArtifactsOptions struct {
	Artifacts   []string
	KotsKinds   *kotsutil.KotsKinds
	UpstreamDir string
}

type UpdateInstallationImagesOptions

type UpdateInstallationImagesOptions struct {
	Images                 []string
	KotsKinds              *kotsutil.KotsKinds
	IsAirgap               bool
	UpstreamDir            string
	DockerHubRegistryCreds registry.Credentials
}