adoc

type Actor struct {
	ID         string
	Attributes map[string]string
}

type AuthConfig struct {
	UserName string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	Email    string `json:"email,omitempty"`
}

type BlkioStatEntry struct {
	Major uint64 `json:"major"`
	Minor uint64 `json:"minor"`
	Op    string `json:"op"`
	Value uint64 `json:"value"`
}

type BlkioStats struct {
	IoServiceBytesRecursive []BlkioStatEntry `json:"io_service_bytes_recursive"`
	IoServicedRecursive     []BlkioStatEntry `json:"io_serviced_recursive"`
	IoQueuedRecursive       []BlkioStatEntry `json:"io_queue_recursive"`
	IoServiceTimeRecursive  []BlkioStatEntry `json:"io_service_time_recursive"`
	IoWaitTimeRecursive     []BlkioStatEntry `json:"io_wait_time_recursive"`
	IoMergedRecursive       []BlkioStatEntry `json:"io_merged_recursive"`
	IoTimeRecursive         []BlkioStatEntry `json:"io_time_recursive"`
	SectorsRecursive        []BlkioStatEntry `json:"sectors_recursive"`
}

type Container struct {
	Command    string
	Created    int64
	Id         string
	Image      string
	Labels     map[string]string
	Names      []string
	Ports      []Port
	SizeRootFs int64
	SizeRw     int64
	Status     string
}

type ContainerConfig struct {
	AttachStderr    bool
	AttachStdin     bool
	AttachStdout    bool
	Cmd             []string
	Domainname      string
	Entrypoint      []string
	Env             []string
	ExposedPorts    map[string]struct{}
	Healthcheck     *HealthConfig `json:",omitempty"`
	Hostname        string
	Image           string
	Labels          map[string]string
	MacAddress      string
	NetworkDisabled bool
	OnBuild         []string
	OpenStdin       bool
	PortSpecs       []string
	StdinOnce       bool
	Tty             bool
	User            string
	VolumeDriver    string
	Volumes         map[string]struct{}
	WorkingDir      string
}

type ContainerDetail struct {
	AppArmorProfile string
	Args            []string
	Config          ContainerConfig
	Created         time.Time
	Driver          string
	ExecDriver      string
	ExecIDs         []string
	GraphDriver     GraphDriverData
	HostConfig      HostConfig
	HostnamePath    string
	HostsPath       string
	Id              string
	Image           string
	LogPath         string
	MountLabel      string
	Name            string
	NetworkSettings NetworkSettings
	Path            string
	ProcessLabel    string
	ResolvConfPath  string
	RestartCount    int
	State           ContainerState
	Volumes         map[string]string
	VolumesRW       map[string]bool
	Node            SwarmNode // swarm api
}

type ContainerState struct {
	Dead       bool
	Error      string
	ExitCode   int
	FinishedAt time.Time
	OOMKilled  bool
	Paused     bool
	Pid        int64
	Restarting bool
	Running    bool
	StartedAt  time.Time
	Health     *Health
}

type CpuStats struct {
	CpuUsage       CpuUsage       `json:"cpu_usage"`
	SystemUsage    uint64         `json:"system_cpu_usage"`
	ThrottlingData ThrottlingData `json:"throttling_data"`
}

type CpuUsage struct {
	TotalUsage        uint64   `json:"total_usage"`
	PercpuUsage       []uint64 `json:"percpu_usage"`
	UsageInKernelmode uint64   `json:"usage_in_kernelmode"`
	UsageInUsermode   uint64   `json:"usage_in_usermode"`
}

type Device struct {
	PathOnHost        string
	PathInContainer   string
	CgroupPermissions string
}

type DockerClient struct {
	// contains filtered or unexported fields
}

type DockerInfo struct {
	Containers      int64
	DockerRootDir   string
	Driver          string
	DriverStatus    [][2]string
	SystemStatus    [][2]string
	ExecutionDriver string
	ID              string
	//IPv4Forwarding     int
	Images             int64
	IndexServerAddress string
	InitPath           string
	InitSha1           string
	KernelVersion      string
	Labels             []string
	MemTotal           int64
	//MemoryLimit        int
	NCPU            int64
	NEventsListener int64
	NFd             int64
	NGoroutines     int64
	Name            string
	OperatingSystem string
	//SwapLimit          int
	HttpProxy  string    // v1.18
	HttpsProxy string    // v1.18
	NoProxy    string    // v1.18
	SystemTime time.Time // v1.18

}

