container

Documentation

Index

• Constants
• func IsOwnedBySkupper(labels map[string]string) bool
• type Client
• type Container
  • func (c *Container) EnvSlice() []string
  • func (c *Container) FromEnv(env []string)
  • func (c *Container) NetworkAliases() map[string][]string
  • func (c *Container) NetworkNames() []string
• type ContainerNetworkInfo
• type FileMount
• type Image
• type Informer
• type InformerBase
  • func (e *InformerBase[T]) OnAdd(obj T)
  • func (e *InformerBase[T]) OnDelete(obj T)
  • func (e *InformerBase[T]) OnUpdate(oldObj, newObj T)
• type Network
• type Port
• type Subnet
• type Version
• type VersionInfo
• type Volume
  • func (v *Volume) CreateDataFiles(fileData map[string][]byte, overwrite bool) ([]*os.File, error)
  • func (v *Volume) CreateDirectory(name string) error
  • func (v *Volume) CreateFile(name string, data []byte, overwrite bool) (*os.File, error)
  • func (v *Volume) CreateFiles(fileData map[string]string, overwrite bool) ([]*os.File, error)
  • func (v *Volume) DeleteFile(name string, recursive bool) error
  • func (v *Volume) GetLabels() map[string]string
  • func (v *Volume) ListFiles() ([]os.DirEntry, error)
  • func (v *Volume) ReadFile(name string) (string, error)

Constants

const (
	ContainerNetworkName = "skupper"
)

Functions

func IsOwnedBySkupper

func IsOwnedBySkupper(labels map[string]string) bool

Types

type Client

type Client interface {
	Version() (*Version, error)
	ContainerList() ([]*Container, error)
	ContainerInspect(id string) (*Container, error)
	ContainerCreate(container *Container) error
	ContainerUpdate(name string, fn func(newContainer *Container)) (*Container, error)
	ContainerRename(currentName, newName string) error
	ContainerRemove(id string) error
	ContainerExec(id string, command []string) (string, error)
	ContainerLogs(id string) (string, error)
	ContainerStart(id string) error
	ContainerStop(id string) error
	ContainerRestart(id string) error
	ImageList() ([]*Image, error)
	ImageInspect(id string) (*Image, error)
	ImagePull(ctx context.Context, id string) error
	NetworkList() ([]*Network, error)
	NetworkInspect(id string) (*Network, error)
	NetworkCreate(network *Network) (*Network, error)
	NetworkRemove(id string) error
	NetworkConnect(id, container string, aliases ...string) error
	NetworkDisconnect(id, container string) error
	VolumeCreate(volume *Volume) (*Volume, error)
	VolumeInspect(id string) (*Volume, error)
	VolumeRemove(id string) error
	VolumeList() ([]*Volume, error)
}

type Container

type Container struct {
	ID             string
	Name           string
	Pod            string
	Image          string
	Env            map[string]string
	Labels         map[string]string
	Annotations    map[string]string
	Networks       map[string]ContainerNetworkInfo
	Mounts         []Volume
	FileMounts     []FileMount
	Ports          []Port
	EntryPoint     []string
	Command        []string
	RestartPolicy  string
	MaxCpus        int
	MaxMemoryBytes int64
	RestartCount   int
	Running        bool
	CreatedAt      time.Time
	StartedAt      time.Time
	ExitedAt       time.Time
	ExitCode       int
}

func (*Container) EnvSlice

func (c *Container) EnvSlice() []string

func (*Container) FromEnv

func (c *Container) FromEnv(env []string)

func (*Container) NetworkAliases

func (c *Container) NetworkAliases() map[string][]string

func (*Container) NetworkNames

func (c *Container) NetworkNames() []string

type ContainerNetworkInfo

type ContainerNetworkInfo struct {
	ID          string
	IPAddress   string
	IPPrefixLen int
	MacAddress  string
	Gateway     string
	Aliases     []string
}

type FileMount

type FileMount struct {
	Source      string
	Destination string
	Options     []string
}

type Image

type Image struct {
	Id         string
	Repository string
	Digest     string
	Created    string
}

type Informer

type Informer[T any] interface {
	OnAdd(obj T)
	OnUpdate(oldObj, newObj T)
	OnDelete(obj T)
}

type InformerBase

type InformerBase[T any] struct {
	Add    func(obj T)
	Update func(oldObj, newObj T)
	Delete func(obj T)
}

func (*InformerBase[T]) OnAdd

func (e *InformerBase[T]) OnAdd(obj T)

func (*InformerBase[T]) OnDelete

func (e *InformerBase[T]) OnDelete(obj T)

func (*InformerBase[T]) OnUpdate

func (e *InformerBase[T]) OnUpdate(oldObj, newObj T)

type Network

type Network struct {
	ID        string
	Name      string
	Subnets   []*Subnet
	Driver    string
	IPV6      bool
	DNS       bool
	Internal  bool
	Labels    map[string]string
	Options   map[string]string
	CreatedAt string
}

type Port

type Port struct {
	Host     string
	HostIP   string
	Target   string
	Protocol string
}

type Subnet

type Subnet struct {
	Subnet  string
	Gateway string
}

type Version

type Version struct {
	Client   VersionInfo
	Server   VersionInfo
	Hostname string
	Arch     string
	Kernel   string
	OS       string
}

type VersionInfo

type VersionInfo struct {
	Version    string
	APIVersion string
}

type Volume

type Volume struct {
	Name        string
	Source      string
	Destination string
	Mode        string
	RW          bool
	Labels      map[string]string
}

func (*Volume) CreateDataFiles

func (v *Volume) CreateDataFiles(fileData map[string][]byte, overwrite bool) ([]*os.File, error)

func (*Volume) CreateDirectory

func (v *Volume) CreateDirectory(name string) error

func (*Volume) CreateFile

func (v *Volume) CreateFile(name string, data []byte, overwrite bool) (*os.File, error)

func (*Volume) CreateFiles

func (v *Volume) CreateFiles(fileData map[string]string, overwrite bool) ([]*os.File, error)

func (*Volume) DeleteFile

func (v *Volume) DeleteFile(name string, recursive bool) error

func (*Volume) GetLabels

func (v *Volume) GetLabels() map[string]string

func (*Volume) ListFiles

func (v *Volume) ListFiles() ([]os.DirEntry, error)

func (*Volume) ReadFile

func (v *Volume) ReadFile(name string) (string, error)