native

Documentation

Index

• type Container
• type DaemonInfo
• type Image
• type Info
• type Namespace
• type NetInterface
• type NetNS
• type Network
• type Process
• type Volume

Types

type Container

type Container struct {
	containers.Container
	Spec    interface{} `json:"Spec,omitempty"`
	Process *Process    `json:"Process,omitempty"`
}

Container corresponds to a containerd-native container object. Not compatible with `docker container inspect`.

type DaemonInfo

type DaemonInfo struct {
	Plugins *introspection.PluginsResponse `json:"Plugins,omitempty"`
	Server  *introspection.ServerResponse  `json:"Server,omitempty"`
	Version *version.VersionResponse       `json:"Version,omitempty"`
}

type Image

type Image struct {
	Image        images.Image        `json:"Image"`
	IndexDesc    *ocispec.Descriptor `json:"IndexDesc,omitempty"`
	Index        *ocispec.Index      `json:"Index,omitempty"`
	ManifestDesc *ocispec.Descriptor `json:"ManifestDesc,omitempty"`
	Manifest     *ocispec.Manifest   `json:"Manifest,omitempty"`
	// e.g., "application/vnd.docker.container.image.v1+json"
	ImageConfigDesc ocispec.Descriptor `json:"ImageConfigDesc"`
	ImageConfig     ocispec.Image      `json:"ImageConfig"`
	Size            int64              `json:"size"`
}

Image corresponds to a containerd-native image object. Not compatible with `docker image inspect`.

type Info

type Info struct {
	Namespace     string      `json:"Namespace,omitempty"`
	Snapshotter   string      `json:"Snapshotter,omitempty"`
	CgroupManager string      `json:"CgroupManager,omitempty"`
	Rootless      bool        `json:"Rootless,omitempty"`
	Daemon        *DaemonInfo `json:"Daemon,omitempty"`
}

type Namespace

type Namespace struct {
	Name   string             `json:"Name"`
	Labels *map[string]string `json:"Labels,omitempty"`
}

type NetInterface

type NetInterface struct {
	net.Interface
	// HardwareAddr overrides Interface.HardwareAddr
	HardwareAddr string
	// Flags overrides Interface.Flags
	Flags []string
	Addrs []string
}

NetInterface wraps net.Interface for JSON marshallability. No support for unmarshalling.

type NetNS

type NetNS struct {
	// PrimaryInterface is a net.Interface.Index value, not an array index.
	// Zero means unset.
	PrimaryInterface int            `json:"PrimaryInterface,omitempty"`
	Interfaces       []NetInterface `json:"Interfaces,omitempty"`
}

NetNS is designed not to depend on CNI

type Network

type Network struct {
	CNI           json.RawMessage    `json:"CNI,omitempty"`
	NerdctlID     *string            `json:"NerdctlID"`
	NerdctlLabels *map[string]string `json:"NerdctlLabels,omitempty"`
	File          string             `json:"File,omitempty"`
}

Network corresponds to pkg/netutil.NetworkConfigList

type Process

type Process struct {
	Pid    int               `json:"Pid,omitempty"`
	Status containerd.Status `json:"Status,omitempty"`
	NetNS  *NetNS            `json:"NetNS,omitempty"`
}

type Volume

type Volume struct {
	Name       string             `json:"Name"`
	Mountpoint string             `json:"Mountpoint"`
	Labels     *map[string]string `json:"Labels,omitempty"`
	Size       int64              `json:"Size,omitempty"`
}

Volume is also compatible with Docker