type EndpointConfig struct {
	IPAMConfig IPAMConfig
}

type Error struct {
	StatusCode int
	Status     string
	Message    string
}

type Event struct {
	// Deprecated information from JSONMessage.
	// With data only in container events.
	Status string `json:"status,omitempty"`
	ID     string `json:"id,omitempty"`
	From   string `json:"from,omitempty"`

	Type   string
	Action string
	Actor  Actor

	Time     int64 `json:"time,omitempty"`
	TimeNano int64 `json:"timeNano,omitempty"`

	Node SwarmNode `json:"node,omitempty"`
}

type EventCallback func(event Event, err error)

type ExecConfig struct {
	AttachStdin  bool
	AttachStdout bool
	AttachStderr bool
	Tty          bool
	Cmd          []string
}

type FsChange struct {
	Path string
	Kind int
}

type GraphDriverData struct {
	// data
	// Required: true
	Data map[string]string `json:"Data"`
	// name
	// Required: true
	Name string `json:"Name"`
}

type Health struct {
	Status        string // Status is one of Starting, Healthy or Unhealthy
	FailingStreak int    // FailingStreak is the number of consecutive failures
}

type HealthConfig struct {
	// Test is the test to perform to check that the container is healthy.
	// An empty slice means to inherit the default.
	// The options are:
	// {} : inherit healthcheck
	// {"NONE"} : disable healthcheck
	// {"CMD", args...} : exec arguments directly
	// {"CMD-SHELL", command} : run command with system's default shell
	Test []string `json:",omitempty"`

	// Zero means to inherit. Durations are expressed as integer nanoseconds.
	Interval    time.Duration `json:",omitempty"` // Interval is the time to wait between checks.
	Timeout     time.Duration `json:",omitempty"` // Timeout is the time to wait before considering the check to have hung.
	StartPeriod time.Duration `json:",omitempty"` // The start period for the container to initialize before the retries starts to count down.

	// Retries is the number of consecutive failures needed to consider a container as unhealthy.
	// Zero means inherit.
	Retries int `json:",omitempty"`
}

type HostConfig struct {
	Binds           []string
	CapAdd          []string
	CapDrop         []string
	ContainerIDFile string
	Dns             []string
	DnsSearch       []string
	ExtraHosts      []string
	IpcMode         string
	Links           []string
	LxcConf         []map[string]string
	NetworkMode     string
	PidMode         string
	PortBindings    map[string][]PortBinding
	Privileged      bool
	PublishAllPorts bool
	ReadonlyRootfs  bool
	RestartPolicy   RestartPolicy
	SecurityOpt     []string
	VolumesFrom     []string
	LogConfig       LogConfig // 1.18

	// Contains container's resources (cgroups, ulimits)
	Resources
}

type IPAMConfig struct {
	IPv4Address string
	IPv6Address string
}

type Image struct {
	Created     int64
	Id          string
	Labels      map[string]string
	ParentId    string
	RepoTags    []string
	Size        int64
	VirtualSize int64
	RepoDigests []string // v1.18
}

type ImageDetail struct {
	Architecture    string
	Author          string
	Comment         string
	Container       string
	ContainerConfig ContainerConfig
	Created         time.Time
	DockerVersion   string
	Id              string
	Os              string
	Parent          string
	Size            int64
	VirtualSize     int64
}

type LogConfig struct {
	Type   string
	Config map[string]string
}

type LogEntry struct {
	Output  string
	Content string
}

type Logger struct {
	// contains filtered or unexported fields
}

type MemoryStats struct {
	Usage    uint64            `json:"usage"`
	MaxUsage uint64            `json:"max_usage"`
	Stats    map[string]uint64 `json:"stats"`
	Failcnt  uint64            `json:"failcnt"`
	Limit    uint64            `json:"limit"`
}

type NetworkOptions struct {
	Container      string
	EndpointConfig EndpointConfig
	Force          bool
}

type NetworkSettings struct {
	Bridge                 string
	Gateway                string
	GlobalIPv6Address      string
	GlobalIPv6PrefixLen    int
	IPAddress              string
	IPPrefixLen            int
	IPv6Gateway            string
	LinkLocalIPv6Address   string
	LinkLocalIPv6PrefixLen int
	MacAddress             string
	Ports                  map[string][]PortBinding
	Networks               map[string]Networks
}

