client

Documentation

Overview

Copyright © 2022 Johnson Shi <Johnson.Shi@microsoft.com>

Index

• type ImageClient
  • func NewImageClient(username, password, imageRefStr string) (ImageClient, error)
  • func (imageClient *ImageClient) EnsureImageIsPulled(ctx context.Context) error
  • func (imageClient *ImageClient) GetImageLayerHistory(ctx context.Context) ([]image.HistoryResponseItem, error)
  • func (imageClient *ImageClient) GetImageManifest(ctx context.Context) (ocispec.Manifest, error)

Types

type ImageClient

type ImageClient struct {
	Username           string
	Password           string
	DockerEngineClient *client.Client
	ImageRef           registry.Reference
	OrasRepoClient     *remote.Repository
}

func NewImageClient

func NewImageClient(username, password, imageRefStr string) (ImageClient, error)

NewImageClient returns a new ImageClient.

func (*ImageClient) EnsureImageIsPulled

func (imageClient *ImageClient) EnsureImageIsPulled(ctx context.Context) error

EnsureImageIsPulled ensures that the image is pulled and present in the Docker Engine (Docker daemon).

func (*ImageClient) GetImageLayerHistory

func (imageClient *ImageClient) GetImageLayerHistory(ctx context.Context) ([]image.HistoryResponseItem, error)

GetImageHistory returns the image layer history. The image layer history is sorted from top layers (most recent layers) to bottom layers (base image layers). See https://docs.docker.com/engine/reference/commandline/image_history/.

func (*ImageClient) GetImageManifest

func (imageClient *ImageClient) GetImageManifest(ctx context.Context) (ocispec.Manifest, error)

GetImageManifest returns the OCI image manifest. See https://github.com/opencontainers/image-spec/blob/main/manifest.md.