Documentation ¶
Index ¶
- Constants
- type AuthConfig
- type AuthResponse
- type Commit
- type Container
- type ContainerConfig
- type ContainerCreateConfig
- func (m *ContainerCreateConfig) MarshalBinary() ([]byte, error)
- func (m ContainerCreateConfig) MarshalJSON() ([]byte, error)
- func (m *ContainerCreateConfig) UnmarshalBinary(b []byte) error
- func (m *ContainerCreateConfig) UnmarshalJSON(raw []byte) error
- func (m *ContainerCreateConfig) Validate(formats strfmt.Registry) error
- type ContainerCreateResp
- type ContainerExecInspect
- type ContainerJSON
- type ContainerLogsOptions
- type ContainerNetworkSettings
- type ContainerProcessList
- type ContainerState
- type ContainerUpgradeConfig
- func (m *ContainerUpgradeConfig) MarshalBinary() ([]byte, error)
- func (m ContainerUpgradeConfig) MarshalJSON() ([]byte, error)
- func (m *ContainerUpgradeConfig) UnmarshalBinary(b []byte) error
- func (m *ContainerUpgradeConfig) UnmarshalJSON(raw []byte) error
- func (m *ContainerUpgradeConfig) Validate(formats strfmt.Registry) error
- type DaemonUpdateConfig
- type DeviceMapping
- type EndpointIPAMConfig
- type EndpointSettings
- type Error
- type ExecCreateConfig
- type ExecCreateResp
- type ExecStartConfig
- type GraphDriverData
- type HostConfig
- type HostConfigAO0LogConfig
- type IPAM
- type IPAMConfig
- type IPAddress
- type ImageInfo
- type ImageInfoRootFS
- type IndexInfo
- type MountPoint
- type NetworkCreate
- type NetworkCreateConfig
- func (m *NetworkCreateConfig) MarshalBinary() ([]byte, error)
- func (m NetworkCreateConfig) MarshalJSON() ([]byte, error)
- func (m *NetworkCreateConfig) UnmarshalBinary(b []byte) error
- func (m *NetworkCreateConfig) UnmarshalJSON(raw []byte) error
- func (m *NetworkCreateConfig) Validate(formats strfmt.Registry) error
- type NetworkCreateResp
- type NetworkInfo
- type NetworkInspectResp
- type NetworkListResp
- type NetworkSettings
- type NetworkingConfig
- type PortBinding
- type PortMap
- type ProcessConfig
- type RegistryServiceConfig
- type ResizeOptions
- type Resources
- type ResourcesUlimitsItems0
- type RestartPolicy
- type Runtime
- type SearchResultItem
- type SnapshotterData
- type Status
- type SystemInfo
- type SystemVersion
- type ThrottleDevice
- type UpdateConfig
- type VolumeCreateConfig
- type VolumeInfo
- type VolumeListResp
- type WeightDevice
Constants ¶
const ( // ContainerConfigRichModeDumbInit captures enum value "dumb-init" ContainerConfigRichModeDumbInit string = "dumb-init" // ContainerConfigRichModeSbinInit captures enum value "sbin-init" ContainerConfigRichModeSbinInit string = "sbin-init" // ContainerConfigRichModeSystemd captures enum value "systemd" ContainerConfigRichModeSystemd string = "systemd" )
const ( // HostConfigAO0LogConfigTypeJSONFile captures enum value "json-file" HostConfigAO0LogConfigTypeJSONFile string = "json-file" // HostConfigAO0LogConfigTypeSyslog captures enum value "syslog" HostConfigAO0LogConfigTypeSyslog string = "syslog" // HostConfigAO0LogConfigTypeJournald captures enum value "journald" HostConfigAO0LogConfigTypeJournald string = "journald" // HostConfigAO0LogConfigTypeGelf captures enum value "gelf" HostConfigAO0LogConfigTypeGelf string = "gelf" // HostConfigAO0LogConfigTypeFluentd captures enum value "fluentd" HostConfigAO0LogConfigTypeFluentd string = "fluentd" // HostConfigAO0LogConfigTypeAwslogs captures enum value "awslogs" HostConfigAO0LogConfigTypeAwslogs string = "awslogs" // HostConfigAO0LogConfigTypeSplunk captures enum value "splunk" HostConfigAO0LogConfigTypeSplunk string = "splunk" // HostConfigAO0LogConfigTypeEtwlogs captures enum value "etwlogs" HostConfigAO0LogConfigTypeEtwlogs string = "etwlogs" // HostConfigAO0LogConfigTypeNone captures enum value "none" HostConfigAO0LogConfigTypeNone string = "none" )
const ( // SystemInfoCgroupDriverCgroupfs captures enum value "cgroupfs" SystemInfoCgroupDriverCgroupfs string = "cgroupfs" // SystemInfoCgroupDriverSystemd captures enum value "systemd" SystemInfoCgroupDriverSystemd string = "systemd" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthConfig ¶
type AuthConfig struct { // auth Auth string `json:"Auth,omitempty"` // IdentityToken is used to authenticate the user and get an access token for the registry IdentityToken string `json:"IdentityToken,omitempty"` // password Password string `json:"Password,omitempty"` // RegistryToken is a bearer token to be sent to a registry RegistryToken string `json:"RegistryToken,omitempty"` // server address ServerAddress string `json:"ServerAddress,omitempty"` // username Username string `json:"Username,omitempty"` }
func (*AuthConfig) MarshalBinary ¶
func (m *AuthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthConfig) UnmarshalBinary ¶
func (m *AuthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthResponse ¶
type AuthResponse struct { // An opaque token used to authenticate a user after a successful login IdentityToken string `json:"IdentityToken,omitempty"` // The status of the authentication // Required: true Status string `json:"Status"` }
func (*AuthResponse) MarshalBinary ¶
func (m *AuthResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthResponse) UnmarshalBinary ¶
func (m *AuthResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Commit ¶
type Commit struct { // Commit ID of external tool expected by pouchd as set at build time. // Expected string `json:"Expected,omitempty"` // Actual commit ID of external tool. ID string `json:"ID,omitempty"` }
func (*Commit) MarshalBinary ¶
MarshalBinary interface implementation
func (*Commit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Container ¶
type Container struct { // command Command string `json:"Command,omitempty"` // Created time of container in daemon. Created int64 `json:"Created,omitempty"` // In Moby's API, HostConfig field in Container struct has following type // struct { NetworkMode string `json:",omitempty"` } // In Pouch, we need to pick runtime field in HostConfig from daemon side to judge runtime type, // So Pouch changes this type to be the complete HostConfig. // Incompatibility exists, ATTENTION. // HostConfig *HostConfig `json:"HostConfig,omitempty"` // Container ID ID string `json:"Id,omitempty"` // image Image string `json:"Image,omitempty"` // image ID ImageID string `json:"ImageID,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // Set of mount point in a container. Mounts []MountPoint `json:"Mounts"` // names Names []string `json:"Names"` // network settings NetworkSettings *ContainerNetworkSettings `json:"NetworkSettings,omitempty"` // size root fs SizeRootFs int64 `json:"SizeRootFs,omitempty"` // size rw SizeRw int64 `json:"SizeRw,omitempty"` // state State string `json:"State,omitempty"` // status Status string `json:"Status,omitempty"` }
func (*Container) MarshalBinary ¶
MarshalBinary interface implementation
func (*Container) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ContainerConfig ¶
type ContainerConfig struct { // Command is already escaped (Windows only) ArgsEscaped bool `json:"ArgsEscaped,omitempty"` // Whether to attach to `stderr`. AttachStderr bool `json:"AttachStderr,omitempty"` // Whether to attach to `stdin`. AttachStdin bool `json:"AttachStdin,omitempty"` // Whether to attach to `stdout`. AttachStdout bool `json:"AttachStdout,omitempty"` // Command to run specified an array of strings. Cmd []string `json:"Cmd"` // Set disk quota for container DiskQuota map[string]string `json:"DiskQuota,omitempty"` // The domain name to use for the container. Domainname string `json:"Domainname,omitempty"` // The entry point for the container as a string or an array of strings. // If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default. // Entrypoint []string `json:"Entrypoint"` // A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. // Env []string `json:"Env"` // An object mapping ports to an empty object in the form:`{<port>/<tcp|udp>: {}}` ExposedPorts map[string]interface{} `json:"ExposedPorts,omitempty"` // The hostname to use for the container, as a valid RFC 1123 hostname. // Min Length: 1 Hostname strfmt.Hostname `json:"Hostname,omitempty"` // The name of the image to use when creating the container // Required: true Image string `json:"Image"` // Initial script executed in container. The script will be executed before entrypoint or command InitScript string `json:"InitScript,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // MAC address of the container. MacAddress string `json:"MacAddress,omitempty"` // Disable networking for the container. NetworkDisabled bool `json:"NetworkDisabled,omitempty"` // `ONBUILD` metadata that were defined. OnBuild []string `json:"OnBuild"` // Open `stdin` OpenStdin bool `json:"OpenStdin,omitempty"` // set disk quota by specified quota id, if id < 0, it means pouchd alloc a unique quota id QuotaID string `json:"QuotaID,omitempty"` // Whether to start container in rich container mode. (default false) Rich bool `json:"Rich,omitempty"` // Choose one rich container mode.(default dumb-init) RichMode string `json:"RichMode,omitempty"` // Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. Shell []string `json:"Shell"` // annotations send to runtime spec. SpecAnnotation map[string]string `json:"SpecAnnotation,omitempty"` // Close `stdin` after one attached client disconnects StdinOnce bool `json:"StdinOnce,omitempty"` // Signal to stop a container as a string or unsigned integer. StopSignal string `json:"StopSignal,omitempty"` // Timeout to stop a container in seconds. StopTimeout *int64 `json:"StopTimeout,omitempty"` // Attach standard streams to a TTY, including `stdin` if it is not closed. Tty bool `json:"Tty,omitempty"` // The user that commands are run as inside the container. User string `json:"User,omitempty"` // An object mapping mount point paths inside the container to empty objects. Volumes map[string]interface{} `json:"Volumes,omitempty"` // The working directory for commands to run in. WorkingDir string `json:"WorkingDir,omitempty"` }
func (*ContainerConfig) MarshalBinary ¶
func (m *ContainerConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerConfig) UnmarshalBinary ¶
func (m *ContainerConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerCreateConfig ¶
type ContainerCreateConfig struct { ContainerConfig // host config HostConfig *HostConfig `json:"HostConfig,omitempty"` // networking config NetworkingConfig *NetworkingConfig `json:"NetworkingConfig,omitempty"` }
func (*ContainerCreateConfig) MarshalBinary ¶
func (m *ContainerCreateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ContainerCreateConfig) MarshalJSON ¶
func (m ContainerCreateConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ContainerCreateConfig) UnmarshalBinary ¶
func (m *ContainerCreateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ContainerCreateConfig) UnmarshalJSON ¶
func (m *ContainerCreateConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type ContainerCreateResp ¶
type ContainerCreateResp struct { // The ID of the created container // Required: true ID string `json:"Id"` // The name of the created container Name string `json:"Name,omitempty"` // Warnings encountered when creating the container // Required: true Warnings []string `json:"Warnings"` }
func (*ContainerCreateResp) MarshalBinary ¶
func (m *ContainerCreateResp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerCreateResp) UnmarshalBinary ¶
func (m *ContainerCreateResp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerExecInspect ¶
type ContainerExecInspect struct { // can remove CanRemove bool `json:"CanRemove,omitempty"` // The ID of this container ContainerID string `json:"ContainerID,omitempty"` // detach keys DetachKeys string `json:"DetachKeys,omitempty"` // The last exit code of this container ExitCode int64 `json:"ExitCode,omitempty"` // The ID of this exec ID string `json:"ID,omitempty"` // open stderr OpenStderr bool `json:"OpenStderr,omitempty"` // open stdin OpenStdin bool `json:"OpenStdin,omitempty"` // open stdout OpenStdout bool `json:"OpenStdout,omitempty"` // process config ProcessConfig *ProcessConfig `json:"ProcessConfig,omitempty"` // running Running bool `json:"Running,omitempty"` }
func (*ContainerExecInspect) MarshalBinary ¶
func (m *ContainerExecInspect) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerExecInspect) UnmarshalBinary ¶
func (m *ContainerExecInspect) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerJSON ¶
type ContainerJSON struct { // app armor profile AppArmorProfile string `json:"AppArmorProfile,omitempty"` // The arguments to the command being run Args []string `json:"Args"` // config Config *ContainerConfig `json:"Config,omitempty"` // The time the container was created Created string `json:"Created,omitempty"` // driver Driver string `json:"Driver,omitempty"` // exec ids ExecIds string `json:"ExecIDs,omitempty"` // graph driver GraphDriver *GraphDriverData `json:"GraphDriver,omitempty"` // host config HostConfig *HostConfig `json:"HostConfig,omitempty"` // hostname path HostnamePath string `json:"HostnamePath,omitempty"` // hosts path HostsPath string `json:"HostsPath,omitempty"` // The ID of the container ID string `json:"Id,omitempty"` // The container's image Image string `json:"Image,omitempty"` // log path LogPath string `json:"LogPath,omitempty"` // mount label MountLabel string `json:"MountLabel,omitempty"` // Set of mount point in a container. Mounts []MountPoint `json:"Mounts"` // name Name string `json:"Name,omitempty"` // NetworkSettings exposes the network settings in the API. NetworkSettings *NetworkSettings `json:"NetworkSettings,omitempty"` // The path to the command being run Path string `json:"Path,omitempty"` // process label ProcessLabel string `json:"ProcessLabel,omitempty"` // resolv conf path ResolvConfPath string `json:"ResolvConfPath,omitempty"` // restart count RestartCount int64 `json:"RestartCount,omitempty"` // The total size of all the files in this container. SizeRootFs *int64 `json:"SizeRootFs,omitempty"` // The size of files that have been created or changed by this container. SizeRw *int64 `json:"SizeRw,omitempty"` // snapshotter Snapshotter *SnapshotterData `json:"Snapshotter,omitempty"` // The state of the container. State *ContainerState `json:"State,omitempty"` }
func (*ContainerJSON) MarshalBinary ¶
func (m *ContainerJSON) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerJSON) UnmarshalBinary ¶
func (m *ContainerJSON) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerLogsOptions ¶
type ContainerLogsOptions struct { // Show extra details provided to logs Details bool `json:"Details,omitempty"` // Return logs as a stream Follow bool `json:"Follow,omitempty"` // Return logs from `stderr` ShowStderr bool `json:"ShowStderr,omitempty"` // Return logs from `stdout` ShowStdout bool `json:"ShowStdout,omitempty"` // Only return logs after this time, as a UNIX timestamp Since string `json:"Since,omitempty"` // Only reture this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines. Tail string `json:"Tail,omitempty"` // Add timestamps to every log line Timestamps bool `json:"Timestamps,omitempty"` // Only reture logs before this time, as a UNIX timestamp Until string `json:"Until,omitempty"` }
func (*ContainerLogsOptions) MarshalBinary ¶
func (m *ContainerLogsOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerLogsOptions) UnmarshalBinary ¶
func (m *ContainerLogsOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerNetworkSettings ¶
type ContainerNetworkSettings struct { // networks Networks map[string]*EndpointSettings `json:"Networks,omitempty"` }
func (*ContainerNetworkSettings) MarshalBinary ¶
func (m *ContainerNetworkSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerNetworkSettings) UnmarshalBinary ¶
func (m *ContainerNetworkSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerProcessList ¶
type ContainerProcessList struct { // Each process running in the container, where each is process is an array of values corresponding to the titles Processes [][]string `json:"Processes"` // The ps column titles Titles []string `json:"Titles"` }
func (*ContainerProcessList) MarshalBinary ¶
func (m *ContainerProcessList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerProcessList) UnmarshalBinary ¶
func (m *ContainerProcessList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerState ¶
type ContainerState struct { // Whether this container is dead. Dead bool `json:"Dead,omitempty"` // The error message of this container Error string `json:"Error,omitempty"` // The last exit code of this container ExitCode int64 `json:"ExitCode,omitempty"` // The time when this container last exited. FinishedAt string `json:"FinishedAt,omitempty"` // Whether this container has been killed because it ran out of memory. OOMKilled bool `json:"OOMKilled,omitempty"` // Whether this container is paused. Paused bool `json:"Paused,omitempty"` // The process ID of this container Pid int64 `json:"Pid,omitempty"` // Whether this container is restarting. Restarting bool `json:"Restarting,omitempty"` // Whether this container is running. // // Note that a running container can be _paused_. The `Running` and `Paused` // booleans are not mutually exclusive: // // When pausing a container (on Linux), the cgroups freezer is used to suspend // all processes in the container. Freezing the process requires the process to // be running. As a result, paused containers are both `Running` _and_ `Paused`. // // Use the `Status` field instead to determine if a container's state is "running". // Running bool `json:"Running,omitempty"` // The time when this container was last started. StartedAt string `json:"StartedAt,omitempty"` // status Status Status `json:"Status,omitempty"` }
func (*ContainerState) MarshalBinary ¶
func (m *ContainerState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerState) UnmarshalBinary ¶
func (m *ContainerState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerUpgradeConfig ¶
type ContainerUpgradeConfig struct { ContainerConfig // host config HostConfig *HostConfig `json:"HostConfig,omitempty"` }
func (*ContainerUpgradeConfig) MarshalBinary ¶
func (m *ContainerUpgradeConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ContainerUpgradeConfig) MarshalJSON ¶
func (m ContainerUpgradeConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ContainerUpgradeConfig) UnmarshalBinary ¶
func (m *ContainerUpgradeConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ContainerUpgradeConfig) UnmarshalJSON ¶
func (m *ContainerUpgradeConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type DaemonUpdateConfig ¶
type DaemonUpdateConfig struct { // Image proxy used to pull image. ImageProxy string `json:"ImageProxy,omitempty"` // Labels indentified the attributes of daemon Labels []string `json:"Labels"` }
func (*DaemonUpdateConfig) MarshalBinary ¶
func (m *DaemonUpdateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DaemonUpdateConfig) UnmarshalBinary ¶
func (m *DaemonUpdateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceMapping ¶
type DeviceMapping struct { // cgroup permissions of the device CgroupPermissions string `json:"CgroupPermissions,omitempty"` // path in container of the device mapping PathInContainer string `json:"PathInContainer,omitempty"` // path on host of the device mapping PathOnHost string `json:"PathOnHost,omitempty"` }
func (*DeviceMapping) MarshalBinary ¶
func (m *DeviceMapping) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceMapping) UnmarshalBinary ¶
func (m *DeviceMapping) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointIPAMConfig ¶
type EndpointIPAMConfig struct { // ipv4 address IPV4Address string `json:"IPv4Address,omitempty"` // ipv6 address IPV6Address string `json:"IPv6Address,omitempty"` // link to the list of local ip LinkLocalIps []string `json:"LinkLocalIPs"` }
func (*EndpointIPAMConfig) MarshalBinary ¶
func (m *EndpointIPAMConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointIPAMConfig) UnmarshalBinary ¶
func (m *EndpointIPAMConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointSettings ¶
type EndpointSettings struct { // aliases Aliases []string `json:"Aliases"` // DriverOpts is a mapping of driver options and values. These options // are passed directly to the driver and are driver specific. // DriverOpts map[string]string `json:"DriverOpts,omitempty"` // Unique ID for the service endpoint in a Sandbox. // EndpointID string `json:"EndpointID,omitempty"` // Gateway address for this network. // Gateway string `json:"Gateway,omitempty"` // Global IPv6 address. // GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"` // Mask length of the global IPv6 address. // GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"` // IP a m config IPAMConfig *EndpointIPAMConfig `json:"IPAMConfig,omitempty"` // IPv4 address. // IPAddress string `json:"IPAddress,omitempty"` // Mask length of the IPv4 address. // IPPrefixLen int64 `json:"IPPrefixLen,omitempty"` // IPv6 gateway address. // IPV6Gateway string `json:"IPv6Gateway,omitempty"` // links Links []string `json:"Links"` // MAC address for the endpoint on this network. // MacAddress string `json:"MacAddress,omitempty"` // Unique ID of the network. // NetworkID string `json:"NetworkID,omitempty"` }
func (*EndpointSettings) MarshalBinary ¶
func (m *EndpointSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointSettings) UnmarshalBinary ¶
func (m *EndpointSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct { // message Message string `json:"message,omitempty"` }
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ExecCreateConfig ¶
type ExecCreateConfig struct { // Attach the standard error AttachStderr bool `json:"AttachStderr,omitempty"` // Attach the standard input, makes possible user interaction AttachStdin bool `json:"AttachStdin,omitempty"` // Attach the standard output AttachStdout bool `json:"AttachStdout,omitempty"` // Execution commands and args // Min Items: 1 Cmd []string `json:"Cmd"` // Execute in detach mode Detach bool `json:"Detach,omitempty"` // Escape keys for detach DetachKeys string `json:"DetachKeys,omitempty"` // Is the container in privileged mode Privileged bool `json:"Privileged,omitempty"` // Attach standard streams to a tty Tty bool `json:"Tty,omitempty"` // User that will run the command User string `json:"User,omitempty"` }
func (*ExecCreateConfig) MarshalBinary ¶
func (m *ExecCreateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExecCreateConfig) UnmarshalBinary ¶
func (m *ExecCreateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExecCreateResp ¶
type ExecCreateResp struct { // ID is the exec ID ID string `json:"Id,omitempty"` }
func (*ExecCreateResp) MarshalBinary ¶
func (m *ExecCreateResp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExecCreateResp) UnmarshalBinary ¶
func (m *ExecCreateResp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExecStartConfig ¶
type ExecStartConfig struct { // ExecStart will first check if it's detached Detach bool `json:"Detach,omitempty"` // Check if there's a tty Tty bool `json:"Tty,omitempty"` }
func (*ExecStartConfig) MarshalBinary ¶
func (m *ExecStartConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExecStartConfig) UnmarshalBinary ¶
func (m *ExecStartConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GraphDriverData ¶
type GraphDriverData struct { // data // Required: true Data map[string]string `json:"Data"` // name // Required: true Name string `json:"Name"` }
func (*GraphDriverData) MarshalBinary ¶
func (m *GraphDriverData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GraphDriverData) UnmarshalBinary ¶
func (m *GraphDriverData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HostConfig ¶
type HostConfig struct { // Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. AutoRemove bool `json:"AutoRemove,omitempty"` // A list of volume bindings for this container. Each volume binding is a string in one of these forms: // // - `host-src:container-dest` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. // - `host-src:container-dest:ro` to make the bind mount read-only inside the container. Both `host-src`, and `container-dest` must be an _absolute_ path. // - `volume-name:container-dest` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. // - `volume-name:container-dest:ro` to mount the volume read-only inside the container. `container-dest` must be an _absolute_ path. // Binds []string `json:"Binds"` // A list of kernel capabilities to add to the container. CapAdd []string `json:"CapAdd"` // A list of kernel capabilities to drop from the container. CapDrop []string `json:"CapDrop"` // Cgroup to use for the container. Cgroup string `json:"Cgroup,omitempty"` // Initial console size, as an `[height, width]` array. (Windows only) // Max Items: 2 // Min Items: 2 ConsoleSize []*int64 `json:"ConsoleSize"` // Path to a file where the container ID is written ContainerIDFile string `json:"ContainerIDFile,omitempty"` // A list of DNS servers for the container to use. DNS []string `json:"Dns"` // A list of DNS options. DNSOptions []string `json:"DnsOptions"` // A list of DNS search domains. DNSSearch []string `json:"DnsSearch"` // Whether to enable lxcfs. EnableLxcfs bool `json:"EnableLxcfs,omitempty"` // A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `["hostname:IP"]`. // ExtraHosts []string `json:"ExtraHosts"` // A list of additional groups that the container process will run as. GroupAdd []string `json:"GroupAdd"` // Initial script executed in container. The script will be executed before entrypoint or command InitScript string `json:"InitScript,omitempty"` // IPC sharing mode for the container. Possible values are: // - `"none"`: own private IPC namespace, with /dev/shm not mounted // - `"private"`: own private IPC namespace // - `"shareable"`: own private IPC namespace, with a possibility to share it with other containers // - `"container:<name|id>"`: join another (shareable) container's IPC namespace // - `"host"`: use the host system's IPC namespace // If not specified, daemon default is used, which can either be `"private"` // or `"shareable"`, depending on daemon version and configuration. // IpcMode string `json:"IpcMode,omitempty"` // Isolation technology of the container. (Windows only) Isolation string `json:"Isolation,omitempty"` // A list of links for the container in the form `container_name:alias`. Links []string `json:"Links"` // log config LogConfig *HostConfigAO0LogConfig `json:"LogConfig,omitempty"` // Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. NetworkMode string `json:"NetworkMode,omitempty"` // An integer value containing the score given to the container in order to tune OOM killer preferences. // The range is in [-1000, 1000]. // // Maximum: 1000 // Minimum: -1000 OomScoreAdj int64 `json:"OomScoreAdj,omitempty"` // Set the PID (Process) Namespace mode for the container. It can be either: // - `"container:<name|id>"`: joins another container's PID namespace // - `"host"`: use the host's PID namespace inside the container // PidMode string `json:"PidMode,omitempty"` // A map of exposed container ports and the host port they should map to. PortBindings PortMap `json:"PortBindings,omitempty"` // Gives the container full access to the host. Privileged bool `json:"Privileged,omitempty"` // Allocates a random host port for all of a container's exposed ports. PublishAllPorts bool `json:"PublishAllPorts,omitempty"` // Mount the container's root filesystem as read only. ReadonlyRootfs bool `json:"ReadonlyRootfs,omitempty"` // Restart policy to be used to manage the container RestartPolicy *RestartPolicy `json:"RestartPolicy,omitempty"` // Whether to start container in rich container mode. (default false) Rich bool `json:"Rich,omitempty"` // Choose one rich container mode.(default dumb-init) RichMode string `json:"RichMode,omitempty"` // Runtime to use with this container. Runtime string `json:"Runtime,omitempty"` // A list of string values to customize labels for MLS systems, such as SELinux. SecurityOpt []string `json:"SecurityOpt"` // Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. // Minimum: 0 ShmSize *int64 `json:"ShmSize,omitempty"` // Storage driver options for this container, in the form `{"size": "120G"}`. // StorageOpt map[string]string `json:"StorageOpt,omitempty"` // A list of kernel parameters (sysctls) to set in the container. For example: `{"net.ipv4.ip_forward": "1"}` // Sysctls map[string]string `json:"Sysctls,omitempty"` // A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: `{ "/run": "rw,noexec,nosuid,size=65536k" }`. // Tmpfs map[string]string `json:"Tmpfs,omitempty"` // UTS namespace to use for the container. UTSMode string `json:"UTSMode,omitempty"` // Sets the usernamespace mode for the container when usernamespace remapping option is enabled. UsernsMode string `json:"UsernsMode,omitempty"` // Driver that this container uses to mount volumes. VolumeDriver string `json:"VolumeDriver,omitempty"` // A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. VolumesFrom []string `json:"VolumesFrom"` Resources }
func (*HostConfig) MarshalBinary ¶
func (m *HostConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (HostConfig) MarshalJSON ¶
func (m HostConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*HostConfig) UnmarshalBinary ¶
func (m *HostConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*HostConfig) UnmarshalJSON ¶
func (m *HostConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type HostConfigAO0LogConfig ¶
type HostConfigAO0LogConfig struct { // config Config map[string]string `json:"Config,omitempty"` // type Type string `json:"Type,omitempty"` }
func (*HostConfigAO0LogConfig) MarshalBinary ¶
func (m *HostConfigAO0LogConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HostConfigAO0LogConfig) UnmarshalBinary ¶
func (m *HostConfigAO0LogConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPAM ¶
type IPAM struct { // config Config []IPAMConfig `json:"Config"` // driver Driver string `json:"Driver,omitempty"` // options Options map[string]string `json:"Options,omitempty"` }
func (*IPAM) MarshalBinary ¶
MarshalBinary interface implementation
func (*IPAM) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type IPAMConfig ¶
type IPAMConfig struct { // aux address AuxAddress map[string]string `json:"AuxAddress,omitempty"` // gateway Gateway string `json:"Gateway,omitempty"` // IP range IPRange string `json:"IPRange,omitempty"` // subnet Subnet string `json:"Subnet,omitempty"` }
func (*IPAMConfig) MarshalBinary ¶
func (m *IPAMConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IPAMConfig) UnmarshalBinary ¶
func (m *IPAMConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPAddress ¶
type IPAddress struct { // IP address. Addr string `json:"Addr,omitempty"` // Mask length of the IP address. PrefixLen int64 `json:"PrefixLen,omitempty"` }
func (*IPAddress) MarshalBinary ¶
MarshalBinary interface implementation
func (*IPAddress) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ImageInfo ¶
type ImageInfo struct { // the CPU architecture. Architecture string `json:"Architecture,omitempty"` // config Config *ContainerConfig `json:"Config,omitempty"` // time of image creation. CreatedAt string `json:"CreatedAt,omitempty"` // ID of an image. ID string `json:"Id,omitempty"` // the name of the operating system. Os string `json:"Os,omitempty"` // repository with digest. RepoDigests []string `json:"RepoDigests"` // repository with tag. RepoTags []string `json:"RepoTags"` // root f s RootFS *ImageInfoRootFS `json:"RootFS,omitempty"` // size of image's taking disk space. Size int64 `json:"Size,omitempty"` }
func (*ImageInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*ImageInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ImageInfoRootFS ¶
type ImageInfoRootFS struct { // the base layer content hash. BaseLayer string `json:"BaseLayer,omitempty"` // an array of layer content hashes Layers []string `json:"Layers"` // type of the rootfs // Required: true Type string `json:"Type"` }
func (*ImageInfoRootFS) MarshalBinary ¶
func (m *ImageInfoRootFS) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageInfoRootFS) UnmarshalBinary ¶
func (m *ImageInfoRootFS) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IndexInfo ¶
type IndexInfo struct { // List of mirrors, expressed as URIs. // Mirrors []string `json:"Mirrors"` // Name of the registry. // Name string `json:"Name,omitempty"` // Indicates whether this is an official registry. // Official bool `json:"Official,omitempty"` // Indicates if the the registry is part of the list of insecure // registries. // // If `false`, the registry is insecure. Insecure registries accept // un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from // unknown CAs) communication. // // > **Warning**: Insecure registries can be useful when running a local // > registry. However, because its use creates security vulnerabilities // > it should ONLY be enabled for testing purposes. For increased // > security, users should add their CA to their system's list of // > trusted CAs instead of enabling this option. // Secure bool `json:"Secure,omitempty"` }
func (*IndexInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*IndexInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MountPoint ¶
type MountPoint struct { // copy data CopyData bool `json:"CopyData,omitempty"` // destination Destination string `json:"Destination,omitempty"` // driver Driver string `json:"Driver,omitempty"` // ID ID string `json:"ID,omitempty"` // mode Mode string `json:"Mode,omitempty"` // name Name string `json:"Name,omitempty"` // named Named bool `json:"Named,omitempty"` // propagation Propagation string `json:"Propagation,omitempty"` // r w RW bool `json:"RW,omitempty"` // replace Replace string `json:"Replace,omitempty"` // source Source string `json:"Source,omitempty"` // type Type string `json:"Type,omitempty"` }
func (*MountPoint) MarshalBinary ¶
func (m *MountPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountPoint) UnmarshalBinary ¶
func (m *MountPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkCreate ¶
type NetworkCreate struct { // CheckDuplicate is used to check the network is duplicate or not. CheckDuplicate bool `json:"CheckDuplicate,omitempty"` // Driver means the network's driver. Driver string `json:"Driver,omitempty"` // enable ipv6 EnableIPV6 bool `json:"EnableIPv6,omitempty"` // IP a m IPAM *IPAM `json:"IPAM,omitempty"` // Internal checks the network is internal network or not. Internal bool `json:"Internal,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // options Options map[string]string `json:"Options,omitempty"` }
func (*NetworkCreate) MarshalBinary ¶
func (m *NetworkCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkCreate) UnmarshalBinary ¶
func (m *NetworkCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkCreateConfig ¶
type NetworkCreateConfig struct { // Name is the name of the network. Name string `json:"Name,omitempty"` NetworkCreate }
func (*NetworkCreateConfig) MarshalBinary ¶
func (m *NetworkCreateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (NetworkCreateConfig) MarshalJSON ¶
func (m NetworkCreateConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*NetworkCreateConfig) UnmarshalBinary ¶
func (m *NetworkCreateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*NetworkCreateConfig) UnmarshalJSON ¶
func (m *NetworkCreateConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type NetworkCreateResp ¶
type NetworkCreateResp struct { // ID is the id of the network. ID string `json:"Id,omitempty"` // Warning means the message of create network result. Warning string `json:"Warning,omitempty"` }
func (*NetworkCreateResp) MarshalBinary ¶
func (m *NetworkCreateResp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkCreateResp) UnmarshalBinary ¶
func (m *NetworkCreateResp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkInfo ¶
type NetworkInfo struct { // Driver is the Driver name used to create the network Driver string `json:"Driver,omitempty"` // ID uniquely identifies a network on a single machine ID string `json:"Id,omitempty"` // Name is the name of the network. Name string `json:"Name,omitempty"` // Scope describes the level at which the network exists Scope string `json:"Scope,omitempty"` }
func (*NetworkInfo) MarshalBinary ¶
func (m *NetworkInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkInfo) UnmarshalBinary ¶
func (m *NetworkInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkInspectResp ¶
type NetworkInspectResp struct { // Driver means the network's driver. Driver string `json:"Driver,omitempty"` // EnableIPv6 represents whether to enable IPv6. EnableIPV6 bool `json:"EnableIPv6,omitempty"` // IPAM is the network's IP Address Management. IPAM *IPAM `json:"IPAM,omitempty"` // ID uniquely identifies a network on a single machine ID string `json:"Id,omitempty"` // Internal checks the network is internal network or not. Internal bool `json:"Internal,omitempty"` // Labels holds metadata specific to the network being created. Labels map[string]string `json:"Labels,omitempty"` // Name is the requested name of the network Name string `json:"Name,omitempty"` // Options holds the network specific options to use for when creating the network. Options map[string]string `json:"Options,omitempty"` // Scope describes the level at which the network exists. Scope string `json:"Scope,omitempty"` }
func (*NetworkInspectResp) MarshalBinary ¶
func (m *NetworkInspectResp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkInspectResp) UnmarshalBinary ¶
func (m *NetworkInspectResp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkListResp ¶
type NetworkListResp struct { // List of networks // Required: true Networks []*NetworkInfo `json:"Networks"` // Warnings that occurred when fetching the list of networks // Required: true Warnings []string `json:"Warnings"` }
func (*NetworkListResp) MarshalBinary ¶
func (m *NetworkListResp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkListResp) UnmarshalBinary ¶
func (m *NetworkListResp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkSettings ¶
type NetworkSettings struct { // Name of the network'a bridge (for example, `pouch-br`). Bridge string `json:"Bridge,omitempty"` // Indicates if hairpin NAT should be enabled on the virtual interface HairpinMode bool `json:"HairpinMode,omitempty"` // IPv6 unicast address using the link-local prefix LinkLocalIPV6Address string `json:"LinkLocalIPv6Address,omitempty"` // Prefix length of the IPv6 unicast address. LinkLocalIPV6PrefixLen int64 `json:"LinkLocalIPv6PrefixLen,omitempty"` // Information about all networks that the container is connected to Networks map[string]*EndpointSettings `json:"Networks,omitempty"` // ports Ports PortMap `json:"Ports,omitempty"` // SandboxID uniquely represents a container's network stack. SandboxID string `json:"SandboxID,omitempty"` // SandboxKey identifies the sandbox SandboxKey string `json:"SandboxKey,omitempty"` // secondary IP addresses SecondaryIPAddresses []*IPAddress `json:"SecondaryIPAddresses"` // secondary ipv6 addresses SecondaryIPV6Addresses []*IPAddress `json:"SecondaryIPv6Addresses"` }
func (*NetworkSettings) MarshalBinary ¶
func (m *NetworkSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkSettings) UnmarshalBinary ¶
func (m *NetworkSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkingConfig ¶
type NetworkingConfig struct { // endpoints config EndpointsConfig map[string]*EndpointSettings `json:"EndpointsConfig,omitempty"` }
func (*NetworkingConfig) MarshalBinary ¶
func (m *NetworkingConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkingConfig) UnmarshalBinary ¶
func (m *NetworkingConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PortBinding ¶
type PortBinding struct { // Host IP address that the container's port is mapped to. HostIP string `json:"HostIp,omitempty"` // Host port number that the container's port is mapped to. HostPort string `json:"HostPort,omitempty"` }
func (*PortBinding) MarshalBinary ¶
func (m *PortBinding) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PortBinding) UnmarshalBinary ¶
func (m *PortBinding) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PortMap ¶
type PortMap map[string][]PortBinding
type ProcessConfig ¶
type ProcessConfig struct { // arguments Arguments []string `json:"arguments"` // entrypoint Entrypoint string `json:"entrypoint,omitempty"` // privileged Privileged bool `json:"privileged,omitempty"` // tty Tty bool `json:"tty,omitempty"` // user User string `json:"user,omitempty"` }
func (*ProcessConfig) MarshalBinary ¶
func (m *ProcessConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProcessConfig) UnmarshalBinary ¶
func (m *ProcessConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RegistryServiceConfig ¶
type RegistryServiceConfig struct { // List of IP ranges to which nondistributable artifacts can be pushed, // using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). // // Some images contain artifacts whose distribution is restricted by license. // When these images are pushed to a registry, restricted artifacts are not // included. // // This configuration override this behavior, and enables the daemon to // push nondistributable artifacts to all registries whose resolved IP // address is within the subnet described by the CIDR syntax. // // This option is useful when pushing images containing // nondistributable artifacts to a registry on an air-gapped network so // hosts on that network can pull the images without connecting to // another server. // // > **Warning**: Nondistributable artifacts typically have restrictions // > on how and where they can be distributed and shared. Only use this // > feature to push artifacts to private registries and ensure that you // > are in compliance with any terms that cover redistributing // > nondistributable artifacts. // AllowNondistributableArtifactsCIDRs []string `json:"AllowNondistributableArtifactsCIDRs"` // List of registry hostnames to which nondistributable artifacts can be // pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`. // // Some images (for example, Windows base images) contain artifacts // whose distribution is restricted by license. When these images are // pushed to a registry, restricted artifacts are not included. // // This configuration override this behavior for the specified // registries. // // This option is useful when pushing images containing // nondistributable artifacts to a registry on an air-gapped network so // hosts on that network can pull the images without connecting to // another server. // // > **Warning**: Nondistributable artifacts typically have restrictions // > on how and where they can be distributed and shared. Only use this // > feature to push artifacts to private registries and ensure that you // > are in compliance with any terms that cover redistributing // > nondistributable artifacts. // AllowNondistributableArtifactsHostnames []string `json:"AllowNondistributableArtifactsHostnames"` // index configs IndexConfigs map[string]IndexInfo `json:"IndexConfigs,omitempty"` // List of IP ranges of insecure registries, using the CIDR syntax // ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries // accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates // from unknown CAs) communication. // // By default, local registries (`127.0.0.0/8`) are configured as // insecure. All other registries are secure. Communicating with an // insecure registry is not possible if the daemon assumes that registry // is secure. // // This configuration override this behavior, insecure communication with // registries whose resolved IP address is within the subnet described by // the CIDR syntax. // // Registries can also be marked insecure by hostname. Those registries // are listed under `IndexConfigs` and have their `Secure` field set to // `false`. // // > **Warning**: Using this option can be useful when running a local // > registry, but introduces security vulnerabilities. This option // > should therefore ONLY be used for testing purposes. For increased // > security, users should add their CA to their system's list of trusted // > CAs instead of enabling this option. // InsecureRegistryCIDRs []string `json:"InsecureRegistryCIDRs"` // List of registry URLs that act as a mirror for the official registry. Mirrors []string `json:"Mirrors"` }
func (*RegistryServiceConfig) MarshalBinary ¶
func (m *RegistryServiceConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RegistryServiceConfig) UnmarshalBinary ¶
func (m *RegistryServiceConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResizeOptions ¶
type ResizeOptions struct { // height Height int64 `json:"Height,omitempty"` // width Width int64 `json:"Width,omitempty"` }
func (*ResizeOptions) MarshalBinary ¶
func (m *ResizeOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResizeOptions) UnmarshalBinary ¶
func (m *ResizeOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Resources ¶
type Resources struct { // Limit read rate (bytes per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`. // BlkioDeviceReadBps []*ThrottleDevice `json:"BlkioDeviceReadBps"` // Limit read rate (IO per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`. // BlkioDeviceReadIOps []*ThrottleDevice `json:"BlkioDeviceReadIOps"` // Limit write rate (bytes per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`. // BlkioDeviceWriteBps []*ThrottleDevice `json:"BlkioDeviceWriteBps"` // Limit write rate (IO per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`. // BlkioDeviceWriteIOps []*ThrottleDevice `json:"BlkioDeviceWriteIOps"` // Block IO weight (relative weight). // Maximum: 1000 // Minimum: 0 BlkioWeight uint16 `json:"BlkioWeight,omitempty"` // Block IO weight (relative device weight) in the form `[{"Path": "device_path", "Weight": weight}]`. // BlkioWeightDevice []*WeightDevice `json:"BlkioWeightDevice"` // Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. CgroupParent string `json:"CgroupParent,omitempty"` // The number of usable CPUs (Windows only). // On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. // CPUCount int64 `json:"CpuCount,omitempty"` // The usable percentage of the available CPUs (Windows only). // On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. // CPUPercent int64 `json:"CpuPercent,omitempty"` // CPU CFS (Completely Fair Scheduler) period. // The length of a CPU period in microseconds. // // Maximum: 1e+06 // Minimum: 1000 CPUPeriod int64 `json:"CpuPeriod,omitempty"` // CPU CFS (Completely Fair Scheduler) quota. // Microseconds of CPU time that the container can get in a CPU period." // // Minimum: 1000 CPUQuota int64 `json:"CpuQuota,omitempty"` // The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. CPURealtimePeriod int64 `json:"CpuRealtimePeriod,omitempty"` // The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. CPURealtimeRuntime int64 `json:"CpuRealtimeRuntime,omitempty"` CPUShares int64 `json:"CpuShares,omitempty"` // CPUs in which to allow execution (e.g., `0-3`, `0,1`) CpusetCpus string `json:"CpusetCpus,omitempty"` // Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. CpusetMems string `json:"CpusetMems,omitempty"` // a list of cgroup rules to apply to the container DeviceCgroupRules []string `json:"DeviceCgroupRules"` // A list of devices to add to the container. Devices []*DeviceMapping `json:"Devices"` // Disk limit (in bytes). DiskQuota int64 `json:"DiskQuota,omitempty"` // Maximum IO in bytes per second for the container system drive (Windows only) IOMaximumBandwidth uint64 `json:"IOMaximumBandwidth,omitempty"` // Maximum IOps for the container system drive (Windows only) IOMaximumIOps uint64 `json:"IOMaximumIOps,omitempty"` // IntelRdtL3Cbm specifies settings for Intel RDT/CAT group that the container is placed into to limit the resources (e.g., L3 cache) the container has available. IntelRdtL3Cbm string `json:"IntelRdtL3Cbm,omitempty"` // Kernel memory limit in bytes. KernelMemory int64 `json:"KernelMemory,omitempty"` // Memory limit in bytes. Memory int64 `json:"Memory,omitempty"` // MemoryExtra is an integer value representing this container's memory high water mark percentage. // The range is in [0, 100]. // // Maximum: 100 // Minimum: 0 MemoryExtra *int64 `json:"MemoryExtra,omitempty"` // MemoryForceEmptyCtl represents whether to reclaim the page cache when deleting cgroup. // Maximum: 1 // Minimum: 0 MemoryForceEmptyCtl int64 `json:"MemoryForceEmptyCtl,omitempty"` // Memory soft limit in bytes. MemoryReservation int64 `json:"MemoryReservation,omitempty"` // Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. MemorySwap int64 `json:"MemorySwap,omitempty"` // Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. // Maximum: 100 // Minimum: -1 MemorySwappiness *int64 `json:"MemorySwappiness,omitempty"` // MemoryWmarkRatio is an integer value representing this container's memory low water mark percentage. // The value of memory low water mark is memory.limit_in_bytes * MemoryWmarkRatio. The range is in [0, 100]. // // Maximum: 100 // Minimum: 0 MemoryWmarkRatio *int64 `json:"MemoryWmarkRatio,omitempty"` // CPU quota in units of 10<sup>-9</sup> CPUs. NanoCpus int64 `json:"NanoCPUs,omitempty"` // Disable OOM Killer for the container. OomKillDisable *bool `json:"OomKillDisable,omitempty"` // Tune a container's pids limit. Set -1 for unlimited. Only on Linux 4.4 does this paramter support. // PidsLimit int64 `json:"PidsLimit,omitempty"` // ScheLatSwitch enables scheduler latency count in cpuacct // Maximum: 1 // Minimum: 0 ScheLatSwitch int64 `json:"ScheLatSwitch,omitempty"` // A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`" // Ulimits []*ResourcesUlimitsItems0 `json:"Ulimits"` }
func (*Resources) MarshalBinary ¶
MarshalBinary interface implementation
func (*Resources) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ResourcesUlimitsItems0 ¶
type ResourcesUlimitsItems0 struct { // Hard limit Hard int64 `json:"Hard,omitempty"` // Name of ulimit Name string `json:"Name,omitempty"` // Soft limit Soft int64 `json:"Soft,omitempty"` }
func (*ResourcesUlimitsItems0) MarshalBinary ¶
func (m *ResourcesUlimitsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourcesUlimitsItems0) UnmarshalBinary ¶
func (m *ResourcesUlimitsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RestartPolicy ¶
type RestartPolicy struct { // maximum retry count MaximumRetryCount int64 `json:"MaximumRetryCount,omitempty"` // name Name string `json:"Name,omitempty"` }
func (*RestartPolicy) MarshalBinary ¶
func (m *RestartPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RestartPolicy) UnmarshalBinary ¶
func (m *RestartPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Runtime ¶
type Runtime struct { // Name and, optional, path, of the OCI executable binary. // // If the path is omitted, the daemon searches the host's `$PATH` for the // binary and uses the first result. // Path string `json:"path,omitempty"` // List of command-line arguments to pass to the runtime when invoked. // RuntimeArgs []string `json:"runtimeArgs"` }
func (*Runtime) MarshalBinary ¶
MarshalBinary interface implementation
func (*Runtime) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SearchResultItem ¶
type SearchResultItem struct { // description just shows the description of this image Description string `json:"description,omitempty"` // is_automated means whether this image is automated. IsAutomated bool `json:"is_automated,omitempty"` // is_official shows if this image is marked official. IsOfficial bool `json:"is_official,omitempty"` // name represents the name of this image Name string `json:"name,omitempty"` // star_count refers to the star count of this image. StarCount int64 `json:"star_count,omitempty"` }
func (*SearchResultItem) MarshalBinary ¶
func (m *SearchResultItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SearchResultItem) UnmarshalBinary ¶
func (m *SearchResultItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SnapshotterData ¶
type SnapshotterData struct { // data // Required: true Data map[string]string `json:"Data"` // name // Required: true Name string `json:"Name"` }
func (*SnapshotterData) MarshalBinary ¶
func (m *SnapshotterData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SnapshotterData) UnmarshalBinary ¶
func (m *SnapshotterData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Status ¶
type Status string
const ( // StatusCreated captures enum value "created" StatusCreated Status = "created" // StatusRunning captures enum value "running" StatusRunning Status = "running" // StatusStopped captures enum value "stopped" StatusStopped Status = "stopped" // StatusPaused captures enum value "paused" StatusPaused Status = "paused" // StatusRestarting captures enum value "restarting" StatusRestarting Status = "restarting" // StatusRemoving captures enum value "removing" StatusRemoving Status = "removing" // StatusExited captures enum value "exited" StatusExited Status = "exited" // StatusDead captures enum value "dead" StatusDead Status = "dead" )
type SystemInfo ¶
type SystemInfo struct { // Hardware architecture of the host, as returned by the Go runtime // (`GOARCH`). // // A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment). // Architecture string `json:"Architecture,omitempty"` // The driver to use for managing cgroups. // CgroupDriver string `json:"CgroupDriver,omitempty"` // containerd commit ContainerdCommit *Commit `json:"ContainerdCommit,omitempty"` // Total number of containers on the host. Containers int64 `json:"Containers,omitempty"` // Number of containers with status `"paused"`. // ContainersPaused int64 `json:"ContainersPaused,omitempty"` // Number of containers with status `"running"`. // ContainersRunning int64 `json:"ContainersRunning,omitempty"` // Number of containers with status `"stopped"`. // ContainersStopped int64 `json:"ContainersStopped,omitempty"` // Indicates if the daemon is running in debug-mode / with debug-level logging enabled. Debug bool `json:"Debug,omitempty"` // default registry can be defined by user. // DefaultRegistry string `json:"DefaultRegistry,omitempty"` // Name of the default OCI runtime that is used when starting containers. // The default can be overridden per-container at create time. // DefaultRuntime string `json:"DefaultRuntime,omitempty"` // Name of the storage driver in use. Driver string `json:"Driver,omitempty"` // Information specific to the storage driver, provided as // "label" / "value" pairs. // // This information is provided by the storage driver, and formatted // in a way consistent with the output of `pouch info` on the command // line. // // <p><br /></p> // // > **Note**: The information returned in this field, including the // > formatting of values and labels, should not be considered stable, // > and may change without notice. // DriverStatus [][]string `json:"DriverStatus"` // Indicates if experimental features are enabled on the daemon. // ExperimentalBuild bool `json:"ExperimentalBuild,omitempty"` // HTTP-proxy configured for the daemon. This value is obtained from the // [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. // // Containers do not automatically inherit this configuration. // HTTPProxy string `json:"HttpProxy,omitempty"` // HTTPS-proxy configured for the daemon. This value is obtained from the // [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. // // Containers do not automatically inherit this configuration. // HTTPSProxy string `json:"HttpsProxy,omitempty"` // Unique identifier of the daemon. // // <p><br /></p> // // > **Note**: The format of the ID itself is not part of the API, and // > should not be considered stable. // ID string `json:"ID,omitempty"` // Total number of images on the host. // // Both _tagged_ and _untagged_ (dangling) images are counted. // Images int64 `json:"Images,omitempty"` // Address / URL of the index server that is used for image search, // and as a default for user authentication. // IndexServerAddress string `json:"IndexServerAddress,omitempty"` // Kernel version of the host. // On Linux, this information obtained from `uname`. // KernelVersion string `json:"KernelVersion,omitempty"` // User-defined labels (key/value metadata) as set on the daemon. // Labels []string `json:"Labels"` // List of addresses the pouchd listens on ListenAddresses []string `json:"ListenAddresses"` // Indicates if live restore is enabled. // If enabled, containers are kept running when the daemon is shutdown // or upon daemon start if running containers are detected. // LiveRestoreEnabled bool `json:"LiveRestoreEnabled,omitempty"` // The logging driver to use as a default for new containers. // LoggingDriver string `json:"LoggingDriver,omitempty"` // Total amount of physical memory available on the host, in kilobytes (kB). // MemTotal int64 `json:"MemTotal,omitempty"` // The number of logical CPUs usable by the daemon. // // The number of available CPUs is checked by querying the operating // system when the daemon starts. Changes to operating system CPU // allocation after the daemon is started are not reflected. // NCPU int64 `json:"NCPU,omitempty"` // Hostname of the host. Name string `json:"Name,omitempty"` // Generic type of the operating system of the host, as returned by the // Go runtime (`GOOS`). // // Currently returned value is "linux". A full list of // possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment). // OSType string `json:"OSType,omitempty"` // Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS". // OperatingSystem string `json:"OperatingSystem,omitempty"` // Root directory of persistent Pouch state. // // Defaults to `/var/lib/pouch` on Linux. // PouchRootDir string `json:"PouchRootDir,omitempty"` // registry config RegistryConfig *RegistryServiceConfig `json:"RegistryConfig,omitempty"` // runc commit RuncCommit *Commit `json:"RuncCommit,omitempty"` // List of [OCI compliant](https://github.com/opencontainers/runtime-spec) // runtimes configured on the daemon. Keys hold the "name" used to // reference the runtime. // // The Pouch daemon relies on an OCI compliant runtime (invoked via the // `containerd` daemon) as its interface to the Linux kernel namespaces, // cgroups, and SELinux. // // The default runtime is `runc`, and automatically configured. Additional // runtimes can be configured by the user and will be listed here. // Runtimes map[string]Runtime `json:"Runtimes,omitempty"` // List of security features that are enabled on the daemon, such as // apparmor, seccomp, SELinux, and user-namespaces (userns). // // Additional configuration options for each security feature may // be present, and are included as a comma-separated list of key/value // pairs. // SecurityOptions []string `json:"SecurityOptions"` // Version string of the daemon. // ServerVersion string `json:"ServerVersion,omitempty"` }
func (*SystemInfo) MarshalBinary ¶
func (m *SystemInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SystemInfo) UnmarshalBinary ¶
func (m *SystemInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SystemVersion ¶
type SystemVersion struct { // Api Version held by daemon APIVersion string `json:"ApiVersion,omitempty"` // Arch type of underlying hardware Arch string `json:"Arch,omitempty"` // The time when this binary of daemon is built BuildTime string `json:"BuildTime,omitempty"` // Commit ID held by the latest commit operation GitCommit string `json:"GitCommit,omitempty"` // version of Go runtime GoVersion string `json:"GoVersion,omitempty"` // Operating system kernel version KernelVersion string `json:"KernelVersion,omitempty"` // Operating system type of underlying system Os string `json:"Os,omitempty"` // version of Pouch Daemon Version string `json:"Version,omitempty"` }
func (*SystemVersion) MarshalBinary ¶
func (m *SystemVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SystemVersion) UnmarshalBinary ¶
func (m *SystemVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ThrottleDevice ¶
type ThrottleDevice struct { // Device path Path string `json:"Path,omitempty"` // Rate // Minimum: 0 Rate uint64 `json:"Rate,omitempty"` }
func (*ThrottleDevice) MarshalBinary ¶
func (m *ThrottleDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ThrottleDevice) UnmarshalBinary ¶
func (m *ThrottleDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateConfig ¶
type UpdateConfig struct { Resources // A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. // Env []string `json:"Env"` // Image ID or Name Image string `json:"Image,omitempty"` // List of labels set to container. Labels map[string]string `json:"Labels,omitempty"` // restart policy RestartPolicy *RestartPolicy `json:"RestartPolicy,omitempty"` }
func (*UpdateConfig) MarshalBinary ¶
func (m *UpdateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (UpdateConfig) MarshalJSON ¶
func (m UpdateConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*UpdateConfig) UnmarshalBinary ¶
func (m *UpdateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*UpdateConfig) UnmarshalJSON ¶
func (m *UpdateConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type VolumeCreateConfig ¶
type VolumeCreateConfig struct { // Name of the volume driver to use. Driver string `json:"Driver,omitempty"` // A mapping of driver options and values. These options are passed directly to the driver and are driver specific. DriverOpts map[string]string `json:"DriverOpts,omitempty"` // User-defined key/value metadata. Labels map[string]string `json:"Labels,omitempty"` // The new volume's name. If not specified, Pouch generates a name. Name string `json:"Name,omitempty"` }
func (*VolumeCreateConfig) MarshalBinary ¶
func (m *VolumeCreateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeCreateConfig) UnmarshalBinary ¶
func (m *VolumeCreateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VolumeInfo ¶
type VolumeInfo struct { // Date/Time the volume was created. CreatedAt string `json:"CreatedAt,omitempty"` // Driver is the Driver name used to create the volume. Driver string `json:"Driver,omitempty"` // Labels is metadata specific to the volume. Labels map[string]string `json:"Labels,omitempty"` // Mountpoint is the location on disk of the volume. Mountpoint string `json:"Mountpoint,omitempty"` // Name is the name of the volume. Name string `json:"Name,omitempty"` // Scope describes the level at which the volume exists // (e.g. `global` for cluster-wide or `local` for machine level) // Scope string `json:"Scope,omitempty"` // Status provides low-level status information about the volume. Status map[string]interface{} `json:"Status,omitempty"` }
func (*VolumeInfo) MarshalBinary ¶
func (m *VolumeInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeInfo) UnmarshalBinary ¶
func (m *VolumeInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VolumeListResp ¶
type VolumeListResp struct { // List of volumes // Required: true Volumes []*VolumeInfo `json:"Volumes"` // Warnings that occurred when fetching the list of volumes // Required: true Warnings []string `json:"Warnings"` }
func (*VolumeListResp) MarshalBinary ¶
func (m *VolumeListResp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeListResp) UnmarshalBinary ¶
func (m *VolumeListResp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WeightDevice ¶
type WeightDevice struct { // Weight Device Path string `json:"Path,omitempty"` // weight // Minimum: 0 Weight uint16 `json:"Weight,omitempty"` }
func (*WeightDevice) MarshalBinary ¶
func (m *WeightDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WeightDevice) UnmarshalBinary ¶
func (m *WeightDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files ¶
- auth_config.go
- auth_response.go
- commit.go
- container.go
- container_config.go
- container_create_config.go
- container_create_resp.go
- container_exec_inspect.go
- container_json.go
- container_logs_options.go
- container_process_list.go
- container_state.go
- container_upgrade_config.go
- daemon_update_config.go
- device_mapping.go
- endpoint_ip_a_m_config.go
- endpoint_settings.go
- error.go
- exec_create_config.go
- exec_create_resp.go
- exec_start_config.go
- graph_driver_data.go
- host_config.go
- image_info.go
- index_info.go
- ip_a_m.go
- ip_a_m_config.go
- ip_address.go
- mount_point.go
- network_create.go
- network_create_config.go
- network_create_resp.go
- network_info.go
- network_inspect_resp.go
- network_list_resp.go
- network_settings.go
- networking_config.go
- port_binding.go
- port_map.go
- process_config.go
- registry_service_config.go
- resize_options.go
- resources.go
- restart_policy.go
- runtime.go
- search_result_item.go
- snapshotter_data.go
- status.go
- system_info.go
- system_version.go
- throttle_device.go
- update_config.go
- volume_create_config.go
- volume_info.go
- volume_list_resp.go
- weight_device.go