type NetworkStats struct {
	RxBytes   uint64 `json:"rx_bytes"`
	RxPackets uint64 `json:"rx_packets"`
	RxErrors  uint64 `json:"rx_errors"`
	RxDropped uint64 `json:"rx_dropped"`
	TxBytes   uint64 `json:"tx_bytes"`
	TxPackets uint64 `json:"tx_packets"`
	TxErrors  uint64 `json:"tx_errors"`
	TxDropped uint64 `json:"tx_dropped"`
}

type NetworkingConfig struct {
	EndpointsConfig map[string]EndpointConfig
}

type Networks struct {
	Gateway   string
	IPAddress string
}

type Port struct {
	IP          string
	PrivatePort int
	PublicPort  int
	Type        string
}

type PortBinding struct {
	HostIp   string
	HostPort string
}

type Processes struct {
	Titles    []string
	Processes [][]string
}

type RequestConfig struct {
	ExtraTimeout time.Duration
}

type Resources struct {
	// Applicable to all platforms
	CPUShares int64 `json:"CpuShares"` // CPU shares (relative weight vs. other containers)
	Memory    int64 // Memory limit (in bytes)

	// Applicable to UNIX platforms
	CgroupParent         string // Parent cgroup.
	BlkioWeight          uint16 // Block IO weight (relative weight vs. other containers)
	BlkioWeightDevice    []*WeightDevice
	BlkioDeviceReadBps   []*ThrottleDevice
	BlkioDeviceWriteBps  []*ThrottleDevice
	BlkioDeviceReadIOps  []*ThrottleDevice
	BlkioDeviceWriteIOps []*ThrottleDevice
	CPUPeriod            int64  `json:"CpuPeriod"` // CPU CFS (Completely Fair Scheduler) period
	CPUQuota             int64  `json:"CpuQuota"`  // CPU CFS (Completely Fair Scheduler) quota
	CpusetCpus           string // CpusetCpus 0-2, 0,1
	CpusetMems           string // CpusetMems 0-2, 0,1
	Devices              []Device
	DiskQuota            int64     // Disk limit (in bytes)
	KernelMemory         int64     // Kernel memory limit (in bytes)
	MemoryReservation    int64     // Memory soft limit (in bytes)
	MemorySwap           int64     // Total memory usage (memory + swap); set `-1` to enable unlimited swap
	MemorySwappiness     *int64    // Tuning container memory swappiness behaviour
	OomKillDisable       *bool     // Whether to disable OOM Killer or not
	PidsLimit            int64     // Setting pids limit for a container
	Ulimits              []*Ulimit // List of ulimits to be set in the container

	// Applicable to Windows
	CPUCount           int64  `json:"CpuCount"`   // CPU count
	CPUPercent         int64  `json:"CpuPercent"` // CPU percent
	IOMaximumIOps      uint64 // Maximum IOps for the container system drive
	IOMaximumBandwidth uint64 // Maximum IO in bytes per second for the container system drive
}

type RestartPolicy struct {
	MaximumRetryCount int
	Name              string
}

type Stats struct {
	Read         time.Time    `json:"read"`
	NetworkStats NetworkStats `json:"network"`
	CpuStats     CpuStats     `json:"cpu_stats"`
	MemoryStats  MemoryStats  `json:"memory_stats"`
	BlkioStats   BlkioStats   `json:"blkio_stats"`
}

type StatsCallback func(stats Stats, err error)

type SwarmInfo struct {
	Role       string
	Containers int64
	Strategy   string
	Filters    string
	Nodes      []SwarmNodeInfo
}

type SwarmNode struct {
	Name   string
	ID     string
	Addr   string
	IP     string
	Cpus   int
	Memory int64
	Labels map[string]string
}

type SwarmNodeInfo struct {
	Name       string
	Address    string
	Containers int64
	CPUs       int
	UsedCPUs   int
	Memory     int64
	UsedMemory int64
}

type ThrottleDevice struct {
	Path string
	Rate uint64
}

type ThrottlingData struct {
	Periods          uint64 `json:"periods"`
	ThrottledPeriods uint64 `json:"throttled_periods"`
	ThrottledTime    uint64 `json:"throttled_time"`
}

type Ulimit struct {
	Name string
	Soft int64
	Hard int64
}

type Version struct {
	ApiVersion    string
	GitCommit     string
	GoVersion     string
	Version       string
	Os            string // v1.18
	Arch          string // v1.18
	KernelVersion string // v1.18
}

type WeightDevice struct {
	Path   string
	Weight uint16
}