windows

Documentation

Index

• func Remove(ref Ref) error
• func RemoveAll(dir string) error
• type Image
  • func Pull(ref Ref) (*Image, error)
• type Paths
  • func ResolvePaths(ref Ref) (Paths, error)
• type Ref

Functions

func Remove

func Remove(ref Ref) error

Remove destroys the HCS layers for ref and deletes the image directory.

func RemoveAll

func RemoveAll(dir string) error

RemoveAll releases HCS layer locks and strips restrictive file attributes across dir, then calls os.RemoveAll. Use instead of os.RemoveAll for any directory that may contain HCS layer data.

Types

type Image

type Image struct {
	Image     string
	Paths     Paths
	BaseLayer string // topmost read-only HCS layer; pass to compute_container.ImageMount
	Scratch   string // writable scratch layer; pass to compute_container.ImageMount
}

Image is returned by Pull.

func Pull

func Pull(ref Ref) (*Image, error)

Pull downloads and imports a Windows container image described by ref.

type Paths

type Paths struct {
	Dir     string // e.g. C:\carbon\mcr.microsoft.com\windows\nanoserver\ltsc2022
	Base    string // root dir for numbered read-only HCS layer subdirectories
	Scratch string // writable scratch layer
	Cache   string // raw downloaded layer tarballs
}

Paths holds all resolved on-disk locations for a Windows container image.

func ResolvePaths

func ResolvePaths(ref Ref) (Paths, error)

ResolvePaths returns the fully resolved paths for ref without pulling anything.

type Ref

type Ref struct {
	Image string // e.g. "mcr.microsoft.com/windows/nanoserver:ltsc2022"
	Dir   string // optional; root dir for all image data — defaults to %LOCALAPPDATA%\carbon
}

Ref describes a Windows container image to pull.