repository

Documentation

Index

• Variables
• type ContainerConfig
• type Image
• type Session
  • func NewSession(containerdSocket string) (*Session, error)
  • func (session *Session) BuildRecipe(ctx context.Context, recipe recipes.Recipe, tag string, imagePrefix string, ...) (reference.ImageRef, error)
  • func (session *Session) Close() error
  • func (session *Session) ExtractImage(ctx context.Context, imageRef reference.ImageRef, destination string) error
  • func (session *Session) GetImageSize(ctx context.Context, name string) (int64, error)
  • func (session *Session) GetImages(ctx context.Context) ([]Image, error)
  • func (session *Session) Pull(ctx context.Context, imageRef reference.ImageRef, resolver remotes.Resolver) (containerd.Image, error)
  • func (session *Session) Push(ctx context.Context, imageRef reference.ImageRef, resolver remotes.Resolver) error
  • func (session *Session) RemoveImage(ctx context.Context, image string) error
  • func (session *Session) RunContainer(ctx context.Context, config ContainerConfig) error
  • func (session *Session) TagImage(ctx context.Context, source, destination reference.ImageRef) error

Variables

var (
	// DefaultContainerdSocketLocation The location to the containerd socket.
	DefaultContainerdSocketLocation = "/var/run/containerd/containerd.sock"
)

Types

type ContainerConfig

type ContainerConfig struct {
	// contains filtered or unexported fields
}

ContainerConfig configuration about how to run the container

type Image

type Image struct {
	Name      string
	Tag       string
	CreatedAt time.Time
}

Image An image fetched from the repository.

type Session

type Session struct {
	// contains filtered or unexported fields
}

Session An object that represent a session to a containerd runtime.

func NewSession

func NewSession(containerdSocket string) (*Session, error)

NewSession creates a new session

func (*Session) BuildRecipe

func (session *Session) BuildRecipe(ctx context.Context, recipe recipes.Recipe, tag string, imagePrefix string, env []string, resolver remotes.Resolver) (reference.ImageRef, error)

BuildRecipe Builds a recipe.

func (*Session) Close

func (session *Session) Close() error

Close Closes the session.

func (*Session) ExtractImage

func (session *Session) ExtractImage(ctx context.Context, imageRef reference.ImageRef, destination string) error

ExtractImage Extracts an image (with tag) to a specified directory

func (*Session) GetImageSize

func (session *Session) GetImageSize(ctx context.Context, name string) (int64, error)

GetImageSize Returns the size of an image.

func (*Session) GetImages

func (session *Session) GetImages(ctx context.Context) ([]Image, error)

GetImages Get all the built images.

func (*Session) Pull

func (session *Session) Pull(ctx context.Context, imageRef reference.ImageRef, resolver remotes.Resolver) (containerd.Image, error)

Pull Pulls an image locally.

func (*Session) Push

func (session *Session) Push(ctx context.Context, imageRef reference.ImageRef, resolver remotes.Resolver) error

Push Push an image remotely.

func (*Session) RemoveImage

func (session *Session) RemoveImage(ctx context.Context, image string) error

RemoveImage Removes an image locally.

func (*Session) RunContainer

func (session *Session) RunContainer(ctx context.Context, config ContainerConfig) error

RunContainer Runs a container

func (*Session) TagImage

func (session *Session) TagImage(ctx context.Context, source, destination reference.ImageRef) error

TagImage Tag an image.