container

Documentation

Index

• Variables
• type Binary
• type Blob
• type Container
  • func New() (*Container, error)
  • func (c *Container) AddBinary(fnames []string) error
  • func (c *Container) Copy(names ...string) error
  • func (c *Container) Save(dirname string) error
  • func (c *Container) SetHealthcheck(cmd []string, interval, timeout, start *time.Duration, retries int) error
  • func (c *Container) SetHealthcheckFromArg(arg string) error
  • func (c *Container) SetLabels(labels ...string) error
  • func (c *Container) WriteBlobs(dirname string) error
  • func (c *Container) WriteIndex(dirname string) error
  • func (c *Container) WriteLayout(dirname string) error
• type HealthcheckConfig
• type Image
• type ImageConfig
• type Layer
• type TarItem

Variables

var (
	ErrInvalidCopyName      = errors.New("invalid copy name (format: <file>[:<destination>])")
	ErrorInvalidLabelFormat = errors.New("invalid label (format: <key>=<value>)")
)

Types

type Binary

type Binary struct {
	Platform ocischemav1.Platform
	File     string
}

type Blob

type Blob struct {
	Sha256 digest.Digest
	Data   []byte
}

type Container

type Container struct {
	Blobs         []Blob
	Shared        []ocischemav1.Descriptor
	SharedDiffIDs []digest.Digest
	Layout        ocischemav1.ImageLayout
	Index         ocischemav1.Index
	Labels        map[string]string
	Healthcheck   *HealthcheckConfig
}

func New

func New() (*Container, error)

func (*Container) AddBinary

func (c *Container) AddBinary(fnames []string) error

func (*Container) Copy

func (c *Container) Copy(names ...string) error

func (*Container) Save

func (c *Container) Save(dirname string) error

func (*Container) SetHealthcheck

func (c *Container) SetHealthcheck(cmd []string, interval, timeout, start *time.Duration, retries int) error

func (*Container) SetHealthcheckFromArg

func (c *Container) SetHealthcheckFromArg(arg string) error

func (*Container) SetLabels

func (c *Container) SetLabels(labels ...string) error

func (*Container) WriteBlobs

func (c *Container) WriteBlobs(dirname string) error

func (*Container) WriteIndex

func (c *Container) WriteIndex(dirname string) error

func (*Container) WriteLayout

func (c *Container) WriteLayout(dirname string) error

type HealthcheckConfig

type HealthcheckConfig struct {
	Test        []string       `json:"Test"`
	Interval    *time.Duration `json:"Interval,omitempty"`
	Timeout     *time.Duration `json:"Timeout,omitempty"`
	StartPeriod *time.Duration `json:"StartPeriod,omitempty"`
	Retries     int            `json:"Retries,omitempty"`
}

type Image

type Image struct {
	Created      *time.Time            `json:"created,omitempty"`
	Author       string                `json:"author,omitempty"`
	Architecture string                `json:"architecture"`
	OS           string                `json:"os"`
	Config       ImageConfig           `json:"config,omitempty"`
	RootFS       ocischemav1.RootFS    `json:"rootfs"`
	History      []ocischemav1.History `json:"history,omitempty"`
}

Image is copied from ocischemav1 (except the Config)

type ImageConfig

type ImageConfig struct {
	// ImageConfig defines the execution parameters which should be used as a base when running a container using an image.
	Entrypoint []string `json:"Entrypoint,omitempty"`
	WorkingDir string   `json:"WorkingDir,omitempty"`

	Healthcheck *HealthcheckConfig  `json:"Healthcheck,omitempty"`
	Volumes     map[string]struct{} `json:"Volumes,omitempty"`
	Labels      map[string]string   `json:"Labels,omitempty"`
}

ImageConfig is copied from ocischemav1.ImageConfig, only selecting used item and adding:

• healthcheck

type Layer

type Layer struct {
}

type TarItem

type TarItem struct {
	File        string
	Destination string
}