types

Documentation

Index

• Variables
• func GetPlatforms(platform Platform) []string
• func SameError(err1, err2 error) bool
• type Binding
• type CommitOptions
• type Container
• type ContainerConfig
• type ImageInfo
• type Platform
  • func GetPlatformSpec() *Platform
  • func NewPlatform(os, arch, variant string) *Platform
  • func (p *Platform) Same() bool
• type PlatformSpec
  • func GetContainerPlatform(host *PlatformSpec) *PlatformSpec
  • func GetContainerPlatform2(host *PlatformSpec) *PlatformSpec
  • func GetImagePlatform(host *PlatformSpec) *PlatformSpec
  • func ParsePlatform(platform string) *PlatformSpec
  • func ParsePlatforms(platforms ...string) []*PlatformSpec
  • func (p *PlatformSpec) String() string
  • func (p *PlatformSpec) ToOrg() *ocispec.Platform
• type PortBinding
  • func (p PortBinding) String() string
• type ReadinessProbe
• type Volume

Variables

var AutoPlatform = &Platform{}

Functions

func GetPlatforms

func GetPlatforms(platform Platform) []string

func SameError

func SameError(err1, err2 error) bool

Function to compare error messages by prefix

Types

type Binding

type Binding struct {
	Host      PortBinding
	Container PortBinding
}

type CommitOptions

type CommitOptions struct {
	Reference string
	Comment   string
	Changes   []string
}

type Container

type Container struct {
	ID      string
	Image   string
	ImageID string
	Names   []string
}

type ContainerConfig

type ContainerConfig struct {
	ExposedPorts []Binding
	Volumes      []Volume // List of volumes (mounts) used for the container
	Platform     *Platform
	Readiness    *ReadinessProbe `json:"-"`
	Image        string          // Name of the image as it was passed by the operator (e.g., could be symbolic)
	Name         string
	Script       string
	User         string // User that will run the command(s) inside the container, also supports user:group
	WorkingDir   string // Current directory (PWD) in which the command will be launched
	Cmd          []string
	Entrypoint   []string
	Env          []string // List of environment variable to set in the container
	Memory       int64
	CPU          uint64
	Tty          bool // Attach standard streams to a tty, including stdin if it is not closed
}

type ImageInfo

type ImageInfo struct {
	Platform *PlatformSpec
	ID       string
}

type Platform

type Platform struct {
	Host      *PlatformSpec
	Container *PlatformSpec
}

func GetPlatformSpec

func GetPlatformSpec() *Platform

func NewPlatform

func NewPlatform(os, arch, variant string) *Platform

func (*Platform) Same

func (p *Platform) Same() bool

type PlatformSpec

type PlatformSpec ocispec.Platform

func GetContainerPlatform

func GetContainerPlatform(host *PlatformSpec) *PlatformSpec

func GetContainerPlatform2

func GetContainerPlatform2(host *PlatformSpec) *PlatformSpec

func GetImagePlatform

func GetImagePlatform(host *PlatformSpec) *PlatformSpec

func ParsePlatform

func ParsePlatform(platform string) *PlatformSpec

func ParsePlatforms

func ParsePlatforms(platforms ...string) []*PlatformSpec

func (*PlatformSpec) String

func (p *PlatformSpec) String() string

func (*PlatformSpec) ToOrg

func (p *PlatformSpec) ToOrg() *ocispec.Platform

type PortBinding

type PortBinding struct {
	IP   string
	Port string
}

func (PortBinding) String

func (p PortBinding) String() string

type ReadinessProbe

type ReadinessProbe struct {
	Validate func([]byte) bool
	Endpoint string
	Timeout  time.Duration
}

type Volume

type Volume struct {
	Type    string
	Source  string
	Target  string
	Options []string
}