...

Package system

import "github.com/docker/docker/api/types/system"
Overview
Index

Overview ▾

type Commit

Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as containerd, or runC.

type Commit struct {
    ID       string // ID is the actual commit ID of external tool.
    Expected string // Expected is the commit ID of external tool expected by dockerd as set at build time.
}

type Info

Info contains response of Engine API: GET "/info"

type Info struct {
    ID                 string
    Containers         int
    ContainersRunning  int
    ContainersPaused   int
    ContainersStopped  int
    Images             int
    Driver             string
    DriverStatus       [][2]string
    SystemStatus       [][2]string `json:",omitempty"` // SystemStatus is only propagated by the Swarm standalone API
    Plugins            PluginsInfo
    MemoryLimit        bool
    SwapLimit          bool
    KernelMemory       bool `json:",omitempty"` // Deprecated: kernel 5.4 deprecated kmem.limit_in_bytes
    KernelMemoryTCP    bool `json:",omitempty"` // KernelMemoryTCP is not supported on cgroups v2.
    CPUCfsPeriod       bool `json:"CpuCfsPeriod"`
    CPUCfsQuota        bool `json:"CpuCfsQuota"`
    CPUShares          bool
    CPUSet             bool
    PidsLimit          bool
    IPv4Forwarding     bool
    BridgeNfIptables   bool
    BridgeNfIP6tables  bool `json:"BridgeNfIp6tables"`
    Debug              bool
    NFd                int
    OomKillDisable     bool
    NGoroutines        int
    SystemTime         string
    LoggingDriver      string
    CgroupDriver       string
    CgroupVersion      string `json:",omitempty"`
    NEventsListener    int
    KernelVersion      string
    OperatingSystem    string
    OSVersion          string
    OSType             string
    Architecture       string
    IndexServerAddress string
    RegistryConfig     *registry.ServiceConfig
    NCPU               int
    MemTotal           int64
    GenericResources   []swarm.GenericResource
    DockerRootDir      string
    HTTPProxy          string `json:"HttpProxy"`
    HTTPSProxy         string `json:"HttpsProxy"`
    NoProxy            string
    Name               string
    Labels             []string
    ExperimentalBuild  bool
    ServerVersion      string
    Runtimes           map[string]RuntimeWithStatus
    DefaultRuntime     string
    Swarm              swarm.Info
    // LiveRestoreEnabled determines whether containers should be kept
    // running when the daemon is shutdown or upon daemon start if
    // running containers are detected
    LiveRestoreEnabled  bool
    Isolation           container.Isolation
    InitBinary          string
    ContainerdCommit    Commit
    RuncCommit          Commit
    InitCommit          Commit
    SecurityOptions     []string
    ProductLicense      string               `json:",omitempty"`
    DefaultAddressPools []NetworkAddressPool `json:",omitempty"`
    CDISpecDirs         []string

    // Warnings contains a slice of warnings that occurred  while collecting
    // system information. These warnings are intended to be informational
    // messages for the user, and are not intended to be parsed / used for
    // other purposes, as they do not have a fixed format.
    Warnings []string
    // contains filtered or unexported fields
}

type KeyValue

KeyValue holds a key/value pair.

type KeyValue struct {
    Key, Value string
}

type NetworkAddressPool

NetworkAddressPool is a temp struct used by Info struct.

type NetworkAddressPool struct {
    Base string
    Size int
}

type PluginsInfo

PluginsInfo is a temp struct holding Plugins name registered with docker daemon. It is used by Info struct

type PluginsInfo struct {
    // List of Volume plugins registered
    Volume []string
    // List of Network plugins registered
    Network []string
    // List of Authorization plugins registered
    Authorization []string
    // List of Log plugins registered
    Log []string
}

type Runtime

Runtime describes an OCI runtime

type Runtime struct {
    Path string   `json:"path,omitempty"`
    Args []string `json:"runtimeArgs,omitempty"`

    Type    string                 `json:"runtimeType,omitempty"`
    Options map[string]interface{} `json:"options,omitempty"`
}

type RuntimeWithStatus

RuntimeWithStatus extends Runtime to hold [RuntimeStatus].

type RuntimeWithStatus struct {
    Runtime
    Status map[string]string `json:"status,omitempty"`
}

type SecurityOpt

SecurityOpt contains the name and options of a security option

type SecurityOpt struct {
    Name    string
    Options []KeyValue
}

func DecodeSecurityOptions

func DecodeSecurityOptions(opts []string) ([]SecurityOpt, error)

DecodeSecurityOptions decodes a security options string slice to a type-safe SecurityOpt.