`.
- For instance, if container name is `my.ctr` and the network is named
- `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be
- `my.ctr.testnet`.
- type: array
- items:
- type: string
- example: ["foobar", "server_x", "server_y", "my.ctr"]
-
- EndpointIPAMConfig:
- description: |
- EndpointIPAMConfig represents an endpoint's IPAM configuration.
- type: "object"
- x-nullable: true
- properties:
- IPv4Address:
- type: "string"
- example: "172.20.30.33"
- IPv6Address:
- type: "string"
- example: "2001:db8:abcd::3033"
- LinkLocalIPs:
- type: "array"
- items:
- type: "string"
- example:
- - "169.254.34.68"
- - "fe80::3468"
-
- PluginMount:
- type: "object"
- x-nullable: false
- required: [Name, Description, Settable, Source, Destination, Type, Options]
- properties:
- Name:
- type: "string"
- x-nullable: false
- example: "some-mount"
- Description:
- type: "string"
- x-nullable: false
- example: "This is a mount that's used by the plugin."
- Settable:
- type: "array"
- items:
- type: "string"
- Source:
- type: "string"
- example: "/var/lib/docker/plugins/"
- Destination:
- type: "string"
- x-nullable: false
- example: "/mnt/state"
- Type:
- type: "string"
- x-nullable: false
- example: "bind"
- Options:
- type: "array"
- items:
- type: "string"
- example:
- - "rbind"
- - "rw"
-
- PluginDevice:
- type: "object"
- required: [Name, Description, Settable, Path]
- x-nullable: false
- properties:
- Name:
- type: "string"
- x-nullable: false
- Description:
- type: "string"
- x-nullable: false
- Settable:
- type: "array"
- items:
- type: "string"
- Path:
- type: "string"
- example: "/dev/fuse"
-
- PluginEnv:
- type: "object"
- x-nullable: false
- required: [Name, Description, Settable, Value]
- properties:
- Name:
- x-nullable: false
- type: "string"
- Description:
- x-nullable: false
- type: "string"
- Settable:
- type: "array"
- items:
- type: "string"
- Value:
- type: "string"
-
- PluginInterfaceType:
- type: "object"
- x-nullable: false
- required: [Prefix, Capability, Version]
- properties:
- Prefix:
- type: "string"
- x-nullable: false
- Capability:
- type: "string"
- x-nullable: false
- Version:
- type: "string"
- x-nullable: false
-
- PluginPrivilege:
- description: |
- Describes a permission the user has to accept upon installing
- the plugin.
- type: "object"
- x-go-name: "PluginPrivilege"
- properties:
- Name:
- type: "string"
- example: "network"
- Description:
- type: "string"
- Value:
- type: "array"
- items:
- type: "string"
- example:
- - "host"
-
- Plugin:
- description: "A plugin for the Engine API"
- type: "object"
- required: [Settings, Enabled, Config, Name]
- properties:
- Id:
- type: "string"
- example: "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078"
- Name:
- type: "string"
- x-nullable: false
- example: "tiborvass/sample-volume-plugin"
- Enabled:
- description:
- True if the plugin is running. False if the plugin is not running,
- only installed.
- type: "boolean"
- x-nullable: false
- example: true
- Settings:
- description: "Settings that can be modified by users."
- type: "object"
- x-nullable: false
- required: [Args, Devices, Env, Mounts]
- properties:
- Mounts:
- type: "array"
- items:
- $ref: "#/definitions/PluginMount"
- Env:
- type: "array"
- items:
- type: "string"
- example:
- - "DEBUG=0"
- Args:
- type: "array"
- items:
- type: "string"
- Devices:
- type: "array"
- items:
- $ref: "#/definitions/PluginDevice"
- PluginReference:
- description: "plugin remote reference used to push/pull the plugin"
- type: "string"
- x-nullable: false
- example: "localhost:5000/tiborvass/sample-volume-plugin:latest"
- Config:
- description: "The config of a plugin."
- type: "object"
- x-nullable: false
- required:
- - Description
- - Documentation
- - Interface
- - Entrypoint
- - WorkDir
- - Network
- - Linux
- - PidHost
- - PropagatedMount
- - IpcHost
- - Mounts
- - Env
- - Args
- properties:
- DockerVersion:
- description: |-
- Docker Version used to create the plugin.
-
- Depending on how the plugin was created, this field may be empty or omitted.
-
- Deprecated: this field is no longer set, and will be removed in the next API version.
- type: "string"
- x-nullable: false
- x-omitempty: true
- Description:
- type: "string"
- x-nullable: false
- example: "A sample volume plugin for Docker"
- Documentation:
- type: "string"
- x-nullable: false
- example: "https://docs.docker.com/engine/extend/plugins/"
- Interface:
- description: "The interface between Docker and the plugin"
- x-nullable: false
- type: "object"
- required: [Types, Socket]
- properties:
- Types:
- type: "array"
- items:
- $ref: "#/definitions/PluginInterfaceType"
- example:
- - "docker.volumedriver/1.0"
- Socket:
- type: "string"
- x-nullable: false
- example: "plugins.sock"
- ProtocolScheme:
- type: "string"
- example: "some.protocol/v1.0"
- description: "Protocol to use for clients connecting to the plugin."
- enum:
- - ""
- - "moby.plugins.http/v1"
- Entrypoint:
- type: "array"
- items:
- type: "string"
- example:
- - "/usr/bin/sample-volume-plugin"
- - "/data"
- WorkDir:
- type: "string"
- x-nullable: false
- example: "/bin/"
- User:
- type: "object"
- x-nullable: false
- properties:
- UID:
- type: "integer"
- format: "uint32"
- example: 1000
- GID:
- type: "integer"
- format: "uint32"
- example: 1000
- Network:
- type: "object"
- x-nullable: false
- required: [Type]
- properties:
- Type:
- x-nullable: false
- type: "string"
- example: "host"
- Linux:
- type: "object"
- x-nullable: false
- required: [Capabilities, AllowAllDevices, Devices]
- properties:
- Capabilities:
- type: "array"
- items:
- type: "string"
- example:
- - "CAP_SYS_ADMIN"
- - "CAP_SYSLOG"
- AllowAllDevices:
- type: "boolean"
- x-nullable: false
- example: false
- Devices:
- type: "array"
- items:
- $ref: "#/definitions/PluginDevice"
- PropagatedMount:
- type: "string"
- x-nullable: false
- example: "/mnt/volumes"
- IpcHost:
- type: "boolean"
- x-nullable: false
- example: false
- PidHost:
- type: "boolean"
- x-nullable: false
- example: false
- Mounts:
- type: "array"
- items:
- $ref: "#/definitions/PluginMount"
- Env:
- type: "array"
- items:
- $ref: "#/definitions/PluginEnv"
- example:
- - Name: "DEBUG"
- Description: "If set, prints debug messages"
- Settable: null
- Value: "0"
- Args:
- type: "object"
- x-nullable: false
- required: [Name, Description, Settable, Value]
- properties:
- Name:
- x-nullable: false
- type: "string"
- example: "args"
- Description:
- x-nullable: false
- type: "string"
- example: "command line arguments"
- Settable:
- type: "array"
- items:
- type: "string"
- Value:
- type: "array"
- items:
- type: "string"
- rootfs:
- type: "object"
- properties:
- type:
- type: "string"
- example: "layers"
- diff_ids:
- type: "array"
- items:
- type: "string"
- example:
- - "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887"
- - "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"
-
- ObjectVersion:
- description: |
- The version number of the object such as node, service, etc. This is needed
- to avoid conflicting writes. The client must send the version number along
- with the modified specification when updating these objects.
-
- This approach ensures safe concurrency and determinism in that the change
- on the object may not be applied if the version number has changed from the
- last read. In other words, if two update requests specify the same base
- version, only one of the requests can succeed. As a result, two separate
- update requests that happen at the same time will not unintentionally
- overwrite each other.
- type: "object"
- properties:
- Index:
- type: "integer"
- format: "uint64"
- example: 373531
-
- NodeSpec:
- type: "object"
- properties:
- Name:
- description: "Name for the node."
- type: "string"
- example: "my-node"
- Labels:
- description: "User-defined key/value metadata."
- type: "object"
- additionalProperties:
- type: "string"
- Role:
- description: "Role of the node."
- type: "string"
- enum:
- - "worker"
- - "manager"
- example: "manager"
- Availability:
- description: "Availability of the node."
- type: "string"
- enum:
- - "active"
- - "pause"
- - "drain"
- example: "active"
- example:
- Availability: "active"
- Name: "node-name"
- Role: "manager"
- Labels:
- foo: "bar"
-
- Node:
- type: "object"
- properties:
- ID:
- type: "string"
- example: "24ifsmvkjbyhk"
- Version:
- $ref: "#/definitions/ObjectVersion"
- CreatedAt:
- description: |
- Date and time at which the node was added to the swarm in
- [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
- type: "string"
- format: "dateTime"
- example: "2016-08-18T10:44:24.496525531Z"
- UpdatedAt:
- description: |
- Date and time at which the node was last updated in
- [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
- type: "string"
- format: "dateTime"
- example: "2017-08-09T07:09:37.632105588Z"
- Spec:
- $ref: "#/definitions/NodeSpec"
- Description:
- $ref: "#/definitions/NodeDescription"
- Status:
- $ref: "#/definitions/NodeStatus"
- ManagerStatus:
- $ref: "#/definitions/ManagerStatus"
-
- NodeDescription:
- description: |
- NodeDescription encapsulates the properties of the Node as reported by the
- agent.
- type: "object"
- properties:
- Hostname:
- type: "string"
- example: "bf3067039e47"
- Platform:
- $ref: "#/definitions/Platform"
- Resources:
- $ref: "#/definitions/ResourceObject"
- Engine:
- $ref: "#/definitions/EngineDescription"
- TLSInfo:
- $ref: "#/definitions/TLSInfo"
-
- Platform:
- description: |
- Platform represents the platform (Arch/OS).
- type: "object"
- properties:
- Architecture:
- description: |
- Architecture represents the hardware architecture (for example,
- `x86_64`).
- type: "string"
- example: "x86_64"
- OS:
- description: |
- OS represents the Operating System (for example, `linux` or `windows`).
- type: "string"
- example: "linux"
-
- EngineDescription:
- description: "EngineDescription provides information about an engine."
- type: "object"
- properties:
- EngineVersion:
- type: "string"
- example: "17.06.0"
- Labels:
- type: "object"
- additionalProperties:
- type: "string"
- example:
- foo: "bar"
- Plugins:
- type: "array"
- items:
- type: "object"
- properties:
- Type:
- type: "string"
- Name:
- type: "string"
- example:
- - Type: "Log"
- Name: "awslogs"
- - Type: "Log"
- Name: "fluentd"
- - Type: "Log"
- Name: "gcplogs"
- - Type: "Log"
- Name: "gelf"
- - Type: "Log"
- Name: "journald"
- - Type: "Log"
- Name: "json-file"
- - Type: "Log"
- Name: "splunk"
- - Type: "Log"
- Name: "syslog"
- - Type: "Network"
- Name: "bridge"
- - Type: "Network"
- Name: "host"
- - Type: "Network"
- Name: "ipvlan"
- - Type: "Network"
- Name: "macvlan"
- - Type: "Network"
- Name: "null"
- - Type: "Network"
- Name: "overlay"
- - Type: "Volume"
- Name: "local"
- - Type: "Volume"
- Name: "localhost:5000/vieux/sshfs:latest"
- - Type: "Volume"
- Name: "vieux/sshfs:latest"
-
- TLSInfo:
- description: |
- Information about the issuer of leaf TLS certificates and the trusted root
- CA certificate.
- type: "object"
- properties:
- TrustRoot:
- description: |
- The root CA certificate(s) that are used to validate leaf TLS
- certificates.
- type: "string"
- CertIssuerSubject:
- description:
- The base64-url-safe-encoded raw subject bytes of the issuer.
- type: "string"
- CertIssuerPublicKey:
- description: |
- The base64-url-safe-encoded raw public key bytes of the issuer.
- type: "string"
- example:
- TrustRoot: |
- -----BEGIN CERTIFICATE-----
- MIIBajCCARCgAwIBAgIUbYqrLSOSQHoxD8CwG6Bi2PJi9c8wCgYIKoZIzj0EAwIw
- EzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNDI0MjE0MzAwWhcNMzcwNDE5MjE0
- MzAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH
- A0IABJk/VyMPYdaqDXJb/VXh5n/1Yuv7iNrxV3Qb3l06XD46seovcDWs3IZNV1lf
- 3Skyr0ofcchipoiHkXBODojJydSjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB
- Af8EBTADAQH/MB0GA1UdDgQWBBRUXxuRcnFjDfR/RIAUQab8ZV/n4jAKBggqhkjO
- PQQDAgNIADBFAiAy+JTe6Uc3KyLCMiqGl2GyWGQqQDEcO3/YG36x7om65AIhAJvz
- pxv6zFeVEkAEEkqIYi0omA9+CjanB/6Bz4n1uw8H
- -----END CERTIFICATE-----
- CertIssuerSubject: "MBMxETAPBgNVBAMTCHN3YXJtLWNh"
- CertIssuerPublicKey: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A=="
-
- NodeStatus:
- description: |
- NodeStatus represents the status of a node.
-
- It provides the current status of the node, as seen by the manager.
- type: "object"
- properties:
- State:
- $ref: "#/definitions/NodeState"
- Message:
- type: "string"
- example: ""
- Addr:
- description: "IP address of the node."
- type: "string"
- example: "172.17.0.2"
-
- NodeState:
- description: "NodeState represents the state of a node."
- type: "string"
- enum:
- - "unknown"
- - "down"
- - "ready"
- - "disconnected"
- example: "ready"
-
- ManagerStatus:
- description: |
- ManagerStatus represents the status of a manager.
-
- It provides the current status of a node's manager component, if the node
- is a manager.
- x-nullable: true
- type: "object"
- properties:
- Leader:
- type: "boolean"
- default: false
- example: true
- Reachability:
- $ref: "#/definitions/Reachability"
- Addr:
- description: |
- The IP address and port at which the manager is reachable.
- type: "string"
- example: "10.0.0.46:2377"
-
- Reachability:
- description: "Reachability represents the reachability of a node."
- type: "string"
- enum:
- - "unknown"
- - "unreachable"
- - "reachable"
- example: "reachable"
-
- SwarmSpec:
- description: "User modifiable swarm configuration."
- type: "object"
- properties:
- Name:
- description: "Name of the swarm."
- type: "string"
- example: "default"
- Labels:
- description: "User-defined key/value metadata."
- type: "object"
- additionalProperties:
- type: "string"
- example:
- com.example.corp.type: "production"
- com.example.corp.department: "engineering"
- Orchestration:
- description: "Orchestration configuration."
- type: "object"
- x-nullable: true
- properties:
- TaskHistoryRetentionLimit:
- description: |
- The number of historic tasks to keep per instance or node. If
- negative, never remove completed or failed tasks.
- type: "integer"
- format: "int64"
- example: 10
- Raft:
- description: "Raft configuration."
- type: "object"
- properties:
- SnapshotInterval:
- description: "The number of log entries between snapshots."
- type: "integer"
- format: "uint64"
- example: 10000
- KeepOldSnapshots:
- description: |
- The number of snapshots to keep beyond the current snapshot.
- type: "integer"
- format: "uint64"
- LogEntriesForSlowFollowers:
- description: |
- The number of log entries to keep around to sync up slow followers
- after a snapshot is created.
- type: "integer"
- format: "uint64"
- example: 500
- ElectionTick:
- description: |
- The number of ticks that a follower will wait for a message from
- the leader before becoming a candidate and starting an election.
- `ElectionTick` must be greater than `HeartbeatTick`.
-
- A tick currently defaults to one second, so these translate
- directly to seconds currently, but this is NOT guaranteed.
- type: "integer"
- example: 3
- HeartbeatTick:
- description: |
- The number of ticks between heartbeats. Every HeartbeatTick ticks,
- the leader will send a heartbeat to the followers.
-
- A tick currently defaults to one second, so these translate
- directly to seconds currently, but this is NOT guaranteed.
- type: "integer"
- example: 1
- Dispatcher:
- description: "Dispatcher configuration."
- type: "object"
- x-nullable: true
- properties:
- HeartbeatPeriod:
- description: |
- The delay for an agent to send a heartbeat to the dispatcher.
- type: "integer"
- format: "int64"
- example: 5000000000
- CAConfig:
- description: "CA configuration."
- type: "object"
- x-nullable: true
- properties:
- NodeCertExpiry:
- description: "The duration node certificates are issued for."
- type: "integer"
- format: "int64"
- example: 7776000000000000
- ExternalCAs:
- description: |
- Configuration for forwarding signing requests to an external
- certificate authority.
- type: "array"
- items:
- type: "object"
- properties:
- Protocol:
- description: |
- Protocol for communication with the external CA (currently
- only `cfssl` is supported).
- type: "string"
- enum:
- - "cfssl"
- default: "cfssl"
- URL:
- description: |
- URL where certificate signing requests should be sent.
- type: "string"
- Options:
- description: |
- An object with key/value pairs that are interpreted as
- protocol-specific options for the external CA driver.
- type: "object"
- additionalProperties:
- type: "string"
- CACert:
- description: |
- The root CA certificate (in PEM format) this external CA uses
- to issue TLS certificates (assumed to be to the current swarm
- root CA certificate if not provided).
- type: "string"
- SigningCACert:
- description: |
- The desired signing CA certificate for all swarm node TLS leaf
- certificates, in PEM format.
- type: "string"
- SigningCAKey:
- description: |
- The desired signing CA key for all swarm node TLS leaf certificates,
- in PEM format.
- type: "string"
- ForceRotate:
- description: |
- An integer whose purpose is to force swarm to generate a new
- signing CA certificate and key, if none have been specified in
- `SigningCACert` and `SigningCAKey`
- format: "uint64"
- type: "integer"
- EncryptionConfig:
- description: "Parameters related to encryption-at-rest."
- type: "object"
- properties:
- AutoLockManagers:
- description: |
- If set, generate a key and use it to lock data stored on the
- managers.
- type: "boolean"
- example: false
- TaskDefaults:
- description: "Defaults for creating tasks in this cluster."
- type: "object"
- properties:
- LogDriver:
- description: |
- The log driver to use for tasks created in the orchestrator if
- unspecified by a service.
-
- Updating this value only affects new tasks. Existing tasks continue
- to use their previously configured log driver until recreated.
- type: "object"
- properties:
- Name:
- description: |
- The log driver to use as a default for new tasks.
- type: "string"
- example: "json-file"
- Options:
- description: |
- Driver-specific options for the selected log driver, specified
- as key/value pairs.
- type: "object"
- additionalProperties:
- type: "string"
- example:
- "max-file": "10"
- "max-size": "100m"
-
- # The Swarm information for `GET /info`. It is the same as `GET /swarm`, but
- # without `JoinTokens`.
- ClusterInfo:
- description: |
- ClusterInfo represents information about the swarm as is returned by the
- "/info" endpoint. Join-tokens are not included.
- x-nullable: true
- type: "object"
- properties:
- ID:
- description: "The ID of the swarm."
- type: "string"
- example: "abajmipo7b4xz5ip2nrla6b11"
- Version:
- $ref: "#/definitions/ObjectVersion"
- CreatedAt:
- description: |
- Date and time at which the swarm was initialised in
- [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
- type: "string"
- format: "dateTime"
- example: "2016-08-18T10:44:24.496525531Z"
- UpdatedAt:
- description: |
- Date and time at which the swarm was last updated in
- [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
- type: "string"
- format: "dateTime"
- example: "2017-08-09T07:09:37.632105588Z"
- Spec:
- $ref: "#/definitions/SwarmSpec"
- TLSInfo:
- $ref: "#/definitions/TLSInfo"
- RootRotationInProgress:
- description: |
- Whether there is currently a root CA rotation in progress for the swarm
- type: "boolean"
- example: false
- DataPathPort:
- description: |
- DataPathPort specifies the data path port number for data traffic.
- Acceptable port range is 1024 to 49151.
- If no port is set or is set to 0, the default port (4789) is used.
- type: "integer"
- format: "uint32"
- default: 4789
- example: 4789
- DefaultAddrPool:
- description: |
- Default Address Pool specifies default subnet pools for global scope
- networks.
- type: "array"
- items:
- type: "string"
- format: "CIDR"
- example: ["10.10.0.0/16", "20.20.0.0/16"]
- SubnetSize:
- description: |
- SubnetSize specifies the subnet size of the networks created from the
- default subnet pool.
- type: "integer"
- format: "uint32"
- maximum: 29
- default: 24
- example: 24
-
- JoinTokens:
- description: |
- JoinTokens contains the tokens workers and managers need to join the swarm.
- type: "object"
- properties:
- Worker:
- description: |
- The token workers can use to join the swarm.
- type: "string"
- example: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx"
- Manager:
- description: |
- The token managers can use to join the swarm.
- type: "string"
- example: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"
-
- Swarm:
- type: "object"
- allOf:
- - $ref: "#/definitions/ClusterInfo"
- - type: "object"
- properties:
- JoinTokens:
- $ref: "#/definitions/JoinTokens"
-
- TaskSpec:
- description: "User modifiable task configuration."
- type: "object"
- properties:
- PluginSpec:
- type: "object"
- description: |
- Plugin spec for the service. *(Experimental release only.)*
-
-
-
- > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are
- > mutually exclusive. PluginSpec is only used when the Runtime field
- > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime
- > field is set to `attachment`.
- properties:
- Name:
- description: "The name or 'alias' to use for the plugin."
- type: "string"
- Remote:
- description: "The plugin image reference to use."
- type: "string"
- Disabled:
- description: "Disable the plugin once scheduled."
- type: "boolean"
- PluginPrivilege:
- type: "array"
- items:
- $ref: "#/definitions/PluginPrivilege"
- ContainerSpec:
- type: "object"
- description: |
- Container spec for the service.
-
-
-
- > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are
- > mutually exclusive. PluginSpec is only used when the Runtime field
- > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime
- > field is set to `attachment`.
- properties:
- Image:
- description: "The image name to use for the container"
- type: "string"
- Labels:
- description: "User-defined key/value data."
- type: "object"
- additionalProperties:
- type: "string"
- Command:
- description: "The command to be run in the image."
- type: "array"
- items:
- type: "string"
- Args:
- description: "Arguments to the command."
- type: "array"
- items:
- type: "string"
- Hostname:
- description: |
- The hostname to use for the container, as a valid
- [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname.
- type: "string"
- Env:
- description: |
- A list of environment variables in the form `VAR=value`.
- type: "array"
- items:
- type: "string"
- Dir:
- description: "The working directory for commands to run in."
- type: "string"
- User:
- description: "The user inside the container."
- type: "string"
- Groups:
- type: "array"
- description: |
- A list of additional groups that the container process will run as.
- items:
- type: "string"
- Privileges:
- type: "object"
- description: "Security options for the container"
- properties:
- CredentialSpec:
- type: "object"
- description: "CredentialSpec for managed service account (Windows only)"
- properties:
- Config:
- type: "string"
- example: "0bt9dmxjvjiqermk6xrop3ekq"
- description: |
- Load credential spec from a Swarm Config with the given ID.
- The specified config must also be present in the Configs
- field with the Runtime property set.
-
-
-
-
- > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`,
- > and `CredentialSpec.Config` are mutually exclusive.
- File:
- type: "string"
- example: "spec.json"
- description: |
- Load credential spec from this file. The file is read by
- the daemon, and must be present in the `CredentialSpecs`
- subdirectory in the docker data directory, which defaults
- to `C:\ProgramData\Docker\` on Windows.
-
- For example, specifying `spec.json` loads
- `C:\ProgramData\Docker\CredentialSpecs\spec.json`.
-
-
-
- > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`,
- > and `CredentialSpec.Config` are mutually exclusive.
- Registry:
- type: "string"
- description: |
- Load credential spec from this value in the Windows
- registry. The specified registry value must be located in:
-
- `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs`
-
-
-
-
- > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`,
- > and `CredentialSpec.Config` are mutually exclusive.
- SELinuxContext:
- type: "object"
- description: "SELinux labels of the container"
- properties:
- Disable:
- type: "boolean"
- description: "Disable SELinux"
- User:
- type: "string"
- description: "SELinux user label"
- Role:
- type: "string"
- description: "SELinux role label"
- Type:
- type: "string"
- description: "SELinux type label"
- Level:
- type: "string"
- description: "SELinux level label"
- Seccomp:
- type: "object"
- description: "Options for configuring seccomp on the container"
- properties:
- Mode:
- type: "string"
- enum:
- - "default"
- - "unconfined"
- - "custom"
- Profile:
- description: "The custom seccomp profile as a json object"
- type: "string"
- AppArmor:
- type: "object"
- description: "Options for configuring AppArmor on the container"
- properties:
- Mode:
- type: "string"
- enum:
- - "default"
- - "disabled"
- NoNewPrivileges:
- type: "boolean"
- description: "Configuration of the no_new_privs bit in the container"
-
- TTY:
- description: "Whether a pseudo-TTY should be allocated."
- type: "boolean"
- OpenStdin:
- description: "Open `stdin`"
- type: "boolean"
- ReadOnly:
- description: "Mount the container's root filesystem as read only."
- type: "boolean"
- Mounts:
- description: |
- Specification for mounts to be added to containers created as part
- of the service.
- type: "array"
- items:
- $ref: "#/definitions/Mount"
- StopSignal:
- description: "Signal to stop the container."
- type: "string"
- StopGracePeriod:
- description: |
- Amount of time to wait for the container to terminate before
- forcefully killing it.
- type: "integer"
- format: "int64"
- HealthCheck:
- $ref: "#/definitions/HealthConfig"
- Hosts:
- type: "array"
- description: |
- A list of hostname/IP mappings to add to the container's `hosts`
- file. The format of extra hosts is specified in the
- [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html)
- man page:
-
- IP_address canonical_hostname [aliases...]
- items:
- type: "string"
- DNSConfig:
- description: |
- Specification for DNS related configurations in resolver configuration
- file (`resolv.conf`).
- type: "object"
- properties:
- Nameservers:
- description: "The IP addresses of the name servers."
- type: "array"
- items:
- type: "string"
- Search:
- description: "A search list for host-name lookup."
- type: "array"
- items:
- type: "string"
- Options:
- description: |
- A list of internal resolver variables to be modified (e.g.,
- `debug`, `ndots:3`, etc.).
- type: "array"
- items:
- type: "string"
- Secrets:
- description: |
- Secrets contains references to zero or more secrets that will be
- exposed to the service.
- type: "array"
- items:
- type: "object"
- properties:
- File:
- description: |
- File represents a specific target that is backed by a file.
- type: "object"
- properties:
- Name:
- description: |
- Name represents the final filename in the filesystem.
- type: "string"
- UID:
- description: "UID represents the file UID."
- type: "string"
- GID:
- description: "GID represents the file GID."
- type: "string"
- Mode:
- description: "Mode represents the FileMode of the file."
- type: "integer"
- format: "uint32"
- SecretID:
- description: |
- SecretID represents the ID of the specific secret that we're
- referencing.
- type: "string"
- SecretName:
- description: |
- SecretName is the name of the secret that this references,
- but this is just provided for lookup/display purposes. The
- secret in the reference will be identified by its ID.
- type: "string"
- OomScoreAdj:
- type: "integer"
- format: "int64"
- description: |
- An integer value containing the score given to the container in
- order to tune OOM killer preferences.
- example: 0
- Configs:
- description: |
- Configs contains references to zero or more configs that will be
- exposed to the service.
- type: "array"
- items:
- type: "object"
- properties:
- File:
- description: |
- File represents a specific target that is backed by a file.
-
-
-
- > **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive
- type: "object"
- properties:
- Name:
- description: |
- Name represents the final filename in the filesystem.
- type: "string"
- UID:
- description: "UID represents the file UID."
- type: "string"
- GID:
- description: "GID represents the file GID."
- type: "string"
- Mode:
- description: "Mode represents the FileMode of the file."
- type: "integer"
- format: "uint32"
- Runtime:
- description: |
- Runtime represents a target that is not mounted into the
- container but is used by the task
-
-
-
- > **Note**: `Configs.File` and `Configs.Runtime` are mutually
- > exclusive
- type: "object"
- ConfigID:
- description: |
- ConfigID represents the ID of the specific config that we're
- referencing.
- type: "string"
- ConfigName:
- description: |
- ConfigName is the name of the config that this references,
- but this is just provided for lookup/display purposes. The
- config in the reference will be identified by its ID.
- type: "string"
- Isolation:
- type: "string"
- description: |
- Isolation technology of the containers running the service.
- (Windows only)
- enum:
- - "default"
- - "process"
- - "hyperv"
- - ""
- Init:
- description: |
- Run an init inside the container that forwards signals and reaps
- processes. This field is omitted if empty, and the default (as
- configured on the daemon) is used.
- type: "boolean"
- x-nullable: true
- Sysctls:
- description: |
- Set kernel namedspaced parameters (sysctls) in the container.
- The Sysctls option on services accepts the same sysctls as the
- are supported on containers. Note that while the same sysctls are
- supported, no guarantees or checks are made about their
- suitability for a clustered environment, and it's up to the user
- to determine whether a given sysctl will work properly in a
- Service.
- type: "object"
- additionalProperties:
- type: "string"
- # This option is not used by Windows containers
- CapabilityAdd:
- type: "array"
- description: |
- A list of kernel capabilities to add to the default set
- for the container.
- items:
- type: "string"
- example:
- - "CAP_NET_RAW"
- - "CAP_SYS_ADMIN"
- - "CAP_SYS_CHROOT"
- - "CAP_SYSLOG"
- CapabilityDrop:
- type: "array"
- description: |
- A list of kernel capabilities to drop from the default set
- for the container.
- items:
- type: "string"
- example:
- - "CAP_NET_RAW"
- Ulimits:
- description: |
- A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`"
- type: "array"
- items:
- type: "object"
- properties:
- Name:
- description: "Name of ulimit"
- type: "string"
- Soft:
- description: "Soft limit"
- type: "integer"
- Hard:
- description: "Hard limit"
- type: "integer"
- NetworkAttachmentSpec:
- description: |
- Read-only spec type for non-swarm containers attached to swarm overlay
- networks.
-
-
-
- > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are
- > mutually exclusive. PluginSpec is only used when the Runtime field
- > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime
- > field is set to `attachment`.
- type: "object"
- properties:
- ContainerID:
- description: "ID of the container represented by this task"
- type: "string"
- Resources:
- description: |
- Resource requirements which apply to each individual container created
- as part of the service.
- type: "object"
- properties:
- Limits:
- description: "Define resources limits."
- $ref: "#/definitions/Limit"
- Reservations:
- description: "Define resources reservation."
- $ref: "#/definitions/ResourceObject"
- RestartPolicy:
- description: |
- Specification for the restart policy which applies to containers
- created as part of this service.
- type: "object"
- properties:
- Condition:
- description: "Condition for restart."
- type: "string"
- enum:
- - "none"
- - "on-failure"
- - "any"
- Delay:
- description: "Delay between restart attempts."
- type: "integer"
- format: "int64"
- MaxAttempts:
- description: |
- Maximum attempts to restart a given container before giving up
- (default value is 0, which is ignored).
- type: "integer"
- format: "int64"
- default: 0
- Window:
- description: |
- Windows is the time window used to evaluate the restart policy
- (default value is 0, which is unbounded).
- type: "integer"
- format: "int64"
- default: 0
- Placement:
- type: "object"
- properties:
- Constraints:
- description: |
- An array of constraint expressions to limit the set of nodes where
- a task can be scheduled. Constraint expressions can either use a
- _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find
- nodes that satisfy every expression (AND match). Constraints can
- match node or Docker Engine labels as follows:
-
- node attribute | matches | example
- ---------------------|--------------------------------|-----------------------------------------------
- `node.id` | Node ID | `node.id==2ivku8v2gvtg4`
- `node.hostname` | Node hostname | `node.hostname!=node-2`
- `node.role` | Node role (`manager`/`worker`) | `node.role==manager`
- `node.platform.os` | Node operating system | `node.platform.os==windows`
- `node.platform.arch` | Node architecture | `node.platform.arch==x86_64`
- `node.labels` | User-defined node labels | `node.labels.security==high`
- `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-24.04`
-
- `engine.labels` apply to Docker Engine labels like operating system,
- drivers, etc. Swarm administrators add `node.labels` for operational
- purposes by using the [`node update endpoint`](#operation/NodeUpdate).
-
- type: "array"
- items:
- type: "string"
- example:
- - "node.hostname!=node3.corp.example.com"
- - "node.role!=manager"
- - "node.labels.type==production"
- - "node.platform.os==linux"
- - "node.platform.arch==x86_64"
- Preferences:
- description: |
- Preferences provide a way to make the scheduler aware of factors
- such as topology. They are provided in order from highest to
- lowest precedence.
- type: "array"
- items:
- type: "object"
- properties:
- Spread:
- type: "object"
- properties:
- SpreadDescriptor:
- description: |
- label descriptor, such as `engine.labels.az`.
- type: "string"
- example:
- - Spread:
- SpreadDescriptor: "node.labels.datacenter"
- - Spread:
- SpreadDescriptor: "node.labels.rack"
- MaxReplicas:
- description: |
- Maximum number of replicas for per node (default value is 0, which
- is unlimited)
- type: "integer"
- format: "int64"
- default: 0
- Platforms:
- description: |
- Platforms stores all the platforms that the service's image can
- run on. This field is used in the platform filter for scheduling.
- If empty, then the platform filter is off, meaning there are no
- scheduling restrictions.
- type: "array"
- items:
- $ref: "#/definitions/Platform"
- ForceUpdate:
- description: |
- A counter that triggers an update even if no relevant parameters have
- been changed.
- type: "integer"
- format: "uint64"
- Runtime:
- description: |
- Runtime is the type of runtime specified for the task executor.
- type: "string"
- Networks:
- description: "Specifies which networks the service should attach to."
- type: "array"
- items:
- $ref: "#/definitions/NetworkAttachmentConfig"
- LogDriver:
- description: |
- Specifies the log driver to use for tasks created from this spec. If
- not present, the default one for the swarm will be used, finally
- falling back to the engine default if not specified.
- type: "object"
- properties:
- Name:
- type: "string"
- Options:
- type: "object"
- additionalProperties:
- type: "string"
-
- TaskState:
- type: "string"
- enum:
- - "new"
- - "allocated"
- - "pending"
- - "assigned"
- - "accepted"
- - "preparing"
- - "ready"
- - "starting"
- - "running"
- - "complete"
- - "shutdown"
- - "failed"
- - "rejected"
- - "remove"
- - "orphaned"
-
- ContainerStatus:
- type: "object"
- description: "represents the status of a container."
- properties:
- ContainerID:
- type: "string"
- PID:
- type: "integer"
- ExitCode:
- type: "integer"
-
- PortStatus:
- type: "object"
- description: "represents the port status of a task's host ports whose service has published host ports"
- properties:
- Ports:
- type: "array"
- items:
- $ref: "#/definitions/EndpointPortConfig"
-
- TaskStatus:
- type: "object"
- description: "represents the status of a task."
- properties:
- Timestamp:
- type: "string"
- format: "dateTime"
- State:
- $ref: "#/definitions/TaskState"
- Message:
- type: "string"
- Err:
- type: "string"
- ContainerStatus:
- $ref: "#/definitions/ContainerStatus"
- PortStatus:
- $ref: "#/definitions/PortStatus"
-
- Task:
- type: "object"
- properties:
- ID:
- description: "The ID of the task."
- type: "string"
- Version:
- $ref: "#/definitions/ObjectVersion"
- CreatedAt:
- type: "string"
- format: "dateTime"
- UpdatedAt:
- type: "string"
- format: "dateTime"
- Name:
- description: "Name of the task."
- type: "string"
- Labels:
- description: "User-defined key/value metadata."
- type: "object"
- additionalProperties:
- type: "string"
- Spec:
- $ref: "#/definitions/TaskSpec"
- ServiceID:
- description: "The ID of the service this task is part of."
- type: "string"
- Slot:
- type: "integer"
- NodeID:
- description: "The ID of the node that this task is on."
- type: "string"
- AssignedGenericResources:
- $ref: "#/definitions/GenericResources"
- Status:
- $ref: "#/definitions/TaskStatus"
- DesiredState:
- $ref: "#/definitions/TaskState"
- JobIteration:
- description: |
- If the Service this Task belongs to is a job-mode service, contains
- the JobIteration of the Service this Task was created for. Absent if
- the Task was created for a Replicated or Global Service.
- $ref: "#/definitions/ObjectVersion"
- example:
- ID: "0kzzo1i0y4jz6027t0k7aezc7"
- Version:
- Index: 71
- CreatedAt: "2016-06-07T21:07:31.171892745Z"
- UpdatedAt: "2016-06-07T21:07:31.376370513Z"
- Spec:
- ContainerSpec:
- Image: "redis"
- Resources:
- Limits: {}
- Reservations: {}
- RestartPolicy:
- Condition: "any"
- MaxAttempts: 0
- Placement: {}
- ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz"
- Slot: 1
- NodeID: "60gvrl6tm78dmak4yl7srz94v"
- Status:
- Timestamp: "2016-06-07T21:07:31.290032978Z"
- State: "running"
- Message: "started"
- ContainerStatus:
- ContainerID: "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035"
- PID: 677
- DesiredState: "running"
- NetworksAttachments:
- - Network:
- ID: "4qvuz4ko70xaltuqbt8956gd1"
- Version:
- Index: 18
- CreatedAt: "2016-06-07T20:31:11.912919752Z"
- UpdatedAt: "2016-06-07T21:07:29.955277358Z"
- Spec:
- Name: "ingress"
- Labels:
- com.docker.swarm.internal: "true"
- DriverConfiguration: {}
- IPAMOptions:
- Driver: {}
- Configs:
- - Subnet: "10.255.0.0/16"
- Gateway: "10.255.0.1"
- DriverState:
- Name: "overlay"
- Options:
- com.docker.network.driver.overlay.vxlanid_list: "256"
- IPAMOptions:
- Driver:
- Name: "default"
- Configs:
- - Subnet: "10.255.0.0/16"
- Gateway: "10.255.0.1"
- Addresses:
- - "10.255.0.10/16"
- AssignedGenericResources:
- - DiscreteResourceSpec:
- Kind: "SSD"
- Value: 3
- - NamedResourceSpec:
- Kind: "GPU"
- Value: "UUID1"
- - NamedResourceSpec:
- Kind: "GPU"
- Value: "UUID2"
-
- ServiceSpec:
- description: "User modifiable configuration for a service."
- type: object
- properties:
- Name:
- description: "Name of the service."
- type: "string"
- Labels:
- description: "User-defined key/value metadata."
- type: "object"
- additionalProperties:
- type: "string"
- TaskTemplate:
- $ref: "#/definitions/TaskSpec"
- Mode:
- description: "Scheduling mode for the service."
- type: "object"
- properties:
- Replicated:
- type: "object"
- properties:
- Replicas:
- type: "integer"
- format: "int64"
- Global:
- type: "object"
- ReplicatedJob:
- description: |
- The mode used for services with a finite number of tasks that run
- to a completed state.
- type: "object"
- properties:
- MaxConcurrent:
- description: |
- The maximum number of replicas to run simultaneously.
- type: "integer"
- format: "int64"
- default: 1
- TotalCompletions:
- description: |
- The total number of replicas desired to reach the Completed
- state. If unset, will default to the value of `MaxConcurrent`
- type: "integer"
- format: "int64"
- GlobalJob:
- description: |
- The mode used for services which run a task to the completed state
- on each valid node.
- type: "object"
- UpdateConfig:
- description: "Specification for the update strategy of the service."
- type: "object"
- properties:
- Parallelism:
- description: |
- Maximum number of tasks to be updated in one iteration (0 means
- unlimited parallelism).
- type: "integer"
- format: "int64"
- Delay:
- description: "Amount of time between updates, in nanoseconds."
- type: "integer"
- format: "int64"
- FailureAction:
- description: |
- Action to take if an updated task fails to run, or stops running
- during the update.
- type: "string"
- enum:
- - "continue"
- - "pause"
- - "rollback"
- Monitor:
- description: |
- Amount of time to monitor each updated task for failures, in
- nanoseconds.
- type: "integer"
- format: "int64"
- MaxFailureRatio:
- description: |
- The fraction of tasks that may fail during an update before the
- failure action is invoked, specified as a floating point number
- between 0 and 1.
- type: "number"
- default: 0
- Order:
- description: |
- The order of operations when rolling out an updated task. Either
- the old task is shut down before the new task is started, or the
- new task is started before the old task is shut down.
- type: "string"
- enum:
- - "stop-first"
- - "start-first"
- RollbackConfig:
- description: "Specification for the rollback strategy of the service."
- type: "object"
- properties:
- Parallelism:
- description: |
- Maximum number of tasks to be rolled back in one iteration (0 means
- unlimited parallelism).
- type: "integer"
- format: "int64"
- Delay:
- description: |
- Amount of time between rollback iterations, in nanoseconds.
- type: "integer"
- format: "int64"
- FailureAction:
- description: |
- Action to take if an rolled back task fails to run, or stops
- running during the rollback.
- type: "string"
- enum:
- - "continue"
- - "pause"
- Monitor:
- description: |
- Amount of time to monitor each rolled back task for failures, in
- nanoseconds.
- type: "integer"
- format: "int64"
- MaxFailureRatio:
- description: |
- The fraction of tasks that may fail during a rollback before the
- failure action is invoked, specified as a floating point number
- between 0 and 1.
- type: "number"
- default: 0
- Order:
- description: |
- The order of operations when rolling back a task. Either the old
- task is shut down before the new task is started, or the new task
- is started before the old task is shut down.
- type: "string"
- enum:
- - "stop-first"
- - "start-first"
- Networks:
- description: |
- Specifies which networks the service should attach to.
-
- Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead.
- type: "array"
- items:
- $ref: "#/definitions/NetworkAttachmentConfig"
-
- EndpointSpec:
- $ref: "#/definitions/EndpointSpec"
-
- EndpointPortConfig:
- type: "object"
- properties:
- Name:
- type: "string"
- Protocol:
- type: "string"
- enum:
- - "tcp"
- - "udp"
- - "sctp"
- TargetPort:
- description: "The port inside the container."
- type: "integer"
- PublishedPort:
- description: "The port on the swarm hosts."
- type: "integer"
- PublishMode:
- description: |
- The mode in which port is published.
-
-
-
- - "ingress" makes the target port accessible on every node,
- regardless of whether there is a task for the service running on
- that node or not.
- - "host" bypasses the routing mesh and publish the port directly on
- the swarm node where that service is running.
-
- type: "string"
- enum:
- - "ingress"
- - "host"
- default: "ingress"
- example: "ingress"
-
- EndpointSpec:
- description: "Properties that can be configured to access and load balance a service."
- type: "object"
- properties:
- Mode:
- description: |
- The mode of resolution to use for internal load balancing between tasks.
- type: "string"
- enum:
- - "vip"
- - "dnsrr"
- default: "vip"
- Ports:
- description: |
- List of exposed ports that this service is accessible on from the
- outside. Ports can only be provided if `vip` resolution mode is used.
- type: "array"
- items:
- $ref: "#/definitions/EndpointPortConfig"
-
- Service:
- type: "object"
- properties:
- ID:
- type: "string"
- Version:
- $ref: "#/definitions/ObjectVersion"
- CreatedAt:
- type: "string"
- format: "dateTime"
- UpdatedAt:
- type: "string"
- format: "dateTime"
- Spec:
- $ref: "#/definitions/ServiceSpec"
- Endpoint:
- type: "object"
- properties:
- Spec:
- $ref: "#/definitions/EndpointSpec"
- Ports:
- type: "array"
- items:
- $ref: "#/definitions/EndpointPortConfig"
- VirtualIPs:
- type: "array"
- items:
- type: "object"
- properties:
- NetworkID:
- type: "string"
- Addr:
- type: "string"
- UpdateStatus:
- description: "The status of a service update."
- type: "object"
- properties:
- State:
- type: "string"
- enum:
- - "updating"
- - "paused"
- - "completed"
- StartedAt:
- type: "string"
- format: "dateTime"
- CompletedAt:
- type: "string"
- format: "dateTime"
- Message:
- type: "string"
- ServiceStatus:
- description: |
- The status of the service's tasks. Provided only when requested as
- part of a ServiceList operation.
- type: "object"
- properties:
- RunningTasks:
- description: |
- The number of tasks for the service currently in the Running state.
- type: "integer"
- format: "uint64"
- example: 7
- DesiredTasks:
- description: |
- The number of tasks for the service desired to be running.
- For replicated services, this is the replica count from the
- service spec. For global services, this is computed by taking
- count of all tasks for the service with a Desired State other
- than Shutdown.
- type: "integer"
- format: "uint64"
- example: 10
- CompletedTasks:
- description: |
- The number of tasks for a job that are in the Completed state.
- This field must be cross-referenced with the service type, as the
- value of 0 may mean the service is not in a job mode, or it may
- mean the job-mode service has no tasks yet Completed.
- type: "integer"
- format: "uint64"
- JobStatus:
- description: |
- The status of the service when it is in one of ReplicatedJob or
- GlobalJob modes. Absent on Replicated and Global mode services. The
- JobIteration is an ObjectVersion, but unlike the Service's version,
- does not need to be sent with an update request.
- type: "object"
- properties:
- JobIteration:
- description: |
- JobIteration is a value increased each time a Job is executed,
- successfully or otherwise. "Executed", in this case, means the
- job as a whole has been started, not that an individual Task has
- been launched. A job is "Executed" when its ServiceSpec is
- updated. JobIteration can be used to disambiguate Tasks belonging
- to different executions of a job. Though JobIteration will
- increase with each subsequent execution, it may not necessarily
- increase by 1, and so JobIteration should not be used to
- $ref: "#/definitions/ObjectVersion"
- LastExecution:
- description: |
- The last time, as observed by the server, that this job was
- started.
- type: "string"
- format: "dateTime"
- example:
- ID: "9mnpnzenvg8p8tdbtq4wvbkcz"
- Version:
- Index: 19
- CreatedAt: "2016-06-07T21:05:51.880065305Z"
- UpdatedAt: "2016-06-07T21:07:29.962229872Z"
- Spec:
- Name: "hopeful_cori"
- TaskTemplate:
- ContainerSpec:
- Image: "redis"
- Resources:
- Limits: {}
- Reservations: {}
- RestartPolicy:
- Condition: "any"
- MaxAttempts: 0
- Placement: {}
- ForceUpdate: 0
- Mode:
- Replicated:
- Replicas: 1
- UpdateConfig:
- Parallelism: 1
- Delay: 1000000000
- FailureAction: "pause"
- Monitor: 15000000000
- MaxFailureRatio: 0.15
- RollbackConfig:
- Parallelism: 1
- Delay: 1000000000
- FailureAction: "pause"
- Monitor: 15000000000
- MaxFailureRatio: 0.15
- EndpointSpec:
- Mode: "vip"
- Ports:
- -
- Protocol: "tcp"
- TargetPort: 6379
- PublishedPort: 30001
- Endpoint:
- Spec:
- Mode: "vip"
- Ports:
- -
- Protocol: "tcp"
- TargetPort: 6379
- PublishedPort: 30001
- Ports:
- -
- Protocol: "tcp"
- TargetPort: 6379
- PublishedPort: 30001
- VirtualIPs:
- -
- NetworkID: "4qvuz4ko70xaltuqbt8956gd1"
- Addr: "10.255.0.2/16"
- -
- NetworkID: "4qvuz4ko70xaltuqbt8956gd1"
- Addr: "10.255.0.3/16"
-
- ImageDeleteResponseItem:
- type: "object"
- x-go-name: "DeleteResponse"
- properties:
- Untagged:
- description: "The image ID of an image that was untagged"
- type: "string"
- Deleted:
- description: "The image ID of an image that was deleted"
- type: "string"
-
- ServiceCreateResponse:
- type: "object"
- description: |
- contains the information returned to a client on the
- creation of a new service.
- properties:
- ID:
- description: "The ID of the created service."
- type: "string"
- x-nullable: false
- example: "ak7w3gjqoa3kuz8xcpnyy0pvl"
- Warnings:
- description: |
- Optional warning message.
-
- FIXME(thaJeztah): this should have "omitempty" in the generated type.
- type: "array"
- x-nullable: true
- items:
- type: "string"
- example:
- - "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
-
- ServiceUpdateResponse:
- type: "object"
- properties:
- Warnings:
- description: "Optional warning messages"
- type: "array"
- items:
- type: "string"
- example:
- Warnings:
- - "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
-
- ContainerInspectResponse:
- type: "object"
- title: "ContainerInspectResponse"
- x-go-name: "InspectResponse"
- properties:
- Id:
- description: |-
- The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes).
- type: "string"
- x-go-name: "ID"
- minLength: 64
- maxLength: 64
- pattern: "^[0-9a-fA-F]{64}$"
- example: "aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf"
- Created:
- description: |-
- Date and time at which the container was created, formatted in
- [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
- type: "string"
- format: "dateTime"
- x-nullable: true
- example: "2025-02-17T17:43:39.64001363Z"
- Path:
- description: |-
- The path to the command being run
- type: "string"
- example: "/bin/sh"
- Args:
- description: "The arguments to the command being run"
- type: "array"
- items:
- type: "string"
- example:
- - "-c"
- - "exit 9"
- State:
- $ref: "#/definitions/ContainerState"
- Image:
- description: |-
- The ID (digest) of the image that this container was created from.
- type: "string"
- example: "sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782"
- ResolvConfPath:
- description: |-
- Location of the `/etc/resolv.conf` generated for the container on the
- host.
-
- This file is managed through the docker daemon, and should not be
- accessed or modified by other tools.
- type: "string"
- example: "/var/lib/docker/containers/aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf/resolv.conf"
- HostnamePath:
- description: |-
- Location of the `/etc/hostname` generated for the container on the
- host.
-
- This file is managed through the docker daemon, and should not be
- accessed or modified by other tools.
- type: "string"
- example: "/var/lib/docker/containers/aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf/hostname"
- HostsPath:
- description: |-
- Location of the `/etc/hosts` generated for the container on the
- host.
-
- This file is managed through the docker daemon, and should not be
- accessed or modified by other tools.
- type: "string"
- example: "/var/lib/docker/containers/aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf/hosts"
- LogPath:
- description: |-
- Location of the file used to buffer the container's logs. Depending on
- the logging-driver used for the container, this field may be omitted.
-
- This file is managed through the docker daemon, and should not be
- accessed or modified by other tools.
- type: "string"
- x-nullable: true
- example: "/var/lib/docker/containers/5b7c7e2b992aa426584ce6c47452756066be0e503a08b4516a433a54d2f69e59/5b7c7e2b992aa426584ce6c47452756066be0e503a08b4516a433a54d2f69e59-json.log"
- Name:
- description: |-
- The name associated with this container.
-
- For historic reasons, the name may be prefixed with a forward-slash (`/`).
- type: "string"
- example: "/funny_chatelet"
- RestartCount:
- description: |-
- Number of times the container was restarted since it was created,
- or since daemon was started.
- type: "integer"
- example: 0
- Driver:
- description: |-
- The storage-driver used for the container's filesystem (graph-driver
- or snapshotter).
- type: "string"
- example: "overlayfs"
- Platform:
- description: |-
- The platform (operating system) for which the container was created.
-
- This field was introduced for the experimental "LCOW" (Linux Containers
- On Windows) features, which has been removed. In most cases, this field
- is equal to the host's operating system (`linux` or `windows`).
- type: "string"
- example: "linux"
- ImageManifestDescriptor:
- $ref: "#/definitions/OCIDescriptor"
- description: |-
- OCI descriptor of the platform-specific manifest of the image
- the container was created from.
-
- Note: Only available if the daemon provides a multi-platform
- image store.
- MountLabel:
- description: |-
- SELinux mount label set for the container.
- type: "string"
- example: ""
- ProcessLabel:
- description: |-
- SELinux process label set for the container.
- type: "string"
- example: ""
- AppArmorProfile:
- description: |-
- The AppArmor profile set for the container.
- type: "string"
- example: ""
- ExecIDs:
- description: |-
- IDs of exec instances that are running in the container.
- type: "array"
- items:
- type: "string"
- x-nullable: true
- example:
- - "b35395de42bc8abd327f9dd65d913b9ba28c74d2f0734eeeae84fa1c616a0fca"
- - "3fc1232e5cd20c8de182ed81178503dc6437f4e7ef12b52cc5e8de020652f1c4"
- HostConfig:
- $ref: "#/definitions/HostConfig"
- GraphDriver:
- $ref: "#/definitions/DriverData"
- SizeRw:
- description: |-
- The size of files that have been created or changed by this container.
-
- This field is omitted by default, and only set when size is requested
- in the API request.
- type: "integer"
- format: "int64"
- x-nullable: true
- example: "122880"
- SizeRootFs:
- description: |-
- The total size of all files in the read-only layers from the image
- that the container uses. These layers can be shared between containers.
-
- This field is omitted by default, and only set when size is requested
- in the API request.
- type: "integer"
- format: "int64"
- x-nullable: true
- example: "1653948416"
- Mounts:
- description: |-
- List of mounts used by the container.
- type: "array"
- items:
- $ref: "#/definitions/MountPoint"
- Config:
- $ref: "#/definitions/ContainerConfig"
- NetworkSettings:
- $ref: "#/definitions/NetworkSettings"
-
- ContainerSummary:
- type: "object"
- properties:
- Id:
- description: |-
- The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes).
- type: "string"
- x-go-name: "ID"
- minLength: 64
- maxLength: 64
- pattern: "^[0-9a-fA-F]{64}$"
- example: "aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf"
- Names:
- description: |-
- The names associated with this container. Most containers have a single
- name, but when using legacy "links", the container can have multiple
- names.
-
- For historic reasons, names are prefixed with a forward-slash (`/`).
- type: "array"
- items:
- type: "string"
- example:
- - "/funny_chatelet"
- Image:
- description: |-
- The name or ID of the image used to create the container.
-
- This field shows the image reference as was specified when creating the container,
- which can be in its canonical form (e.g., `docker.io/library/ubuntu:latest`
- or `docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`),
- short form (e.g., `ubuntu:latest`)), or the ID(-prefix) of the image (e.g., `72297848456d`).
-
- The content of this field can be updated at runtime if the image used to
- create the container is untagged, in which case the field is updated to
- contain the the image ID (digest) it was resolved to in its canonical,
- non-truncated form (e.g., `sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`).
- type: "string"
- example: "docker.io/library/ubuntu:latest"
- ImageID:
- description: |-
- The ID (digest) of the image that this container was created from.
- type: "string"
- example: "sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782"
- ImageManifestDescriptor:
- $ref: "#/definitions/OCIDescriptor"
- x-nullable: true
- description: |
- OCI descriptor of the platform-specific manifest of the image
- the container was created from.
-
- Note: Only available if the daemon provides a multi-platform
- image store.
-
- This field is not populated in the `GET /system/df` endpoint.
- Command:
- description: "Command to run when starting the container"
- type: "string"
- example: "/bin/bash"
- Created:
- description: |-
- Date and time at which the container was created as a Unix timestamp
- (number of seconds since EPOCH).
- type: "integer"
- format: "int64"
- example: "1739811096"
- Ports:
- description: |-
- Port-mappings for the container.
- type: "array"
- items:
- $ref: "#/definitions/Port"
- SizeRw:
- description: |-
- The size of files that have been created or changed by this container.
-
- This field is omitted by default, and only set when size is requested
- in the API request.
- type: "integer"
- format: "int64"
- x-nullable: true
- example: "122880"
- SizeRootFs:
- description: |-
- The total size of all files in the read-only layers from the image
- that the container uses. These layers can be shared between containers.
-
- This field is omitted by default, and only set when size is requested
- in the API request.
- type: "integer"
- format: "int64"
- x-nullable: true
- example: "1653948416"
- Labels:
- description: "User-defined key/value metadata."
- type: "object"
- additionalProperties:
- type: "string"
- example:
- com.example.vendor: "Acme"
- com.example.license: "GPL"
- com.example.version: "1.0"
- State:
- description: |
- The state of this container.
- type: "string"
- enum:
- - "created"
- - "running"
- - "paused"
- - "restarting"
- - "exited"
- - "removing"
- - "dead"
- example: "running"
- Status:
- description: |-
- Additional human-readable status of this container (e.g. `Exit 0`)
- type: "string"
- example: "Up 4 days"
- HostConfig:
- type: "object"
- description: |-
- Summary of host-specific runtime information of the container. This
- is a reduced set of information in the container's "HostConfig" as
- available in the container "inspect" response.
- properties:
- NetworkMode:
- description: |-
- Networking mode (`host`, `none`, `container:`) or name of the
- primary network the container is using.
-
- This field is primarily for backward compatibility. The container
- can be connected to multiple networks for which information can be
- found in the `NetworkSettings.Networks` field, which enumerates
- settings per network.
- type: "string"
- example: "mynetwork"
- Annotations:
- description: |-
- Arbitrary key-value metadata attached to the container.
- type: "object"
- x-nullable: true
- additionalProperties:
- type: "string"
- example:
- io.kubernetes.docker.type: "container"
- io.kubernetes.sandbox.id: "3befe639bed0fd6afdd65fd1fa84506756f59360ec4adc270b0fdac9be22b4d3"
- NetworkSettings:
- description: |-
- Summary of the container's network settings
- type: "object"
- properties:
- Networks:
- type: "object"
- description: |-
- Summary of network-settings for each network the container is
- attached to.
- additionalProperties:
- $ref: "#/definitions/EndpointSettings"
- Mounts:
- type: "array"
- description: |-
- List of mounts used by the container.
- items:
- $ref: "#/definitions/MountPoint"
-
- Driver:
- description: "Driver represents a driver (network, logging, secrets)."
- type: "object"
- required: [Name]
- properties:
- Name:
- description: "Name of the driver."
- type: "string"
- x-nullable: false
- example: "some-driver"
- Options:
- description: "Key/value map of driver-specific options."
- type: "object"
- x-nullable: false
- additionalProperties:
- type: "string"
- example:
- OptionA: "value for driver-specific option A"
- OptionB: "value for driver-specific option B"
-
- SecretSpec:
- type: "object"
- properties:
- Name:
- description: "User-defined name of the secret."
- type: "string"
- Labels:
- description: "User-defined key/value metadata."
- type: "object"
- additionalProperties:
- type: "string"
- example:
- com.example.some-label: "some-value"
- com.example.some-other-label: "some-other-value"
- Data:
- description: |
- Data is the data to store as a secret, formatted as a Base64-url-safe-encoded
- ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string.
- It must be empty if the Driver field is set, in which case the data is
- loaded from an external secret store. The maximum allowed size is 500KB,
- as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/api/validation#MaxSecretSize).
-
- This field is only used to _create_ a secret, and is not returned by
- other endpoints.
- type: "string"
- example: ""
- Driver:
- description: |
- Name of the secrets driver used to fetch the secret's value from an
- external secret store.
- $ref: "#/definitions/Driver"
- Templating:
- description: |
- Templating driver, if applicable
-
- Templating controls whether and how to evaluate the config payload as
- a template. If no driver is set, no templating is used.
- $ref: "#/definitions/Driver"
-
- Secret:
- type: "object"
- properties:
- ID:
- type: "string"
- example: "blt1owaxmitz71s9v5zh81zun"
- Version:
- $ref: "#/definitions/ObjectVersion"
- CreatedAt:
- type: "string"
- format: "dateTime"
- example: "2017-07-20T13:55:28.678958722Z"
- UpdatedAt:
- type: "string"
- format: "dateTime"
- example: "2017-07-20T13:55:28.678958722Z"
- Spec:
- $ref: "#/definitions/SecretSpec"
-
- ConfigSpec:
- type: "object"
- properties:
- Name:
- description: "User-defined name of the config."
- type: "string"
- Labels:
- description: "User-defined key/value metadata."
- type: "object"
- additionalProperties:
- type: "string"
- Data:
- description: |
- Data is the data to store as a config, formatted as a Base64-url-safe-encoded
- ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string.
- The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize).
- type: "string"
- Templating:
- description: |
- Templating driver, if applicable
-
- Templating controls whether and how to evaluate the config payload as
- a template. If no driver is set, no templating is used.
- $ref: "#/definitions/Driver"
-
- Config:
- type: "object"
- properties:
- ID:
- type: "string"
- Version:
- $ref: "#/definitions/ObjectVersion"
- CreatedAt:
- type: "string"
- format: "dateTime"
- UpdatedAt:
- type: "string"
- format: "dateTime"
- Spec:
- $ref: "#/definitions/ConfigSpec"
-
- ContainerState:
- description: |
- ContainerState stores container's running state. It's part of ContainerJSONBase
- and will be returned by the "inspect" command.
- type: "object"
- x-nullable: true
- properties:
- Status:
- description: |
- String representation of the container state. Can be one of "created",
- "running", "paused", "restarting", "removing", "exited", or "dead".
- type: "string"
- enum: ["created", "running", "paused", "restarting", "removing", "exited", "dead"]
- example: "running"
- Running:
- description: |
- 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 freezer cgroup 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".
- type: "boolean"
- example: true
- Paused:
- description: "Whether this container is paused."
- type: "boolean"
- example: false
- Restarting:
- description: "Whether this container is restarting."
- type: "boolean"
- example: false
- OOMKilled:
- description: |
- Whether a process within this container has been killed because it ran
- out of memory since the container was last started.
- type: "boolean"
- example: false
- Dead:
- type: "boolean"
- example: false
- Pid:
- description: "The process ID of this container"
- type: "integer"
- example: 1234
- ExitCode:
- description: "The last exit code of this container"
- type: "integer"
- example: 0
- Error:
- type: "string"
- StartedAt:
- description: "The time when this container was last started."
- type: "string"
- example: "2020-01-06T09:06:59.461876391Z"
- FinishedAt:
- description: "The time when this container last exited."
- type: "string"
- example: "2020-01-06T09:07:59.461876391Z"
- Health:
- $ref: "#/definitions/Health"
-
- ContainerCreateResponse:
- description: "OK response to ContainerCreate operation"
- type: "object"
- title: "ContainerCreateResponse"
- x-go-name: "CreateResponse"
- required: [Id, Warnings]
- properties:
- Id:
- description: "The ID of the created container"
- type: "string"
- x-nullable: false
- example: "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743"
- Warnings:
- description: "Warnings encountered when creating the container"
- type: "array"
- x-nullable: false
- items:
- type: "string"
- example: []
-
- ContainerUpdateResponse:
- type: "object"
- title: "ContainerUpdateResponse"
- x-go-name: "UpdateResponse"
- description: |-
- Response for a successful container-update.
- properties:
- Warnings:
- type: "array"
- description: |-
- Warnings encountered when updating the container.
- items:
- type: "string"
- example: ["Published ports are discarded when using host network mode"]
-
- ContainerStatsResponse:
- description: |
- Statistics sample for a container.
- type: "object"
- x-go-name: "StatsResponse"
- title: "ContainerStatsResponse"
- properties:
- name:
- description: "Name of the container"
- type: "string"
- x-nullable: true
- example: "boring_wozniak"
- id:
- description: "ID of the container"
- type: "string"
- x-nullable: true
- example: "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743"
- read:
- description: |
- Date and time at which this sample was collected.
- The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt)
- with nano-seconds.
- type: "string"
- format: "date-time"
- example: "2025-01-16T13:55:22.165243637Z"
- preread:
- description: |
- Date and time at which this first sample was collected. This field
- is not propagated if the "one-shot" option is set. If the "one-shot"
- option is set, this field may be omitted, empty, or set to a default
- date (`0001-01-01T00:00:00Z`).
-
- The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt)
- with nano-seconds.
- type: "string"
- format: "date-time"
- example: "2025-01-16T13:55:21.160452595Z"
- pids_stats:
- $ref: "#/definitions/ContainerPidsStats"
- blkio_stats:
- $ref: "#/definitions/ContainerBlkioStats"
- num_procs:
- description: |
- The number of processors on the system.
-
- This field is Windows-specific and always zero for Linux containers.
- type: "integer"
- format: "uint32"
- example: 16
- storage_stats:
- $ref: "#/definitions/ContainerStorageStats"
- cpu_stats:
- $ref: "#/definitions/ContainerCPUStats"
- precpu_stats:
- $ref: "#/definitions/ContainerCPUStats"
- memory_stats:
- $ref: "#/definitions/ContainerMemoryStats"
- networks:
- description: |
- Network statistics for the container per interface.
-
- This field is omitted if the container has no networking enabled.
- x-nullable: true
- additionalProperties:
- $ref: "#/definitions/ContainerNetworkStats"
- example:
- eth0:
- rx_bytes: 5338
- rx_dropped: 0
- rx_errors: 0
- rx_packets: 36
- tx_bytes: 648
- tx_dropped: 0
- tx_errors: 0
- tx_packets: 8
- eth5:
- rx_bytes: 4641
- rx_dropped: 0
- rx_errors: 0
- rx_packets: 26
- tx_bytes: 690
- tx_dropped: 0
- tx_errors: 0
- tx_packets: 9
-
- ContainerBlkioStats:
- description: |
- BlkioStats stores all IO service stats for data read and write.
-
- This type is Linux-specific and holds many fields that are specific to cgroups v1.
- On a cgroup v2 host, all fields other than `io_service_bytes_recursive`
- are omitted or `null`.
-
- This type is only populated on Linux and omitted for Windows containers.
- type: "object"
- x-go-name: "BlkioStats"
- x-nullable: true
- properties:
- io_service_bytes_recursive:
- type: "array"
- items:
- $ref: "#/definitions/ContainerBlkioStatEntry"
- io_serviced_recursive:
- description: |
- This field is only available when using Linux containers with
- cgroups v1. It is omitted or `null` when using cgroups v2.
- x-nullable: true
- type: "array"
- items:
- $ref: "#/definitions/ContainerBlkioStatEntry"
- io_queue_recursive:
- description: |
- This field is only available when using Linux containers with
- cgroups v1. It is omitted or `null` when using cgroups v2.
- x-nullable: true
- type: "array"
- items:
- $ref: "#/definitions/ContainerBlkioStatEntry"
- io_service_time_recursive:
- description: |
- This field is only available when using Linux containers with
- cgroups v1. It is omitted or `null` when using cgroups v2.
- x-nullable: true
- type: "array"
- items:
- $ref: "#/definitions/ContainerBlkioStatEntry"
- io_wait_time_recursive:
- description: |
- This field is only available when using Linux containers with
- cgroups v1. It is omitted or `null` when using cgroups v2.
- x-nullable: true
- type: "array"
- items:
- $ref: "#/definitions/ContainerBlkioStatEntry"
- io_merged_recursive:
- description: |
- This field is only available when using Linux containers with
- cgroups v1. It is omitted or `null` when using cgroups v2.
- x-nullable: true
- type: "array"
- items:
- $ref: "#/definitions/ContainerBlkioStatEntry"
- io_time_recursive:
- description: |
- This field is only available when using Linux containers with
- cgroups v1. It is omitted or `null` when using cgroups v2.
- x-nullable: true
- type: "array"
- items:
- $ref: "#/definitions/ContainerBlkioStatEntry"
- sectors_recursive:
- description: |
- This field is only available when using Linux containers with
- cgroups v1. It is omitted or `null` when using cgroups v2.
- x-nullable: true
- type: "array"
- items:
- $ref: "#/definitions/ContainerBlkioStatEntry"
- example:
- io_service_bytes_recursive: [
- {"major": 254, "minor": 0, "op": "read", "value": 7593984},
- {"major": 254, "minor": 0, "op": "write", "value": 100}
- ]
- io_serviced_recursive: null
- io_queue_recursive: null
- io_service_time_recursive: null
- io_wait_time_recursive: null
- io_merged_recursive: null
- io_time_recursive: null
- sectors_recursive: null
-
- ContainerBlkioStatEntry:
- description: |
- Blkio stats entry.
-
- This type is Linux-specific and omitted for Windows containers.
- type: "object"
- x-go-name: "BlkioStatEntry"
- x-nullable: true
- properties:
- major:
- type: "integer"
- format: "uint64"
- example: 254
- minor:
- type: "integer"
- format: "uint64"
- example: 0
- op:
- type: "string"
- example: "read"
- value:
- type: "integer"
- format: "uint64"
- example: 7593984
-
- ContainerCPUStats:
- description: |
- CPU related info of the container
- type: "object"
- x-go-name: "CPUStats"
- x-nullable: true
- properties:
- cpu_usage:
- $ref: "#/definitions/ContainerCPUUsage"
- system_cpu_usage:
- description: |
- System Usage.
-
- This field is Linux-specific and omitted for Windows containers.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 5
- online_cpus:
- description: |
- Number of online CPUs.
-
- This field is Linux-specific and omitted for Windows containers.
- type: "integer"
- format: "uint32"
- x-nullable: true
- example: 5
- throttling_data:
- $ref: "#/definitions/ContainerThrottlingData"
-
- ContainerCPUUsage:
- description: |
- All CPU stats aggregated since container inception.
- type: "object"
- x-go-name: "CPUUsage"
- x-nullable: true
- properties:
- total_usage:
- description: |
- Total CPU time consumed in nanoseconds (Linux) or 100's of nanoseconds (Windows).
- type: "integer"
- format: "uint64"
- example: 29912000
- percpu_usage:
- description: |
- Total CPU time (in nanoseconds) consumed per core (Linux).
-
- This field is Linux-specific when using cgroups v1. It is omitted
- when using cgroups v2 and Windows containers.
- type: "array"
- x-nullable: true
- items:
- type: "integer"
- format: "uint64"
- example: 29912000
-
- usage_in_kernelmode:
- description: |
- Time (in nanoseconds) spent by tasks of the cgroup in kernel mode (Linux),
- or time spent (in 100's of nanoseconds) by all container processes in
- kernel mode (Windows).
-
- Not populated for Windows containers using Hyper-V isolation.
- type: "integer"
- format: "uint64"
- example: 21994000
- usage_in_usermode:
- description: |
- Time (in nanoseconds) spent by tasks of the cgroup in user mode (Linux),
- or time spent (in 100's of nanoseconds) by all container processes in
- kernel mode (Windows).
-
- Not populated for Windows containers using Hyper-V isolation.
- type: "integer"
- format: "uint64"
- example: 7918000
-
- ContainerPidsStats:
- description: |
- PidsStats contains Linux-specific stats of a container's process-IDs (PIDs).
-
- This type is Linux-specific and omitted for Windows containers.
- type: "object"
- x-go-name: "PidsStats"
- x-nullable: true
- properties:
- current:
- description: |
- Current is the number of PIDs in the cgroup.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 5
- limit:
- description: |
- Limit is the hard limit on the number of pids in the cgroup.
- A "Limit" of 0 means that there is no limit.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: "18446744073709551615"
-
- ContainerThrottlingData:
- description: |
- CPU throttling stats of the container.
-
- This type is Linux-specific and omitted for Windows containers.
- type: "object"
- x-go-name: "ThrottlingData"
- x-nullable: true
- properties:
- periods:
- description: |
- Number of periods with throttling active.
- type: "integer"
- format: "uint64"
- example: 0
- throttled_periods:
- description: |
- Number of periods when the container hit its throttling limit.
- type: "integer"
- format: "uint64"
- example: 0
- throttled_time:
- description: |
- Aggregated time (in nanoseconds) the container was throttled for.
- type: "integer"
- format: "uint64"
- example: 0
-
- ContainerMemoryStats:
- description: |
- Aggregates all memory stats since container inception on Linux.
- Windows returns stats for commit and private working set only.
- type: "object"
- x-go-name: "MemoryStats"
- properties:
- usage:
- description: |
- Current `res_counter` usage for memory.
-
- This field is Linux-specific and omitted for Windows containers.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 0
- max_usage:
- description: |
- Maximum usage ever recorded.
-
- This field is Linux-specific and only supported on cgroups v1.
- It is omitted when using cgroups v2 and for Windows containers.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 0
- stats:
- description: |
- All the stats exported via memory.stat. when using cgroups v2.
-
- This field is Linux-specific and omitted for Windows containers.
- type: "object"
- additionalProperties:
- type: "integer"
- format: "uint64"
- x-nullable: true
- example:
- {
- "active_anon": 1572864,
- "active_file": 5115904,
- "anon": 1572864,
- "anon_thp": 0,
- "file": 7626752,
- "file_dirty": 0,
- "file_mapped": 2723840,
- "file_writeback": 0,
- "inactive_anon": 0,
- "inactive_file": 2510848,
- "kernel_stack": 16384,
- "pgactivate": 0,
- "pgdeactivate": 0,
- "pgfault": 2042,
- "pglazyfree": 0,
- "pglazyfreed": 0,
- "pgmajfault": 45,
- "pgrefill": 0,
- "pgscan": 0,
- "pgsteal": 0,
- "shmem": 0,
- "slab": 1180928,
- "slab_reclaimable": 725576,
- "slab_unreclaimable": 455352,
- "sock": 0,
- "thp_collapse_alloc": 0,
- "thp_fault_alloc": 1,
- "unevictable": 0,
- "workingset_activate": 0,
- "workingset_nodereclaim": 0,
- "workingset_refault": 0
- }
- failcnt:
- description: |
- Number of times memory usage hits limits.
-
- This field is Linux-specific and only supported on cgroups v1.
- It is omitted when using cgroups v2 and for Windows containers.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 0
- limit:
- description: |
- This field is Linux-specific and omitted for Windows containers.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 8217579520
- commitbytes:
- description: |
- Committed bytes.
-
- This field is Windows-specific and omitted for Linux containers.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 0
- commitpeakbytes:
- description: |
- Peak committed bytes.
-
- This field is Windows-specific and omitted for Linux containers.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 0
- privateworkingset:
- description: |
- Private working set.
-
- This field is Windows-specific and omitted for Linux containers.
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 0
-
- ContainerNetworkStats:
- description: |
- Aggregates the network stats of one container
- type: "object"
- x-go-name: "NetworkStats"
- x-nullable: true
- properties:
- rx_bytes:
- description: |
- Bytes received. Windows and Linux.
- type: "integer"
- format: "uint64"
- example: 5338
- rx_packets:
- description: |
- Packets received. Windows and Linux.
- type: "integer"
- format: "uint64"
- example: 36
- rx_errors:
- description: |
- Received errors. Not used on Windows.
-
- This field is Linux-specific and always zero for Windows containers.
- type: "integer"
- format: "uint64"
- example: 0
- rx_dropped:
- description: |
- Incoming packets dropped. Windows and Linux.
- type: "integer"
- format: "uint64"
- example: 0
- tx_bytes:
- description: |
- Bytes sent. Windows and Linux.
- type: "integer"
- format: "uint64"
- example: 1200
- tx_packets:
- description: |
- Packets sent. Windows and Linux.
- type: "integer"
- format: "uint64"
- example: 12
- tx_errors:
- description: |
- Sent errors. Not used on Windows.
-
- This field is Linux-specific and always zero for Windows containers.
- type: "integer"
- format: "uint64"
- example: 0
- tx_dropped:
- description: |
- Outgoing packets dropped. Windows and Linux.
- type: "integer"
- format: "uint64"
- example: 0
- endpoint_id:
- description: |
- Endpoint ID. Not used on Linux.
-
- This field is Windows-specific and omitted for Linux containers.
- type: "string"
- x-nullable: true
- instance_id:
- description: |
- Instance ID. Not used on Linux.
-
- This field is Windows-specific and omitted for Linux containers.
- type: "string"
- x-nullable: true
-
- ContainerStorageStats:
- description: |
- StorageStats is the disk I/O stats for read/write on Windows.
-
- This type is Windows-specific and omitted for Linux containers.
- type: "object"
- x-go-name: "StorageStats"
- x-nullable: true
- properties:
- read_count_normalized:
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 7593984
- read_size_bytes:
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 7593984
- write_count_normalized:
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 7593984
- write_size_bytes:
- type: "integer"
- format: "uint64"
- x-nullable: true
- example: 7593984
-
- ContainerTopResponse:
- type: "object"
- x-go-name: "TopResponse"
- title: "ContainerTopResponse"
- description: |-
- Container "top" response.
- properties:
- Titles:
- description: "The ps column titles"
- type: "array"
- items:
- type: "string"
- example:
- Titles:
- - "UID"
- - "PID"
- - "PPID"
- - "C"
- - "STIME"
- - "TTY"
- - "TIME"
- - "CMD"
- Processes:
- description: |-
- Each process running in the container, where each process
- is an array of values corresponding to the titles.
- type: "array"
- items:
- type: "array"
- items:
- type: "string"
- example:
- Processes:
- -
- - "root"
- - "13642"
- - "882"
- - "0"
- - "17:03"
- - "pts/0"
- - "00:00:00"
- - "/bin/bash"
- -
- - "root"
- - "13735"
- - "13642"
- - "0"
- - "17:06"
- - "pts/0"
- - "00:00:00"
- - "sleep 10"
-
- ContainerWaitResponse:
- description: "OK response to ContainerWait operation"
- type: "object"
- x-go-name: "WaitResponse"
- title: "ContainerWaitResponse"
- required: [StatusCode]
- properties:
- StatusCode:
- description: "Exit code of the container"
- type: "integer"
- format: "int64"
- x-nullable: false
- Error:
- $ref: "#/definitions/ContainerWaitExitError"
-
- ContainerWaitExitError:
- description: "container waiting error, if any"
- type: "object"
- x-go-name: "WaitExitError"
- properties:
- Message:
- description: "Details of an error"
- type: "string"
-
- SystemVersion:
- type: "object"
- description: |
- Response of Engine API: GET "/version"
- properties:
- Platform:
- type: "object"
- required: [Name]
- properties:
- Name:
- type: "string"
- Components:
- type: "array"
- description: |
- Information about system components
- items:
- type: "object"
- x-go-name: ComponentVersion
- required: [Name, Version]
- properties:
- Name:
- description: |
- Name of the component
- type: "string"
- example: "Engine"
- Version:
- description: |
- Version of the component
- type: "string"
- x-nullable: false
- example: "27.0.1"
- Details:
- description: |
- Key/value pairs of strings with additional information about the
- component. These values are intended for informational purposes
- only, and their content is not defined, and not part of the API
- specification.
-
- These messages can be printed by the client as information to the user.
- type: "object"
- x-nullable: true
- Version:
- description: "The version of the daemon"
- type: "string"
- example: "27.0.1"
- ApiVersion:
- description: |
- The default (and highest) API version that is supported by the daemon
- type: "string"
- example: "1.47"
- MinAPIVersion:
- description: |
- The minimum API version that is supported by the daemon
- type: "string"
- example: "1.24"
- GitCommit:
- description: |
- The Git commit of the source code that was used to build the daemon
- type: "string"
- example: "48a66213fe"
- GoVersion:
- description: |
- The version Go used to compile the daemon, and the version of the Go
- runtime in use.
- type: "string"
- example: "go1.22.7"
- Os:
- description: |
- The operating system that the daemon is running on ("linux" or "windows")
- type: "string"
- example: "linux"
- Arch:
- description: |
- The architecture that the daemon is running on
- type: "string"
- example: "amd64"
- KernelVersion:
- description: |
- The kernel version (`uname -r`) that the daemon is running on.
-
- This field is omitted when empty.
- type: "string"
- example: "6.8.0-31-generic"
- Experimental:
- description: |
- Indicates if the daemon is started with experimental features enabled.
-
- This field is omitted when empty / false.
- type: "boolean"
- example: true
- BuildTime:
- description: |
- The date and time that the daemon was compiled.
- type: "string"
- example: "2020-06-22T15:49:27.000000000+00:00"
-
- SystemInfo:
- type: "object"
- properties:
- ID:
- description: |
- Unique identifier of the daemon.
-
-
-
- > **Note**: The format of the ID itself is not part of the API, and
- > should not be considered stable.
- type: "string"
- example: "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS"
- Containers:
- description: "Total number of containers on the host."
- type: "integer"
- example: 14
- ContainersRunning:
- description: |
- Number of containers with status `"running"`.
- type: "integer"
- example: 3
- ContainersPaused:
- description: |
- Number of containers with status `"paused"`.
- type: "integer"
- example: 1
- ContainersStopped:
- description: |
- Number of containers with status `"stopped"`.
- type: "integer"
- example: 10
- Images:
- description: |
- Total number of images on the host.
-
- Both _tagged_ and _untagged_ (dangling) images are counted.
- type: "integer"
- example: 508
- Driver:
- description: "Name of the storage driver in use."
- type: "string"
- example: "overlay2"
- DriverStatus:
- description: |
- 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 `docker info` on the command
- line.
-
-
-
- > **Note**: The information returned in this field, including the
- > formatting of values and labels, should not be considered stable,
- > and may change without notice.
- type: "array"
- items:
- type: "array"
- items:
- type: "string"
- example:
- - ["Backing Filesystem", "extfs"]
- - ["Supports d_type", "true"]
- - ["Native Overlay Diff", "true"]
- DockerRootDir:
- description: |
- Root directory of persistent Docker state.
-
- Defaults to `/var/lib/docker` on Linux, and `C:\ProgramData\docker`
- on Windows.
- type: "string"
- example: "/var/lib/docker"
- Plugins:
- $ref: "#/definitions/PluginsInfo"
- MemoryLimit:
- description: "Indicates if the host has memory limit support enabled."
- type: "boolean"
- example: true
- SwapLimit:
- description: "Indicates if the host has memory swap limit support enabled."
- type: "boolean"
- example: true
- KernelMemoryTCP:
- description: |
- Indicates if the host has kernel memory TCP limit support enabled. This
- field is omitted if not supported.
-
- Kernel memory TCP limits are not supported when using cgroups v2, which
- does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup.
-
- **Deprecated**: This field is deprecated as kernel 6.12 has deprecated kernel memory TCP accounting.
- type: "boolean"
- example: true
- CpuCfsPeriod:
- description: |
- Indicates if CPU CFS(Completely Fair Scheduler) period is supported by
- the host.
- type: "boolean"
- example: true
- CpuCfsQuota:
- description: |
- Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by
- the host.
- type: "boolean"
- example: true
- CPUShares:
- description: |
- Indicates if CPU Shares limiting is supported by the host.
- type: "boolean"
- example: true
- CPUSet:
- description: |
- Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.
-
- See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt)
- type: "boolean"
- example: true
- PidsLimit:
- description: "Indicates if the host kernel has PID limit support enabled."
- type: "boolean"
- example: true
- OomKillDisable:
- description: "Indicates if OOM killer disable is supported on the host."
- type: "boolean"
- IPv4Forwarding:
- description: "Indicates IPv4 forwarding is enabled."
- type: "boolean"
- example: true
- Debug:
- description: |
- Indicates if the daemon is running in debug-mode / with debug-level
- logging enabled.
- type: "boolean"
- example: true
- NFd:
- description: |
- The total number of file Descriptors in use by the daemon process.
-
- This information is only returned if debug-mode is enabled.
- type: "integer"
- example: 64
- NGoroutines:
- description: |
- The number of goroutines that currently exist.
-
- This information is only returned if debug-mode is enabled.
- type: "integer"
- example: 174
- SystemTime:
- description: |
- Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt)
- format with nano-seconds.
- type: "string"
- example: "2017-08-08T20:28:29.06202363Z"
- LoggingDriver:
- description: |
- The logging driver to use as a default for new containers.
- type: "string"
- CgroupDriver:
- description: |
- The driver to use for managing cgroups.
- type: "string"
- enum: ["cgroupfs", "systemd", "none"]
- default: "cgroupfs"
- example: "cgroupfs"
- CgroupVersion:
- description: |
- The version of the cgroup.
- type: "string"
- enum: ["1", "2"]
- default: "1"
- example: "1"
- NEventsListener:
- description: "Number of event listeners subscribed."
- type: "integer"
- example: 30
- KernelVersion:
- description: |
- Kernel version of the host.
-
- On Linux, this information obtained from `uname`. On Windows this
- information is queried from the HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\
- registry value, for example _"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)"_.
- type: "string"
- example: "6.8.0-31-generic"
- OperatingSystem:
- description: |
- Name of the host's operating system, for example: "Ubuntu 24.04 LTS"
- or "Windows Server 2016 Datacenter"
- type: "string"
- example: "Ubuntu 24.04 LTS"
- OSVersion:
- description: |
- Version of the host's operating system
-
-
-
- > **Note**: The information returned in this field, including its
- > very existence, and the formatting of values, should not be considered
- > stable, and may change without notice.
- type: "string"
- example: "24.04"
- OSType:
- description: |
- Generic type of the operating system of the host, as returned by the
- Go runtime (`GOOS`).
-
- Currently returned values are "linux" and "windows". A full list of
- possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment).
- type: "string"
- example: "linux"
- Architecture:
- description: |
- 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://go.dev/doc/install/source#environment).
- type: "string"
- example: "x86_64"
- NCPU:
- description: |
- 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.
- type: "integer"
- example: 4
- MemTotal:
- description: |
- Total amount of physical memory available on the host, in bytes.
- type: "integer"
- format: "int64"
- example: 2095882240
-
- IndexServerAddress:
- description: |
- Address / URL of the index server that is used for image search,
- and as a default for user authentication for Docker Hub and Docker Cloud.
- default: "https://index.docker.io/v1/"
- type: "string"
- example: "https://index.docker.io/v1/"
- RegistryConfig:
- $ref: "#/definitions/RegistryServiceConfig"
- GenericResources:
- $ref: "#/definitions/GenericResources"
- HttpProxy:
- description: |
- 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.
- Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL
- are masked in the API response.
-
- Containers do not automatically inherit this configuration.
- type: "string"
- example: "http://xxxxx:xxxxx@proxy.corp.example.com:8080"
- HttpsProxy:
- description: |
- 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.
- Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL
- are masked in the API response.
-
- Containers do not automatically inherit this configuration.
- type: "string"
- example: "https://xxxxx:xxxxx@proxy.corp.example.com:4443"
- NoProxy:
- description: |
- Comma-separated list of domain extensions for which no proxy should be
- used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html)
- environment variable.
-
- Containers do not automatically inherit this configuration.
- type: "string"
- example: "*.local, 169.254/16"
- Name:
- description: "Hostname of the host."
- type: "string"
- example: "node5.corp.example.com"
- Labels:
- description: |
- User-defined labels (key/value metadata) as set on the daemon.
-
-
-
- > **Note**: When part of a Swarm, nodes can both have _daemon_ labels,
- > set through the daemon configuration, and _node_ labels, set from a
- > manager node in the Swarm. Node labels are not included in this
- > field. Node labels can be retrieved using the `/nodes/(id)` endpoint
- > on a manager node in the Swarm.
- type: "array"
- items:
- type: "string"
- example: ["storage=ssd", "production"]
- ExperimentalBuild:
- description: |
- Indicates if experimental features are enabled on the daemon.
- type: "boolean"
- example: true
- ServerVersion:
- description: |
- Version string of the daemon.
- type: "string"
- example: "27.0.1"
- Runtimes:
- description: |
- 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 Docker 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.
- type: "object"
- additionalProperties:
- $ref: "#/definitions/Runtime"
- default:
- runc:
- path: "runc"
- example:
- runc:
- path: "runc"
- runc-master:
- path: "/go/bin/runc"
- custom:
- path: "/usr/local/bin/my-oci-runtime"
- runtimeArgs: ["--debug", "--systemd-cgroup=false"]
- DefaultRuntime:
- description: |
- Name of the default OCI runtime that is used when starting containers.
-
- The default can be overridden per-container at create time.
- type: "string"
- default: "runc"
- example: "runc"
- Swarm:
- $ref: "#/definitions/SwarmInfo"
- LiveRestoreEnabled:
- description: |
- 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.
- type: "boolean"
- default: false
- example: false
- Isolation:
- description: |
- Represents the isolation technology to use as a default for containers.
- The supported values are platform-specific.
-
- If no isolation value is specified on daemon start, on Windows client,
- the default is `hyperv`, and on Windows server, the default is `process`.
-
- This option is currently not used on other platforms.
- default: "default"
- type: "string"
- enum:
- - "default"
- - "hyperv"
- - "process"
- - ""
- InitBinary:
- description: |
- Name and, optional, path of the `docker-init` binary.
-
- If the path is omitted, the daemon searches the host's `$PATH` for the
- binary and uses the first result.
- type: "string"
- example: "docker-init"
- ContainerdCommit:
- $ref: "#/definitions/Commit"
- RuncCommit:
- $ref: "#/definitions/Commit"
- InitCommit:
- $ref: "#/definitions/Commit"
- SecurityOptions:
- description: |
- List of security features that are enabled on the daemon, such as
- apparmor, seccomp, SELinux, user-namespaces (userns), rootless and
- no-new-privileges.
-
- Additional configuration options for each security feature may
- be present, and are included as a comma-separated list of key/value
- pairs.
- type: "array"
- items:
- type: "string"
- example:
- - "name=apparmor"
- - "name=seccomp,profile=default"
- - "name=selinux"
- - "name=userns"
- - "name=rootless"
- ProductLicense:
- description: |
- Reports a summary of the product license on the daemon.
-
- If a commercial license has been applied to the daemon, information
- such as number of nodes, and expiration are included.
- type: "string"
- example: "Community Engine"
- DefaultAddressPools:
- description: |
- List of custom default address pools for local networks, which can be
- specified in the daemon.json file or dockerd option.
-
- Example: a Base "10.10.0.0/16" with Size 24 will define the set of 256
- 10.10.[0-255].0/24 address pools.
- type: "array"
- items:
- type: "object"
- properties:
- Base:
- description: "The network address in CIDR format"
- type: "string"
- example: "10.10.0.0/16"
- Size:
- description: "The network pool size"
- type: "integer"
- example: "24"
- FirewallBackend:
- $ref: "#/definitions/FirewallInfo"
- DiscoveredDevices:
- description: |
- List of devices discovered by device drivers.
-
- Each device includes information about its source driver, kind, name,
- and additional driver-specific attributes.
- type: "array"
- items:
- $ref: "#/definitions/DeviceInfo"
- Warnings:
- description: |
- List of warnings / informational messages about missing features, or
- issues related to the daemon configuration.
-
- These messages can be printed by the client as information to the user.
- type: "array"
- items:
- type: "string"
- example:
- - "WARNING: No memory limit support"
- CDISpecDirs:
- description: |
- List of directories where (Container Device Interface) CDI
- specifications are located.
-
- These specifications define vendor-specific modifications to an OCI
- runtime specification for a container being created.
-
- An empty list indicates that CDI device injection is disabled.
-
- Note that since using CDI device injection requires the daemon to have
- experimental enabled. For non-experimental daemons an empty list will
- always be returned.
- type: "array"
- items:
- type: "string"
- example:
- - "/etc/cdi"
- - "/var/run/cdi"
- Containerd:
- $ref: "#/definitions/ContainerdInfo"
-
- ContainerdInfo:
- description: |
- Information for connecting to the containerd instance that is used by the daemon.
- This is included for debugging purposes only.
- type: "object"
- x-nullable: true
- properties:
- Address:
- description: "The address of the containerd socket."
- type: "string"
- example: "/run/containerd/containerd.sock"
- Namespaces:
- description: |
- The namespaces that the daemon uses for running containers and
- plugins in containerd. These namespaces can be configured in the
- daemon configuration, and are considered to be used exclusively
- by the daemon, Tampering with the containerd instance may cause
- unexpected behavior.
-
- As these namespaces are considered to be exclusively accessed
- by the daemon, it is not recommended to change these values,
- or to change them to a value that is used by other systems,
- such as cri-containerd.
- type: "object"
- properties:
- Containers:
- description: |
- The default containerd namespace used for containers managed
- by the daemon.
-
- The default namespace for containers is "moby", but will be
- suffixed with the `.` of the remapped `root` if
- user-namespaces are enabled and the containerd image-store
- is used.
- type: "string"
- default: "moby"
- example: "moby"
- Plugins:
- description: |
- The default containerd namespace used for plugins managed by
- the daemon.
-
- The default namespace for plugins is "plugins.moby", but will be
- suffixed with the `.` of the remapped `root` if
- user-namespaces are enabled and the containerd image-store
- is used.
- type: "string"
- default: "plugins.moby"
- example: "plugins.moby"
-
- FirewallInfo:
- description: |
- Information about the daemon's firewalling configuration.
-
- This field is currently only used on Linux, and omitted on other platforms.
- type: "object"
- x-nullable: true
- properties:
- Driver:
- description: |
- The name of the firewall backend driver.
- type: "string"
- example: "nftables"
- Info:
- description: |
- Information about the firewall backend, provided as
- "label" / "value" pairs.
-
-
-
- > **Note**: The information returned in this field, including the
- > formatting of values and labels, should not be considered stable,
- > and may change without notice.
- type: "array"
- items:
- type: "array"
- items:
- type: "string"
- example:
- - ["ReloadedAt", "2025-01-01T00:00:00Z"]
-
- # PluginsInfo is a temp struct holding Plugins name
- # registered with docker daemon. It is used by Info struct
- PluginsInfo:
- description: |
- Available plugins per type.
-
-
-
- > **Note**: Only unmanaged (V1) plugins are included in this list.
- > V1 plugins are "lazily" loaded, and are not returned in this list
- > if there is no resource using the plugin.
- type: "object"
- properties:
- Volume:
- description: "Names of available volume-drivers, and network-driver plugins."
- type: "array"
- items:
- type: "string"
- example: ["local"]
- Network:
- description: "Names of available network-drivers, and network-driver plugins."
- type: "array"
- items:
- type: "string"
- example: ["bridge", "host", "ipvlan", "macvlan", "null", "overlay"]
- Authorization:
- description: "Names of available authorization plugins."
- type: "array"
- items:
- type: "string"
- example: ["img-authz-plugin", "hbm"]
- Log:
- description: "Names of available logging-drivers, and logging-driver plugins."
- type: "array"
- items:
- type: "string"
- example: ["awslogs", "fluentd", "gcplogs", "gelf", "journald", "json-file", "splunk", "syslog"]
-
-
- RegistryServiceConfig:
- description: |
- RegistryServiceConfig stores daemon registry services configuration.
- type: "object"
- x-nullable: true
- properties:
- InsecureRegistryCIDRs:
- description: |
- 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 (`::1/128` and `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.
- type: "array"
- items:
- type: "string"
- example: ["::1/128", "127.0.0.0/8"]
- IndexConfigs:
- type: "object"
- additionalProperties:
- $ref: "#/definitions/IndexInfo"
- example:
- "127.0.0.1:5000":
- "Name": "127.0.0.1:5000"
- "Mirrors": []
- "Secure": false
- "Official": false
- "[2001:db8:a0b:12f0::1]:80":
- "Name": "[2001:db8:a0b:12f0::1]:80"
- "Mirrors": []
- "Secure": false
- "Official": false
- "docker.io":
- Name: "docker.io"
- Mirrors: ["https://hub-mirror.corp.example.com:5000/"]
- Secure: true
- Official: true
- "registry.internal.corp.example.com:3000":
- Name: "registry.internal.corp.example.com:3000"
- Mirrors: []
- Secure: false
- Official: false
- Mirrors:
- description: |
- List of registry URLs that act as a mirror for the official
- (`docker.io`) registry.
-
- type: "array"
- items:
- type: "string"
- example:
- - "https://hub-mirror.corp.example.com:5000/"
- - "https://[2001:db8:a0b:12f0::1]/"
-
- IndexInfo:
- description:
- IndexInfo contains information about a registry.
- type: "object"
- x-nullable: true
- properties:
- Name:
- description: |
- Name of the registry, such as "docker.io".
- type: "string"
- example: "docker.io"
- Mirrors:
- description: |
- List of mirrors, expressed as URIs.
- type: "array"
- items:
- type: "string"
- example:
- - "https://hub-mirror.corp.example.com:5000/"
- - "https://registry-2.docker.io/"
- - "https://registry-3.docker.io/"
- Secure:
- description: |
- Indicates if 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.
- type: "boolean"
- example: true
- Official:
- description: |
- Indicates whether this is an official registry (i.e., Docker Hub / docker.io)
- type: "boolean"
- example: true
-
- Runtime:
- description: |
- Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec)
- runtime.
-
- The runtime is invoked by the daemon via the `containerd` daemon. OCI
- runtimes act as an interface to the Linux kernel namespaces, cgroups,
- and SELinux.
- type: "object"
- properties:
- path:
- description: |
- 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.
- type: "string"
- example: "/usr/local/bin/my-oci-runtime"
- runtimeArgs:
- description: |
- List of command-line arguments to pass to the runtime when invoked.
- type: "array"
- x-nullable: true
- items:
- type: "string"
- example: ["--debug", "--systemd-cgroup=false"]
- status:
- description: |
- Information specific to the runtime.
-
- While this API specification does not define data provided by runtimes,
- the following well-known properties may be provided by runtimes:
-
- `org.opencontainers.runtime-spec.features`: features structure as defined
- in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md),
- in a JSON string representation.
-
-
-
- > **Note**: The information returned in this field, including the
- > formatting of values and labels, should not be considered stable,
- > and may change without notice.
- type: "object"
- x-nullable: true
- additionalProperties:
- type: "string"
- example:
- "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",\"ociVersionMax\":\"1.1.0\",\"...\":\"...\"}"
-
- Commit:
- description: |
- 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: "object"
- properties:
- ID:
- description: "Actual commit ID of external tool."
- type: "string"
- example: "cfb82a876ecc11b5ca0977d1733adbe58599088a"
-
- SwarmInfo:
- description: |
- Represents generic information about swarm.
- type: "object"
- properties:
- NodeID:
- description: "Unique identifier of for this node in the swarm."
- type: "string"
- default: ""
- example: "k67qz4598weg5unwwffg6z1m1"
- NodeAddr:
- description: |
- IP address at which this node can be reached by other nodes in the
- swarm.
- type: "string"
- default: ""
- example: "10.0.0.46"
- LocalNodeState:
- $ref: "#/definitions/LocalNodeState"
- ControlAvailable:
- type: "boolean"
- default: false
- example: true
- Error:
- type: "string"
- default: ""
- RemoteManagers:
- description: |
- List of ID's and addresses of other managers in the swarm.
- type: "array"
- default: null
- x-nullable: true
- items:
- $ref: "#/definitions/PeerNode"
- example:
- - NodeID: "71izy0goik036k48jg985xnds"
- Addr: "10.0.0.158:2377"
- - NodeID: "79y6h1o4gv8n120drcprv5nmc"
- Addr: "10.0.0.159:2377"
- - NodeID: "k67qz4598weg5unwwffg6z1m1"
- Addr: "10.0.0.46:2377"
- Nodes:
- description: "Total number of nodes in the swarm."
- type: "integer"
- x-nullable: true
- example: 4
- Managers:
- description: "Total number of managers in the swarm."
- type: "integer"
- x-nullable: true
- example: 3
- Cluster:
- $ref: "#/definitions/ClusterInfo"
-
- LocalNodeState:
- description: "Current local status of this node."
- type: "string"
- default: ""
- enum:
- - ""
- - "inactive"
- - "pending"
- - "active"
- - "error"
- - "locked"
- example: "active"
-
- PeerNode:
- description: "Represents a peer-node in the swarm"
- type: "object"
- properties:
- NodeID:
- description: "Unique identifier of for this node in the swarm."
- type: "string"
- Addr:
- description: |
- IP address and ports at which this node can be reached.
- type: "string"
-
- NetworkAttachmentConfig:
- description: |
- Specifies how a service should be attached to a particular network.
- type: "object"
- properties:
- Target:
- description: |
- The target network for attachment. Must be a network name or ID.
- type: "string"
- Aliases:
- description: |
- Discoverable alternate names for the service on this network.
- type: "array"
- items:
- type: "string"
- DriverOpts:
- description: |
- Driver attachment options for the network target.
- type: "object"
- additionalProperties:
- type: "string"
-
- EventActor:
- description: |
- Actor describes something that generates events, like a container, network,
- or a volume.
- type: "object"
- properties:
- ID:
- description: "The ID of the object emitting the event"
- type: "string"
- example: "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743"
- Attributes:
- description: |
- Various key/value attributes of the object, depending on its type.
- type: "object"
- additionalProperties:
- type: "string"
- example:
- com.example.some-label: "some-label-value"
- image: "alpine:latest"
- name: "my-container"
-
- EventMessage:
- description: |
- EventMessage represents the information an event contains.
- type: "object"
- title: "SystemEventsResponse"
- properties:
- Type:
- description: "The type of object emitting the event"
- type: "string"
- enum: ["builder", "config", "container", "daemon", "image", "network", "node", "plugin", "secret", "service", "volume"]
- example: "container"
- Action:
- description: "The type of event"
- type: "string"
- example: "create"
- Actor:
- $ref: "#/definitions/EventActor"
- scope:
- description: |
- Scope of the event. Engine events are `local` scope. Cluster (Swarm)
- events are `swarm` scope.
- type: "string"
- enum: ["local", "swarm"]
- time:
- description: "Timestamp of event"
- type: "integer"
- format: "int64"
- example: 1629574695
- timeNano:
- description: "Timestamp of event, with nanosecond accuracy"
- type: "integer"
- format: "int64"
- example: 1629574695515050031
-
- OCIDescriptor:
- type: "object"
- x-go-name: Descriptor
- description: |
- A descriptor struct containing digest, media type, and size, as defined in
- the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
- properties:
- mediaType:
- description: |
- The media type of the object this schema refers to.
- type: "string"
- example: "application/vnd.oci.image.manifest.v1+json"
- digest:
- description: |
- The digest of the targeted content.
- type: "string"
- example: "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96"
- size:
- description: |
- The size in bytes of the blob.
- type: "integer"
- format: "int64"
- example: 424
- urls:
- description: |-
- List of URLs from which this object MAY be downloaded.
- type: "array"
- items:
- type: "string"
- format: "uri"
- x-nullable: true
- annotations:
- description: |-
- Arbitrary metadata relating to the targeted content.
- type: "object"
- x-nullable: true
- additionalProperties:
- type: "string"
- example:
- "com.docker.official-images.bashbrew.arch": "amd64"
- "org.opencontainers.image.base.digest": "sha256:0d0ef5c914d3ea700147da1bd050c59edb8bb12ca312f3800b29d7c8087eabd8"
- "org.opencontainers.image.base.name": "scratch"
- "org.opencontainers.image.created": "2025-01-27T00:00:00Z"
- "org.opencontainers.image.revision": "9fabb4bad5138435b01857e2fe9363e2dc5f6a79"
- "org.opencontainers.image.source": "https://git.launchpad.net/cloud-images/+oci/ubuntu-base"
- "org.opencontainers.image.url": "https://hub.docker.com/_/ubuntu"
- "org.opencontainers.image.version": "24.04"
- data:
- type: string
- x-nullable: true
- description: |-
- Data is an embedding of the targeted content. This is encoded as a base64
- string when marshalled to JSON (automatically, by encoding/json). If
- present, Data can be used directly to avoid fetching the targeted content.
- example: null
- platform:
- $ref: "#/definitions/OCIPlatform"
- artifactType:
- description: |-
- ArtifactType is the IANA media type of this artifact.
- type: "string"
- x-nullable: true
- example: null
-
- OCIPlatform:
- type: "object"
- x-go-name: Platform
- x-nullable: true
- description: |
- Describes the platform which the image in the manifest runs on, as defined
- in the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
- properties:
- architecture:
- description: |
- The CPU architecture, for example `amd64` or `ppc64`.
- type: "string"
- example: "arm"
- os:
- description: |
- The operating system, for example `linux` or `windows`.
- type: "string"
- example: "windows"
- os.version:
- description: |
- Optional field specifying the operating system version, for example on
- Windows `10.0.19041.1165`.
- type: "string"
- example: "10.0.19041.1165"
- os.features:
- description: |
- Optional field specifying an array of strings, each listing a required
- OS feature (for example on Windows `win32k`).
- type: "array"
- items:
- type: "string"
- example:
- - "win32k"
- variant:
- description: |
- Optional field specifying a variant of the CPU, for example `v7` to
- specify ARMv7 when architecture is `arm`.
- type: "string"
- example: "v7"
-
- DistributionInspect:
- type: "object"
- x-go-name: DistributionInspect
- title: "DistributionInspectResponse"
- required: [Descriptor, Platforms]
- description: |
- Describes the result obtained from contacting the registry to retrieve
- image metadata.
- properties:
- Descriptor:
- $ref: "#/definitions/OCIDescriptor"
- Platforms:
- type: "array"
- description: |
- An array containing all platforms supported by the image.
- items:
- $ref: "#/definitions/OCIPlatform"
-
- ClusterVolume:
- type: "object"
- description: |
- Options and information specific to, and only present on, Swarm CSI
- cluster volumes.
- properties:
- ID:
- type: "string"
- description: |
- The Swarm ID of this volume. Because cluster volumes are Swarm
- objects, they have an ID, unlike non-cluster volumes. This ID can
- be used to refer to the Volume instead of the name.
- Version:
- $ref: "#/definitions/ObjectVersion"
- CreatedAt:
- type: "string"
- format: "dateTime"
- UpdatedAt:
- type: "string"
- format: "dateTime"
- Spec:
- $ref: "#/definitions/ClusterVolumeSpec"
- Info:
- type: "object"
- description: |
- Information about the global status of the volume.
- properties:
- CapacityBytes:
- type: "integer"
- format: "int64"
- description: |
- The capacity of the volume in bytes. A value of 0 indicates that
- the capacity is unknown.
- VolumeContext:
- type: "object"
- description: |
- A map of strings to strings returned from the storage plugin when
- the volume is created.
- additionalProperties:
- type: "string"
- VolumeID:
- type: "string"
- description: |
- The ID of the volume as returned by the CSI storage plugin. This
- is distinct from the volume's ID as provided by Docker. This ID
- is never used by the user when communicating with Docker to refer
- to this volume. If the ID is blank, then the Volume has not been
- successfully created in the plugin yet.
- AccessibleTopology:
- type: "array"
- description: |
- The topology this volume is actually accessible from.
- items:
- $ref: "#/definitions/Topology"
- PublishStatus:
- type: "array"
- description: |
- The status of the volume as it pertains to its publishing and use on
- specific nodes
- items:
- type: "object"
- properties:
- NodeID:
- type: "string"
- description: |
- The ID of the Swarm node the volume is published on.
- State:
- type: "string"
- description: |
- The published state of the volume.
- * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed.
- * `published` The volume is published successfully to the node.
- * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so.
- * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.
- enum:
- - "pending-publish"
- - "published"
- - "pending-node-unpublish"
- - "pending-controller-unpublish"
- PublishContext:
- type: "object"
- description: |
- A map of strings to strings returned by the CSI controller
- plugin when a volume is published.
- additionalProperties:
- type: "string"
-
- ClusterVolumeSpec:
- type: "object"
- description: |
- Cluster-specific options used to create the volume.
- properties:
- Group:
- type: "string"
- description: |
- Group defines the volume group of this volume. Volumes belonging to
- the same group can be referred to by group name when creating
- Services. Referring to a volume by group instructs Swarm to treat
- volumes in that group interchangeably for the purpose of scheduling.
- Volumes with an empty string for a group technically all belong to
- the same, emptystring group.
- AccessMode:
- type: "object"
- description: |
- Defines how the volume is used by tasks.
- properties:
- Scope:
- type: "string"
- description: |
- The set of nodes this volume can be used on at one time.
- - `single` The volume may only be scheduled to one node at a time.
- - `multi` the volume may be scheduled to any supported number of nodes at a time.
- default: "single"
- enum: ["single", "multi"]
- x-nullable: false
- Sharing:
- type: "string"
- description: |
- The number and way that different tasks can use this volume
- at one time.
- - `none` The volume may only be used by one task at a time.
- - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly
- - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write.
- - `all` The volume may have any number of readers and writers.
- default: "none"
- enum: ["none", "readonly", "onewriter", "all"]
- x-nullable: false
- MountVolume:
- type: "object"
- description: |
- Options for using this volume as a Mount-type volume.
-
- Either MountVolume or BlockVolume, but not both, must be
- present.
- properties:
- FsType:
- type: "string"
- description: |
- Specifies the filesystem type for the mount volume.
- Optional.
- MountFlags:
- type: "array"
- description: |
- Flags to pass when mounting the volume. Optional.
- items:
- type: "string"
- BlockVolume:
- type: "object"
- description: |
- Options for using this volume as a Block-type volume.
- Intentionally empty.
- Secrets:
- type: "array"
- description: |
- Swarm Secrets that are passed to the CSI storage plugin when
- operating on this volume.
- items:
- type: "object"
- description: |
- One cluster volume secret entry. Defines a key-value pair that
- is passed to the plugin.
- properties:
- Key:
- type: "string"
- description: |
- Key is the name of the key of the key-value pair passed to
- the plugin.
- Secret:
- type: "string"
- description: |
- Secret is the swarm Secret object from which to read data.
- This can be a Secret name or ID. The Secret data is
- retrieved by swarm and used as the value of the key-value
- pair passed to the plugin.
- AccessibilityRequirements:
- type: "object"
- description: |
- Requirements for the accessible topology of the volume. These
- fields are optional. For an in-depth description of what these
- fields mean, see the CSI specification.
- properties:
- Requisite:
- type: "array"
- description: |
- A list of required topologies, at least one of which the
- volume must be accessible from.
- items:
- $ref: "#/definitions/Topology"
- Preferred:
- type: "array"
- description: |
- A list of topologies that the volume should attempt to be
- provisioned in.
- items:
- $ref: "#/definitions/Topology"
- CapacityRange:
- type: "object"
- description: |
- The desired capacity that the volume should be created with. If
- empty, the plugin will decide the capacity.
- properties:
- RequiredBytes:
- type: "integer"
- format: "int64"
- description: |
- The volume must be at least this big. The value of 0
- indicates an unspecified minimum
- LimitBytes:
- type: "integer"
- format: "int64"
- description: |
- The volume must not be bigger than this. The value of 0
- indicates an unspecified maximum.
- Availability:
- type: "string"
- description: |
- The availability of the volume for use in tasks.
- - `active` The volume is fully available for scheduling on the cluster
- - `pause` No new workloads should use the volume, but existing workloads are not stopped.
- - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started.
- default: "active"
- x-nullable: false
- enum:
- - "active"
- - "pause"
- - "drain"
-
- Topology:
- description: |
- A map of topological domains to topological segments. For in depth
- details, see documentation for the Topology object in the CSI
- specification.
- type: "object"
- additionalProperties:
- type: "string"
-
- ImageManifestSummary:
- x-go-name: "ManifestSummary"
- description: |
- ImageManifestSummary represents a summary of an image manifest.
- type: "object"
- required: ["ID", "Descriptor", "Available", "Size", "Kind"]
- properties:
- ID:
- description: |
- ID is the content-addressable ID of an image and is the same as the
- digest of the image manifest.
- type: "string"
- example: "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f"
- Descriptor:
- $ref: "#/definitions/OCIDescriptor"
- Available:
- description: Indicates whether all the child content (image config, layers) is fully available locally.
- type: "boolean"
- example: true
- Size:
- type: "object"
- x-nullable: false
- required: ["Content", "Total"]
- properties:
- Total:
- type: "integer"
- format: "int64"
- example: 8213251
- description: |
- Total is the total size (in bytes) of all the locally present
- data (both distributable and non-distributable) that's related to
- this manifest and its children.
- This equal to the sum of [Content] size AND all the sizes in the
- [Size] struct present in the Kind-specific data struct.
- For example, for an image kind (Kind == "image")
- this would include the size of the image content and unpacked
- image snapshots ([Size.Content] + [ImageData.Size.Unpacked]).
- Content:
- description: |
- Content is the size (in bytes) of all the locally present
- content in the content store (e.g. image config, layers)
- referenced by this manifest and its children.
- This only includes blobs in the content store.
- type: "integer"
- format: "int64"
- example: 3987495
- Kind:
- type: "string"
- example: "image"
- enum:
- - "image"
- - "attestation"
- - "unknown"
- description: |
- The kind of the manifest.
-
- kind | description
- -------------|-----------------------------------------------------------
- image | Image manifest that can be used to start a container.
- attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest.
- ImageData:
- description: |
- The image data for the image manifest.
- This field is only populated when Kind is "image".
- type: "object"
- x-nullable: true
- x-omitempty: true
- required: ["Platform", "Containers", "Size", "UnpackedSize"]
- properties:
- Platform:
- $ref: "#/definitions/OCIPlatform"
- description: |
- OCI platform of the image. This will be the platform specified in the
- manifest descriptor from the index/manifest list.
- If it's not available, it will be obtained from the image config.
- Containers:
- description: |
- The IDs of the containers that are using this image.
- type: "array"
- items:
- type: "string"
- example: ["ede54ee1fda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c7430", "abadbce344c096744d8d6071a90d474d28af8f1034b5ea9fb03c3f4bfc6d005e"]
- Size:
- type: "object"
- x-nullable: false
- required: ["Unpacked"]
- properties:
- Unpacked:
- type: "integer"
- format: "int64"
- example: 3987495
- description: |
- Unpacked is the size (in bytes) of the locally unpacked
- (uncompressed) image content that's directly usable by the containers
- running this image.
- It's independent of the distributable content - e.g.
- the image might still have an unpacked data that's still used by
- some container even when the distributable/compressed content is
- already gone.
- AttestationData:
- description: |
- The image data for the attestation manifest.
- This field is only populated when Kind is "attestation".
- type: "object"
- x-nullable: true
- x-omitempty: true
- required: ["For"]
- properties:
- For:
- description: |
- The digest of the image manifest that this attestation is for.
- type: "string"
- example: "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f"
-
-paths:
- /containers/json:
- get:
- summary: "List containers"
- description: |
- Returns a list of containers. For details on the format, see the
- [inspect endpoint](#operation/ContainerInspect).
-
- Note that it uses a different, smaller representation of a container
- than inspecting a single container. For example, the list of linked
- containers is not propagated .
- operationId: "ContainerList"
- produces:
- - "application/json"
- parameters:
- - name: "all"
- in: "query"
- description: |
- Return all containers. By default, only running containers are shown.
- type: "boolean"
- default: false
- - name: "limit"
- in: "query"
- description: |
- Return this number of most recently created containers, including
- non-running ones.
- type: "integer"
- - name: "size"
- in: "query"
- description: |
- Return the size of container as fields `SizeRw` and `SizeRootFs`.
- type: "boolean"
- default: false
- - name: "filters"
- in: "query"
- description: |
- Filters to process on the container list, encoded as JSON (a
- `map[string][]string`). For example, `{"status": ["paused"]}` will
- only return paused containers.
-
- Available filters:
-
- - `ancestor`=(`[:]`, ``, or ``)
- - `before`=(`` or ``)
- - `expose`=(`[/]`|`/[]`)
- - `exited=` containers with exit code of ``
- - `health`=(`starting`|`healthy`|`unhealthy`|`none`)
- - `id=` a container's ID
- - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
- - `is-task=`(`true`|`false`)
- - `label=key` or `label="key=value"` of a container label
- - `name=` a container's name
- - `network`=(`` or ``)
- - `publish`=(`[/]`|`/[]`)
- - `since`=(`` or ``)
- - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
- - `volume`=(`` or ``)
- type: "string"
- responses:
- 200:
- description: "no error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/ContainerSummary"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Container"]
- /containers/create:
- post:
- summary: "Create a container"
- operationId: "ContainerCreate"
- consumes:
- - "application/json"
- - "application/octet-stream"
- produces:
- - "application/json"
- parameters:
- - name: "name"
- in: "query"
- description: |
- Assign the specified name to the container. Must match
- `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
- type: "string"
- pattern: "^/?[a-zA-Z0-9][a-zA-Z0-9_.-]+$"
- - name: "platform"
- in: "query"
- description: |
- Platform in the format `os[/arch[/variant]]` used for image lookup.
-
- When specified, the daemon checks if the requested image is present
- in the local image cache with the given OS and Architecture, and
- otherwise returns a `404` status.
-
- If the option is not set, the host's native OS and Architecture are
- used to look up the image in the image cache. However, if no platform
- is passed and the given image does exist in the local image cache,
- but its OS or architecture does not match, the container is created
- with the available image, and a warning is added to the `Warnings`
- field in the response, for example;
-
- WARNING: The requested image's platform (linux/arm64/v8) does not
- match the detected host platform (linux/amd64) and no
- specific platform was requested
-
- type: "string"
- default: ""
- - name: "body"
- in: "body"
- description: "Container to create"
- schema:
- allOf:
- - $ref: "#/definitions/ContainerConfig"
- - type: "object"
- properties:
- HostConfig:
- $ref: "#/definitions/HostConfig"
- NetworkingConfig:
- $ref: "#/definitions/NetworkingConfig"
- example:
- Hostname: ""
- Domainname: ""
- User: ""
- AttachStdin: false
- AttachStdout: true
- AttachStderr: true
- Tty: false
- OpenStdin: false
- StdinOnce: false
- Env:
- - "FOO=bar"
- - "BAZ=quux"
- Cmd:
- - "date"
- Entrypoint: ""
- Image: "ubuntu"
- Labels:
- com.example.vendor: "Acme"
- com.example.license: "GPL"
- com.example.version: "1.0"
- Volumes:
- /volumes/data: {}
- WorkingDir: ""
- NetworkDisabled: false
- MacAddress: "12:34:56:78:9a:bc"
- ExposedPorts:
- 22/tcp: {}
- StopSignal: "SIGTERM"
- StopTimeout: 10
- HostConfig:
- Binds:
- - "/tmp:/tmp"
- Links:
- - "redis3:redis"
- Memory: 0
- MemorySwap: 0
- MemoryReservation: 0
- NanoCpus: 500000
- CpuPercent: 80
- CpuShares: 512
- CpuPeriod: 100000
- CpuRealtimePeriod: 1000000
- CpuRealtimeRuntime: 10000
- CpuQuota: 50000
- CpusetCpus: "0,1"
- CpusetMems: "0,1"
- MaximumIOps: 0
- MaximumIOBps: 0
- BlkioWeight: 300
- BlkioWeightDevice:
- - {}
- BlkioDeviceReadBps:
- - {}
- BlkioDeviceReadIOps:
- - {}
- BlkioDeviceWriteBps:
- - {}
- BlkioDeviceWriteIOps:
- - {}
- DeviceRequests:
- - Driver: "nvidia"
- Count: -1
- DeviceIDs": ["0", "1", "GPU-fef8089b-4820-abfc-e83e-94318197576e"]
- Capabilities: [["gpu", "nvidia", "compute"]]
- Options:
- property1: "string"
- property2: "string"
- MemorySwappiness: 60
- OomKillDisable: false
- OomScoreAdj: 500
- PidMode: ""
- PidsLimit: 0
- PortBindings:
- 22/tcp:
- - HostPort: "11022"
- PublishAllPorts: false
- Privileged: false
- ReadonlyRootfs: false
- Dns:
- - "8.8.8.8"
- DnsOptions:
- - ""
- DnsSearch:
- - ""
- VolumesFrom:
- - "parent"
- - "other:ro"
- CapAdd:
- - "NET_ADMIN"
- CapDrop:
- - "MKNOD"
- GroupAdd:
- - "newgroup"
- RestartPolicy:
- Name: ""
- MaximumRetryCount: 0
- AutoRemove: true
- NetworkMode: "bridge"
- Devices: []
- Ulimits:
- - {}
- LogConfig:
- Type: "json-file"
- Config: {}
- SecurityOpt: []
- StorageOpt: {}
- CgroupParent: ""
- VolumeDriver: ""
- ShmSize: 67108864
- NetworkingConfig:
- EndpointsConfig:
- isolated_nw:
- IPAMConfig:
- IPv4Address: "172.20.30.33"
- IPv6Address: "2001:db8:abcd::3033"
- LinkLocalIPs:
- - "169.254.34.68"
- - "fe80::3468"
- Links:
- - "container_1"
- - "container_2"
- Aliases:
- - "server_x"
- - "server_y"
- database_nw: {}
-
- required: true
- responses:
- 201:
- description: "Container created successfully"
- schema:
- $ref: "#/definitions/ContainerCreateResponse"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such image"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such image: c2ada9df5af8"
- 409:
- description: "conflict"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Container"]
- /containers/{id}/json:
- get:
- summary: "Inspect a container"
- description: "Return low-level information about a container."
- operationId: "ContainerInspect"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/ContainerInspectResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "size"
- in: "query"
- type: "boolean"
- default: false
- description: "Return the size of container as fields `SizeRw` and `SizeRootFs`"
- tags: ["Container"]
- /containers/{id}/top:
- get:
- summary: "List processes running inside a container"
- description: |
- On Unix systems, this is done by running the `ps` command. This endpoint
- is not supported on Windows.
- operationId: "ContainerTop"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/ContainerTopResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "ps_args"
- in: "query"
- description: "The arguments to pass to `ps`. For example, `aux`"
- type: "string"
- default: "-ef"
- tags: ["Container"]
- /containers/{id}/logs:
- get:
- summary: "Get container logs"
- description: |
- Get `stdout` and `stderr` logs from a container.
-
- Note: This endpoint works only for containers with the `json-file` or
- `journald` logging driver.
- produces:
- - "application/vnd.docker.raw-stream"
- - "application/vnd.docker.multiplexed-stream"
- operationId: "ContainerLogs"
- responses:
- 200:
- description: |
- logs returned as a stream in response body.
- For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).
- Note that unlike the attach endpoint, the logs endpoint does not
- upgrade the connection and does not set Content-Type.
- schema:
- type: "string"
- format: "binary"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "follow"
- in: "query"
- description: "Keep connection after returning logs."
- type: "boolean"
- default: false
- - name: "stdout"
- in: "query"
- description: "Return logs from `stdout`"
- type: "boolean"
- default: false
- - name: "stderr"
- in: "query"
- description: "Return logs from `stderr`"
- type: "boolean"
- default: false
- - name: "since"
- in: "query"
- description: "Only return logs since this time, as a UNIX timestamp"
- type: "integer"
- default: 0
- - name: "until"
- in: "query"
- description: "Only return logs before this time, as a UNIX timestamp"
- type: "integer"
- default: 0
- - name: "timestamps"
- in: "query"
- description: "Add timestamps to every log line"
- type: "boolean"
- default: false
- - name: "tail"
- in: "query"
- description: |
- Only return this number of log lines from the end of the logs.
- Specify as an integer or `all` to output all log lines.
- type: "string"
- default: "all"
- tags: ["Container"]
- /containers/{id}/changes:
- get:
- summary: "Get changes on a container’s filesystem"
- description: |
- Returns which files in a container's filesystem have been added, deleted,
- or modified. The `Kind` of modification can be one of:
-
- - `0`: Modified ("C")
- - `1`: Added ("A")
- - `2`: Deleted ("D")
- operationId: "ContainerChanges"
- produces: ["application/json"]
- responses:
- 200:
- description: "The list of changes"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/FilesystemChange"
- examples:
- application/json:
- - Path: "/dev"
- Kind: 0
- - Path: "/dev/kmsg"
- Kind: 1
- - Path: "/test"
- Kind: 1
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- tags: ["Container"]
- /containers/{id}/export:
- get:
- summary: "Export a container"
- description: "Export the contents of a container as a tarball."
- operationId: "ContainerExport"
- produces:
- - "application/octet-stream"
- responses:
- 200:
- description: "no error"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- tags: ["Container"]
- /containers/{id}/stats:
- get:
- summary: "Get container stats based on resource usage"
- description: |
- This endpoint returns a live stream of a container’s resource usage
- statistics.
-
- The `precpu_stats` is the CPU statistic of the *previous* read, and is
- used to calculate the CPU usage percentage. It is not an exact copy
- of the `cpu_stats` field.
-
- If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is
- nil then for compatibility with older daemons the length of the
- corresponding `cpu_usage.percpu_usage` array should be used.
-
- On a cgroup v2 host, the following fields are not set
- * `blkio_stats`: all fields other than `io_service_bytes_recursive`
- * `cpu_stats`: `cpu_usage.percpu_usage`
- * `memory_stats`: `max_usage` and `failcnt`
- Also, `memory_stats.stats` fields are incompatible with cgroup v1.
-
- To calculate the values shown by the `stats` command of the docker cli tool
- the following formulas can be used:
- * used_memory = `memory_stats.usage - memory_stats.stats.cache`
- * available_memory = `memory_stats.limit`
- * Memory usage % = `(used_memory / available_memory) * 100.0`
- * cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage`
- * system_cpu_delta = `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage`
- * number_cpus = `length(cpu_stats.cpu_usage.percpu_usage)` or `cpu_stats.online_cpus`
- * CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0`
- operationId: "ContainerStats"
- produces: ["application/json"]
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/ContainerStatsResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "stream"
- in: "query"
- description: |
- Stream the output. If false, the stats will be output once and then
- it will disconnect.
- type: "boolean"
- default: true
- - name: "one-shot"
- in: "query"
- description: |
- Only get a single stat instead of waiting for 2 cycles. Must be used
- with `stream=false`.
- type: "boolean"
- default: false
- tags: ["Container"]
- /containers/{id}/resize:
- post:
- summary: "Resize a container TTY"
- description: "Resize the TTY for a container."
- operationId: "ContainerResize"
- consumes:
- - "application/octet-stream"
- produces:
- - "text/plain"
- responses:
- 200:
- description: "no error"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "cannot resize container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "h"
- in: "query"
- required: true
- description: "Height of the TTY session in characters"
- type: "integer"
- - name: "w"
- in: "query"
- required: true
- description: "Width of the TTY session in characters"
- type: "integer"
- tags: ["Container"]
- /containers/{id}/start:
- post:
- summary: "Start a container"
- operationId: "ContainerStart"
- responses:
- 204:
- description: "no error"
- 304:
- description: "container already started"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "detachKeys"
- in: "query"
- description: |
- Override the key sequence for detaching a container. Format is a
- single character `[a-Z]` or `ctrl-` where `` is one
- of: `a-z`, `@`, `^`, `[`, `,` or `_`.
- type: "string"
- tags: ["Container"]
- /containers/{id}/stop:
- post:
- summary: "Stop a container"
- operationId: "ContainerStop"
- responses:
- 204:
- description: "no error"
- 304:
- description: "container already stopped"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "signal"
- in: "query"
- description: |
- Signal to send to the container as an integer or string (e.g. `SIGINT`).
- type: "string"
- - name: "t"
- in: "query"
- description: "Number of seconds to wait before killing the container"
- type: "integer"
- tags: ["Container"]
- /containers/{id}/restart:
- post:
- summary: "Restart a container"
- operationId: "ContainerRestart"
- responses:
- 204:
- description: "no error"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "signal"
- in: "query"
- description: |
- Signal to send to the container as an integer or string (e.g. `SIGINT`).
- type: "string"
- - name: "t"
- in: "query"
- description: "Number of seconds to wait before killing the container"
- type: "integer"
- tags: ["Container"]
- /containers/{id}/kill:
- post:
- summary: "Kill a container"
- description: |
- Send a POSIX signal to a container, defaulting to killing to the
- container.
- operationId: "ContainerKill"
- responses:
- 204:
- description: "no error"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 409:
- description: "container is not running"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "signal"
- in: "query"
- description: |
- Signal to send to the container as an integer or string (e.g. `SIGINT`).
- type: "string"
- default: "SIGKILL"
- tags: ["Container"]
- /containers/{id}/update:
- post:
- summary: "Update a container"
- description: |
- Change various configuration options of a container without having to
- recreate it.
- operationId: "ContainerUpdate"
- consumes: ["application/json"]
- produces: ["application/json"]
- responses:
- 200:
- description: "The container has been updated."
- schema:
- $ref: "#/definitions/ContainerUpdateResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "update"
- in: "body"
- required: true
- schema:
- allOf:
- - $ref: "#/definitions/Resources"
- - type: "object"
- properties:
- RestartPolicy:
- $ref: "#/definitions/RestartPolicy"
- example:
- BlkioWeight: 300
- CpuShares: 512
- CpuPeriod: 100000
- CpuQuota: 50000
- CpuRealtimePeriod: 1000000
- CpuRealtimeRuntime: 10000
- CpusetCpus: "0,1"
- CpusetMems: "0"
- Memory: 314572800
- MemorySwap: 514288000
- MemoryReservation: 209715200
- RestartPolicy:
- MaximumRetryCount: 4
- Name: "on-failure"
- tags: ["Container"]
- /containers/{id}/rename:
- post:
- summary: "Rename a container"
- operationId: "ContainerRename"
- responses:
- 204:
- description: "no error"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 409:
- description: "name already in use"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "name"
- in: "query"
- required: true
- description: "New name for the container"
- type: "string"
- tags: ["Container"]
- /containers/{id}/pause:
- post:
- summary: "Pause a container"
- description: |
- Use the freezer cgroup to suspend all processes in a container.
-
- Traditionally, when suspending a process the `SIGSTOP` signal is used,
- which is observable by the process being suspended. With the freezer
- cgroup the process is unaware, and unable to capture, that it is being
- suspended, and subsequently resumed.
- operationId: "ContainerPause"
- responses:
- 204:
- description: "no error"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- tags: ["Container"]
- /containers/{id}/unpause:
- post:
- summary: "Unpause a container"
- description: "Resume a container which has been paused."
- operationId: "ContainerUnpause"
- responses:
- 204:
- description: "no error"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- tags: ["Container"]
- /containers/{id}/attach:
- post:
- summary: "Attach to a container"
- description: |
- Attach to a container to read its output or send it input. You can attach
- to the same container multiple times and you can reattach to containers
- that have been detached.
-
- Either the `stream` or `logs` parameter must be `true` for this endpoint
- to do anything.
-
- See the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/)
- for more details.
-
- ### Hijacking
-
- This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`,
- and `stderr` on the same socket.
-
- This is the response from the daemon for an attach request:
-
- ```
- HTTP/1.1 200 OK
- Content-Type: application/vnd.docker.raw-stream
-
- [STREAM]
- ```
-
- After the headers and two new lines, the TCP connection can now be used
- for raw, bidirectional communication between the client and server.
-
- To hint potential proxies about connection hijacking, the Docker client
- can also optionally send connection upgrade headers.
-
- For example, the client sends this request to upgrade the connection:
-
- ```
- POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1
- Upgrade: tcp
- Connection: Upgrade
- ```
-
- The Docker daemon will respond with a `101 UPGRADED` response, and will
- similarly follow with the raw stream:
-
- ```
- HTTP/1.1 101 UPGRADED
- Content-Type: application/vnd.docker.raw-stream
- Connection: Upgrade
- Upgrade: tcp
-
- [STREAM]
- ```
-
- ### Stream format
-
- When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate),
- the HTTP Content-Type header is set to application/vnd.docker.multiplexed-stream
- and the stream over the hijacked connected is multiplexed to separate out
- `stdout` and `stderr`. The stream consists of a series of frames, each
- containing a header and a payload.
-
- The header contains the information which the stream writes (`stdout` or
- `stderr`). It also contains the size of the associated frame encoded in
- the last four bytes (`uint32`).
-
- It is encoded on the first eight bytes like this:
-
- ```go
- header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
- ```
-
- `STREAM_TYPE` can be:
-
- - 0: `stdin` (is written on `stdout`)
- - 1: `stdout`
- - 2: `stderr`
-
- `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size
- encoded as big endian.
-
- Following the header is the payload, which is the specified number of
- bytes of `STREAM_TYPE`.
-
- The simplest way to implement this protocol is the following:
-
- 1. Read 8 bytes.
- 2. Choose `stdout` or `stderr` depending on the first byte.
- 3. Extract the frame size from the last four bytes.
- 4. Read the extracted size and output it on the correct output.
- 5. Goto 1.
-
- ### Stream format when using a TTY
-
- When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate),
- the stream is not multiplexed. The data exchanged over the hijacked
- connection is simply the raw data from the process PTY and client's
- `stdin`.
-
- operationId: "ContainerAttach"
- produces:
- - "application/vnd.docker.raw-stream"
- - "application/vnd.docker.multiplexed-stream"
- responses:
- 101:
- description: "no error, hints proxy about hijacking"
- 200:
- description: "no error, no upgrade header found"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "detachKeys"
- in: "query"
- description: |
- Override the key sequence for detaching a container.Format is a single
- character `[a-Z]` or `ctrl-` where `` is one of: `a-z`,
- `@`, `^`, `[`, `,` or `_`.
- type: "string"
- - name: "logs"
- in: "query"
- description: |
- Replay previous logs from the container.
-
- This is useful for attaching to a container that has started and you
- want to output everything since the container started.
-
- If `stream` is also enabled, once all the previous output has been
- returned, it will seamlessly transition into streaming current
- output.
- type: "boolean"
- default: false
- - name: "stream"
- in: "query"
- description: |
- Stream attached streams from the time the request was made onwards.
- type: "boolean"
- default: false
- - name: "stdin"
- in: "query"
- description: "Attach to `stdin`"
- type: "boolean"
- default: false
- - name: "stdout"
- in: "query"
- description: "Attach to `stdout`"
- type: "boolean"
- default: false
- - name: "stderr"
- in: "query"
- description: "Attach to `stderr`"
- type: "boolean"
- default: false
- tags: ["Container"]
- /containers/{id}/attach/ws:
- get:
- summary: "Attach to a container via a websocket"
- operationId: "ContainerAttachWebsocket"
- responses:
- 101:
- description: "no error, hints proxy about hijacking"
- 200:
- description: "no error, no upgrade header found"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "detachKeys"
- in: "query"
- description: |
- Override the key sequence for detaching a container.Format is a single
- character `[a-Z]` or `ctrl-` where `` is one of: `a-z`,
- `@`, `^`, `[`, `,`, or `_`.
- type: "string"
- - name: "logs"
- in: "query"
- description: "Return logs"
- type: "boolean"
- default: false
- - name: "stream"
- in: "query"
- description: "Return stream"
- type: "boolean"
- default: false
- - name: "stdin"
- in: "query"
- description: "Attach to `stdin`"
- type: "boolean"
- default: false
- - name: "stdout"
- in: "query"
- description: "Attach to `stdout`"
- type: "boolean"
- default: false
- - name: "stderr"
- in: "query"
- description: "Attach to `stderr`"
- type: "boolean"
- default: false
- tags: ["Container"]
- /containers/{id}/wait:
- post:
- summary: "Wait for a container"
- description: "Block until a container stops, then returns the exit code."
- operationId: "ContainerWait"
- produces: ["application/json"]
- responses:
- 200:
- description: "The container has exit."
- schema:
- $ref: "#/definitions/ContainerWaitResponse"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "condition"
- in: "query"
- description: |
- Wait until a container state reaches the given condition.
-
- Defaults to `not-running` if omitted or empty.
- type: "string"
- enum:
- - "not-running"
- - "next-exit"
- - "removed"
- default: "not-running"
- tags: ["Container"]
- /containers/{id}:
- delete:
- summary: "Remove a container"
- operationId: "ContainerDelete"
- responses:
- 204:
- description: "no error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 409:
- description: "conflict"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: |
- You cannot remove a running container: c2ada9df5af8. Stop the
- container before attempting removal or force remove
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "v"
- in: "query"
- description: "Remove anonymous volumes associated with the container."
- type: "boolean"
- default: false
- - name: "force"
- in: "query"
- description: "If the container is running, kill it before removing it."
- type: "boolean"
- default: false
- - name: "link"
- in: "query"
- description: "Remove the specified link associated with the container."
- type: "boolean"
- default: false
- tags: ["Container"]
- /containers/{id}/archive:
- head:
- summary: "Get information about files in a container"
- description: |
- A response header `X-Docker-Container-Path-Stat` is returned, containing
- a base64 - encoded JSON object with some filesystem header information
- about the path.
- operationId: "ContainerArchiveInfo"
- responses:
- 200:
- description: "no error"
- headers:
- X-Docker-Container-Path-Stat:
- type: "string"
- description: |
- A base64 - encoded JSON object with some filesystem header
- information about the path
- 400:
- description: "Bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "Container or path does not exist"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "path"
- in: "query"
- required: true
- description: "Resource in the container’s filesystem to archive."
- type: "string"
- tags: ["Container"]
- get:
- summary: "Get an archive of a filesystem resource in a container"
- description: "Get a tar archive of a resource in the filesystem of container id."
- operationId: "ContainerArchive"
- produces: ["application/x-tar"]
- responses:
- 200:
- description: "no error"
- 400:
- description: "Bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "Container or path does not exist"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "path"
- in: "query"
- required: true
- description: "Resource in the container’s filesystem to archive."
- type: "string"
- tags: ["Container"]
- put:
- summary: "Extract an archive of files or folders to a directory in a container"
- description: |
- Upload a tar archive to be extracted to a path in the filesystem of container id.
- `path` parameter is asserted to be a directory. If it exists as a file, 400 error
- will be returned with message "not a directory".
- operationId: "PutContainerArchive"
- consumes: ["application/x-tar", "application/octet-stream"]
- responses:
- 200:
- description: "The content was extracted successfully"
- 400:
- description: "Bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "not a directory"
- 403:
- description: "Permission denied, the volume or container rootfs is marked as read-only."
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "No such container or path does not exist inside the container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the container"
- type: "string"
- - name: "path"
- in: "query"
- required: true
- description: "Path to a directory in the container to extract the archive’s contents into. "
- type: "string"
- - name: "noOverwriteDirNonDir"
- in: "query"
- description: |
- If `1`, `true`, or `True` then it will be an error if unpacking the
- given content would cause an existing directory to be replaced with
- a non-directory and vice versa.
- type: "string"
- - name: "copyUIDGID"
- in: "query"
- description: |
- If `1`, `true`, then it will copy UID/GID maps to the dest file or
- dir
- type: "string"
- - name: "inputStream"
- in: "body"
- required: true
- description: |
- The input stream must be a tar archive compressed with one of the
- following algorithms: `identity` (no compression), `gzip`, `bzip2`,
- or `xz`.
- schema:
- type: "string"
- format: "binary"
- tags: ["Container"]
- /containers/prune:
- post:
- summary: "Delete stopped containers"
- produces:
- - "application/json"
- operationId: "ContainerPrune"
- parameters:
- - name: "filters"
- in: "query"
- description: |
- Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-
- Available filters:
- - `until=` Prune containers created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.
- - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels.
- type: "string"
- responses:
- 200:
- description: "No error"
- schema:
- type: "object"
- title: "ContainerPruneResponse"
- properties:
- ContainersDeleted:
- description: "Container IDs that were deleted"
- type: "array"
- items:
- type: "string"
- SpaceReclaimed:
- description: "Disk space reclaimed in bytes"
- type: "integer"
- format: "int64"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Container"]
- /images/json:
- get:
- summary: "List Images"
- description: "Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image."
- operationId: "ImageList"
- produces:
- - "application/json"
- responses:
- 200:
- description: "Summary image data for the images matching the query"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/ImageSummary"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "all"
- in: "query"
- description: "Show all images. Only images from a final layer (no children) are shown by default."
- type: "boolean"
- default: false
- - name: "filters"
- in: "query"
- description: |
- A JSON encoded value of the filters (a `map[string][]string`) to
- process on the images list.
-
- Available filters:
-
- - `before`=(`[:]`, `` or ``)
- - `dangling=true`
- - `label=key` or `label="key=value"` of an image label
- - `reference`=(`[:]`)
- - `since`=(`[:]`, `` or ``)
- - `until=`
- type: "string"
- - name: "shared-size"
- in: "query"
- description: "Compute and show shared size as a `SharedSize` field on each image."
- type: "boolean"
- default: false
- - name: "digests"
- in: "query"
- description: "Show digest information as a `RepoDigests` field on each image."
- type: "boolean"
- default: false
- - name: "manifests"
- in: "query"
- description: "Include `Manifests` in the image summary."
- type: "boolean"
- default: false
- tags: ["Image"]
- /build:
- post:
- summary: "Build an image"
- description: |
- Build an image from a tar archive with a `Dockerfile` in it.
-
- The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/).
-
- The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.
-
- The build is canceled if the client drops the connection by quitting or being killed.
- operationId: "ImageBuild"
- consumes:
- - "application/octet-stream"
- produces:
- - "application/json"
- parameters:
- - name: "inputStream"
- in: "body"
- description: "A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz."
- schema:
- type: "string"
- format: "binary"
- - name: "dockerfile"
- in: "query"
- description: "Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`."
- type: "string"
- default: "Dockerfile"
- - name: "t"
- in: "query"
- description: "A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters."
- type: "string"
- - name: "extrahosts"
- in: "query"
- description: "Extra hosts to add to /etc/hosts"
- type: "string"
- - name: "remote"
- in: "query"
- description: "A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball."
- type: "string"
- - name: "q"
- in: "query"
- description: "Suppress verbose build output."
- type: "boolean"
- default: false
- - name: "nocache"
- in: "query"
- description: "Do not use the cache when building the image."
- type: "boolean"
- default: false
- - name: "cachefrom"
- in: "query"
- description: "JSON array of images used for build cache resolution."
- type: "string"
- - name: "pull"
- in: "query"
- description: "Attempt to pull the image even if an older image exists locally."
- type: "string"
- - name: "rm"
- in: "query"
- description: "Remove intermediate containers after a successful build."
- type: "boolean"
- default: true
- - name: "forcerm"
- in: "query"
- description: "Always remove intermediate containers, even upon failure."
- type: "boolean"
- default: false
- - name: "memory"
- in: "query"
- description: "Set memory limit for build."
- type: "integer"
- - name: "memswap"
- in: "query"
- description: "Total memory (memory + swap). Set as `-1` to disable swap."
- type: "integer"
- - name: "cpushares"
- in: "query"
- description: "CPU shares (relative weight)."
- type: "integer"
- - name: "cpusetcpus"
- in: "query"
- description: "CPUs in which to allow execution (e.g., `0-3`, `0,1`)."
- type: "string"
- - name: "cpuperiod"
- in: "query"
- description: "The length of a CPU period in microseconds."
- type: "integer"
- - name: "cpuquota"
- in: "query"
- description: "Microseconds of CPU time that the container can get in a CPU period."
- type: "integer"
- - name: "buildargs"
- in: "query"
- description: >
- JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker
- uses the buildargs as the environment context for commands run via the `Dockerfile` RUN
- instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for
- passing secret values.
-
-
- For example, the build arg `FOO=bar` would become `{"FOO":"bar"}` in JSON. This would result in the
- query parameter `buildargs={"FOO":"bar"}`. Note that `{"FOO":"bar"}` should be URI component encoded.
-
-
- [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
- type: "string"
- - name: "shmsize"
- in: "query"
- description: "Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB."
- type: "integer"
- - name: "squash"
- in: "query"
- description: "Squash the resulting images layers into a single layer. *(Experimental release only.)*"
- type: "boolean"
- - name: "labels"
- in: "query"
- description: "Arbitrary key/value labels to set on the image, as a JSON map of string pairs."
- type: "string"
- - name: "networkmode"
- in: "query"
- description: |
- Sets the networking mode for the run commands during build. Supported
- standard values are: `bridge`, `host`, `none`, and `container:`.
- Any other value is taken as a custom network's name or ID to which this
- container should connect to.
- type: "string"
- - name: "Content-type"
- in: "header"
- type: "string"
- enum:
- - "application/x-tar"
- default: "application/x-tar"
- - name: "X-Registry-Config"
- in: "header"
- description: |
- This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to.
-
- The key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example:
-
- ```
- {
- "docker.example.com": {
- "username": "janedoe",
- "password": "hunter2"
- },
- "https://index.docker.io/v1/": {
- "username": "mobydock",
- "password": "conta1n3rize14"
- }
- }
- ```
-
- Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API.
- type: "string"
- - name: "platform"
- in: "query"
- description: "Platform in the format os[/arch[/variant]]"
- type: "string"
- default: ""
- - name: "target"
- in: "query"
- description: "Target build stage"
- type: "string"
- default: ""
- - name: "outputs"
- in: "query"
- description: "BuildKit output configuration"
- type: "string"
- default: ""
- - name: "version"
- in: "query"
- type: "string"
- default: "1"
- enum: ["1", "2"]
- description: |
- Version of the builder backend to use.
-
- - `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
- - `2` is [BuildKit](https://github.com/moby/buildkit)
- responses:
- 200:
- description: "no error"
- 400:
- description: "Bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Image"]
- /build/prune:
- post:
- summary: "Delete builder cache"
- produces:
- - "application/json"
- operationId: "BuildPrune"
- parameters:
- - name: "keep-storage"
- in: "query"
- description: |
- Amount of disk space in bytes to keep for cache
-
- > **Deprecated**: This parameter is deprecated and has been renamed to "reserved-space".
- > It is kept for backward compatibility and will be removed in API v1.49.
- type: "integer"
- format: "int64"
- - name: "reserved-space"
- in: "query"
- description: "Amount of disk space in bytes to keep for cache"
- type: "integer"
- format: "int64"
- - name: "max-used-space"
- in: "query"
- description: "Maximum amount of disk space allowed to keep for cache"
- type: "integer"
- format: "int64"
- - name: "min-free-space"
- in: "query"
- description: "Target amount of free disk space after pruning"
- type: "integer"
- format: "int64"
- - name: "all"
- in: "query"
- type: "boolean"
- description: "Remove all types of build cache"
- - name: "filters"
- in: "query"
- type: "string"
- description: |
- A JSON encoded value of the filters (a `map[string][]string`) to
- process on the list of build cache objects.
-
- Available filters:
-
- - `until=` remove cache older than ``. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon's local time.
- - `id=`
- - `parent=`
- - `type=`
- - `description=`
- - `inuse`
- - `shared`
- - `private`
- responses:
- 200:
- description: "No error"
- schema:
- type: "object"
- title: "BuildPruneResponse"
- properties:
- CachesDeleted:
- type: "array"
- items:
- description: "ID of build cache object"
- type: "string"
- SpaceReclaimed:
- description: "Disk space reclaimed in bytes"
- type: "integer"
- format: "int64"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Image"]
- /images/create:
- post:
- summary: "Create an image"
- description: "Pull or import an image."
- operationId: "ImageCreate"
- consumes:
- - "text/plain"
- - "application/octet-stream"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- 404:
- description: "repository does not exist or no read access"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "fromImage"
- in: "query"
- description: |
- Name of the image to pull. If the name includes a tag or digest, specific behavior applies:
-
- - If only `fromImage` includes a tag, that tag is used.
- - If both `fromImage` and `tag` are provided, `tag` takes precedence.
- - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is ignored.
- - If neither a tag nor digest is specified, all tags are pulled.
- type: "string"
- - name: "fromSrc"
- in: "query"
- description: "Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image."
- type: "string"
- - name: "repo"
- in: "query"
- description: "Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image."
- type: "string"
- - name: "tag"
- in: "query"
- description: "Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled."
- type: "string"
- - name: "message"
- in: "query"
- description: "Set commit message for imported image."
- type: "string"
- - name: "inputImage"
- in: "body"
- description: "Image content if the value `-` has been specified in fromSrc query parameter"
- schema:
- type: "string"
- required: false
- - name: "X-Registry-Auth"
- in: "header"
- description: |
- A base64url-encoded auth configuration.
-
- Refer to the [authentication section](#section/Authentication) for
- details.
- type: "string"
- - name: "changes"
- in: "query"
- description: |
- Apply `Dockerfile` instructions to the image that is created,
- for example: `changes=ENV DEBUG=true`.
- Note that `ENV DEBUG=true` should be URI component encoded.
-
- Supported `Dockerfile` instructions:
- `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
- type: "array"
- items:
- type: "string"
- - name: "platform"
- in: "query"
- description: |
- Platform in the format os[/arch[/variant]].
-
- When used in combination with the `fromImage` option, the daemon checks
- if the given image is present in the local image cache with the given
- OS and Architecture, and otherwise attempts to pull the image. If the
- option is not set, the host's native OS and Architecture are used.
- If the given image does not exist in the local image cache, the daemon
- attempts to pull the image with the host's native OS and Architecture.
- If the given image does exists in the local image cache, but its OS or
- architecture does not match, a warning is produced.
-
- When used with the `fromSrc` option to import an image from an archive,
- this option sets the platform information for the imported image. If
- the option is not set, the host's native OS and Architecture are used
- for the imported image.
- type: "string"
- default: ""
- tags: ["Image"]
- /images/{name}/json:
- get:
- summary: "Inspect an image"
- description: "Return low-level information about an image."
- operationId: "ImageInspect"
- produces:
- - "application/json"
- responses:
- 200:
- description: "No error"
- schema:
- $ref: "#/definitions/ImageInspect"
- 404:
- description: "No such image"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such image: someimage (tag: latest)"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: "Image name or id"
- type: "string"
- required: true
- - name: "manifests"
- in: "query"
- description: "Include Manifests in the image summary."
- type: "boolean"
- default: false
- required: false
- tags: ["Image"]
- /images/{name}/history:
- get:
- summary: "Get the history of an image"
- description: "Return parent layers of an image."
- operationId: "ImageHistory"
- produces: ["application/json"]
- responses:
- 200:
- description: "List of image layers"
- schema:
- type: "array"
- items:
- type: "object"
- x-go-name: HistoryResponseItem
- title: "HistoryResponseItem"
- description: "individual image layer information in response to ImageHistory operation"
- required: [Id, Created, CreatedBy, Tags, Size, Comment]
- properties:
- Id:
- type: "string"
- x-nullable: false
- Created:
- type: "integer"
- format: "int64"
- x-nullable: false
- CreatedBy:
- type: "string"
- x-nullable: false
- Tags:
- type: "array"
- items:
- type: "string"
- Size:
- type: "integer"
- format: "int64"
- x-nullable: false
- Comment:
- type: "string"
- x-nullable: false
- examples:
- application/json:
- - Id: "3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710"
- Created: 1398108230
- CreatedBy: "/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /"
- Tags:
- - "ubuntu:lucid"
- - "ubuntu:10.04"
- Size: 182964289
- Comment: ""
- - Id: "6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8"
- Created: 1398108222
- CreatedBy: "/bin/sh -c #(nop) MAINTAINER Tianon Gravi - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/"
- Tags: []
- Size: 0
- Comment: ""
- - Id: "511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158"
- Created: 1371157430
- CreatedBy: ""
- Tags:
- - "scratch12:latest"
- - "scratch:latest"
- Size: 0
- Comment: "Imported from -"
- 404:
- description: "No such image"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: "Image name or ID"
- type: "string"
- required: true
- - name: "platform"
- type: "string"
- in: "query"
- description: |
- JSON-encoded OCI platform to select the platform-variant.
- If omitted, it defaults to any locally available platform,
- prioritizing the daemon's host platform.
-
- If the daemon provides a multi-platform image store, this selects
- the platform-variant to show the history for. If the image is
- a single-platform image, or if the multi-platform image does not
- provide a variant matching the given platform, an error is returned.
-
- Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
- tags: ["Image"]
- /images/{name}/push:
- post:
- summary: "Push an image"
- description: |
- Push an image to a registry.
-
- If you wish to push an image on to a private registry, that image must
- already have a tag which references the registry. For example,
- `registry.example.com/myimage:latest`.
-
- The push is cancelled if the HTTP connection is closed.
- operationId: "ImagePush"
- consumes:
- - "application/octet-stream"
- responses:
- 200:
- description: "No error"
- 404:
- description: "No such image"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: |
- Name of the image to push. For example, `registry.example.com/myimage`.
- The image must be present in the local image store with the same name.
-
- The name should be provided without tag; if a tag is provided, it
- is ignored. For example, `registry.example.com/myimage:latest` is
- considered equivalent to `registry.example.com/myimage`.
-
- Use the `tag` parameter to specify the tag to push.
- type: "string"
- required: true
- - name: "tag"
- in: "query"
- description: |
- Tag of the image to push. For example, `latest`. If no tag is provided,
- all tags of the given image that are present in the local image store
- are pushed.
- type: "string"
- - name: "platform"
- type: "string"
- in: "query"
- description: |
- JSON-encoded OCI platform to select the platform-variant to push.
- If not provided, all available variants will attempt to be pushed.
-
- If the daemon provides a multi-platform image store, this selects
- the platform-variant to push to the registry. If the image is
- a single-platform image, or if the multi-platform image does not
- provide a variant matching the given platform, an error is returned.
-
- Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
- - name: "X-Registry-Auth"
- in: "header"
- description: |
- A base64url-encoded auth configuration.
-
- Refer to the [authentication section](#section/Authentication) for
- details.
- type: "string"
- required: true
- tags: ["Image"]
- /images/{name}/tag:
- post:
- summary: "Tag an image"
- description: "Tag an image so that it becomes part of a repository."
- operationId: "ImageTag"
- responses:
- 201:
- description: "No error"
- 400:
- description: "Bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "No such image"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 409:
- description: "Conflict"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: "Image name or ID to tag."
- type: "string"
- required: true
- - name: "repo"
- in: "query"
- description: "The repository to tag in. For example, `someuser/someimage`."
- type: "string"
- - name: "tag"
- in: "query"
- description: "The name of the new tag."
- type: "string"
- tags: ["Image"]
- /images/{name}:
- delete:
- summary: "Remove an image"
- description: |
- Remove an image, along with any untagged parent images that were
- referenced by that image.
-
- Images can't be removed if they have descendant images, are being
- used by a running container or are being used by a build.
- operationId: "ImageDelete"
- produces: ["application/json"]
- responses:
- 200:
- description: "The image was deleted successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/ImageDeleteResponseItem"
- examples:
- application/json:
- - Untagged: "3e2f21a89f"
- - Deleted: "3e2f21a89f"
- - Deleted: "53b4f83ac9"
- 404:
- description: "No such image"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 409:
- description: "Conflict"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: "Image name or ID"
- type: "string"
- required: true
- - name: "force"
- in: "query"
- description: "Remove the image even if it is being used by stopped containers or has other tags"
- type: "boolean"
- default: false
- - name: "noprune"
- in: "query"
- description: "Do not delete untagged parent images"
- type: "boolean"
- default: false
- - name: "platforms"
- in: "query"
- description: |
- Select platform-specific content to delete.
- Multiple values are accepted.
- Each platform is a OCI platform encoded as a JSON string.
- type: "array"
- items:
- # This should be OCIPlatform
- # but $ref is not supported for array in query in Swagger 2.0
- # $ref: "#/definitions/OCIPlatform"
- type: "string"
- tags: ["Image"]
- /images/search:
- get:
- summary: "Search images"
- description: "Search for an image on Docker Hub."
- operationId: "ImageSearch"
- produces:
- - "application/json"
- responses:
- 200:
- description: "No error"
- schema:
- type: "array"
- items:
- type: "object"
- title: "ImageSearchResponseItem"
- properties:
- description:
- type: "string"
- is_official:
- type: "boolean"
- is_automated:
- description: |
- Whether this repository has automated builds enabled.
-
-
-
- > **Deprecated**: This field is deprecated and will always be "false".
- type: "boolean"
- example: false
- name:
- type: "string"
- star_count:
- type: "integer"
- examples:
- application/json:
- - description: "A minimal Docker image based on Alpine Linux with a complete package index and only 5 MB in size!"
- is_official: true
- is_automated: false
- name: "alpine"
- star_count: 10093
- - description: "Busybox base image."
- is_official: true
- is_automated: false
- name: "Busybox base image."
- star_count: 3037
- - description: "The PostgreSQL object-relational database system provides reliability and data integrity."
- is_official: true
- is_automated: false
- name: "postgres"
- star_count: 12408
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "term"
- in: "query"
- description: "Term to search"
- type: "string"
- required: true
- - name: "limit"
- in: "query"
- description: "Maximum number of results to return"
- type: "integer"
- - name: "filters"
- in: "query"
- description: |
- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:
-
- - `is-official=(true|false)`
- - `stars=` Matches images that has at least 'number' stars.
- type: "string"
- tags: ["Image"]
- /images/prune:
- post:
- summary: "Delete unused images"
- produces:
- - "application/json"
- operationId: "ImagePrune"
- parameters:
- - name: "filters"
- in: "query"
- description: |
- Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters:
-
- - `dangling=` When set to `true` (or `1`), prune only
- unused *and* untagged images. When set to `false`
- (or `0`), all unused images are pruned.
- - `until=` Prune images created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.
- - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels.
- type: "string"
- responses:
- 200:
- description: "No error"
- schema:
- type: "object"
- title: "ImagePruneResponse"
- properties:
- ImagesDeleted:
- description: "Images that were deleted"
- type: "array"
- items:
- $ref: "#/definitions/ImageDeleteResponseItem"
- SpaceReclaimed:
- description: "Disk space reclaimed in bytes"
- type: "integer"
- format: "int64"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Image"]
- /auth:
- post:
- summary: "Check auth configuration"
- description: |
- Validate credentials for a registry and, if available, get an identity
- token for accessing the registry without password.
- operationId: "SystemAuth"
- consumes: ["application/json"]
- produces: ["application/json"]
- responses:
- 200:
- description: "An identity token was generated successfully."
- schema:
- type: "object"
- title: "SystemAuthResponse"
- required: [Status]
- properties:
- Status:
- description: "The status of the authentication"
- type: "string"
- x-nullable: false
- IdentityToken:
- description: "An opaque token used to authenticate a user after a successful login"
- type: "string"
- x-nullable: false
- examples:
- application/json:
- Status: "Login Succeeded"
- IdentityToken: "9cbaf023786cd7..."
- 204:
- description: "No error"
- 401:
- description: "Auth error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "authConfig"
- in: "body"
- description: "Authentication to check"
- schema:
- $ref: "#/definitions/AuthConfig"
- tags: ["System"]
- /info:
- get:
- summary: "Get system information"
- operationId: "SystemInfo"
- produces:
- - "application/json"
- responses:
- 200:
- description: "No error"
- schema:
- $ref: "#/definitions/SystemInfo"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["System"]
- /version:
- get:
- summary: "Get version"
- description: "Returns the version of Docker that is running and various information about the system that Docker is running on."
- operationId: "SystemVersion"
- produces: ["application/json"]
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/SystemVersion"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["System"]
- /_ping:
- get:
- summary: "Ping"
- description: "This is a dummy endpoint you can use to test if the server is accessible."
- operationId: "SystemPing"
- produces: ["text/plain"]
- responses:
- 200:
- description: "no error"
- schema:
- type: "string"
- example: "OK"
- headers:
- Api-Version:
- type: "string"
- description: "Max API Version the server supports"
- Builder-Version:
- type: "string"
- description: |
- Default version of docker image builder
-
- The default on Linux is version "2" (BuildKit), but the daemon
- can be configured to recommend version "1" (classic Builder).
- Windows does not yet support BuildKit for native Windows images,
- and uses "1" (classic builder) as a default.
-
- This value is a recommendation as advertised by the daemon, and
- it is up to the client to choose which builder to use.
- default: "2"
- Docker-Experimental:
- type: "boolean"
- description: "If the server is running with experimental mode enabled"
- Swarm:
- type: "string"
- enum: ["inactive", "pending", "error", "locked", "active/worker", "active/manager"]
- description: |
- Contains information about Swarm status of the daemon,
- and if the daemon is acting as a manager or worker node.
- default: "inactive"
- Cache-Control:
- type: "string"
- default: "no-cache, no-store, must-revalidate"
- Pragma:
- type: "string"
- default: "no-cache"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- headers:
- Cache-Control:
- type: "string"
- default: "no-cache, no-store, must-revalidate"
- Pragma:
- type: "string"
- default: "no-cache"
- tags: ["System"]
- head:
- summary: "Ping"
- description: "This is a dummy endpoint you can use to test if the server is accessible."
- operationId: "SystemPingHead"
- produces: ["text/plain"]
- responses:
- 200:
- description: "no error"
- schema:
- type: "string"
- example: "(empty)"
- headers:
- Api-Version:
- type: "string"
- description: "Max API Version the server supports"
- Builder-Version:
- type: "string"
- description: "Default version of docker image builder"
- Docker-Experimental:
- type: "boolean"
- description: "If the server is running with experimental mode enabled"
- Swarm:
- type: "string"
- enum: ["inactive", "pending", "error", "locked", "active/worker", "active/manager"]
- description: |
- Contains information about Swarm status of the daemon,
- and if the daemon is acting as a manager or worker node.
- default: "inactive"
- Cache-Control:
- type: "string"
- default: "no-cache, no-store, must-revalidate"
- Pragma:
- type: "string"
- default: "no-cache"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["System"]
- /commit:
- post:
- summary: "Create a new image from a container"
- operationId: "ImageCommit"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- responses:
- 201:
- description: "no error"
- schema:
- $ref: "#/definitions/IDResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "containerConfig"
- in: "body"
- description: "The container configuration"
- schema:
- $ref: "#/definitions/ContainerConfig"
- - name: "container"
- in: "query"
- description: "The ID or name of the container to commit"
- type: "string"
- - name: "repo"
- in: "query"
- description: "Repository name for the created image"
- type: "string"
- - name: "tag"
- in: "query"
- description: "Tag name for the create image"
- type: "string"
- - name: "comment"
- in: "query"
- description: "Commit message"
- type: "string"
- - name: "author"
- in: "query"
- description: "Author of the image (e.g., `John Hannibal Smith `)"
- type: "string"
- - name: "pause"
- in: "query"
- description: "Whether to pause the container before committing"
- type: "boolean"
- default: true
- - name: "changes"
- in: "query"
- description: "`Dockerfile` instructions to apply while committing"
- type: "string"
- tags: ["Image"]
- /events:
- get:
- summary: "Monitor events"
- description: |
- Stream real-time events from the server.
-
- Various objects within Docker report events when something happens to them.
-
- Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`, `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`, `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`, `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`
-
- Images report these events: `create`, `delete`, `import`, `load`, `pull`, `push`, `save`, `tag`, `untag`, and `prune`
-
- Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and `prune`
-
- Networks report these events: `create`, `connect`, `disconnect`, `destroy`, `update`, `remove`, and `prune`
-
- The Docker daemon reports these events: `reload`
-
- Services report these events: `create`, `update`, and `remove`
-
- Nodes report these events: `create`, `update`, and `remove`
-
- Secrets report these events: `create`, `update`, and `remove`
-
- Configs report these events: `create`, `update`, and `remove`
-
- The Builder reports `prune` events
-
- operationId: "SystemEvents"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/EventMessage"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "since"
- in: "query"
- description: "Show events created since this timestamp then stream new events."
- type: "string"
- - name: "until"
- in: "query"
- description: "Show events created until this timestamp then stop streaming."
- type: "string"
- - name: "filters"
- in: "query"
- description: |
- A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters:
-
- - `config=` config name or ID
- - `container=` container name or ID
- - `daemon=` daemon name or ID
- - `event=` event type
- - `image=` image name or ID
- - `label=` image or container label
- - `network=` network name or ID
- - `node=` node ID
- - `plugin`= plugin name or ID
- - `scope`= local or swarm
- - `secret=` secret name or ID
- - `service=` service name or ID
- - `type=` object to filter by, one of `container`, `image`, `volume`, `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`
- - `volume=` volume name
- type: "string"
- tags: ["System"]
- /system/df:
- get:
- summary: "Get data usage information"
- operationId: "SystemDataUsage"
- responses:
- 200:
- description: "no error"
- schema:
- type: "object"
- title: "SystemDataUsageResponse"
- properties:
- LayersSize:
- type: "integer"
- format: "int64"
- Images:
- type: "array"
- items:
- $ref: "#/definitions/ImageSummary"
- Containers:
- type: "array"
- items:
- $ref: "#/definitions/ContainerSummary"
- Volumes:
- type: "array"
- items:
- $ref: "#/definitions/Volume"
- BuildCache:
- type: "array"
- items:
- $ref: "#/definitions/BuildCache"
- example:
- LayersSize: 1092588
- Images:
- -
- Id: "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749"
- ParentId: ""
- RepoTags:
- - "busybox:latest"
- RepoDigests:
- - "busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6"
- Created: 1466724217
- Size: 1092588
- SharedSize: 0
- Labels: {}
- Containers: 1
- Containers:
- -
- Id: "e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148"
- Names:
- - "/top"
- Image: "busybox"
- ImageID: "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749"
- Command: "top"
- Created: 1472592424
- Ports: []
- SizeRootFs: 1092588
- Labels: {}
- State: "exited"
- Status: "Exited (0) 56 minutes ago"
- HostConfig:
- NetworkMode: "default"
- NetworkSettings:
- Networks:
- bridge:
- IPAMConfig: null
- Links: null
- Aliases: null
- NetworkID: "d687bc59335f0e5c9ee8193e5612e8aee000c8c62ea170cfb99c098f95899d92"
- EndpointID: "8ed5115aeaad9abb174f68dcf135b49f11daf597678315231a32ca28441dec6a"
- Gateway: "172.18.0.1"
- IPAddress: "172.18.0.2"
- IPPrefixLen: 16
- IPv6Gateway: ""
- GlobalIPv6Address: ""
- GlobalIPv6PrefixLen: 0
- MacAddress: "02:42:ac:12:00:02"
- Mounts: []
- Volumes:
- -
- Name: "my-volume"
- Driver: "local"
- Mountpoint: "/var/lib/docker/volumes/my-volume/_data"
- Labels: null
- Scope: "local"
- Options: null
- UsageData:
- Size: 10920104
- RefCount: 2
- BuildCache:
- -
- ID: "hw53o5aio51xtltp5xjp8v7fx"
- Parents: []
- Type: "regular"
- Description: "pulled from docker.io/library/debian@sha256:234cb88d3020898631af0ccbbcca9a66ae7306ecd30c9720690858c1b007d2a0"
- InUse: false
- Shared: true
- Size: 0
- CreatedAt: "2021-06-28T13:31:01.474619385Z"
- LastUsedAt: "2021-07-07T22:02:32.738075951Z"
- UsageCount: 26
- -
- ID: "ndlpt0hhvkqcdfkputsk4cq9c"
- Parents: ["ndlpt0hhvkqcdfkputsk4cq9c"]
- Type: "regular"
- Description: "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' > /etc/apt/apt.conf.d/keep-cache"
- InUse: false
- Shared: true
- Size: 51
- CreatedAt: "2021-06-28T13:31:03.002625487Z"
- LastUsedAt: "2021-07-07T22:02:32.773909517Z"
- UsageCount: 26
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "type"
- in: "query"
- description: |
- Object types, for which to compute and return data.
- type: "array"
- collectionFormat: multi
- items:
- type: "string"
- enum: ["container", "image", "volume", "build-cache"]
- tags: ["System"]
- /images/{name}/get:
- get:
- summary: "Export an image"
- description: |
- Get a tarball containing all images and metadata for a repository.
-
- If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced.
-
- ### Image tarball format
-
- An image tarball contains [Content as defined in the OCI Image Layout Specification](https://github.com/opencontainers/image-spec/blob/v1.1.1/image-layout.md#content).
-
- Additionally, includes the manifest.json file associated with a backwards compatible docker save format.
-
- If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs.
-
- ```json
- {
- "hello-world": {
- "latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1"
- }
- }
- ```
- operationId: "ImageGet"
- produces:
- - "application/x-tar"
- responses:
- 200:
- description: "no error"
- schema:
- type: "string"
- format: "binary"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: "Image name or ID"
- type: "string"
- required: true
- - name: "platform"
- type: "string"
- in: "query"
- description: |
- JSON encoded OCI platform describing a platform which will be used
- to select a platform-specific image to be saved if the image is
- multi-platform.
- If not provided, the full multi-platform image will be saved.
-
- Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
- tags: ["Image"]
- /images/get:
- get:
- summary: "Export several images"
- description: |
- Get a tarball containing all images and metadata for several image
- repositories.
-
- For each value of the `names` parameter: if it is a specific name and
- tag (e.g. `ubuntu:latest`), then only that image (and its parents) are
- returned; if it is an image ID, similarly only that image (and its parents)
- are returned and there would be no names referenced in the 'repositories'
- file for this image ID.
-
- For details on the format, see the [export image endpoint](#operation/ImageGet).
- operationId: "ImageGetAll"
- produces:
- - "application/x-tar"
- responses:
- 200:
- description: "no error"
- schema:
- type: "string"
- format: "binary"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "names"
- in: "query"
- description: "Image names to filter by"
- type: "array"
- items:
- type: "string"
- - name: "platform"
- type: "string"
- in: "query"
- description: |
- JSON encoded OCI platform describing a platform which will be used
- to select a platform-specific image to be saved if the image is
- multi-platform.
- If not provided, the full multi-platform image will be saved.
-
- Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
- tags: ["Image"]
- /images/load:
- post:
- summary: "Import images"
- description: |
- Load a set of images and tags into a repository.
-
- For details on the format, see the [export image endpoint](#operation/ImageGet).
- operationId: "ImageLoad"
- consumes:
- - "application/x-tar"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "imagesTarball"
- in: "body"
- description: "Tar archive containing images"
- schema:
- type: "string"
- format: "binary"
- - name: "quiet"
- in: "query"
- description: "Suppress progress details during load."
- type: "boolean"
- default: false
- - name: "platform"
- type: "string"
- in: "query"
- description: |
- JSON encoded OCI platform describing a platform which will be used
- to select a platform-specific image to be load if the image is
- multi-platform.
- If not provided, the full multi-platform image will be loaded.
-
- Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
- tags: ["Image"]
- /containers/{id}/exec:
- post:
- summary: "Create an exec instance"
- description: "Run a command inside a running container."
- operationId: "ContainerExec"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- responses:
- 201:
- description: "no error"
- schema:
- $ref: "#/definitions/IDResponse"
- 404:
- description: "no such container"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such container: c2ada9df5af8"
- 409:
- description: "container is paused"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "execConfig"
- in: "body"
- description: "Exec configuration"
- schema:
- type: "object"
- title: "ExecConfig"
- properties:
- AttachStdin:
- type: "boolean"
- description: "Attach to `stdin` of the exec command."
- AttachStdout:
- type: "boolean"
- description: "Attach to `stdout` of the exec command."
- AttachStderr:
- type: "boolean"
- description: "Attach to `stderr` of the exec command."
- ConsoleSize:
- type: "array"
- description: "Initial console size, as an `[height, width]` array."
- x-nullable: true
- minItems: 2
- maxItems: 2
- items:
- type: "integer"
- minimum: 0
- example: [80, 64]
- DetachKeys:
- type: "string"
- description: |
- Override the key sequence for detaching a container. Format is
- a single character `[a-Z]` or `ctrl-` where ``
- is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.
- Tty:
- type: "boolean"
- description: "Allocate a pseudo-TTY."
- Env:
- description: |
- A list of environment variables in the form `["VAR=value", ...]`.
- type: "array"
- items:
- type: "string"
- Cmd:
- type: "array"
- description: "Command to run, as a string or array of strings."
- items:
- type: "string"
- Privileged:
- type: "boolean"
- description: "Runs the exec process with extended privileges."
- default: false
- User:
- type: "string"
- description: |
- The user, and optionally, group to run the exec process inside
- the container. Format is one of: `user`, `user:group`, `uid`,
- or `uid:gid`.
- WorkingDir:
- type: "string"
- description: |
- The working directory for the exec process inside the container.
- example:
- AttachStdin: false
- AttachStdout: true
- AttachStderr: true
- DetachKeys: "ctrl-p,ctrl-q"
- Tty: false
- Cmd:
- - "date"
- Env:
- - "FOO=bar"
- - "BAZ=quux"
- required: true
- - name: "id"
- in: "path"
- description: "ID or name of container"
- type: "string"
- required: true
- tags: ["Exec"]
- /exec/{id}/start:
- post:
- summary: "Start an exec instance"
- description: |
- Starts a previously set up exec instance. If detach is true, this endpoint
- returns immediately after starting the command. Otherwise, it sets up an
- interactive session with the command.
- operationId: "ExecStart"
- consumes:
- - "application/json"
- produces:
- - "application/vnd.docker.raw-stream"
- - "application/vnd.docker.multiplexed-stream"
- responses:
- 200:
- description: "No error"
- 404:
- description: "No such exec instance"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 409:
- description: "Container is stopped or paused"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "execStartConfig"
- in: "body"
- schema:
- type: "object"
- title: "ExecStartConfig"
- properties:
- Detach:
- type: "boolean"
- description: "Detach from the command."
- example: false
- Tty:
- type: "boolean"
- description: "Allocate a pseudo-TTY."
- example: true
- ConsoleSize:
- type: "array"
- description: "Initial console size, as an `[height, width]` array."
- x-nullable: true
- minItems: 2
- maxItems: 2
- items:
- type: "integer"
- minimum: 0
- example: [80, 64]
- - name: "id"
- in: "path"
- description: "Exec instance ID"
- required: true
- type: "string"
- tags: ["Exec"]
- /exec/{id}/resize:
- post:
- summary: "Resize an exec instance"
- description: |
- Resize the TTY session used by an exec instance. This endpoint only works
- if `tty` was specified as part of creating and starting the exec instance.
- operationId: "ExecResize"
- responses:
- 200:
- description: "No error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "No such exec instance"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "Exec instance ID"
- required: true
- type: "string"
- - name: "h"
- in: "query"
- required: true
- description: "Height of the TTY session in characters"
- type: "integer"
- - name: "w"
- in: "query"
- required: true
- description: "Width of the TTY session in characters"
- type: "integer"
- tags: ["Exec"]
- /exec/{id}/json:
- get:
- summary: "Inspect an exec instance"
- description: "Return low-level information about an exec instance."
- operationId: "ExecInspect"
- produces:
- - "application/json"
- responses:
- 200:
- description: "No error"
- schema:
- type: "object"
- title: "ExecInspectResponse"
- properties:
- CanRemove:
- type: "boolean"
- DetachKeys:
- type: "string"
- ID:
- type: "string"
- Running:
- type: "boolean"
- ExitCode:
- type: "integer"
- ProcessConfig:
- $ref: "#/definitions/ProcessConfig"
- OpenStdin:
- type: "boolean"
- OpenStderr:
- type: "boolean"
- OpenStdout:
- type: "boolean"
- ContainerID:
- type: "string"
- Pid:
- type: "integer"
- description: "The system process ID for the exec process."
- examples:
- application/json:
- CanRemove: false
- ContainerID: "b53ee82b53a40c7dca428523e34f741f3abc51d9f297a14ff874bf761b995126"
- DetachKeys: ""
- ExitCode: 2
- ID: "f33bbfb39f5b142420f4759b2348913bd4a8d1a6d7fd56499cb41a1bb91d7b3b"
- OpenStderr: true
- OpenStdin: true
- OpenStdout: true
- ProcessConfig:
- arguments:
- - "-c"
- - "exit 2"
- entrypoint: "sh"
- privileged: false
- tty: true
- user: "1000"
- Running: false
- Pid: 42000
- 404:
- description: "No such exec instance"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "Exec instance ID"
- required: true
- type: "string"
- tags: ["Exec"]
-
- /volumes:
- get:
- summary: "List volumes"
- operationId: "VolumeList"
- produces: ["application/json"]
- responses:
- 200:
- description: "Summary volume data that matches the query"
- schema:
- $ref: "#/definitions/VolumeListResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "filters"
- in: "query"
- description: |
- JSON encoded value of the filters (a `map[string][]string`) to
- process on the volumes list. Available filters:
-
- - `dangling=` When set to `true` (or `1`), returns all
- volumes that are not in use by a container. When set to `false`
- (or `0`), only volumes that are in use by one or more
- containers are returned.
- - `driver=` Matches volumes based on their driver.
- - `label=` or `label=:` Matches volumes based on
- the presence of a `label` alone or a `label` and a value.
- - `name=` Matches all or part of a volume name.
- type: "string"
- format: "json"
- tags: ["Volume"]
-
- /volumes/create:
- post:
- summary: "Create a volume"
- operationId: "VolumeCreate"
- consumes: ["application/json"]
- produces: ["application/json"]
- responses:
- 201:
- description: "The volume was created successfully"
- schema:
- $ref: "#/definitions/Volume"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "volumeConfig"
- in: "body"
- required: true
- description: "Volume configuration"
- schema:
- $ref: "#/definitions/VolumeCreateOptions"
- tags: ["Volume"]
-
- /volumes/{name}:
- get:
- summary: "Inspect a volume"
- operationId: "VolumeInspect"
- produces: ["application/json"]
- responses:
- 200:
- description: "No error"
- schema:
- $ref: "#/definitions/Volume"
- 404:
- description: "No such volume"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- required: true
- description: "Volume name or ID"
- type: "string"
- tags: ["Volume"]
-
- put:
- summary: |
- "Update a volume. Valid only for Swarm cluster volumes"
- operationId: "VolumeUpdate"
- consumes: ["application/json"]
- produces: ["application/json"]
- responses:
- 200:
- description: "no error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such volume"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: "The name or ID of the volume"
- type: "string"
- required: true
- - name: "body"
- in: "body"
- schema:
- # though the schema for is an object that contains only a
- # ClusterVolumeSpec, wrapping the ClusterVolumeSpec in this object
- # means that if, later on, we support things like changing the
- # labels, we can do so without duplicating that information to the
- # ClusterVolumeSpec.
- type: "object"
- description: "Volume configuration"
- properties:
- Spec:
- $ref: "#/definitions/ClusterVolumeSpec"
- description: |
- The spec of the volume to update. Currently, only Availability may
- change. All other fields must remain unchanged.
- - name: "version"
- in: "query"
- description: |
- The version number of the volume being updated. This is required to
- avoid conflicting writes. Found in the volume's `ClusterVolume`
- field.
- type: "integer"
- format: "int64"
- required: true
- tags: ["Volume"]
-
- delete:
- summary: "Remove a volume"
- description: "Instruct the driver to remove the volume."
- operationId: "VolumeDelete"
- responses:
- 204:
- description: "The volume was removed"
- 404:
- description: "No such volume or volume driver"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 409:
- description: "Volume is in use and cannot be removed"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- required: true
- description: "Volume name or ID"
- type: "string"
- - name: "force"
- in: "query"
- description: "Force the removal of the volume"
- type: "boolean"
- default: false
- tags: ["Volume"]
-
- /volumes/prune:
- post:
- summary: "Delete unused volumes"
- produces:
- - "application/json"
- operationId: "VolumePrune"
- parameters:
- - name: "filters"
- in: "query"
- description: |
- Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-
- Available filters:
- - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels.
- - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes.
- type: "string"
- responses:
- 200:
- description: "No error"
- schema:
- type: "object"
- title: "VolumePruneResponse"
- properties:
- VolumesDeleted:
- description: "Volumes that were deleted"
- type: "array"
- items:
- type: "string"
- SpaceReclaimed:
- description: "Disk space reclaimed in bytes"
- type: "integer"
- format: "int64"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Volume"]
- /networks:
- get:
- summary: "List networks"
- description: |
- Returns a list of networks. For details on the format, see the
- [network inspect endpoint](#operation/NetworkInspect).
-
- Note that it uses a different, smaller representation of a network than
- inspecting a single network. For example, the list of containers attached
- to the network is not propagated in API versions 1.28 and up.
- operationId: "NetworkList"
- produces:
- - "application/json"
- responses:
- 200:
- description: "No error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Network"
- examples:
- application/json:
- - Name: "bridge"
- Id: "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566"
- Created: "2016-10-19T06:21:00.416543526Z"
- Scope: "local"
- Driver: "bridge"
- EnableIPv4: true
- EnableIPv6: false
- Internal: false
- Attachable: false
- Ingress: false
- IPAM:
- Driver: "default"
- Config:
- -
- Subnet: "172.17.0.0/16"
- Options:
- com.docker.network.bridge.default_bridge: "true"
- com.docker.network.bridge.enable_icc: "true"
- com.docker.network.bridge.enable_ip_masquerade: "true"
- com.docker.network.bridge.host_binding_ipv4: "0.0.0.0"
- com.docker.network.bridge.name: "docker0"
- com.docker.network.driver.mtu: "1500"
- - Name: "none"
- Id: "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794"
- Created: "0001-01-01T00:00:00Z"
- Scope: "local"
- Driver: "null"
- EnableIPv4: false
- EnableIPv6: false
- Internal: false
- Attachable: false
- Ingress: false
- IPAM:
- Driver: "default"
- Config: []
- Containers: {}
- Options: {}
- - Name: "host"
- Id: "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e"
- Created: "0001-01-01T00:00:00Z"
- Scope: "local"
- Driver: "host"
- EnableIPv4: false
- EnableIPv6: false
- Internal: false
- Attachable: false
- Ingress: false
- IPAM:
- Driver: "default"
- Config: []
- Containers: {}
- Options: {}
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "filters"
- in: "query"
- description: |
- JSON encoded value of the filters (a `map[string][]string`) to process
- on the networks list.
-
- Available filters:
-
- - `dangling=` When set to `true` (or `1`), returns all
- networks that are not in use by a container. When set to `false`
- (or `0`), only networks that are in use by one or more
- containers are returned.
- - `driver=` Matches a network's driver.
- - `id=` Matches all or part of a network ID.
- - `label=` or `label==` of a network label.
- - `name=` Matches all or part of a network name.
- - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`, `global`, or `local`).
- - `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword returns all user-defined networks.
- type: "string"
- tags: ["Network"]
-
- /networks/{id}:
- get:
- summary: "Inspect a network"
- operationId: "NetworkInspect"
- produces:
- - "application/json"
- responses:
- 200:
- description: "No error"
- schema:
- $ref: "#/definitions/Network"
- 404:
- description: "Network not found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "Network ID or name"
- required: true
- type: "string"
- - name: "verbose"
- in: "query"
- description: "Detailed inspect output for troubleshooting"
- type: "boolean"
- default: false
- - name: "scope"
- in: "query"
- description: "Filter the network by scope (swarm, global, or local)"
- type: "string"
- tags: ["Network"]
-
- delete:
- summary: "Remove a network"
- operationId: "NetworkDelete"
- responses:
- 204:
- description: "No error"
- 403:
- description: "operation not supported for pre-defined networks"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such network"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "Network ID or name"
- required: true
- type: "string"
- tags: ["Network"]
-
- /networks/create:
- post:
- summary: "Create a network"
- operationId: "NetworkCreate"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- responses:
- 201:
- description: "Network created successfully"
- schema:
- $ref: "#/definitions/NetworkCreateResponse"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 403:
- description: |
- Forbidden operation. This happens when trying to create a network named after a pre-defined network,
- or when trying to create an overlay network on a daemon which is not part of a Swarm cluster.
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "plugin not found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "networkConfig"
- in: "body"
- description: "Network configuration"
- required: true
- schema:
- type: "object"
- title: "NetworkCreateRequest"
- required: ["Name"]
- properties:
- Name:
- description: "The network's name."
- type: "string"
- example: "my_network"
- Driver:
- description: "Name of the network driver plugin to use."
- type: "string"
- default: "bridge"
- example: "bridge"
- Scope:
- description: |
- The level at which the network exists (e.g. `swarm` for cluster-wide
- or `local` for machine level).
- type: "string"
- Internal:
- description: "Restrict external access to the network."
- type: "boolean"
- Attachable:
- description: |
- Globally scoped network is manually attachable by regular
- containers from workers in swarm mode.
- type: "boolean"
- example: true
- Ingress:
- description: |
- Ingress network is the network which provides the routing-mesh
- in swarm mode.
- type: "boolean"
- example: false
- ConfigOnly:
- description: |
- Creates a config-only network. Config-only networks are placeholder
- networks for network configurations to be used by other networks.
- Config-only networks cannot be used directly to run containers
- or services.
- type: "boolean"
- default: false
- example: false
- ConfigFrom:
- description: |
- Specifies the source which will provide the configuration for
- this network. The specified network must be an existing
- config-only network; see ConfigOnly.
- $ref: "#/definitions/ConfigReference"
- IPAM:
- description: "Optional custom IP scheme for the network."
- $ref: "#/definitions/IPAM"
- EnableIPv4:
- description: "Enable IPv4 on the network."
- type: "boolean"
- example: true
- EnableIPv6:
- description: "Enable IPv6 on the network."
- type: "boolean"
- example: true
- Options:
- description: "Network specific options to be used by the drivers."
- type: "object"
- additionalProperties:
- type: "string"
- example:
- com.docker.network.bridge.default_bridge: "true"
- com.docker.network.bridge.enable_icc: "true"
- com.docker.network.bridge.enable_ip_masquerade: "true"
- com.docker.network.bridge.host_binding_ipv4: "0.0.0.0"
- com.docker.network.bridge.name: "docker0"
- com.docker.network.driver.mtu: "1500"
- Labels:
- description: "User-defined key/value metadata."
- type: "object"
- additionalProperties:
- type: "string"
- example:
- com.example.some-label: "some-value"
- com.example.some-other-label: "some-other-value"
- tags: ["Network"]
-
- /networks/{id}/connect:
- post:
- summary: "Connect a container to a network"
- description: "The network must be either a local-scoped network or a swarm-scoped network with the `attachable` option set. A network cannot be re-attached to a running container"
- operationId: "NetworkConnect"
- consumes:
- - "application/json"
- responses:
- 200:
- description: "No error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 403:
- description: "Operation forbidden"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "Network or container not found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "Network ID or name"
- required: true
- type: "string"
- - name: "container"
- in: "body"
- required: true
- schema:
- type: "object"
- title: "NetworkConnectRequest"
- properties:
- Container:
- type: "string"
- description: "The ID or name of the container to connect to the network."
- EndpointConfig:
- $ref: "#/definitions/EndpointSettings"
- example:
- Container: "3613f73ba0e4"
- EndpointConfig:
- IPAMConfig:
- IPv4Address: "172.24.56.89"
- IPv6Address: "2001:db8::5689"
- MacAddress: "02:42:ac:12:05:02"
- Priority: 100
- tags: ["Network"]
-
- /networks/{id}/disconnect:
- post:
- summary: "Disconnect a container from a network"
- operationId: "NetworkDisconnect"
- consumes:
- - "application/json"
- responses:
- 200:
- description: "No error"
- 403:
- description: "Operation not supported for swarm scoped networks"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "Network or container not found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "Network ID or name"
- required: true
- type: "string"
- - name: "container"
- in: "body"
- required: true
- schema:
- type: "object"
- title: "NetworkDisconnectRequest"
- properties:
- Container:
- type: "string"
- description: |
- The ID or name of the container to disconnect from the network.
- Force:
- type: "boolean"
- description: |
- Force the container to disconnect from the network.
- tags: ["Network"]
- /networks/prune:
- post:
- summary: "Delete unused networks"
- produces:
- - "application/json"
- operationId: "NetworkPrune"
- parameters:
- - name: "filters"
- in: "query"
- description: |
- Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-
- Available filters:
- - `until=` Prune networks created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.
- - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels.
- type: "string"
- responses:
- 200:
- description: "No error"
- schema:
- type: "object"
- title: "NetworkPruneResponse"
- properties:
- NetworksDeleted:
- description: "Networks that were deleted"
- type: "array"
- items:
- type: "string"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Network"]
- /plugins:
- get:
- summary: "List plugins"
- operationId: "PluginList"
- description: "Returns information about installed plugins."
- produces: ["application/json"]
- responses:
- 200:
- description: "No error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Plugin"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "filters"
- in: "query"
- type: "string"
- description: |
- A JSON encoded value of the filters (a `map[string][]string`) to
- process on the plugin list.
-
- Available filters:
-
- - `capability=`
- - `enable=|`
- tags: ["Plugin"]
-
- /plugins/privileges:
- get:
- summary: "Get plugin privileges"
- operationId: "GetPluginPrivileges"
- responses:
- 200:
- description: "no error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/PluginPrivilege"
- example:
- - Name: "network"
- Description: ""
- Value:
- - "host"
- - Name: "mount"
- Description: ""
- Value:
- - "/data"
- - Name: "device"
- Description: ""
- Value:
- - "/dev/cpu_dma_latency"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "remote"
- in: "query"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- tags:
- - "Plugin"
-
- /plugins/pull:
- post:
- summary: "Install a plugin"
- operationId: "PluginPull"
- description: |
- Pulls and installs a plugin. After the plugin is installed, it can be
- enabled using the [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable).
- produces:
- - "application/json"
- responses:
- 204:
- description: "no error"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "remote"
- in: "query"
- description: |
- Remote reference for plugin to install.
-
- The `:latest` tag is optional, and is used as the default if omitted.
- required: true
- type: "string"
- - name: "name"
- in: "query"
- description: |
- Local name for the pulled plugin.
-
- The `:latest` tag is optional, and is used as the default if omitted.
- required: false
- type: "string"
- - name: "X-Registry-Auth"
- in: "header"
- description: |
- A base64url-encoded auth configuration to use when pulling a plugin
- from a registry.
-
- Refer to the [authentication section](#section/Authentication) for
- details.
- type: "string"
- - name: "body"
- in: "body"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/PluginPrivilege"
- example:
- - Name: "network"
- Description: ""
- Value:
- - "host"
- - Name: "mount"
- Description: ""
- Value:
- - "/data"
- - Name: "device"
- Description: ""
- Value:
- - "/dev/cpu_dma_latency"
- tags: ["Plugin"]
- /plugins/{name}/json:
- get:
- summary: "Inspect a plugin"
- operationId: "PluginInspect"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/Plugin"
- 404:
- description: "plugin is not installed"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- tags: ["Plugin"]
- /plugins/{name}:
- delete:
- summary: "Remove a plugin"
- operationId: "PluginDelete"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/Plugin"
- 404:
- description: "plugin is not installed"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- - name: "force"
- in: "query"
- description: |
- Disable the plugin before removing. This may result in issues if the
- plugin is in use by a container.
- type: "boolean"
- default: false
- tags: ["Plugin"]
- /plugins/{name}/enable:
- post:
- summary: "Enable a plugin"
- operationId: "PluginEnable"
- responses:
- 200:
- description: "no error"
- 404:
- description: "plugin is not installed"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- - name: "timeout"
- in: "query"
- description: "Set the HTTP client timeout (in seconds)"
- type: "integer"
- default: 0
- tags: ["Plugin"]
- /plugins/{name}/disable:
- post:
- summary: "Disable a plugin"
- operationId: "PluginDisable"
- responses:
- 200:
- description: "no error"
- 404:
- description: "plugin is not installed"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- - name: "force"
- in: "query"
- description: |
- Force disable a plugin even if still in use.
- required: false
- type: "boolean"
- tags: ["Plugin"]
- /plugins/{name}/upgrade:
- post:
- summary: "Upgrade a plugin"
- operationId: "PluginUpgrade"
- responses:
- 204:
- description: "no error"
- 404:
- description: "plugin not installed"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- - name: "remote"
- in: "query"
- description: |
- Remote reference to upgrade to.
-
- The `:latest` tag is optional, and is used as the default if omitted.
- required: true
- type: "string"
- - name: "X-Registry-Auth"
- in: "header"
- description: |
- A base64url-encoded auth configuration to use when pulling a plugin
- from a registry.
-
- Refer to the [authentication section](#section/Authentication) for
- details.
- type: "string"
- - name: "body"
- in: "body"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/PluginPrivilege"
- example:
- - Name: "network"
- Description: ""
- Value:
- - "host"
- - Name: "mount"
- Description: ""
- Value:
- - "/data"
- - Name: "device"
- Description: ""
- Value:
- - "/dev/cpu_dma_latency"
- tags: ["Plugin"]
- /plugins/create:
- post:
- summary: "Create a plugin"
- operationId: "PluginCreate"
- consumes:
- - "application/x-tar"
- responses:
- 204:
- description: "no error"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "query"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- - name: "tarContext"
- in: "body"
- description: "Path to tar containing plugin rootfs and manifest"
- schema:
- type: "string"
- format: "binary"
- tags: ["Plugin"]
- /plugins/{name}/push:
- post:
- summary: "Push a plugin"
- operationId: "PluginPush"
- description: |
- Push a plugin to the registry.
- parameters:
- - name: "name"
- in: "path"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- responses:
- 200:
- description: "no error"
- 404:
- description: "plugin not installed"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Plugin"]
- /plugins/{name}/set:
- post:
- summary: "Configure a plugin"
- operationId: "PluginSet"
- consumes:
- - "application/json"
- parameters:
- - name: "name"
- in: "path"
- description: |
- The name of the plugin. The `:latest` tag is optional, and is the
- default if omitted.
- required: true
- type: "string"
- - name: "body"
- in: "body"
- schema:
- type: "array"
- items:
- type: "string"
- example: ["DEBUG=1"]
- responses:
- 204:
- description: "No error"
- 404:
- description: "Plugin not installed"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Plugin"]
- /nodes:
- get:
- summary: "List nodes"
- operationId: "NodeList"
- responses:
- 200:
- description: "no error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Node"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "filters"
- in: "query"
- description: |
- Filters to process on the nodes list, encoded as JSON (a `map[string][]string`).
-
- Available filters:
- - `id=`
- - `label=`
- - `membership=`(`accepted`|`pending`)`
- - `name=`
- - `node.label=`
- - `role=`(`manager`|`worker`)`
- type: "string"
- tags: ["Node"]
- /nodes/{id}:
- get:
- summary: "Inspect a node"
- operationId: "NodeInspect"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/Node"
- 404:
- description: "no such node"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "The ID or name of the node"
- type: "string"
- required: true
- tags: ["Node"]
- delete:
- summary: "Delete a node"
- operationId: "NodeDelete"
- responses:
- 200:
- description: "no error"
- 404:
- description: "no such node"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "The ID or name of the node"
- type: "string"
- required: true
- - name: "force"
- in: "query"
- description: "Force remove a node from the swarm"
- default: false
- type: "boolean"
- tags: ["Node"]
- /nodes/{id}/update:
- post:
- summary: "Update a node"
- operationId: "NodeUpdate"
- responses:
- 200:
- description: "no error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such node"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "The ID of the node"
- type: "string"
- required: true
- - name: "body"
- in: "body"
- schema:
- $ref: "#/definitions/NodeSpec"
- - name: "version"
- in: "query"
- description: |
- The version number of the node object being updated. This is required
- to avoid conflicting writes.
- type: "integer"
- format: "int64"
- required: true
- tags: ["Node"]
- /swarm:
- get:
- summary: "Inspect swarm"
- operationId: "SwarmInspect"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/Swarm"
- 404:
- description: "no such swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Swarm"]
- /swarm/init:
- post:
- summary: "Initialize a new swarm"
- operationId: "SwarmInit"
- produces:
- - "application/json"
- - "text/plain"
- responses:
- 200:
- description: "no error"
- schema:
- description: "The node ID"
- type: "string"
- example: "7v2t30z9blmxuhnyo6s4cpenp"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is already part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "body"
- in: "body"
- required: true
- schema:
- type: "object"
- title: "SwarmInitRequest"
- properties:
- ListenAddr:
- description: |
- Listen address used for inter-manager communication, as well
- as determining the networking interface used for the VXLAN
- Tunnel Endpoint (VTEP). This can either be an address/port
- combination in the form `192.168.1.1:4567`, or an interface
- followed by a port number, like `eth0:4567`. If the port number
- is omitted, the default swarm listening port is used.
- type: "string"
- AdvertiseAddr:
- description: |
- Externally reachable address advertised to other nodes. This
- can either be an address/port combination in the form
- `192.168.1.1:4567`, or an interface followed by a port number,
- like `eth0:4567`. If the port number is omitted, the port
- number from the listen address is used. If `AdvertiseAddr` is
- not specified, it will be automatically detected when possible.
- type: "string"
- DataPathAddr:
- description: |
- Address or interface to use for data path traffic (format:
- ``), for example, `192.168.1.1`, or an interface,
- like `eth0`. If `DataPathAddr` is unspecified, the same address
- as `AdvertiseAddr` is used.
-
- The `DataPathAddr` specifies the address that global scope
- network drivers will publish towards other nodes in order to
- reach the containers running on this node. Using this parameter
- it is possible to separate the container data traffic from the
- management traffic of the cluster.
- type: "string"
- DataPathPort:
- description: |
- DataPathPort specifies the data path port number for data traffic.
- Acceptable port range is 1024 to 49151.
- if no port is set or is set to 0, default port 4789 will be used.
- type: "integer"
- format: "uint32"
- DefaultAddrPool:
- description: |
- Default Address Pool specifies default subnet pools for global
- scope networks.
- type: "array"
- items:
- type: "string"
- example: ["10.10.0.0/16", "20.20.0.0/16"]
- ForceNewCluster:
- description: "Force creation of a new swarm."
- type: "boolean"
- SubnetSize:
- description: |
- SubnetSize specifies the subnet size of the networks created
- from the default subnet pool.
- type: "integer"
- format: "uint32"
- Spec:
- $ref: "#/definitions/SwarmSpec"
- example:
- ListenAddr: "0.0.0.0:2377"
- AdvertiseAddr: "192.168.1.1:2377"
- DataPathPort: 4789
- DefaultAddrPool: ["10.10.0.0/8", "20.20.0.0/8"]
- SubnetSize: 24
- ForceNewCluster: false
- Spec:
- Orchestration: {}
- Raft: {}
- Dispatcher: {}
- CAConfig: {}
- EncryptionConfig:
- AutoLockManagers: false
- tags: ["Swarm"]
- /swarm/join:
- post:
- summary: "Join an existing swarm"
- operationId: "SwarmJoin"
- responses:
- 200:
- description: "no error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is already part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "body"
- in: "body"
- required: true
- schema:
- type: "object"
- title: "SwarmJoinRequest"
- properties:
- ListenAddr:
- description: |
- Listen address used for inter-manager communication if the node
- gets promoted to manager, as well as determining the networking
- interface used for the VXLAN Tunnel Endpoint (VTEP).
- type: "string"
- AdvertiseAddr:
- description: |
- Externally reachable address advertised to other nodes. This
- can either be an address/port combination in the form
- `192.168.1.1:4567`, or an interface followed by a port number,
- like `eth0:4567`. If the port number is omitted, the port
- number from the listen address is used. If `AdvertiseAddr` is
- not specified, it will be automatically detected when possible.
- type: "string"
- DataPathAddr:
- description: |
- Address or interface to use for data path traffic (format:
- ``), for example, `192.168.1.1`, or an interface,
- like `eth0`. If `DataPathAddr` is unspecified, the same address
- as `AdvertiseAddr` is used.
-
- The `DataPathAddr` specifies the address that global scope
- network drivers will publish towards other nodes in order to
- reach the containers running on this node. Using this parameter
- it is possible to separate the container data traffic from the
- management traffic of the cluster.
-
- type: "string"
- RemoteAddrs:
- description: |
- Addresses of manager nodes already participating in the swarm.
- type: "array"
- items:
- type: "string"
- JoinToken:
- description: "Secret token for joining this swarm."
- type: "string"
- example:
- ListenAddr: "0.0.0.0:2377"
- AdvertiseAddr: "192.168.1.1:2377"
- DataPathAddr: "192.168.1.1"
- RemoteAddrs:
- - "node1:2377"
- JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"
- tags: ["Swarm"]
- /swarm/leave:
- post:
- summary: "Leave a swarm"
- operationId: "SwarmLeave"
- responses:
- 200:
- description: "no error"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "force"
- description: |
- Force leave swarm, even if this is the last manager or that it will
- break the cluster.
- in: "query"
- type: "boolean"
- default: false
- tags: ["Swarm"]
- /swarm/update:
- post:
- summary: "Update a swarm"
- operationId: "SwarmUpdate"
- responses:
- 200:
- description: "no error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "body"
- in: "body"
- required: true
- schema:
- $ref: "#/definitions/SwarmSpec"
- - name: "version"
- in: "query"
- description: |
- The version number of the swarm object being updated. This is
- required to avoid conflicting writes.
- type: "integer"
- format: "int64"
- required: true
- - name: "rotateWorkerToken"
- in: "query"
- description: "Rotate the worker join token."
- type: "boolean"
- default: false
- - name: "rotateManagerToken"
- in: "query"
- description: "Rotate the manager join token."
- type: "boolean"
- default: false
- - name: "rotateManagerUnlockKey"
- in: "query"
- description: "Rotate the manager unlock key."
- type: "boolean"
- default: false
- tags: ["Swarm"]
- /swarm/unlockkey:
- get:
- summary: "Get the unlock key"
- operationId: "SwarmUnlockkey"
- consumes:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- type: "object"
- title: "UnlockKeyResponse"
- properties:
- UnlockKey:
- description: "The swarm's unlock key."
- type: "string"
- example:
- UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Swarm"]
- /swarm/unlock:
- post:
- summary: "Unlock a locked manager"
- operationId: "SwarmUnlock"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "body"
- in: "body"
- required: true
- schema:
- type: "object"
- title: "SwarmUnlockRequest"
- properties:
- UnlockKey:
- description: "The swarm's unlock key."
- type: "string"
- example:
- UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8"
- responses:
- 200:
- description: "no error"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Swarm"]
- /services:
- get:
- summary: "List services"
- operationId: "ServiceList"
- responses:
- 200:
- description: "no error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Service"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "filters"
- in: "query"
- type: "string"
- description: |
- A JSON encoded value of the filters (a `map[string][]string`) to
- process on the services list.
-
- Available filters:
-
- - `id=`
- - `label=`
- - `mode=["replicated"|"global"]`
- - `name=`
- - name: "status"
- in: "query"
- type: "boolean"
- description: |
- Include service status, with count of running and desired tasks.
- tags: ["Service"]
- /services/create:
- post:
- summary: "Create a service"
- operationId: "ServiceCreate"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- responses:
- 201:
- description: "no error"
- schema:
- $ref: "#/definitions/ServiceCreateResponse"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 403:
- description: "network is not eligible for services"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 409:
- description: "name conflicts with an existing service"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "body"
- in: "body"
- required: true
- schema:
- allOf:
- - $ref: "#/definitions/ServiceSpec"
- - type: "object"
- example:
- Name: "web"
- TaskTemplate:
- ContainerSpec:
- Image: "nginx:alpine"
- Mounts:
- -
- ReadOnly: true
- Source: "web-data"
- Target: "/usr/share/nginx/html"
- Type: "volume"
- VolumeOptions:
- DriverConfig: {}
- Labels:
- com.example.something: "something-value"
- Hosts: ["10.10.10.10 host1", "ABCD:EF01:2345:6789:ABCD:EF01:2345:6789 host2"]
- User: "33"
- DNSConfig:
- Nameservers: ["8.8.8.8"]
- Search: ["example.org"]
- Options: ["timeout:3"]
- Secrets:
- -
- File:
- Name: "www.example.org.key"
- UID: "33"
- GID: "33"
- Mode: 384
- SecretID: "fpjqlhnwb19zds35k8wn80lq9"
- SecretName: "example_org_domain_key"
- OomScoreAdj: 0
- LogDriver:
- Name: "json-file"
- Options:
- max-file: "3"
- max-size: "10M"
- Placement: {}
- Resources:
- Limits:
- MemoryBytes: 104857600
- Reservations: {}
- RestartPolicy:
- Condition: "on-failure"
- Delay: 10000000000
- MaxAttempts: 10
- Mode:
- Replicated:
- Replicas: 4
- UpdateConfig:
- Parallelism: 2
- Delay: 1000000000
- FailureAction: "pause"
- Monitor: 15000000000
- MaxFailureRatio: 0.15
- RollbackConfig:
- Parallelism: 1
- Delay: 1000000000
- FailureAction: "pause"
- Monitor: 15000000000
- MaxFailureRatio: 0.15
- EndpointSpec:
- Ports:
- -
- Protocol: "tcp"
- PublishedPort: 8080
- TargetPort: 80
- Labels:
- foo: "bar"
- - name: "X-Registry-Auth"
- in: "header"
- description: |
- A base64url-encoded auth configuration for pulling from private
- registries.
-
- Refer to the [authentication section](#section/Authentication) for
- details.
- type: "string"
- tags: ["Service"]
- /services/{id}:
- get:
- summary: "Inspect a service"
- operationId: "ServiceInspect"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/Service"
- 404:
- description: "no such service"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "ID or name of service."
- required: true
- type: "string"
- - name: "insertDefaults"
- in: "query"
- description: "Fill empty fields with default values."
- type: "boolean"
- default: false
- tags: ["Service"]
- delete:
- summary: "Delete a service"
- operationId: "ServiceDelete"
- responses:
- 200:
- description: "no error"
- 404:
- description: "no such service"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "ID or name of service."
- required: true
- type: "string"
- tags: ["Service"]
- /services/{id}/update:
- post:
- summary: "Update a service"
- operationId: "ServiceUpdate"
- consumes: ["application/json"]
- produces: ["application/json"]
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/ServiceUpdateResponse"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such service"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "ID or name of service."
- required: true
- type: "string"
- - name: "body"
- in: "body"
- required: true
- schema:
- allOf:
- - $ref: "#/definitions/ServiceSpec"
- - type: "object"
- example:
- Name: "top"
- TaskTemplate:
- ContainerSpec:
- Image: "busybox"
- Args:
- - "top"
- OomScoreAdj: 0
- Resources:
- Limits: {}
- Reservations: {}
- RestartPolicy:
- Condition: "any"
- MaxAttempts: 0
- Placement: {}
- ForceUpdate: 0
- Mode:
- Replicated:
- Replicas: 1
- UpdateConfig:
- Parallelism: 2
- Delay: 1000000000
- FailureAction: "pause"
- Monitor: 15000000000
- MaxFailureRatio: 0.15
- RollbackConfig:
- Parallelism: 1
- Delay: 1000000000
- FailureAction: "pause"
- Monitor: 15000000000
- MaxFailureRatio: 0.15
- EndpointSpec:
- Mode: "vip"
-
- - name: "version"
- in: "query"
- description: |
- The version number of the service object being updated. This is
- required to avoid conflicting writes.
- This version number should be the value as currently set on the
- service *before* the update. You can find the current version by
- calling `GET /services/{id}`
- required: true
- type: "integer"
- - name: "registryAuthFrom"
- in: "query"
- description: |
- If the `X-Registry-Auth` header is not specified, this parameter
- indicates where to find registry authorization credentials.
- type: "string"
- enum: ["spec", "previous-spec"]
- default: "spec"
- - name: "rollback"
- in: "query"
- description: |
- Set to this parameter to `previous` to cause a server-side rollback
- to the previous service spec. The supplied spec will be ignored in
- this case.
- type: "string"
- - name: "X-Registry-Auth"
- in: "header"
- description: |
- A base64url-encoded auth configuration for pulling from private
- registries.
-
- Refer to the [authentication section](#section/Authentication) for
- details.
- type: "string"
-
- tags: ["Service"]
- /services/{id}/logs:
- get:
- summary: "Get service logs"
- description: |
- Get `stdout` and `stderr` logs from a service. See also
- [`/containers/{id}/logs`](#operation/ContainerLogs).
-
- **Note**: This endpoint works only for services with the `local`,
- `json-file` or `journald` logging drivers.
- produces:
- - "application/vnd.docker.raw-stream"
- - "application/vnd.docker.multiplexed-stream"
- operationId: "ServiceLogs"
- responses:
- 200:
- description: "logs returned as a stream in response body"
- schema:
- type: "string"
- format: "binary"
- 404:
- description: "no such service"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such service: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID or name of the service"
- type: "string"
- - name: "details"
- in: "query"
- description: "Show service context and extra details provided to logs."
- type: "boolean"
- default: false
- - name: "follow"
- in: "query"
- description: "Keep connection after returning logs."
- type: "boolean"
- default: false
- - name: "stdout"
- in: "query"
- description: "Return logs from `stdout`"
- type: "boolean"
- default: false
- - name: "stderr"
- in: "query"
- description: "Return logs from `stderr`"
- type: "boolean"
- default: false
- - name: "since"
- in: "query"
- description: "Only return logs since this time, as a UNIX timestamp"
- type: "integer"
- default: 0
- - name: "timestamps"
- in: "query"
- description: "Add timestamps to every log line"
- type: "boolean"
- default: false
- - name: "tail"
- in: "query"
- description: |
- Only return this number of log lines from the end of the logs.
- Specify as an integer or `all` to output all log lines.
- type: "string"
- default: "all"
- tags: ["Service"]
- /tasks:
- get:
- summary: "List tasks"
- operationId: "TaskList"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Task"
- example:
- - ID: "0kzzo1i0y4jz6027t0k7aezc7"
- Version:
- Index: 71
- CreatedAt: "2016-06-07T21:07:31.171892745Z"
- UpdatedAt: "2016-06-07T21:07:31.376370513Z"
- Spec:
- ContainerSpec:
- Image: "redis"
- Resources:
- Limits: {}
- Reservations: {}
- RestartPolicy:
- Condition: "any"
- MaxAttempts: 0
- Placement: {}
- ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz"
- Slot: 1
- NodeID: "60gvrl6tm78dmak4yl7srz94v"
- Status:
- Timestamp: "2016-06-07T21:07:31.290032978Z"
- State: "running"
- Message: "started"
- ContainerStatus:
- ContainerID: "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035"
- PID: 677
- DesiredState: "running"
- NetworksAttachments:
- - Network:
- ID: "4qvuz4ko70xaltuqbt8956gd1"
- Version:
- Index: 18
- CreatedAt: "2016-06-07T20:31:11.912919752Z"
- UpdatedAt: "2016-06-07T21:07:29.955277358Z"
- Spec:
- Name: "ingress"
- Labels:
- com.docker.swarm.internal: "true"
- DriverConfiguration: {}
- IPAMOptions:
- Driver: {}
- Configs:
- - Subnet: "10.255.0.0/16"
- Gateway: "10.255.0.1"
- DriverState:
- Name: "overlay"
- Options:
- com.docker.network.driver.overlay.vxlanid_list: "256"
- IPAMOptions:
- Driver:
- Name: "default"
- Configs:
- - Subnet: "10.255.0.0/16"
- Gateway: "10.255.0.1"
- Addresses:
- - "10.255.0.10/16"
- - ID: "1yljwbmlr8er2waf8orvqpwms"
- Version:
- Index: 30
- CreatedAt: "2016-06-07T21:07:30.019104782Z"
- UpdatedAt: "2016-06-07T21:07:30.231958098Z"
- Name: "hopeful_cori"
- Spec:
- ContainerSpec:
- Image: "redis"
- Resources:
- Limits: {}
- Reservations: {}
- RestartPolicy:
- Condition: "any"
- MaxAttempts: 0
- Placement: {}
- ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz"
- Slot: 1
- NodeID: "60gvrl6tm78dmak4yl7srz94v"
- Status:
- Timestamp: "2016-06-07T21:07:30.202183143Z"
- State: "shutdown"
- Message: "shutdown"
- ContainerStatus:
- ContainerID: "1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213"
- DesiredState: "shutdown"
- NetworksAttachments:
- - Network:
- ID: "4qvuz4ko70xaltuqbt8956gd1"
- Version:
- Index: 18
- CreatedAt: "2016-06-07T20:31:11.912919752Z"
- UpdatedAt: "2016-06-07T21:07:29.955277358Z"
- Spec:
- Name: "ingress"
- Labels:
- com.docker.swarm.internal: "true"
- DriverConfiguration: {}
- IPAMOptions:
- Driver: {}
- Configs:
- - Subnet: "10.255.0.0/16"
- Gateway: "10.255.0.1"
- DriverState:
- Name: "overlay"
- Options:
- com.docker.network.driver.overlay.vxlanid_list: "256"
- IPAMOptions:
- Driver:
- Name: "default"
- Configs:
- - Subnet: "10.255.0.0/16"
- Gateway: "10.255.0.1"
- Addresses:
- - "10.255.0.5/16"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "filters"
- in: "query"
- type: "string"
- description: |
- A JSON encoded value of the filters (a `map[string][]string`) to
- process on the tasks list.
-
- Available filters:
-
- - `desired-state=(running | shutdown | accepted)`
- - `id=`
- - `label=key` or `label="key=value"`
- - `name=`
- - `node=`
- - `service=`
- tags: ["Task"]
- /tasks/{id}:
- get:
- summary: "Inspect a task"
- operationId: "TaskInspect"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/Task"
- 404:
- description: "no such task"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "ID of the task"
- required: true
- type: "string"
- tags: ["Task"]
- /tasks/{id}/logs:
- get:
- summary: "Get task logs"
- description: |
- Get `stdout` and `stderr` logs from a task.
- See also [`/containers/{id}/logs`](#operation/ContainerLogs).
-
- **Note**: This endpoint works only for services with the `local`,
- `json-file` or `journald` logging drivers.
- operationId: "TaskLogs"
- produces:
- - "application/vnd.docker.raw-stream"
- - "application/vnd.docker.multiplexed-stream"
- responses:
- 200:
- description: "logs returned as a stream in response body"
- schema:
- type: "string"
- format: "binary"
- 404:
- description: "no such task"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such task: c2ada9df5af8"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- description: "ID of the task"
- type: "string"
- - name: "details"
- in: "query"
- description: "Show task context and extra details provided to logs."
- type: "boolean"
- default: false
- - name: "follow"
- in: "query"
- description: "Keep connection after returning logs."
- type: "boolean"
- default: false
- - name: "stdout"
- in: "query"
- description: "Return logs from `stdout`"
- type: "boolean"
- default: false
- - name: "stderr"
- in: "query"
- description: "Return logs from `stderr`"
- type: "boolean"
- default: false
- - name: "since"
- in: "query"
- description: "Only return logs since this time, as a UNIX timestamp"
- type: "integer"
- default: 0
- - name: "timestamps"
- in: "query"
- description: "Add timestamps to every log line"
- type: "boolean"
- default: false
- - name: "tail"
- in: "query"
- description: |
- Only return this number of log lines from the end of the logs.
- Specify as an integer or `all` to output all log lines.
- type: "string"
- default: "all"
- tags: ["Task"]
- /secrets:
- get:
- summary: "List secrets"
- operationId: "SecretList"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Secret"
- example:
- - ID: "blt1owaxmitz71s9v5zh81zun"
- Version:
- Index: 85
- CreatedAt: "2017-07-20T13:55:28.678958722Z"
- UpdatedAt: "2017-07-20T13:55:28.678958722Z"
- Spec:
- Name: "mysql-passwd"
- Labels:
- some.label: "some.value"
- Driver:
- Name: "secret-bucket"
- Options:
- OptionA: "value for driver option A"
- OptionB: "value for driver option B"
- - ID: "ktnbjxoalbkvbvedmg1urrz8h"
- Version:
- Index: 11
- CreatedAt: "2016-11-05T01:20:17.327670065Z"
- UpdatedAt: "2016-11-05T01:20:17.327670065Z"
- Spec:
- Name: "app-dev.crt"
- Labels:
- foo: "bar"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "filters"
- in: "query"
- type: "string"
- description: |
- A JSON encoded value of the filters (a `map[string][]string`) to
- process on the secrets list.
-
- Available filters:
-
- - `id=`
- - `label= or label==value`
- - `name=`
- - `names=`
- tags: ["Secret"]
- /secrets/create:
- post:
- summary: "Create a secret"
- operationId: "SecretCreate"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- responses:
- 201:
- description: "no error"
- schema:
- $ref: "#/definitions/IDResponse"
- 409:
- description: "name conflicts with an existing object"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "body"
- in: "body"
- schema:
- allOf:
- - $ref: "#/definitions/SecretSpec"
- - type: "object"
- example:
- Name: "app-key.crt"
- Labels:
- foo: "bar"
- Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg=="
- Driver:
- Name: "secret-bucket"
- Options:
- OptionA: "value for driver option A"
- OptionB: "value for driver option B"
- tags: ["Secret"]
- /secrets/{id}:
- get:
- summary: "Inspect a secret"
- operationId: "SecretInspect"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/Secret"
- examples:
- application/json:
- ID: "ktnbjxoalbkvbvedmg1urrz8h"
- Version:
- Index: 11
- CreatedAt: "2016-11-05T01:20:17.327670065Z"
- UpdatedAt: "2016-11-05T01:20:17.327670065Z"
- Spec:
- Name: "app-dev.crt"
- Labels:
- foo: "bar"
- Driver:
- Name: "secret-bucket"
- Options:
- OptionA: "value for driver option A"
- OptionB: "value for driver option B"
-
- 404:
- description: "secret not found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- type: "string"
- description: "ID of the secret"
- tags: ["Secret"]
- delete:
- summary: "Delete a secret"
- operationId: "SecretDelete"
- produces:
- - "application/json"
- responses:
- 204:
- description: "no error"
- 404:
- description: "secret not found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- type: "string"
- description: "ID of the secret"
- tags: ["Secret"]
- /secrets/{id}/update:
- post:
- summary: "Update a Secret"
- operationId: "SecretUpdate"
- responses:
- 200:
- description: "no error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such secret"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "The ID or name of the secret"
- type: "string"
- required: true
- - name: "body"
- in: "body"
- schema:
- $ref: "#/definitions/SecretSpec"
- description: |
- The spec of the secret to update. Currently, only the Labels field
- can be updated. All other fields must remain unchanged from the
- [SecretInspect endpoint](#operation/SecretInspect) response values.
- - name: "version"
- in: "query"
- description: |
- The version number of the secret object being updated. This is
- required to avoid conflicting writes.
- type: "integer"
- format: "int64"
- required: true
- tags: ["Secret"]
- /configs:
- get:
- summary: "List configs"
- operationId: "ConfigList"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Config"
- example:
- - ID: "ktnbjxoalbkvbvedmg1urrz8h"
- Version:
- Index: 11
- CreatedAt: "2016-11-05T01:20:17.327670065Z"
- UpdatedAt: "2016-11-05T01:20:17.327670065Z"
- Spec:
- Name: "server.conf"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "filters"
- in: "query"
- type: "string"
- description: |
- A JSON encoded value of the filters (a `map[string][]string`) to
- process on the configs list.
-
- Available filters:
-
- - `id=`
- - `label= or label==value`
- - `name=`
- - `names=`
- tags: ["Config"]
- /configs/create:
- post:
- summary: "Create a config"
- operationId: "ConfigCreate"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- responses:
- 201:
- description: "no error"
- schema:
- $ref: "#/definitions/IDResponse"
- 409:
- description: "name conflicts with an existing object"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "body"
- in: "body"
- schema:
- allOf:
- - $ref: "#/definitions/ConfigSpec"
- - type: "object"
- example:
- Name: "server.conf"
- Labels:
- foo: "bar"
- Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg=="
- tags: ["Config"]
- /configs/{id}:
- get:
- summary: "Inspect a config"
- operationId: "ConfigInspect"
- produces:
- - "application/json"
- responses:
- 200:
- description: "no error"
- schema:
- $ref: "#/definitions/Config"
- examples:
- application/json:
- ID: "ktnbjxoalbkvbvedmg1urrz8h"
- Version:
- Index: 11
- CreatedAt: "2016-11-05T01:20:17.327670065Z"
- UpdatedAt: "2016-11-05T01:20:17.327670065Z"
- Spec:
- Name: "app-dev.crt"
- 404:
- description: "config not found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- type: "string"
- description: "ID of the config"
- tags: ["Config"]
- delete:
- summary: "Delete a config"
- operationId: "ConfigDelete"
- produces:
- - "application/json"
- responses:
- 204:
- description: "no error"
- 404:
- description: "config not found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- required: true
- type: "string"
- description: "ID of the config"
- tags: ["Config"]
- /configs/{id}/update:
- post:
- summary: "Update a Config"
- operationId: "ConfigUpdate"
- responses:
- 200:
- description: "no error"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 404:
- description: "no such config"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 503:
- description: "node is not part of a swarm"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "id"
- in: "path"
- description: "The ID or name of the config"
- type: "string"
- required: true
- - name: "body"
- in: "body"
- schema:
- $ref: "#/definitions/ConfigSpec"
- description: |
- The spec of the config to update. Currently, only the Labels field
- can be updated. All other fields must remain unchanged from the
- [ConfigInspect endpoint](#operation/ConfigInspect) response values.
- - name: "version"
- in: "query"
- description: |
- The version number of the config object being updated. This is
- required to avoid conflicting writes.
- type: "integer"
- format: "int64"
- required: true
- tags: ["Config"]
- /distribution/{name}/json:
- get:
- summary: "Get image information from the registry"
- description: |
- Return image digest and platform information by contacting the registry.
- operationId: "DistributionInspect"
- produces:
- - "application/json"
- responses:
- 200:
- description: "descriptor and platform information"
- schema:
- $ref: "#/definitions/DistributionInspect"
- 401:
- description: "Failed authentication or no image found"
- schema:
- $ref: "#/definitions/ErrorResponse"
- examples:
- application/json:
- message: "No such image: someimage (tag: latest)"
- 500:
- description: "Server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- parameters:
- - name: "name"
- in: "path"
- description: "Image name or id"
- type: "string"
- required: true
- tags: ["Distribution"]
- /session:
- post:
- summary: "Initialize interactive session"
- description: |
- Start a new interactive session with a server. Session allows server to
- call back to the client for advanced capabilities.
-
- ### Hijacking
-
- This endpoint hijacks the HTTP connection to HTTP2 transport that allows
- the client to expose gPRC services on that connection.
-
- For example, the client sends this request to upgrade the connection:
-
- ```
- POST /session HTTP/1.1
- Upgrade: h2c
- Connection: Upgrade
- ```
-
- The Docker daemon responds with a `101 UPGRADED` response follow with
- the raw stream:
-
- ```
- HTTP/1.1 101 UPGRADED
- Connection: Upgrade
- Upgrade: h2c
- ```
- operationId: "Session"
- produces:
- - "application/vnd.docker.raw-stream"
- responses:
- 101:
- description: "no error, hijacking successful"
- 400:
- description: "bad parameter"
- schema:
- $ref: "#/definitions/ErrorResponse"
- 500:
- description: "server error"
- schema:
- $ref: "#/definitions/ErrorResponse"
- tags: ["Session"]
diff --git a/vendor/github.com/docker/docker/api/types/blkiodev/blkio.go b/vendor/github.com/docker/docker/api/types/blkiodev/blkio.go
deleted file mode 100644
index 931ae10a..00000000
--- a/vendor/github.com/docker/docker/api/types/blkiodev/blkio.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package blkiodev
-
-import "fmt"
-
-// WeightDevice is a structure that holds device:weight pair
-type WeightDevice struct {
- Path string
- Weight uint16
-}
-
-func (w *WeightDevice) String() string {
- return fmt.Sprintf("%s:%d", w.Path, w.Weight)
-}
-
-// ThrottleDevice is a structure that holds device:rate_per_second pair
-type ThrottleDevice struct {
- Path string
- Rate uint64
-}
-
-func (t *ThrottleDevice) String() string {
- return fmt.Sprintf("%s:%d", t.Path, t.Rate)
-}
diff --git a/vendor/github.com/docker/docker/api/types/build/build.go b/vendor/github.com/docker/docker/api/types/build/build.go
deleted file mode 100644
index c43a0e21..00000000
--- a/vendor/github.com/docker/docker/api/types/build/build.go
+++ /dev/null
@@ -1,91 +0,0 @@
-package build
-
-import (
- "io"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/registry"
-)
-
-// BuilderVersion sets the version of underlying builder to use
-type BuilderVersion string
-
-const (
- // BuilderV1 is the first generation builder in docker daemon
- BuilderV1 BuilderVersion = "1"
- // BuilderBuildKit is builder based on moby/buildkit project
- BuilderBuildKit BuilderVersion = "2"
-)
-
-// Result contains the image id of a successful build.
-type Result struct {
- ID string
-}
-
-// ImageBuildOptions holds the information
-// necessary to build images.
-type ImageBuildOptions struct {
- Tags []string
- SuppressOutput bool
- RemoteContext string
- NoCache bool
- Remove bool
- ForceRemove bool
- PullParent bool
- Isolation container.Isolation
- CPUSetCPUs string
- CPUSetMems string
- CPUShares int64
- CPUQuota int64
- CPUPeriod int64
- Memory int64
- MemorySwap int64
- CgroupParent string
- NetworkMode string
- ShmSize int64
- Dockerfile string
- Ulimits []*container.Ulimit
- // BuildArgs needs to be a *string instead of just a string so that
- // we can tell the difference between "" (empty string) and no value
- // at all (nil). See the parsing of buildArgs in
- // api/server/router/build/build_routes.go for even more info.
- BuildArgs map[string]*string
- AuthConfigs map[string]registry.AuthConfig
- Context io.Reader
- Labels map[string]string
- // squash the resulting image's layers to the parent
- // preserves the original image and creates a new one from the parent with all
- // the changes applied to a single layer
- Squash bool
- // CacheFrom specifies images that are used for matching cache. Images
- // specified here do not need to have a valid parent chain to match cache.
- CacheFrom []string
- SecurityOpt []string
- ExtraHosts []string // List of extra hosts
- Target string
- SessionID string
- Platform string
- // Version specifies the version of the underlying builder to use
- Version BuilderVersion
- // BuildID is an optional identifier that can be passed together with the
- // build request. The same identifier can be used to gracefully cancel the
- // build with the cancel request.
- BuildID string
- // Outputs defines configurations for exporting build results. Only supported
- // in BuildKit mode
- Outputs []ImageBuildOutput
-}
-
-// ImageBuildOutput defines configuration for exporting a build result
-type ImageBuildOutput struct {
- Type string
- Attrs map[string]string
-}
-
-// ImageBuildResponse holds information
-// returned by a server after building
-// an image.
-type ImageBuildResponse struct {
- Body io.ReadCloser
- OSType string
-}
diff --git a/vendor/github.com/docker/docker/api/types/build/cache.go b/vendor/github.com/docker/docker/api/types/build/cache.go
deleted file mode 100644
index 42c84045..00000000
--- a/vendor/github.com/docker/docker/api/types/build/cache.go
+++ /dev/null
@@ -1,52 +0,0 @@
-package build
-
-import (
- "time"
-
- "github.com/docker/docker/api/types/filters"
-)
-
-// CacheRecord contains information about a build cache record.
-type CacheRecord struct {
- // ID is the unique ID of the build cache record.
- ID string
- // Parent is the ID of the parent build cache record.
- //
- // Deprecated: deprecated in API v1.42 and up, as it was deprecated in BuildKit; use Parents instead.
- Parent string `json:"Parent,omitempty"`
- // Parents is the list of parent build cache record IDs.
- Parents []string `json:" Parents,omitempty"`
- // Type is the cache record type.
- Type string
- // Description is a description of the build-step that produced the build cache.
- Description string
- // InUse indicates if the build cache is in use.
- InUse bool
- // Shared indicates if the build cache is shared.
- Shared bool
- // Size is the amount of disk space used by the build cache (in bytes).
- Size int64
- // CreatedAt is the date and time at which the build cache was created.
- CreatedAt time.Time
- // LastUsedAt is the date and time at which the build cache was last used.
- LastUsedAt *time.Time
- UsageCount int
-}
-
-// CachePruneOptions hold parameters to prune the build cache.
-type CachePruneOptions struct {
- All bool
- ReservedSpace int64
- MaxUsedSpace int64
- MinFreeSpace int64
- Filters filters.Args
-
- KeepStorage int64 // Deprecated: deprecated in API 1.48.
-}
-
-// CachePruneReport contains the response for Engine API:
-// POST "/build/prune"
-type CachePruneReport struct {
- CachesDeleted []string
- SpaceReclaimed uint64
-}
diff --git a/vendor/github.com/docker/docker/api/types/build/disk_usage.go b/vendor/github.com/docker/docker/api/types/build/disk_usage.go
deleted file mode 100644
index cfd73332..00000000
--- a/vendor/github.com/docker/docker/api/types/build/disk_usage.go
+++ /dev/null
@@ -1,10 +0,0 @@
-package build
-
-// CacheDiskUsage contains disk usage for the build cache.
-//
-// Deprecated: this type is no longer used and will be removed in the next release.
-type CacheDiskUsage struct {
- TotalSize int64
- Reclaimable int64
- Items []*CacheRecord
-}
diff --git a/vendor/github.com/docker/docker/api/types/checkpoint/list.go b/vendor/github.com/docker/docker/api/types/checkpoint/list.go
deleted file mode 100644
index 94a9c0a4..00000000
--- a/vendor/github.com/docker/docker/api/types/checkpoint/list.go
+++ /dev/null
@@ -1,7 +0,0 @@
-package checkpoint
-
-// Summary represents the details of a checkpoint when listing endpoints.
-type Summary struct {
- // Name is the name of the checkpoint.
- Name string
-}
diff --git a/vendor/github.com/docker/docker/api/types/checkpoint/options.go b/vendor/github.com/docker/docker/api/types/checkpoint/options.go
deleted file mode 100644
index 9477458c..00000000
--- a/vendor/github.com/docker/docker/api/types/checkpoint/options.go
+++ /dev/null
@@ -1,19 +0,0 @@
-package checkpoint
-
-// CreateOptions holds parameters to create a checkpoint from a container.
-type CreateOptions struct {
- CheckpointID string
- CheckpointDir string
- Exit bool
-}
-
-// ListOptions holds parameters to list checkpoints for a container.
-type ListOptions struct {
- CheckpointDir string
-}
-
-// DeleteOptions holds parameters to delete a checkpoint from a container.
-type DeleteOptions struct {
- CheckpointID string
- CheckpointDir string
-}
diff --git a/vendor/github.com/docker/docker/api/types/client.go b/vendor/github.com/docker/docker/api/types/client.go
deleted file mode 100644
index 42fe03ec..00000000
--- a/vendor/github.com/docker/docker/api/types/client.go
+++ /dev/null
@@ -1,85 +0,0 @@
-package types
-
-import (
- "bufio"
- "context"
- "net"
-)
-
-// NewHijackedResponse initializes a [HijackedResponse] type.
-func NewHijackedResponse(conn net.Conn, mediaType string) HijackedResponse {
- return HijackedResponse{Conn: conn, Reader: bufio.NewReader(conn), mediaType: mediaType}
-}
-
-// HijackedResponse holds connection information for a hijacked request.
-type HijackedResponse struct {
- mediaType string
- Conn net.Conn
- Reader *bufio.Reader
-}
-
-// Close closes the hijacked connection and reader.
-func (h *HijackedResponse) Close() {
- h.Conn.Close()
-}
-
-// MediaType let client know if HijackedResponse hold a raw or multiplexed stream.
-// returns false if HTTP Content-Type is not relevant, and container must be inspected
-func (h *HijackedResponse) MediaType() (string, bool) {
- if h.mediaType == "" {
- return "", false
- }
- return h.mediaType, true
-}
-
-// CloseWriter is an interface that implements structs
-// that close input streams to prevent from writing.
-type CloseWriter interface {
- CloseWrite() error
-}
-
-// CloseWrite closes a readWriter for writing.
-func (h *HijackedResponse) CloseWrite() error {
- if conn, ok := h.Conn.(CloseWriter); ok {
- return conn.CloseWrite()
- }
- return nil
-}
-
-// PluginRemoveOptions holds parameters to remove plugins.
-type PluginRemoveOptions struct {
- Force bool
-}
-
-// PluginEnableOptions holds parameters to enable plugins.
-type PluginEnableOptions struct {
- Timeout int
-}
-
-// PluginDisableOptions holds parameters to disable plugins.
-type PluginDisableOptions struct {
- Force bool
-}
-
-// PluginInstallOptions holds parameters to install a plugin.
-type PluginInstallOptions struct {
- Disabled bool
- AcceptAllPermissions bool
- RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry
- RemoteRef string // RemoteRef is the plugin name on the registry
-
- // PrivilegeFunc is a function that clients can supply to retry operations
- // after getting an authorization error. This function returns the registry
- // authentication header value in base64 encoded format, or an error if the
- // privilege request fails.
- //
- // For details, refer to [github.com/docker/docker/api/types/registry.RequestAuthConfig].
- PrivilegeFunc func(context.Context) (string, error)
- AcceptPermissionsFunc func(context.Context, PluginPrivileges) (bool, error)
- Args []string
-}
-
-// PluginCreateOptions hold all options to plugin create.
-type PluginCreateOptions struct {
- RepoName string
-}
diff --git a/vendor/github.com/docker/docker/api/types/common/id_response.go b/vendor/github.com/docker/docker/api/types/common/id_response.go
deleted file mode 100644
index 22e8c60a..00000000
--- a/vendor/github.com/docker/docker/api/types/common/id_response.go
+++ /dev/null
@@ -1,13 +0,0 @@
-package common
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// IDResponse Response to an API call that returns just an Id
-// swagger:model IDResponse
-type IDResponse struct {
-
- // The id of the newly created object.
- // Required: true
- ID string `json:"Id"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/change_type.go b/vendor/github.com/docker/docker/api/types/container/change_type.go
deleted file mode 100644
index fe8d6d36..00000000
--- a/vendor/github.com/docker/docker/api/types/container/change_type.go
+++ /dev/null
@@ -1,15 +0,0 @@
-package container
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// ChangeType Kind of change
-//
-// Can be one of:
-//
-// - `0`: Modified ("C")
-// - `1`: Added ("A")
-// - `2`: Deleted ("D")
-//
-// swagger:model ChangeType
-type ChangeType uint8
diff --git a/vendor/github.com/docker/docker/api/types/container/change_types.go b/vendor/github.com/docker/docker/api/types/container/change_types.go
deleted file mode 100644
index 3a3a8386..00000000
--- a/vendor/github.com/docker/docker/api/types/container/change_types.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package container
-
-const (
- // ChangeModify represents the modify operation.
- ChangeModify ChangeType = 0
- // ChangeAdd represents the add operation.
- ChangeAdd ChangeType = 1
- // ChangeDelete represents the delete operation.
- ChangeDelete ChangeType = 2
-)
-
-func (ct ChangeType) String() string {
- switch ct {
- case ChangeModify:
- return "C"
- case ChangeAdd:
- return "A"
- case ChangeDelete:
- return "D"
- default:
- return ""
- }
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/commit.go b/vendor/github.com/docker/docker/api/types/container/commit.go
deleted file mode 100644
index 6fd1b0ea..00000000
--- a/vendor/github.com/docker/docker/api/types/container/commit.go
+++ /dev/null
@@ -1,7 +0,0 @@
-package container
-
-import "github.com/docker/docker/api/types/common"
-
-// CommitResponse response for the commit API call, containing the ID of the
-// image that was produced.
-type CommitResponse = common.IDResponse
diff --git a/vendor/github.com/docker/docker/api/types/container/config.go b/vendor/github.com/docker/docker/api/types/container/config.go
deleted file mode 100644
index 05554165..00000000
--- a/vendor/github.com/docker/docker/api/types/container/config.go
+++ /dev/null
@@ -1,73 +0,0 @@
-package container
-
-import (
- "time"
-
- "github.com/docker/docker/api/types/strslice"
- "github.com/docker/go-connections/nat"
- dockerspec "github.com/moby/docker-image-spec/specs-go/v1"
-)
-
-// MinimumDuration puts a minimum on user configured duration.
-// This is to prevent API error on time unit. For example, API may
-// set 3 as healthcheck interval with intention of 3 seconds, but
-// Docker interprets it as 3 nanoseconds.
-const MinimumDuration = 1 * time.Millisecond
-
-// StopOptions holds the options to stop or restart a container.
-type StopOptions struct {
- // Signal (optional) is the signal to send to the container to (gracefully)
- // stop it before forcibly terminating the container with SIGKILL after the
- // timeout expires. If not value is set, the default (SIGTERM) is used.
- Signal string `json:",omitempty"`
-
- // Timeout (optional) is the timeout (in seconds) to wait for the container
- // to stop gracefully before forcibly terminating it with SIGKILL.
- //
- // - Use nil to use the default timeout (10 seconds).
- // - Use '-1' to wait indefinitely.
- // - Use '0' to not wait for the container to exit gracefully, and
- // immediately proceeds to forcibly terminating the container.
- // - Other positive values are used as timeout (in seconds).
- Timeout *int `json:",omitempty"`
-}
-
-// HealthConfig holds configuration settings for the HEALTHCHECK feature.
-type HealthConfig = dockerspec.HealthcheckConfig
-
-// Config contains the configuration data about a container.
-// It should hold only portable information about the container.
-// Here, "portable" means "independent from the host we are running on".
-// Non-portable information *should* appear in HostConfig.
-// All fields added to this struct must be marked `omitempty` to keep getting
-// predictable hashes from the old `v1Compatibility` configuration.
-type Config struct {
- Hostname string // Hostname
- Domainname string // Domainname
- User string // User that will run the command(s) inside the container, also support user:group
- AttachStdin bool // Attach the standard input, makes possible user interaction
- AttachStdout bool // Attach the standard output
- AttachStderr bool // Attach the standard error
- ExposedPorts nat.PortSet `json:",omitempty"` // List of exposed ports
- Tty bool // Attach standard streams to a tty, including stdin if it is not closed.
- OpenStdin bool // Open stdin
- StdinOnce bool // If true, close stdin after the 1 attached client disconnects.
- Env []string // List of environment variable to set in the container
- Cmd strslice.StrSlice // Command to run when starting the container
- Healthcheck *HealthConfig `json:",omitempty"` // Healthcheck describes how to check the container is healthy
- ArgsEscaped bool `json:",omitempty"` // True if command is already escaped (meaning treat as a command line) (Windows specific).
- Image string // Name of the image as it was passed by the operator (e.g. could be symbolic)
- Volumes map[string]struct{} // List of volumes (mounts) used for the container
- WorkingDir string // Current directory (PWD) in the command will be launched
- Entrypoint strslice.StrSlice // Entrypoint to run when starting the container
- NetworkDisabled bool `json:",omitempty"` // Is network disabled
- // Mac Address of the container.
- //
- // Deprecated: this field is deprecated since API v1.44. Use EndpointSettings.MacAddress instead.
- MacAddress string `json:",omitempty"`
- OnBuild []string // ONBUILD metadata that were defined on the image Dockerfile
- Labels map[string]string // List of labels set to this container
- StopSignal string `json:",omitempty"` // Signal to stop a container
- StopTimeout *int `json:",omitempty"` // Timeout (in seconds) to stop a container
- Shell strslice.StrSlice `json:",omitempty"` // Shell for shell-form of RUN, CMD, ENTRYPOINT
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/container.go b/vendor/github.com/docker/docker/api/types/container/container.go
deleted file mode 100644
index a191ca8b..00000000
--- a/vendor/github.com/docker/docker/api/types/container/container.go
+++ /dev/null
@@ -1,188 +0,0 @@
-package container
-
-import (
- "io"
- "os"
- "time"
-
- "github.com/docker/docker/api/types/mount"
- "github.com/docker/docker/api/types/storage"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-// ContainerUpdateOKBody OK response to ContainerUpdate operation
-//
-// Deprecated: use [UpdateResponse]. This alias will be removed in the next release.
-type ContainerUpdateOKBody = UpdateResponse
-
-// ContainerTopOKBody OK response to ContainerTop operation
-//
-// Deprecated: use [TopResponse]. This alias will be removed in the next release.
-type ContainerTopOKBody = TopResponse
-
-// PruneReport contains the response for Engine API:
-// POST "/containers/prune"
-type PruneReport struct {
- ContainersDeleted []string
- SpaceReclaimed uint64
-}
-
-// PathStat is used to encode the header from
-// GET "/containers/{name:.*}/archive"
-// "Name" is the file or directory name.
-type PathStat struct {
- Name string `json:"name"`
- Size int64 `json:"size"`
- Mode os.FileMode `json:"mode"`
- Mtime time.Time `json:"mtime"`
- LinkTarget string `json:"linkTarget"`
-}
-
-// CopyToContainerOptions holds information
-// about files to copy into a container
-type CopyToContainerOptions struct {
- AllowOverwriteDirWithFile bool
- CopyUIDGID bool
-}
-
-// StatsResponseReader wraps an io.ReadCloser to read (a stream of) stats
-// for a container, as produced by the GET "/stats" endpoint.
-//
-// The OSType field is set to the server's platform to allow
-// platform-specific handling of the response.
-//
-// TODO(thaJeztah): remove this wrapper, and make OSType part of [StatsResponse].
-type StatsResponseReader struct {
- Body io.ReadCloser `json:"body"`
- OSType string `json:"ostype"`
-}
-
-// MountPoint represents a mount point configuration inside the container.
-// This is used for reporting the mountpoints in use by a container.
-type MountPoint struct {
- // Type is the type of mount, see `Type` definitions in
- // github.com/docker/docker/api/types/mount.Type
- Type mount.Type `json:",omitempty"`
-
- // Name is the name reference to the underlying data defined by `Source`
- // e.g., the volume name.
- Name string `json:",omitempty"`
-
- // Source is the source location of the mount.
- //
- // For volumes, this contains the storage location of the volume (within
- // `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains
- // the source (host) part of the bind-mount. For `tmpfs` mount points, this
- // field is empty.
- Source string
-
- // Destination is the path relative to the container root (`/`) where the
- // Source is mounted inside the container.
- Destination string
-
- // Driver is the volume driver used to create the volume (if it is a volume).
- Driver string `json:",omitempty"`
-
- // Mode is a comma separated list of options supplied by the user when
- // creating the bind/volume mount.
- //
- // The default is platform-specific (`"z"` on Linux, empty on Windows).
- Mode string
-
- // RW indicates whether the mount is mounted writable (read-write).
- RW bool
-
- // Propagation describes how mounts are propagated from the host into the
- // mount point, and vice-versa. Refer to the Linux kernel documentation
- // for details:
- // https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt
- //
- // This field is not used on Windows.
- Propagation mount.Propagation
-}
-
-// State stores container's running state
-// it's part of ContainerJSONBase and returned by "inspect" command
-type State struct {
- Status ContainerState // String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead"
- Running bool
- Paused bool
- Restarting bool
- OOMKilled bool
- Dead bool
- Pid int
- ExitCode int
- Error string
- StartedAt string
- FinishedAt string
- Health *Health `json:",omitempty"`
-}
-
-// Summary contains response of Engine API:
-// GET "/containers/json"
-type Summary struct {
- ID string `json:"Id"`
- Names []string
- Image string
- ImageID string
- ImageManifestDescriptor *ocispec.Descriptor `json:"ImageManifestDescriptor,omitempty"`
- Command string
- Created int64
- Ports []Port
- SizeRw int64 `json:",omitempty"`
- SizeRootFs int64 `json:",omitempty"`
- Labels map[string]string
- State ContainerState
- Status string
- HostConfig struct {
- NetworkMode string `json:",omitempty"`
- Annotations map[string]string `json:",omitempty"`
- }
- NetworkSettings *NetworkSettingsSummary
- Mounts []MountPoint
-}
-
-// ContainerJSONBase contains response of Engine API GET "/containers/{name:.*}/json"
-// for API version 1.18 and older.
-//
-// TODO(thaJeztah): combine ContainerJSONBase and InspectResponse into a single struct.
-// The split between ContainerJSONBase (ContainerJSONBase) and InspectResponse (InspectResponse)
-// was done in commit 6deaa58ba5f051039643cedceee97c8695e2af74 (https://github.com/moby/moby/pull/13675).
-// ContainerJSONBase contained all fields for API < 1.19, and InspectResponse
-// held fields that were added in API 1.19 and up. Given that the minimum
-// supported API version is now 1.24, we no longer use the separate type.
-type ContainerJSONBase struct {
- ID string `json:"Id"`
- Created string
- Path string
- Args []string
- State *State
- Image string
- ResolvConfPath string
- HostnamePath string
- HostsPath string
- LogPath string
- Name string
- RestartCount int
- Driver string
- Platform string
- MountLabel string
- ProcessLabel string
- AppArmorProfile string
- ExecIDs []string
- HostConfig *HostConfig
- GraphDriver storage.DriverData
- SizeRw *int64 `json:",omitempty"`
- SizeRootFs *int64 `json:",omitempty"`
-}
-
-// InspectResponse is the response for the GET "/containers/{name:.*}/json"
-// endpoint.
-type InspectResponse struct {
- *ContainerJSONBase
- Mounts []MountPoint
- Config *Config
- NetworkSettings *NetworkSettings
- // ImageManifestDescriptor is the descriptor of a platform-specific manifest of the image used to create the container.
- ImageManifestDescriptor *ocispec.Descriptor `json:"ImageManifestDescriptor,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/create_request.go b/vendor/github.com/docker/docker/api/types/container/create_request.go
deleted file mode 100644
index e98dd6ad..00000000
--- a/vendor/github.com/docker/docker/api/types/container/create_request.go
+++ /dev/null
@@ -1,13 +0,0 @@
-package container
-
-import "github.com/docker/docker/api/types/network"
-
-// CreateRequest is the request message sent to the server for container
-// create calls. It is a config wrapper that holds the container [Config]
-// (portable) and the corresponding [HostConfig] (non-portable) and
-// [network.NetworkingConfig].
-type CreateRequest struct {
- *Config
- HostConfig *HostConfig `json:"HostConfig,omitempty"`
- NetworkingConfig *network.NetworkingConfig `json:"NetworkingConfig,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/create_response.go b/vendor/github.com/docker/docker/api/types/container/create_response.go
deleted file mode 100644
index aa0e7f7d..00000000
--- a/vendor/github.com/docker/docker/api/types/container/create_response.go
+++ /dev/null
@@ -1,19 +0,0 @@
-package container
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// CreateResponse ContainerCreateResponse
-//
-// OK response to ContainerCreate operation
-// swagger:model CreateResponse
-type CreateResponse struct {
-
- // The ID of the created container
- // Required: true
- ID string `json:"Id"`
-
- // Warnings encountered when creating the container
- // Required: true
- Warnings []string `json:"Warnings"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/disk_usage.go b/vendor/github.com/docker/docker/api/types/container/disk_usage.go
deleted file mode 100644
index d77538c2..00000000
--- a/vendor/github.com/docker/docker/api/types/container/disk_usage.go
+++ /dev/null
@@ -1,10 +0,0 @@
-package container
-
-// DiskUsage contains disk usage for containers.
-//
-// Deprecated: this type is no longer used and will be removed in the next release.
-type DiskUsage struct {
- TotalSize int64
- Reclaimable int64
- Items []*Summary
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/errors.go b/vendor/github.com/docker/docker/api/types/container/errors.go
deleted file mode 100644
index 32c97803..00000000
--- a/vendor/github.com/docker/docker/api/types/container/errors.go
+++ /dev/null
@@ -1,9 +0,0 @@
-package container
-
-type errInvalidParameter struct{ error }
-
-func (e *errInvalidParameter) InvalidParameter() {}
-
-func (e *errInvalidParameter) Unwrap() error {
- return e.error
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/exec.go b/vendor/github.com/docker/docker/api/types/container/exec.go
deleted file mode 100644
index e455cd27..00000000
--- a/vendor/github.com/docker/docker/api/types/container/exec.go
+++ /dev/null
@@ -1,53 +0,0 @@
-package container
-
-import "github.com/docker/docker/api/types/common"
-
-// ExecCreateResponse is the response for a successful exec-create request.
-// It holds the ID of the exec that was created.
-//
-// TODO(thaJeztah): make this a distinct type.
-type ExecCreateResponse = common.IDResponse
-
-// ExecOptions is a small subset of the Config struct that holds the configuration
-// for the exec feature of docker.
-type ExecOptions struct {
- User string // User that will run the command
- Privileged bool // Is the container in privileged mode
- Tty bool // Attach standard streams to a tty.
- ConsoleSize *[2]uint `json:",omitempty"` // Initial console size [height, width]
- AttachStdin bool // Attach the standard input, makes possible user interaction
- AttachStderr bool // Attach the standard error
- AttachStdout bool // Attach the standard output
- DetachKeys string // Escape keys for detach
- Env []string // Environment variables
- WorkingDir string // Working directory
- Cmd []string // Execution commands and args
-
- // Deprecated: the Detach field is not used, and will be removed in a future release.
- Detach bool
-}
-
-// ExecStartOptions is a temp struct used by execStart
-// Config fields is part of ExecConfig in runconfig package
-type ExecStartOptions struct {
- // ExecStart will first check if it's detached
- Detach bool
- // Check if there's a tty
- Tty bool
- // Terminal size [height, width], unused if Tty == false
- ConsoleSize *[2]uint `json:",omitempty"`
-}
-
-// ExecAttachOptions is a temp struct used by execAttach.
-//
-// TODO(thaJeztah): make this a separate type; ContainerExecAttach does not use the Detach option, and cannot run detached.
-type ExecAttachOptions = ExecStartOptions
-
-// ExecInspect holds information returned by exec inspect.
-type ExecInspect struct {
- ExecID string `json:"ID"`
- ContainerID string
- Running bool
- ExitCode int
- Pid int
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/filesystem_change.go b/vendor/github.com/docker/docker/api/types/container/filesystem_change.go
deleted file mode 100644
index 9e9c2ad1..00000000
--- a/vendor/github.com/docker/docker/api/types/container/filesystem_change.go
+++ /dev/null
@@ -1,19 +0,0 @@
-package container
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// FilesystemChange Change in the container's filesystem.
-//
-// swagger:model FilesystemChange
-type FilesystemChange struct {
-
- // kind
- // Required: true
- Kind ChangeType `json:"Kind"`
-
- // Path to file or directory that has changed.
- //
- // Required: true
- Path string `json:"Path"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/health.go b/vendor/github.com/docker/docker/api/types/container/health.go
deleted file mode 100644
index 96e91cc8..00000000
--- a/vendor/github.com/docker/docker/api/types/container/health.go
+++ /dev/null
@@ -1,50 +0,0 @@
-package container
-
-import (
- "fmt"
- "strings"
- "time"
-)
-
-// HealthStatus is a string representation of the container's health.
-//
-// It currently is an alias for string, but may become a distinct type in future.
-type HealthStatus = string
-
-// Health states
-const (
- NoHealthcheck HealthStatus = "none" // Indicates there is no healthcheck
- Starting HealthStatus = "starting" // Starting indicates that the container is not yet ready
- Healthy HealthStatus = "healthy" // Healthy indicates that the container is running correctly
- Unhealthy HealthStatus = "unhealthy" // Unhealthy indicates that the container has a problem
-)
-
-// Health stores information about the container's healthcheck results
-type Health struct {
- Status HealthStatus // Status is one of [Starting], [Healthy] or [Unhealthy].
- FailingStreak int // FailingStreak is the number of consecutive failures
- Log []*HealthcheckResult // Log contains the last few results (oldest first)
-}
-
-// HealthcheckResult stores information about a single run of a healthcheck probe
-type HealthcheckResult struct {
- Start time.Time // Start is the time this check started
- End time.Time // End is the time this check ended
- ExitCode int // ExitCode meanings: 0=healthy, 1=unhealthy, 2=reserved (considered unhealthy), else=error running probe
- Output string // Output from last check
-}
-
-var validHealths = []string{
- NoHealthcheck, Starting, Healthy, Unhealthy,
-}
-
-// ValidateHealthStatus checks if the provided string is a valid
-// container [HealthStatus].
-func ValidateHealthStatus(s HealthStatus) error {
- switch s {
- case NoHealthcheck, Starting, Healthy, Unhealthy:
- return nil
- default:
- return errInvalidParameter{error: fmt.Errorf("invalid value for health (%s): must be one of %s", s, strings.Join(validHealths, ", "))}
- }
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/hostconfig.go b/vendor/github.com/docker/docker/api/types/container/hostconfig.go
deleted file mode 100644
index 7a41436c..00000000
--- a/vendor/github.com/docker/docker/api/types/container/hostconfig.go
+++ /dev/null
@@ -1,506 +0,0 @@
-package container
-
-import (
- "errors"
- "fmt"
- "strings"
-
- "github.com/docker/docker/api/types/blkiodev"
- "github.com/docker/docker/api/types/mount"
- "github.com/docker/docker/api/types/network"
- "github.com/docker/docker/api/types/strslice"
- "github.com/docker/go-connections/nat"
- "github.com/docker/go-units"
-)
-
-// CgroupnsMode represents the cgroup namespace mode of the container
-type CgroupnsMode string
-
-// cgroup namespace modes for containers
-const (
- CgroupnsModeEmpty CgroupnsMode = ""
- CgroupnsModePrivate CgroupnsMode = "private"
- CgroupnsModeHost CgroupnsMode = "host"
-)
-
-// IsPrivate indicates whether the container uses its own private cgroup namespace
-func (c CgroupnsMode) IsPrivate() bool {
- return c == CgroupnsModePrivate
-}
-
-// IsHost indicates whether the container shares the host's cgroup namespace
-func (c CgroupnsMode) IsHost() bool {
- return c == CgroupnsModeHost
-}
-
-// IsEmpty indicates whether the container cgroup namespace mode is unset
-func (c CgroupnsMode) IsEmpty() bool {
- return c == CgroupnsModeEmpty
-}
-
-// Valid indicates whether the cgroup namespace mode is valid
-func (c CgroupnsMode) Valid() bool {
- return c.IsEmpty() || c.IsPrivate() || c.IsHost()
-}
-
-// Isolation represents the isolation technology of a container. The supported
-// values are platform specific
-type Isolation string
-
-// Isolation modes for containers
-const (
- IsolationEmpty Isolation = "" // IsolationEmpty is unspecified (same behavior as default)
- IsolationDefault Isolation = "default" // IsolationDefault is the default isolation mode on current daemon
- IsolationProcess Isolation = "process" // IsolationProcess is process isolation mode
- IsolationHyperV Isolation = "hyperv" // IsolationHyperV is HyperV isolation mode
-)
-
-// IsDefault indicates the default isolation technology of a container. On Linux this
-// is the native driver. On Windows, this is a Windows Server Container.
-func (i Isolation) IsDefault() bool {
- // TODO consider making isolation-mode strict (case-sensitive)
- v := Isolation(strings.ToLower(string(i)))
- return v == IsolationDefault || v == IsolationEmpty
-}
-
-// IsHyperV indicates the use of a Hyper-V partition for isolation
-func (i Isolation) IsHyperV() bool {
- // TODO consider making isolation-mode strict (case-sensitive)
- return Isolation(strings.ToLower(string(i))) == IsolationHyperV
-}
-
-// IsProcess indicates the use of process isolation
-func (i Isolation) IsProcess() bool {
- // TODO consider making isolation-mode strict (case-sensitive)
- return Isolation(strings.ToLower(string(i))) == IsolationProcess
-}
-
-// IpcMode represents the container ipc stack.
-type IpcMode string
-
-// IpcMode constants
-const (
- IPCModeNone IpcMode = "none"
- IPCModeHost IpcMode = "host"
- IPCModeContainer IpcMode = "container"
- IPCModePrivate IpcMode = "private"
- IPCModeShareable IpcMode = "shareable"
-)
-
-// IsPrivate indicates whether the container uses its own private ipc namespace which can not be shared.
-func (n IpcMode) IsPrivate() bool {
- return n == IPCModePrivate
-}
-
-// IsHost indicates whether the container shares the host's ipc namespace.
-func (n IpcMode) IsHost() bool {
- return n == IPCModeHost
-}
-
-// IsShareable indicates whether the container's ipc namespace can be shared with another container.
-func (n IpcMode) IsShareable() bool {
- return n == IPCModeShareable
-}
-
-// IsContainer indicates whether the container uses another container's ipc namespace.
-func (n IpcMode) IsContainer() bool {
- _, ok := containerID(string(n))
- return ok
-}
-
-// IsNone indicates whether container IpcMode is set to "none".
-func (n IpcMode) IsNone() bool {
- return n == IPCModeNone
-}
-
-// IsEmpty indicates whether container IpcMode is empty
-func (n IpcMode) IsEmpty() bool {
- return n == ""
-}
-
-// Valid indicates whether the ipc mode is valid.
-func (n IpcMode) Valid() bool {
- // TODO(thaJeztah): align with PidMode, and consider container-mode without a container name/ID to be invalid.
- return n.IsEmpty() || n.IsNone() || n.IsPrivate() || n.IsHost() || n.IsShareable() || n.IsContainer()
-}
-
-// Container returns the name of the container ipc stack is going to be used.
-func (n IpcMode) Container() (idOrName string) {
- idOrName, _ = containerID(string(n))
- return idOrName
-}
-
-// NetworkMode represents the container network stack.
-type NetworkMode string
-
-// IsNone indicates whether container isn't using a network stack.
-func (n NetworkMode) IsNone() bool {
- return n == network.NetworkNone
-}
-
-// IsDefault indicates whether container uses the default network stack.
-func (n NetworkMode) IsDefault() bool {
- return n == network.NetworkDefault
-}
-
-// IsPrivate indicates whether container uses its private network stack.
-func (n NetworkMode) IsPrivate() bool {
- return !n.IsHost() && !n.IsContainer()
-}
-
-// IsContainer indicates whether container uses a container network stack.
-func (n NetworkMode) IsContainer() bool {
- _, ok := containerID(string(n))
- return ok
-}
-
-// ConnectedContainer is the id of the container which network this container is connected to.
-func (n NetworkMode) ConnectedContainer() (idOrName string) {
- idOrName, _ = containerID(string(n))
- return idOrName
-}
-
-// UserDefined indicates user-created network
-func (n NetworkMode) UserDefined() string {
- if n.IsUserDefined() {
- return string(n)
- }
- return ""
-}
-
-// UsernsMode represents userns mode in the container.
-type UsernsMode string
-
-// IsHost indicates whether the container uses the host's userns.
-func (n UsernsMode) IsHost() bool {
- return n == "host"
-}
-
-// IsPrivate indicates whether the container uses the a private userns.
-func (n UsernsMode) IsPrivate() bool {
- return !n.IsHost()
-}
-
-// Valid indicates whether the userns is valid.
-func (n UsernsMode) Valid() bool {
- return n == "" || n.IsHost()
-}
-
-// CgroupSpec represents the cgroup to use for the container.
-type CgroupSpec string
-
-// IsContainer indicates whether the container is using another container cgroup
-func (c CgroupSpec) IsContainer() bool {
- _, ok := containerID(string(c))
- return ok
-}
-
-// Valid indicates whether the cgroup spec is valid.
-func (c CgroupSpec) Valid() bool {
- // TODO(thaJeztah): align with PidMode, and consider container-mode without a container name/ID to be invalid.
- return c == "" || c.IsContainer()
-}
-
-// Container returns the ID or name of the container whose cgroup will be used.
-func (c CgroupSpec) Container() (idOrName string) {
- idOrName, _ = containerID(string(c))
- return idOrName
-}
-
-// UTSMode represents the UTS namespace of the container.
-type UTSMode string
-
-// IsPrivate indicates whether the container uses its private UTS namespace.
-func (n UTSMode) IsPrivate() bool {
- return !n.IsHost()
-}
-
-// IsHost indicates whether the container uses the host's UTS namespace.
-func (n UTSMode) IsHost() bool {
- return n == "host"
-}
-
-// Valid indicates whether the UTS namespace is valid.
-func (n UTSMode) Valid() bool {
- return n == "" || n.IsHost()
-}
-
-// PidMode represents the pid namespace of the container.
-type PidMode string
-
-// IsPrivate indicates whether the container uses its own new pid namespace.
-func (n PidMode) IsPrivate() bool {
- return !n.IsHost() && !n.IsContainer()
-}
-
-// IsHost indicates whether the container uses the host's pid namespace.
-func (n PidMode) IsHost() bool {
- return n == "host"
-}
-
-// IsContainer indicates whether the container uses a container's pid namespace.
-func (n PidMode) IsContainer() bool {
- _, ok := containerID(string(n))
- return ok
-}
-
-// Valid indicates whether the pid namespace is valid.
-func (n PidMode) Valid() bool {
- return n == "" || n.IsHost() || validContainer(string(n))
-}
-
-// Container returns the name of the container whose pid namespace is going to be used.
-func (n PidMode) Container() (idOrName string) {
- idOrName, _ = containerID(string(n))
- return idOrName
-}
-
-// DeviceRequest represents a request for devices from a device driver.
-// Used by GPU device drivers.
-type DeviceRequest struct {
- Driver string // Name of device driver
- Count int // Number of devices to request (-1 = All)
- DeviceIDs []string // List of device IDs as recognizable by the device driver
- Capabilities [][]string // An OR list of AND lists of device capabilities (e.g. "gpu")
- Options map[string]string // Options to pass onto the device driver
-}
-
-// DeviceMapping represents the device mapping between the host and the container.
-type DeviceMapping struct {
- PathOnHost string
- PathInContainer string
- CgroupPermissions string
-}
-
-// RestartPolicy represents the restart policies of the container.
-type RestartPolicy struct {
- Name RestartPolicyMode
- MaximumRetryCount int
-}
-
-type RestartPolicyMode string
-
-const (
- RestartPolicyDisabled RestartPolicyMode = "no"
- RestartPolicyAlways RestartPolicyMode = "always"
- RestartPolicyOnFailure RestartPolicyMode = "on-failure"
- RestartPolicyUnlessStopped RestartPolicyMode = "unless-stopped"
-)
-
-// IsNone indicates whether the container has the "no" restart policy.
-// This means the container will not automatically restart when exiting.
-func (rp *RestartPolicy) IsNone() bool {
- return rp.Name == RestartPolicyDisabled || rp.Name == ""
-}
-
-// IsAlways indicates whether the container has the "always" restart policy.
-// This means the container will automatically restart regardless of the exit status.
-func (rp *RestartPolicy) IsAlways() bool {
- return rp.Name == RestartPolicyAlways
-}
-
-// IsOnFailure indicates whether the container has the "on-failure" restart policy.
-// This means the container will automatically restart of exiting with a non-zero exit status.
-func (rp *RestartPolicy) IsOnFailure() bool {
- return rp.Name == RestartPolicyOnFailure
-}
-
-// IsUnlessStopped indicates whether the container has the
-// "unless-stopped" restart policy. This means the container will
-// automatically restart unless user has put it to stopped state.
-func (rp *RestartPolicy) IsUnlessStopped() bool {
- return rp.Name == RestartPolicyUnlessStopped
-}
-
-// IsSame compares two RestartPolicy to see if they are the same
-func (rp *RestartPolicy) IsSame(tp *RestartPolicy) bool {
- return rp.Name == tp.Name && rp.MaximumRetryCount == tp.MaximumRetryCount
-}
-
-// ValidateRestartPolicy validates the given RestartPolicy.
-func ValidateRestartPolicy(policy RestartPolicy) error {
- switch policy.Name {
- case RestartPolicyAlways, RestartPolicyUnlessStopped, RestartPolicyDisabled:
- if policy.MaximumRetryCount != 0 {
- msg := "invalid restart policy: maximum retry count can only be used with 'on-failure'"
- if policy.MaximumRetryCount < 0 {
- msg += " and cannot be negative"
- }
- return &errInvalidParameter{errors.New(msg)}
- }
- return nil
- case RestartPolicyOnFailure:
- if policy.MaximumRetryCount < 0 {
- return &errInvalidParameter{errors.New("invalid restart policy: maximum retry count cannot be negative")}
- }
- return nil
- case "":
- // Versions before v25.0.0 created an empty restart-policy "name" as
- // default. Allow an empty name with "any" MaximumRetryCount for
- // backward-compatibility.
- return nil
- default:
- return &errInvalidParameter{fmt.Errorf("invalid restart policy: unknown policy '%s'; use one of '%s', '%s', '%s', or '%s'", policy.Name, RestartPolicyDisabled, RestartPolicyAlways, RestartPolicyOnFailure, RestartPolicyUnlessStopped)}
- }
-}
-
-// LogMode is a type to define the available modes for logging
-// These modes affect how logs are handled when log messages start piling up.
-type LogMode string
-
-// Available logging modes
-const (
- LogModeUnset LogMode = ""
- LogModeBlocking LogMode = "blocking"
- LogModeNonBlock LogMode = "non-blocking"
-)
-
-// LogConfig represents the logging configuration of the container.
-type LogConfig struct {
- Type string
- Config map[string]string
-}
-
-// Ulimit is an alias for [units.Ulimit], which may be moving to a different
-// location or become a local type. This alias is to help transitioning.
-//
-// Users are recommended to use this alias instead of using [units.Ulimit] directly.
-type Ulimit = units.Ulimit
-
-// Resources contains container's resources (cgroups config, ulimits...)
-type Resources struct {
- // Applicable to all platforms
- CPUShares int64 `json:"CpuShares"` // CPU shares (relative weight vs. other containers)
- Memory int64 // Memory limit (in bytes)
- NanoCPUs int64 `json:"NanoCpus"` // CPU quota in units of 10-9 CPUs.
-
- // Applicable to UNIX platforms
- CgroupParent string // Parent cgroup.
- BlkioWeight uint16 // Block IO weight (relative weight vs. other containers)
- BlkioWeightDevice []*blkiodev.WeightDevice
- BlkioDeviceReadBps []*blkiodev.ThrottleDevice
- BlkioDeviceWriteBps []*blkiodev.ThrottleDevice
- BlkioDeviceReadIOps []*blkiodev.ThrottleDevice
- BlkioDeviceWriteIOps []*blkiodev.ThrottleDevice
- CPUPeriod int64 `json:"CpuPeriod"` // CPU CFS (Completely Fair Scheduler) period
- CPUQuota int64 `json:"CpuQuota"` // CPU CFS (Completely Fair Scheduler) quota
- CPURealtimePeriod int64 `json:"CpuRealtimePeriod"` // CPU real-time period
- CPURealtimeRuntime int64 `json:"CpuRealtimeRuntime"` // CPU real-time runtime
- CpusetCpus string // CpusetCpus 0-2, 0,1
- CpusetMems string // CpusetMems 0-2, 0,1
- Devices []DeviceMapping // List of devices to map inside the container
- DeviceCgroupRules []string // List of rule to be added to the device cgroup
- DeviceRequests []DeviceRequest // List of device requests for device drivers
-
- // KernelMemory specifies the kernel memory limit (in bytes) for the container.
- // Deprecated: kernel 5.4 deprecated kmem.limit_in_bytes.
- KernelMemory int64 `json:",omitempty"`
- // Hard limit for kernel TCP buffer memory (in bytes).
- //
- // Deprecated: This field is deprecated and will be removed in the next release.
- // Starting with 6.12, the kernel has deprecated kernel memory tcp accounting
- // for cgroups v1.
- KernelMemoryTCP int64 `json:",omitempty"` // Hard limit for kernel TCP buffer memory (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; Set `0` or `-1` for unlimited, or `null` to not change.
- 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
-}
-
-// UpdateConfig holds the mutable attributes of a Container.
-// Those attributes can be updated at runtime.
-type UpdateConfig struct {
- // Contains container's resources (cgroups, ulimits)
- Resources
- RestartPolicy RestartPolicy
-}
-
-// HostConfig the non-portable Config structure of a container.
-// Here, "non-portable" means "dependent of the host we are running on".
-// Portable information *should* appear in Config.
-type HostConfig struct {
- // Applicable to all platforms
- Binds []string // List of volume bindings for this container
- ContainerIDFile string // File (path) where the containerId is written
- LogConfig LogConfig // Configuration of the logs for this container
- NetworkMode NetworkMode // Network mode to use for the container
- PortBindings nat.PortMap // Port mapping between the exposed port (container) and the host
- RestartPolicy RestartPolicy // Restart policy to be used for the container
- AutoRemove bool // Automatically remove container when it exits
- VolumeDriver string // Name of the volume driver used to mount volumes
- VolumesFrom []string // List of volumes to take from other container
- ConsoleSize [2]uint // Initial console size (height,width)
- Annotations map[string]string `json:",omitempty"` // Arbitrary non-identifying metadata attached to container and provided to the runtime
-
- // Applicable to UNIX platforms
- CapAdd strslice.StrSlice // List of kernel capabilities to add to the container
- CapDrop strslice.StrSlice // List of kernel capabilities to remove from the container
- CgroupnsMode CgroupnsMode // Cgroup namespace mode to use for the container
- DNS []string `json:"Dns"` // List of DNS server to lookup
- DNSOptions []string `json:"DnsOptions"` // List of DNSOption to look for
- DNSSearch []string `json:"DnsSearch"` // List of DNSSearch to look for
- ExtraHosts []string // List of extra hosts
- GroupAdd []string // List of additional groups that the container process will run as
- IpcMode IpcMode // IPC namespace to use for the container
- Cgroup CgroupSpec // Cgroup to use for the container
- Links []string // List of links (in the name:alias form)
- OomScoreAdj int // Container preference for OOM-killing
- PidMode PidMode // PID namespace to use for the container
- Privileged bool // Is the container in privileged mode
- PublishAllPorts bool // Should docker publish all exposed port for the container
- ReadonlyRootfs bool // Is the container root filesystem in read-only
- SecurityOpt []string // List of string values to customize labels for MLS systems, such as SELinux.
- StorageOpt map[string]string `json:",omitempty"` // Storage driver options per container.
- Tmpfs map[string]string `json:",omitempty"` // List of tmpfs (mounts) used for the container
- UTSMode UTSMode // UTS namespace to use for the container
- UsernsMode UsernsMode // The user namespace to use for the container
- ShmSize int64 // Total shm memory usage
- Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
- Runtime string `json:",omitempty"` // Runtime to use with this container
-
- // Applicable to Windows
- Isolation Isolation // Isolation technology of the container (e.g. default, hyperv)
-
- // Contains container's resources (cgroups, ulimits)
- Resources
-
- // Mounts specs used by the container
- Mounts []mount.Mount `json:",omitempty"`
-
- // MaskedPaths is the list of paths to be masked inside the container (this overrides the default set of paths)
- MaskedPaths []string
-
- // ReadonlyPaths is the list of paths to be set as read-only inside the container (this overrides the default set of paths)
- ReadonlyPaths []string
-
- // Run a custom init inside the container, if null, use the daemon's configured settings
- Init *bool `json:",omitempty"`
-}
-
-// containerID splits "container:" values. It returns the container
-// ID or name, and whether an ID/name was found. It returns an empty string and
-// a "false" if the value does not have a "container:" prefix. Further validation
-// of the returned, including checking if the value is empty, should be handled
-// by the caller.
-func containerID(val string) (idOrName string, ok bool) {
- k, v, hasSep := strings.Cut(val, ":")
- if !hasSep || k != "container" {
- return "", false
- }
- return v, true
-}
-
-// validContainer checks if the given value is a "container:" mode with
-// a non-empty name/ID.
-func validContainer(val string) bool {
- id, ok := containerID(val)
- return ok && id != ""
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/hostconfig_unix.go b/vendor/github.com/docker/docker/api/types/container/hostconfig_unix.go
deleted file mode 100644
index cd6a7a9b..00000000
--- a/vendor/github.com/docker/docker/api/types/container/hostconfig_unix.go
+++ /dev/null
@@ -1,45 +0,0 @@
-//go:build !windows
-
-package container
-
-import "github.com/docker/docker/api/types/network"
-
-// IsValid indicates if an isolation technology is valid
-func (i Isolation) IsValid() bool {
- return i.IsDefault()
-}
-
-// IsBridge indicates whether container uses the bridge network stack
-func (n NetworkMode) IsBridge() bool {
- return n == network.NetworkBridge
-}
-
-// IsHost indicates whether container uses the host network stack.
-func (n NetworkMode) IsHost() bool {
- return n == network.NetworkHost
-}
-
-// IsUserDefined indicates user-created network
-func (n NetworkMode) IsUserDefined() bool {
- return !n.IsDefault() && !n.IsBridge() && !n.IsHost() && !n.IsNone() && !n.IsContainer()
-}
-
-// NetworkName returns the name of the network stack.
-func (n NetworkMode) NetworkName() string {
- switch {
- case n.IsDefault():
- return network.NetworkDefault
- case n.IsBridge():
- return network.NetworkBridge
- case n.IsHost():
- return network.NetworkHost
- case n.IsNone():
- return network.NetworkNone
- case n.IsContainer():
- return "container"
- case n.IsUserDefined():
- return n.UserDefined()
- default:
- return ""
- }
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/hostconfig_windows.go b/vendor/github.com/docker/docker/api/types/container/hostconfig_windows.go
deleted file mode 100644
index db63e190..00000000
--- a/vendor/github.com/docker/docker/api/types/container/hostconfig_windows.go
+++ /dev/null
@@ -1,47 +0,0 @@
-package container
-
-import "github.com/docker/docker/api/types/network"
-
-// IsValid indicates if an isolation technology is valid
-func (i Isolation) IsValid() bool {
- return i.IsDefault() || i.IsHyperV() || i.IsProcess()
-}
-
-// IsBridge indicates whether container uses the bridge network stack
-// in windows it is given the name NAT
-func (n NetworkMode) IsBridge() bool {
- return n == network.NetworkNat
-}
-
-// IsHost indicates whether container uses the host network stack.
-// returns false as this is not supported by windows
-func (n NetworkMode) IsHost() bool {
- return false
-}
-
-// IsUserDefined indicates user-created network
-func (n NetworkMode) IsUserDefined() bool {
- return !n.IsDefault() && !n.IsNone() && !n.IsBridge() && !n.IsContainer()
-}
-
-// NetworkName returns the name of the network stack.
-func (n NetworkMode) NetworkName() string {
- switch {
- case n.IsDefault():
- return network.NetworkDefault
- case n.IsBridge():
- return network.NetworkNat
- case n.IsHost():
- // Windows currently doesn't support host network-mode, so
- // this would currently never happen..
- return network.NetworkHost
- case n.IsNone():
- return network.NetworkNone
- case n.IsContainer():
- return "container"
- case n.IsUserDefined():
- return n.UserDefined()
- default:
- return ""
- }
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/network_settings.go b/vendor/github.com/docker/docker/api/types/container/network_settings.go
deleted file mode 100644
index 687145f2..00000000
--- a/vendor/github.com/docker/docker/api/types/container/network_settings.go
+++ /dev/null
@@ -1,85 +0,0 @@
-package container
-
-import (
- "github.com/docker/docker/api/types/network"
- "github.com/docker/go-connections/nat"
-)
-
-// NetworkSettings exposes the network settings in the api
-type NetworkSettings struct {
- NetworkSettingsBase
- DefaultNetworkSettings
- Networks map[string]*network.EndpointSettings
-}
-
-// NetworkSettingsBase holds networking state for a container when inspecting it.
-//
-// Deprecated: Most fields in NetworkSettingsBase are deprecated. Fields which aren't deprecated will move to
-// NetworkSettings in v29.0, and this struct will be removed.
-type NetworkSettingsBase struct {
- Bridge string // Deprecated: This field is only set when the daemon is started with the --bridge flag specified.
- SandboxID string // SandboxID uniquely represents a container's network stack
- SandboxKey string // SandboxKey identifies the sandbox
- Ports nat.PortMap // Ports is a collection of PortBinding indexed by Port
-
- // HairpinMode specifies if hairpin NAT should be enabled on the virtual interface
- //
- // Deprecated: This field is never set and will be removed in a future release.
- HairpinMode bool
- // LinkLocalIPv6Address is an IPv6 unicast address using the link-local prefix
- //
- // Deprecated: This field is never set and will be removed in a future release.
- LinkLocalIPv6Address string
- // LinkLocalIPv6PrefixLen is the prefix length of an IPv6 unicast address
- //
- // Deprecated: This field is never set and will be removed in a future release.
- LinkLocalIPv6PrefixLen int
- SecondaryIPAddresses []network.Address // Deprecated: This field is never set and will be removed in a future release.
- SecondaryIPv6Addresses []network.Address // Deprecated: This field is never set and will be removed in a future release.
-}
-
-// DefaultNetworkSettings holds the networking state for the default bridge, if the container is connected to that
-// network.
-//
-// Deprecated: this struct is deprecated since Docker v1.11 and will be removed in v29. You should look for the default
-// network in NetworkSettings.Networks instead.
-type DefaultNetworkSettings struct {
- // EndpointID uniquely represents a service endpoint in a Sandbox
- //
- // Deprecated: This field will be removed in v29. You should look for the default network in NetworkSettings.Networks instead.
- EndpointID string
- // Gateway holds the gateway address for the network
- //
- // Deprecated: This field will be removed in v29. You should look for the default network in NetworkSettings.Networks instead.
- Gateway string
- // GlobalIPv6Address holds network's global IPv6 address
- //
- // Deprecated: This field will be removed in v29. You should look for the default network in NetworkSettings.Networks instead.
- GlobalIPv6Address string
- // GlobalIPv6PrefixLen represents mask length of network's global IPv6 address
- //
- // Deprecated: This field will be removed in v29. You should look for the default network in NetworkSettings.Networks instead.
- GlobalIPv6PrefixLen int
- // IPAddress holds the IPv4 address for the network
- //
- // Deprecated: This field will be removed in v29. You should look for the default network in NetworkSettings.Networks instead.
- IPAddress string
- // IPPrefixLen represents mask length of network's IPv4 address
- //
- // Deprecated: This field will be removed in v29. You should look for the default network in NetworkSettings.Networks instead.
- IPPrefixLen int
- // IPv6Gateway holds gateway address specific for IPv6
- //
- // Deprecated: This field will be removed in v29. You should look for the default network in NetworkSettings.Networks instead.
- IPv6Gateway string
- // MacAddress holds the MAC address for the network
- //
- // Deprecated: This field will be removed in v29. You should look for the default network in NetworkSettings.Networks instead.
- MacAddress string
-}
-
-// NetworkSettingsSummary provides a summary of container's networks
-// in /containers/json
-type NetworkSettingsSummary struct {
- Networks map[string]*network.EndpointSettings
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/options.go b/vendor/github.com/docker/docker/api/types/container/options.go
deleted file mode 100644
index 7a230057..00000000
--- a/vendor/github.com/docker/docker/api/types/container/options.go
+++ /dev/null
@@ -1,67 +0,0 @@
-package container
-
-import "github.com/docker/docker/api/types/filters"
-
-// ResizeOptions holds parameters to resize a TTY.
-// It can be used to resize container TTYs and
-// exec process TTYs too.
-type ResizeOptions struct {
- Height uint
- Width uint
-}
-
-// AttachOptions holds parameters to attach to a container.
-type AttachOptions struct {
- Stream bool
- Stdin bool
- Stdout bool
- Stderr bool
- DetachKeys string
- Logs bool
-}
-
-// CommitOptions holds parameters to commit changes into a container.
-type CommitOptions struct {
- Reference string
- Comment string
- Author string
- Changes []string
- Pause bool
- Config *Config
-}
-
-// RemoveOptions holds parameters to remove containers.
-type RemoveOptions struct {
- RemoveVolumes bool
- RemoveLinks bool
- Force bool
-}
-
-// StartOptions holds parameters to start containers.
-type StartOptions struct {
- CheckpointID string
- CheckpointDir string
-}
-
-// ListOptions holds parameters to list containers with.
-type ListOptions struct {
- Size bool
- All bool
- Latest bool
- Since string
- Before string
- Limit int
- Filters filters.Args
-}
-
-// LogsOptions holds parameters to filter logs with.
-type LogsOptions struct {
- ShowStdout bool
- ShowStderr bool
- Since string
- Until string
- Timestamps bool
- Follow bool
- Tail string
- Details bool
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/port.go b/vendor/github.com/docker/docker/api/types/container/port.go
deleted file mode 100644
index 895043cf..00000000
--- a/vendor/github.com/docker/docker/api/types/container/port.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package container
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// Port An open port on a container
-// swagger:model Port
-type Port struct {
-
- // Host IP address that the container's port is mapped to
- IP string `json:"IP,omitempty"`
-
- // Port on the container
- // Required: true
- PrivatePort uint16 `json:"PrivatePort"`
-
- // Port exposed on the host
- PublicPort uint16 `json:"PublicPort,omitempty"`
-
- // type
- // Required: true
- Type string `json:"Type"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/state.go b/vendor/github.com/docker/docker/api/types/container/state.go
deleted file mode 100644
index 78d5c4fe..00000000
--- a/vendor/github.com/docker/docker/api/types/container/state.go
+++ /dev/null
@@ -1,64 +0,0 @@
-package container
-
-import (
- "fmt"
- "strings"
-)
-
-// ContainerState is a string representation of the container's current state.
-//
-// It currently is an alias for string, but may become a distinct type in the future.
-type ContainerState = string
-
-const (
- StateCreated ContainerState = "created" // StateCreated indicates the container is created, but not (yet) started.
- StateRunning ContainerState = "running" // StateRunning indicates that the container is running.
- StatePaused ContainerState = "paused" // StatePaused indicates that the container's current state is paused.
- StateRestarting ContainerState = "restarting" // StateRestarting indicates that the container is currently restarting.
- StateRemoving ContainerState = "removing" // StateRemoving indicates that the container is being removed.
- StateExited ContainerState = "exited" // StateExited indicates that the container exited.
- StateDead ContainerState = "dead" // StateDead indicates that the container failed to be deleted. Containers in this state are attempted to be cleaned up when the daemon restarts.
-)
-
-var validStates = []ContainerState{
- StateCreated, StateRunning, StatePaused, StateRestarting, StateRemoving, StateExited, StateDead,
-}
-
-// ValidateContainerState checks if the provided string is a valid
-// container [ContainerState].
-func ValidateContainerState(s ContainerState) error {
- switch s {
- case StateCreated, StateRunning, StatePaused, StateRestarting, StateRemoving, StateExited, StateDead:
- return nil
- default:
- return errInvalidParameter{error: fmt.Errorf("invalid value for state (%s): must be one of %s", s, strings.Join(validStates, ", "))}
- }
-}
-
-// StateStatus is used to return container wait results.
-// Implements exec.ExitCode interface.
-// This type is needed as State include a sync.Mutex field which make
-// copying it unsafe.
-type StateStatus struct {
- exitCode int
- err error
-}
-
-// ExitCode returns current exitcode for the state.
-func (s StateStatus) ExitCode() int {
- return s.exitCode
-}
-
-// Err returns current error for the state. Returns nil if the container had
-// exited on its own.
-func (s StateStatus) Err() error {
- return s.err
-}
-
-// NewStateStatus returns a new StateStatus with the given exit code and error.
-func NewStateStatus(exitCode int, err error) StateStatus {
- return StateStatus{
- exitCode: exitCode,
- err: err,
- }
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/stats.go b/vendor/github.com/docker/docker/api/types/container/stats.go
deleted file mode 100644
index 3bfeb484..00000000
--- a/vendor/github.com/docker/docker/api/types/container/stats.go
+++ /dev/null
@@ -1,177 +0,0 @@
-package container
-
-import "time"
-
-// ThrottlingData stores CPU throttling stats of one running container.
-// Not used on Windows.
-type ThrottlingData struct {
- // Number of periods with throttling active
- Periods uint64 `json:"periods"`
- // Number of periods when the container hits its throttling limit.
- ThrottledPeriods uint64 `json:"throttled_periods"`
- // Aggregate time the container was throttled for in nanoseconds.
- ThrottledTime uint64 `json:"throttled_time"`
-}
-
-// CPUUsage stores All CPU stats aggregated since container inception.
-type CPUUsage struct {
- // Total CPU time consumed.
- // Units: nanoseconds (Linux)
- // Units: 100's of nanoseconds (Windows)
- TotalUsage uint64 `json:"total_usage"`
-
- // Total CPU time consumed per core (Linux). Not used on Windows.
- // Units: nanoseconds.
- PercpuUsage []uint64 `json:"percpu_usage,omitempty"`
-
- // Time spent by tasks of the cgroup in kernel mode (Linux).
- // Time spent by all container processes in kernel mode (Windows).
- // Units: nanoseconds (Linux).
- // Units: 100's of nanoseconds (Windows). Not populated for Hyper-V Containers.
- UsageInKernelmode uint64 `json:"usage_in_kernelmode"`
-
- // Time spent by tasks of the cgroup in user mode (Linux).
- // Time spent by all container processes in user mode (Windows).
- // Units: nanoseconds (Linux).
- // Units: 100's of nanoseconds (Windows). Not populated for Hyper-V Containers
- UsageInUsermode uint64 `json:"usage_in_usermode"`
-}
-
-// CPUStats aggregates and wraps all CPU related info of container
-type CPUStats struct {
- // CPU Usage. Linux and Windows.
- CPUUsage CPUUsage `json:"cpu_usage"`
-
- // System Usage. Linux only.
- SystemUsage uint64 `json:"system_cpu_usage,omitempty"`
-
- // Online CPUs. Linux only.
- OnlineCPUs uint32 `json:"online_cpus,omitempty"`
-
- // Throttling Data. Linux only.
- ThrottlingData ThrottlingData `json:"throttling_data,omitempty"`
-}
-
-// MemoryStats aggregates all memory stats since container inception on Linux.
-// Windows returns stats for commit and private working set only.
-type MemoryStats struct {
- // Linux Memory Stats
-
- // current res_counter usage for memory
- Usage uint64 `json:"usage,omitempty"`
- // maximum usage ever recorded.
- MaxUsage uint64 `json:"max_usage,omitempty"`
- // TODO(vishh): Export these as stronger types.
- // all the stats exported via memory.stat.
- Stats map[string]uint64 `json:"stats,omitempty"`
- // number of times memory usage hits limits.
- Failcnt uint64 `json:"failcnt,omitempty"`
- Limit uint64 `json:"limit,omitempty"`
-
- // Windows Memory Stats
- // See https://technet.microsoft.com/en-us/magazine/ff382715.aspx
-
- // committed bytes
- Commit uint64 `json:"commitbytes,omitempty"`
- // peak committed bytes
- CommitPeak uint64 `json:"commitpeakbytes,omitempty"`
- // private working set
- PrivateWorkingSet uint64 `json:"privateworkingset,omitempty"`
-}
-
-// BlkioStatEntry is one small entity to store a piece of Blkio stats
-// Not used on Windows.
-type BlkioStatEntry struct {
- Major uint64 `json:"major"`
- Minor uint64 `json:"minor"`
- Op string `json:"op"`
- Value uint64 `json:"value"`
-}
-
-// BlkioStats stores All IO service stats for data read and write.
-// This is a Linux specific structure as the differences between expressing
-// block I/O on Windows and Linux are sufficiently significant to make
-// little sense attempting to morph into a combined structure.
-type BlkioStats struct {
- // number of bytes transferred to and from the block device
- 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"`
-}
-
-// StorageStats is the disk I/O stats for read/write on Windows.
-type StorageStats struct {
- ReadCountNormalized uint64 `json:"read_count_normalized,omitempty"`
- ReadSizeBytes uint64 `json:"read_size_bytes,omitempty"`
- WriteCountNormalized uint64 `json:"write_count_normalized,omitempty"`
- WriteSizeBytes uint64 `json:"write_size_bytes,omitempty"`
-}
-
-// NetworkStats aggregates the network stats of one container
-type NetworkStats struct {
- // Bytes received. Windows and Linux.
- RxBytes uint64 `json:"rx_bytes"`
- // Packets received. Windows and Linux.
- RxPackets uint64 `json:"rx_packets"`
- // Received errors. Not used on Windows. Note that we don't `omitempty` this
- // field as it is expected in the >=v1.21 API stats structure.
- RxErrors uint64 `json:"rx_errors"`
- // Incoming packets dropped. Windows and Linux.
- RxDropped uint64 `json:"rx_dropped"`
- // Bytes sent. Windows and Linux.
- TxBytes uint64 `json:"tx_bytes"`
- // Packets sent. Windows and Linux.
- TxPackets uint64 `json:"tx_packets"`
- // Sent errors. Not used on Windows. Note that we don't `omitempty` this
- // field as it is expected in the >=v1.21 API stats structure.
- TxErrors uint64 `json:"tx_errors"`
- // Outgoing packets dropped. Windows and Linux.
- TxDropped uint64 `json:"tx_dropped"`
- // Endpoint ID. Not used on Linux.
- EndpointID string `json:"endpoint_id,omitempty"`
- // Instance ID. Not used on Linux.
- InstanceID string `json:"instance_id,omitempty"`
-}
-
-// PidsStats contains the stats of a container's pids
-type PidsStats struct {
- // Current is the number of pids in the cgroup
- Current uint64 `json:"current,omitempty"`
- // Limit is the hard limit on the number of pids in the cgroup.
- // A "Limit" of 0 means that there is no limit.
- Limit uint64 `json:"limit,omitempty"`
-}
-
-// Stats is Ultimate struct aggregating all types of stats of one container
-//
-// Deprecated: use [StatsResponse] instead. This type will be removed in the next release.
-type Stats = StatsResponse
-
-// StatsResponse aggregates all types of stats of one container.
-type StatsResponse struct {
- Name string `json:"name,omitempty"`
- ID string `json:"id,omitempty"`
-
- // Common stats
- Read time.Time `json:"read"`
- PreRead time.Time `json:"preread"`
-
- // Linux specific stats, not populated on Windows.
- PidsStats PidsStats `json:"pids_stats,omitempty"`
- BlkioStats BlkioStats `json:"blkio_stats,omitempty"`
-
- // Windows specific stats, not populated on Linux.
- NumProcs uint32 `json:"num_procs"`
- StorageStats StorageStats `json:"storage_stats,omitempty"`
-
- // Shared stats
- CPUStats CPUStats `json:"cpu_stats,omitempty"`
- PreCPUStats CPUStats `json:"precpu_stats,omitempty"` // "Pre"="Previous"
- MemoryStats MemoryStats `json:"memory_stats,omitempty"`
- Networks map[string]NetworkStats `json:"networks,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/top_response.go b/vendor/github.com/docker/docker/api/types/container/top_response.go
deleted file mode 100644
index b4bae5ef..00000000
--- a/vendor/github.com/docker/docker/api/types/container/top_response.go
+++ /dev/null
@@ -1,18 +0,0 @@
-package container
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// TopResponse ContainerTopResponse
-//
-// Container "top" response.
-// swagger:model TopResponse
-type TopResponse struct {
-
- // Each process running in the container, where each process
- // is an array of values corresponding to the titles.
- Processes [][]string `json:"Processes"`
-
- // The ps column titles
- Titles []string `json:"Titles"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/update_response.go b/vendor/github.com/docker/docker/api/types/container/update_response.go
deleted file mode 100644
index e2b5bf5a..00000000
--- a/vendor/github.com/docker/docker/api/types/container/update_response.go
+++ /dev/null
@@ -1,14 +0,0 @@
-package container
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// UpdateResponse ContainerUpdateResponse
-//
-// Response for a successful container-update.
-// swagger:model UpdateResponse
-type UpdateResponse struct {
-
- // Warnings encountered when updating the container.
- Warnings []string `json:"Warnings"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/wait_exit_error.go b/vendor/github.com/docker/docker/api/types/container/wait_exit_error.go
deleted file mode 100644
index ab56d4ee..00000000
--- a/vendor/github.com/docker/docker/api/types/container/wait_exit_error.go
+++ /dev/null
@@ -1,12 +0,0 @@
-package container
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// WaitExitError container waiting error, if any
-// swagger:model WaitExitError
-type WaitExitError struct {
-
- // Details of an error
- Message string `json:"Message,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/wait_response.go b/vendor/github.com/docker/docker/api/types/container/wait_response.go
deleted file mode 100644
index 84fc6afd..00000000
--- a/vendor/github.com/docker/docker/api/types/container/wait_response.go
+++ /dev/null
@@ -1,18 +0,0 @@
-package container
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// WaitResponse ContainerWaitResponse
-//
-// OK response to ContainerWait operation
-// swagger:model WaitResponse
-type WaitResponse struct {
-
- // error
- Error *WaitExitError `json:"Error,omitempty"`
-
- // Exit code of the container
- // Required: true
- StatusCode int64 `json:"StatusCode"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/container/waitcondition.go b/vendor/github.com/docker/docker/api/types/container/waitcondition.go
deleted file mode 100644
index 64820fe3..00000000
--- a/vendor/github.com/docker/docker/api/types/container/waitcondition.go
+++ /dev/null
@@ -1,22 +0,0 @@
-package container
-
-// WaitCondition is a type used to specify a container state for which
-// to wait.
-type WaitCondition string
-
-// Possible WaitCondition Values.
-//
-// WaitConditionNotRunning (default) is used to wait for any of the non-running
-// states: "created", "exited", "dead", "removing", or "removed".
-//
-// WaitConditionNextExit is used to wait for the next time the state changes
-// to a non-running state. If the state is currently "created" or "exited",
-// this would cause Wait() to block until either the container runs and exits
-// or is removed.
-//
-// WaitConditionRemoved is used to wait for the container to be removed.
-const (
- WaitConditionNotRunning WaitCondition = "not-running"
- WaitConditionNextExit WaitCondition = "next-exit"
- WaitConditionRemoved WaitCondition = "removed"
-)
diff --git a/vendor/github.com/docker/docker/api/types/error_response.go b/vendor/github.com/docker/docker/api/types/error_response.go
deleted file mode 100644
index dc942d9d..00000000
--- a/vendor/github.com/docker/docker/api/types/error_response.go
+++ /dev/null
@@ -1,13 +0,0 @@
-package types
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// ErrorResponse Represents an error.
-// swagger:model ErrorResponse
-type ErrorResponse struct {
-
- // The error message.
- // Required: true
- Message string `json:"message"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/error_response_ext.go b/vendor/github.com/docker/docker/api/types/error_response_ext.go
deleted file mode 100644
index f84f034c..00000000
--- a/vendor/github.com/docker/docker/api/types/error_response_ext.go
+++ /dev/null
@@ -1,6 +0,0 @@
-package types
-
-// Error returns the error message
-func (e ErrorResponse) Error() string {
- return e.Message
-}
diff --git a/vendor/github.com/docker/docker/api/types/events/events.go b/vendor/github.com/docker/docker/api/types/events/events.go
deleted file mode 100644
index 952c0ff2..00000000
--- a/vendor/github.com/docker/docker/api/types/events/events.go
+++ /dev/null
@@ -1,139 +0,0 @@
-package events
-
-import "github.com/docker/docker/api/types/filters"
-
-// Type is used for event-types.
-type Type string
-
-// List of known event types.
-const (
- BuilderEventType Type = "builder" // BuilderEventType is the event type that the builder generates.
- ConfigEventType Type = "config" // ConfigEventType is the event type that configs generate.
- ContainerEventType Type = "container" // ContainerEventType is the event type that containers generate.
- DaemonEventType Type = "daemon" // DaemonEventType is the event type that daemon generate.
- ImageEventType Type = "image" // ImageEventType is the event type that images generate.
- NetworkEventType Type = "network" // NetworkEventType is the event type that networks generate.
- NodeEventType Type = "node" // NodeEventType is the event type that nodes generate.
- PluginEventType Type = "plugin" // PluginEventType is the event type that plugins generate.
- SecretEventType Type = "secret" // SecretEventType is the event type that secrets generate.
- ServiceEventType Type = "service" // ServiceEventType is the event type that services generate.
- VolumeEventType Type = "volume" // VolumeEventType is the event type that volumes generate.
-)
-
-// Action is used for event-actions.
-type Action string
-
-const (
- ActionCreate Action = "create"
- ActionStart Action = "start"
- ActionRestart Action = "restart"
- ActionStop Action = "stop"
- ActionCheckpoint Action = "checkpoint"
- ActionPause Action = "pause"
- ActionUnPause Action = "unpause"
- ActionAttach Action = "attach"
- ActionDetach Action = "detach"
- ActionResize Action = "resize"
- ActionUpdate Action = "update"
- ActionRename Action = "rename"
- ActionKill Action = "kill"
- ActionDie Action = "die"
- ActionOOM Action = "oom"
- ActionDestroy Action = "destroy"
- ActionRemove Action = "remove"
- ActionCommit Action = "commit"
- ActionTop Action = "top"
- ActionCopy Action = "copy"
- ActionArchivePath Action = "archive-path"
- ActionExtractToDir Action = "extract-to-dir"
- ActionExport Action = "export"
- ActionImport Action = "import"
- ActionSave Action = "save"
- ActionLoad Action = "load"
- ActionTag Action = "tag"
- ActionUnTag Action = "untag"
- ActionPush Action = "push"
- ActionPull Action = "pull"
- ActionPrune Action = "prune"
- ActionDelete Action = "delete"
- ActionEnable Action = "enable"
- ActionDisable Action = "disable"
- ActionConnect Action = "connect"
- ActionDisconnect Action = "disconnect"
- ActionReload Action = "reload"
- ActionMount Action = "mount"
- ActionUnmount Action = "unmount"
-
- // ActionExecCreate is the prefix used for exec_create events. These
- // event-actions are commonly followed by a colon and space (": "),
- // and the command that's defined for the exec, for example:
- //
- // exec_create: /bin/sh -c 'echo hello'
- //
- // This is far from ideal; it's a compromise to allow filtering and
- // to preserve backward-compatibility.
- ActionExecCreate Action = "exec_create"
- // ActionExecStart is the prefix used for exec_create events. These
- // event-actions are commonly followed by a colon and space (": "),
- // and the command that's defined for the exec, for example:
- //
- // exec_start: /bin/sh -c 'echo hello'
- //
- // This is far from ideal; it's a compromise to allow filtering and
- // to preserve backward-compatibility.
- ActionExecStart Action = "exec_start"
- ActionExecDie Action = "exec_die"
- ActionExecDetach Action = "exec_detach"
-
- // ActionHealthStatus is the prefix to use for health_status events.
- //
- // Health-status events can either have a pre-defined status, in which
- // case the "health_status" action is followed by a colon, or can be
- // "free-form", in which case they're followed by the output of the
- // health-check output.
- //
- // This is far form ideal, and a compromise to allow filtering, and
- // to preserve backward-compatibility.
- ActionHealthStatus Action = "health_status"
- ActionHealthStatusRunning Action = "health_status: running"
- ActionHealthStatusHealthy Action = "health_status: healthy"
- ActionHealthStatusUnhealthy Action = "health_status: unhealthy"
-)
-
-// Actor describes something that generates events,
-// like a container, or a network, or a volume.
-// It has a defined name and a set of attributes.
-// The container attributes are its labels, other actors
-// can generate these attributes from other properties.
-type Actor struct {
- ID string
- Attributes map[string]string
-}
-
-// Message represents the information an event contains
-type Message struct {
- // Deprecated: use Action instead.
- // Information from JSONMessage.
- // With data only in container events.
- Status string `json:"status,omitempty"`
- // Deprecated: use Actor.ID instead.
- ID string `json:"id,omitempty"`
- // Deprecated: use Actor.Attributes["image"] instead.
- From string `json:"from,omitempty"`
-
- Type Type
- Action Action
- Actor Actor
- // Engine events are local scope. Cluster events are swarm scope.
- Scope string `json:"scope,omitempty"`
-
- Time int64 `json:"time,omitempty"`
- TimeNano int64 `json:"timeNano,omitempty"`
-}
-
-// ListOptions holds parameters to filter events with.
-type ListOptions struct {
- Since string
- Until string
- Filters filters.Args
-}
diff --git a/vendor/github.com/docker/docker/api/types/image/delete_response.go b/vendor/github.com/docker/docker/api/types/image/delete_response.go
deleted file mode 100644
index 998620dc..00000000
--- a/vendor/github.com/docker/docker/api/types/image/delete_response.go
+++ /dev/null
@@ -1,15 +0,0 @@
-package image
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// DeleteResponse delete response
-// swagger:model DeleteResponse
-type DeleteResponse struct {
-
- // The image ID of an image that was deleted
- Deleted string `json:"Deleted,omitempty"`
-
- // The image ID of an image that was untagged
- Untagged string `json:"Untagged,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/image/disk_usage.go b/vendor/github.com/docker/docker/api/types/image/disk_usage.go
deleted file mode 100644
index e847386a..00000000
--- a/vendor/github.com/docker/docker/api/types/image/disk_usage.go
+++ /dev/null
@@ -1,10 +0,0 @@
-package image
-
-// DiskUsage contains disk usage for images.
-//
-// Deprecated: this type is no longer used and will be removed in the next release.
-type DiskUsage struct {
- TotalSize int64
- Reclaimable int64
- Items []*Summary
-}
diff --git a/vendor/github.com/docker/docker/api/types/image/image.go b/vendor/github.com/docker/docker/api/types/image/image.go
deleted file mode 100644
index abb7ffd8..00000000
--- a/vendor/github.com/docker/docker/api/types/image/image.go
+++ /dev/null
@@ -1,47 +0,0 @@
-package image
-
-import (
- "io"
- "time"
-)
-
-// Metadata contains engine-local data about the image.
-type Metadata struct {
- // LastTagTime is the date and time at which the image was last tagged.
- LastTagTime time.Time `json:",omitempty"`
-}
-
-// PruneReport contains the response for Engine API:
-// POST "/images/prune"
-type PruneReport struct {
- ImagesDeleted []DeleteResponse
- SpaceReclaimed uint64
-}
-
-// LoadResponse returns information to the client about a load process.
-//
-// TODO(thaJeztah): remove this type, and just use an io.ReadCloser
-//
-// This type was added in https://github.com/moby/moby/pull/18878, related
-// to https://github.com/moby/moby/issues/19177;
-//
-// Make docker load to output json when the response content type is json
-// Swarm hijacks the response from docker load and returns JSON rather
-// than plain text like the Engine does. This makes the API library to return
-// information to figure that out.
-//
-// However the "load" endpoint unconditionally returns JSON;
-// https://github.com/moby/moby/blob/7b9d2ef6e5518a3d3f3cc418459f8df786cfbbd1/api/server/router/image/image_routes.go#L248-L255
-//
-// PR https://github.com/moby/moby/pull/21959 made the response-type depend
-// on whether "quiet" was set, but this logic got changed in a follow-up
-// https://github.com/moby/moby/pull/25557, which made the JSON response-type
-// unconditionally, but the output produced depend on whether"quiet" was set.
-//
-// We should deprecated the "quiet" option, as it's really a client
-// responsibility.
-type LoadResponse struct {
- // Body must be closed to avoid a resource leak
- Body io.ReadCloser
- JSON bool
-}
diff --git a/vendor/github.com/docker/docker/api/types/image/image_history.go b/vendor/github.com/docker/docker/api/types/image/image_history.go
deleted file mode 100644
index a6cdab84..00000000
--- a/vendor/github.com/docker/docker/api/types/image/image_history.go
+++ /dev/null
@@ -1,36 +0,0 @@
-package image
-
-// ----------------------------------------------------------------------------
-// Code generated by `swagger generate operation`. DO NOT EDIT.
-//
-// See hack/generate-swagger-api.sh
-// ----------------------------------------------------------------------------
-
-// HistoryResponseItem individual image layer information in response to ImageHistory operation
-// swagger:model HistoryResponseItem
-type HistoryResponseItem struct {
-
- // comment
- // Required: true
- Comment string `json:"Comment"`
-
- // created
- // Required: true
- Created int64 `json:"Created"`
-
- // created by
- // Required: true
- CreatedBy string `json:"CreatedBy"`
-
- // Id
- // Required: true
- ID string `json:"Id"`
-
- // size
- // Required: true
- Size int64 `json:"Size"`
-
- // tags
- // Required: true
- Tags []string `json:"Tags"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/image/image_inspect.go b/vendor/github.com/docker/docker/api/types/image/image_inspect.go
deleted file mode 100644
index 1bec0b72..00000000
--- a/vendor/github.com/docker/docker/api/types/image/image_inspect.go
+++ /dev/null
@@ -1,146 +0,0 @@
-package image
-
-import (
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/storage"
- dockerspec "github.com/moby/docker-image-spec/specs-go/v1"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-// RootFS returns Image's RootFS description including the layer IDs.
-type RootFS struct {
- Type string `json:",omitempty"`
- Layers []string `json:",omitempty"`
-}
-
-// InspectResponse contains response of Engine API:
-// GET "/images/{name:.*}/json"
-type InspectResponse struct {
- // ID is the content-addressable ID of an image.
- //
- // This identifier is a content-addressable digest calculated from the
- // image's configuration (which includes the digests of layers used by
- // the image).
- //
- // Note that this digest differs from the `RepoDigests` below, which
- // holds digests of image manifests that reference the image.
- ID string `json:"Id"`
-
- // RepoTags is a list of image names/tags in the local image cache that
- // reference this image.
- //
- // Multiple image tags can refer to the same image, and this list may be
- // empty if no tags reference the image, in which case the image is
- // "untagged", in which case it can still be referenced by its ID.
- RepoTags []string
-
- // RepoDigests is a list of content-addressable digests of locally available
- // image manifests that the image is referenced from. Multiple manifests can
- // refer to the same image.
- //
- // These digests are usually only available if the image was either pulled
- // from a registry, or if the image was pushed to a registry, which is when
- // the manifest is generated and its digest calculated.
- RepoDigests []string
-
- // Parent is the ID of the parent image.
- //
- // Depending on how the image was created, this field may be empty and
- // is only set for images that were built/created locally. This field
- // is empty if the image was pulled from an image registry.
- //
- // Deprecated: this field is deprecated, and will be removed in the next release.
- Parent string
-
- // Comment is an optional message that can be set when committing or
- // importing the image.
- Comment string
-
- // Created is the date and time at which the image was created, formatted in
- // RFC 3339 nano-seconds (time.RFC3339Nano).
- //
- // This information is only available if present in the image,
- // and omitted otherwise.
- Created string `json:",omitempty"`
-
- // Container is the ID of the container that was used to create the image.
- //
- // Depending on how the image was created, this field may be empty.
- //
- // Deprecated: this field is omitted in API v1.45, but kept for backward compatibility.
- Container string `json:",omitempty"`
-
- // ContainerConfig is an optional field containing the configuration of the
- // container that was last committed when creating the image.
- //
- // Previous versions of Docker builder used this field to store build cache,
- // and it is not in active use anymore.
- //
- // Deprecated: this field is omitted in API v1.45, but kept for backward compatibility.
- ContainerConfig *container.Config `json:",omitempty"`
-
- // DockerVersion is the version of Docker that was used to build the image.
- //
- // Depending on how the image was created, this field may be empty.
- //
- // Deprecated: this field is deprecated, and will be removed in the next release.
- DockerVersion string
-
- // Author is the name of the author that was specified when committing the
- // image, or as specified through MAINTAINER (deprecated) in the Dockerfile.
- Author string
- Config *dockerspec.DockerOCIImageConfig
-
- // Architecture is the hardware CPU architecture that the image runs on.
- Architecture string
-
- // Variant is the CPU architecture variant (presently ARM-only).
- Variant string `json:",omitempty"`
-
- // OS is the Operating System the image is built to run on.
- Os string
-
- // OsVersion is the version of the Operating System the image is built to
- // run on (especially for Windows).
- OsVersion string `json:",omitempty"`
-
- // Size is the total size of the image including all layers it is composed of.
- Size int64
-
- // VirtualSize is the total size of the image including all layers it is
- // composed of.
- //
- // Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead.
- VirtualSize int64 `json:"VirtualSize,omitempty"`
-
- // GraphDriver holds information about the storage driver used to store the
- // container's and image's filesystem.
- GraphDriver storage.DriverData
-
- // RootFS contains information about the image's RootFS, including the
- // layer IDs.
- RootFS RootFS
-
- // Metadata of the image in the local cache.
- //
- // This information is local to the daemon, and not part of the image itself.
- Metadata Metadata
-
- // Descriptor is the OCI descriptor of the image target.
- // It's only set if the daemon provides a multi-platform image store.
- //
- // WARNING: This is experimental and may change at any time without any backward
- // compatibility.
- Descriptor *ocispec.Descriptor `json:"Descriptor,omitempty"`
-
- // Manifests is a list of image manifests available in this image. It
- // provides a more detailed view of the platform-specific image manifests or
- // other image-attached data like build attestations.
- //
- // Only available if the daemon provides a multi-platform image store, the client
- // requests manifests AND does not request a specific platform.
- //
- // WARNING: This is experimental and may change at any time without any backward
- // compatibility.
- Manifests []ManifestSummary `json:"Manifests,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/image/manifest.go b/vendor/github.com/docker/docker/api/types/image/manifest.go
deleted file mode 100644
index db8a0083..00000000
--- a/vendor/github.com/docker/docker/api/types/image/manifest.go
+++ /dev/null
@@ -1,99 +0,0 @@
-package image
-
-import (
- "github.com/opencontainers/go-digest"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-type ManifestKind string
-
-const (
- ManifestKindImage ManifestKind = "image"
- ManifestKindAttestation ManifestKind = "attestation"
- ManifestKindUnknown ManifestKind = "unknown"
-)
-
-type ManifestSummary struct {
- // ID is the content-addressable ID of an image and is the same as the
- // digest of the image manifest.
- //
- // Required: true
- ID string `json:"ID"`
-
- // Descriptor is the OCI descriptor of the image.
- //
- // Required: true
- Descriptor ocispec.Descriptor `json:"Descriptor"`
-
- // Indicates whether all the child content (image config, layers) is
- // fully available locally
- //
- // Required: true
- Available bool `json:"Available"`
-
- // Size is the size information of the content related to this manifest.
- // Note: These sizes only take the locally available content into account.
- //
- // Required: true
- Size struct {
- // Content is the size (in bytes) of all the locally present
- // content in the content store (e.g. image config, layers)
- // referenced by this manifest and its children.
- // This only includes blobs in the content store.
- Content int64 `json:"Content"`
-
- // Total is the total size (in bytes) of all the locally present
- // data (both distributable and non-distributable) that's related to
- // this manifest and its children.
- // This equal to the sum of [Content] size AND all the sizes in the
- // [Size] struct present in the Kind-specific data struct.
- // For example, for an image kind (Kind == ManifestKindImage),
- // this would include the size of the image content and unpacked
- // image snapshots ([Size.Content] + [ImageData.Size.Unpacked]).
- Total int64 `json:"Total"`
- } `json:"Size"`
-
- // Kind is the kind of the image manifest.
- //
- // Required: true
- Kind ManifestKind `json:"Kind"`
-
- // Fields below are specific to the kind of the image manifest.
-
- // Present only if Kind == ManifestKindImage.
- ImageData *ImageProperties `json:"ImageData,omitempty"`
-
- // Present only if Kind == ManifestKindAttestation.
- AttestationData *AttestationProperties `json:"AttestationData,omitempty"`
-}
-
-type ImageProperties struct {
- // Platform is the OCI platform object describing the platform of the image.
- //
- // Required: true
- Platform ocispec.Platform `json:"Platform"`
-
- Size struct {
- // Unpacked is the size (in bytes) of the locally unpacked
- // (uncompressed) image content that's directly usable by the containers
- // running this image.
- // It's independent of the distributable content - e.g.
- // the image might still have an unpacked data that's still used by
- // some container even when the distributable/compressed content is
- // already gone.
- //
- // Required: true
- Unpacked int64 `json:"Unpacked"`
- }
-
- // Containers is an array containing the IDs of the containers that are
- // using this image.
- //
- // Required: true
- Containers []string `json:"Containers"`
-}
-
-type AttestationProperties struct {
- // For is the digest of the image manifest that this attestation is for.
- For digest.Digest `json:"For"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/image/opts.go b/vendor/github.com/docker/docker/api/types/image/opts.go
deleted file mode 100644
index 9e33a42f..00000000
--- a/vendor/github.com/docker/docker/api/types/image/opts.go
+++ /dev/null
@@ -1,124 +0,0 @@
-package image
-
-import (
- "context"
- "io"
-
- "github.com/docker/docker/api/types/filters"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-// ImportSource holds source information for ImageImport
-type ImportSource struct {
- Source io.Reader // Source is the data to send to the server to create this image from. You must set SourceName to "-" to leverage this.
- SourceName string // SourceName is the name of the image to pull. Set to "-" to leverage the Source attribute.
-}
-
-// ImportOptions holds information to import images from the client host.
-type ImportOptions struct {
- Tag string // Tag is the name to tag this image with. This attribute is deprecated.
- Message string // Message is the message to tag the image with
- Changes []string // Changes are the raw changes to apply to this image
- Platform string // Platform is the target platform of the image
-}
-
-// CreateOptions holds information to create images.
-type CreateOptions struct {
- RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry.
- Platform string // Platform is the target platform of the image if it needs to be pulled from the registry.
-}
-
-// PullOptions holds information to pull images.
-type PullOptions struct {
- All bool
- RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry
-
- // PrivilegeFunc is a function that clients can supply to retry operations
- // after getting an authorization error. This function returns the registry
- // authentication header value in base64 encoded format, or an error if the
- // privilege request fails.
- //
- // For details, refer to [github.com/docker/docker/api/types/registry.RequestAuthConfig].
- PrivilegeFunc func(context.Context) (string, error)
- Platform string
-}
-
-// PushOptions holds information to push images.
-type PushOptions struct {
- All bool
- RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry
-
- // PrivilegeFunc is a function that clients can supply to retry operations
- // after getting an authorization error. This function returns the registry
- // authentication header value in base64 encoded format, or an error if the
- // privilege request fails.
- //
- // For details, refer to [github.com/docker/docker/api/types/registry.RequestAuthConfig].
- PrivilegeFunc func(context.Context) (string, error)
-
- // Platform is an optional field that selects a specific platform to push
- // when the image is a multi-platform image.
- // Using this will only push a single platform-specific manifest.
- Platform *ocispec.Platform `json:",omitempty"`
-}
-
-// ListOptions holds parameters to list images with.
-type ListOptions struct {
- // All controls whether all images in the graph are filtered, or just
- // the heads.
- All bool
-
- // Filters is a JSON-encoded set of filter arguments.
- Filters filters.Args
-
- // SharedSize indicates whether the shared size of images should be computed.
- SharedSize bool
-
- // ContainerCount indicates whether container count should be computed.
- //
- // Deprecated: This field has been unused and is no longer required and will be removed in a future version.
- ContainerCount bool
-
- // Manifests indicates whether the image manifests should be returned.
- Manifests bool
-}
-
-// RemoveOptions holds parameters to remove images.
-type RemoveOptions struct {
- Platforms []ocispec.Platform
- Force bool
- PruneChildren bool
-}
-
-// HistoryOptions holds parameters to get image history.
-type HistoryOptions struct {
- // Platform from the manifest list to use for history.
- Platform *ocispec.Platform
-}
-
-// LoadOptions holds parameters to load images.
-type LoadOptions struct {
- // Quiet suppresses progress output
- Quiet bool
-
- // Platforms selects the platforms to load if the image is a
- // multi-platform image and has multiple variants.
- Platforms []ocispec.Platform
-}
-
-type InspectOptions struct {
- // Manifests returns the image manifests.
- Manifests bool
-
- // Platform selects the specific platform of a multi-platform image to inspect.
- //
- // This option is only available for API version 1.49 and up.
- Platform *ocispec.Platform
-}
-
-// SaveOptions holds parameters to save images.
-type SaveOptions struct {
- // Platforms selects the platforms to save if the image is a
- // multi-platform image and has multiple variants.
- Platforms []ocispec.Platform
-}
diff --git a/vendor/github.com/docker/docker/api/types/image/summary.go b/vendor/github.com/docker/docker/api/types/image/summary.go
deleted file mode 100644
index c5ae6ab9..00000000
--- a/vendor/github.com/docker/docker/api/types/image/summary.go
+++ /dev/null
@@ -1,101 +0,0 @@
-package image
-
-import ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-
-type Summary struct {
-
- // Number of containers using this image. Includes both stopped and running
- // containers.
- //
- // This size is not calculated by default, and depends on which API endpoint
- // is used. `-1` indicates that the value has not been set / calculated.
- //
- // Required: true
- Containers int64 `json:"Containers"`
-
- // Date and time at which the image was created as a Unix timestamp
- // (number of seconds since EPOCH).
- //
- // Required: true
- Created int64 `json:"Created"`
-
- // ID is the content-addressable ID of an image.
- //
- // This identifier is a content-addressable digest calculated from the
- // image's configuration (which includes the digests of layers used by
- // the image).
- //
- // Note that this digest differs from the `RepoDigests` below, which
- // holds digests of image manifests that reference the image.
- //
- // Required: true
- ID string `json:"Id"`
-
- // User-defined key/value metadata.
- // Required: true
- Labels map[string]string `json:"Labels"`
-
- // ID of the parent image.
- //
- // Depending on how the image was created, this field may be empty and
- // is only set for images that were built/created locally. This field
- // is empty if the image was pulled from an image registry.
- //
- // Required: true
- ParentID string `json:"ParentId"`
-
- // Descriptor is the OCI descriptor of the image target.
- // It's only set if the daemon provides a multi-platform image store.
- //
- // WARNING: This is experimental and may change at any time without any backward
- // compatibility.
- Descriptor *ocispec.Descriptor `json:"Descriptor,omitempty"`
-
- // Manifests is a list of image manifests available in this image. It
- // provides a more detailed view of the platform-specific image manifests or
- // other image-attached data like build attestations.
- //
- // WARNING: This is experimental and may change at any time without any backward
- // compatibility.
- Manifests []ManifestSummary `json:"Manifests,omitempty"`
-
- // List of content-addressable digests of locally available image manifests
- // that the image is referenced from. Multiple manifests can refer to the
- // same image.
- //
- // These digests are usually only available if the image was either pulled
- // from a registry, or if the image was pushed to a registry, which is when
- // the manifest is generated and its digest calculated.
- //
- // Required: true
- RepoDigests []string `json:"RepoDigests"`
-
- // List of image names/tags in the local image cache that reference this
- // image.
- //
- // Multiple image tags can refer to the same image, and this list may be
- // empty if no tags reference the image, in which case the image is
- // "untagged", in which case it can still be referenced by its ID.
- //
- // Required: true
- RepoTags []string `json:"RepoTags"`
-
- // Total size of image layers that are shared between this image and other
- // images.
- //
- // This size is not calculated by default. `-1` indicates that the value
- // has not been set / calculated.
- //
- // Required: true
- SharedSize int64 `json:"SharedSize"`
-
- // Total size of the image including all layers it is composed of.
- //
- // Required: true
- Size int64 `json:"Size"`
-
- // Total size of the image including all layers it is composed of.
- //
- // Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead.
- VirtualSize int64 `json:"VirtualSize,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/mount/mount.go b/vendor/github.com/docker/docker/api/types/mount/mount.go
deleted file mode 100644
index 090d436c..00000000
--- a/vendor/github.com/docker/docker/api/types/mount/mount.go
+++ /dev/null
@@ -1,157 +0,0 @@
-package mount
-
-import (
- "os"
-)
-
-// Type represents the type of a mount.
-type Type string
-
-// Type constants
-const (
- // TypeBind is the type for mounting host dir
- TypeBind Type = "bind"
- // TypeVolume is the type for remote storage volumes
- TypeVolume Type = "volume"
- // TypeTmpfs is the type for mounting tmpfs
- TypeTmpfs Type = "tmpfs"
- // TypeNamedPipe is the type for mounting Windows named pipes
- TypeNamedPipe Type = "npipe"
- // TypeCluster is the type for Swarm Cluster Volumes.
- TypeCluster Type = "cluster"
- // TypeImage is the type for mounting another image's filesystem
- TypeImage Type = "image"
-)
-
-// Mount represents a mount (volume).
-type Mount struct {
- Type Type `json:",omitempty"`
- // Source specifies the name of the mount. Depending on mount type, this
- // may be a volume name or a host path, or even ignored.
- // Source is not supported for tmpfs (must be an empty value)
- Source string `json:",omitempty"`
- Target string `json:",omitempty"`
- ReadOnly bool `json:",omitempty"` // attempts recursive read-only if possible
- Consistency Consistency `json:",omitempty"`
-
- BindOptions *BindOptions `json:",omitempty"`
- VolumeOptions *VolumeOptions `json:",omitempty"`
- ImageOptions *ImageOptions `json:",omitempty"`
- TmpfsOptions *TmpfsOptions `json:",omitempty"`
- ClusterOptions *ClusterOptions `json:",omitempty"`
-}
-
-// Propagation represents the propagation of a mount.
-type Propagation string
-
-const (
- // PropagationRPrivate RPRIVATE
- PropagationRPrivate Propagation = "rprivate"
- // PropagationPrivate PRIVATE
- PropagationPrivate Propagation = "private"
- // PropagationRShared RSHARED
- PropagationRShared Propagation = "rshared"
- // PropagationShared SHARED
- PropagationShared Propagation = "shared"
- // PropagationRSlave RSLAVE
- PropagationRSlave Propagation = "rslave"
- // PropagationSlave SLAVE
- PropagationSlave Propagation = "slave"
-)
-
-// Propagations is the list of all valid mount propagations
-var Propagations = []Propagation{
- PropagationRPrivate,
- PropagationPrivate,
- PropagationRShared,
- PropagationShared,
- PropagationRSlave,
- PropagationSlave,
-}
-
-// Consistency represents the consistency requirements of a mount.
-type Consistency string
-
-const (
- // ConsistencyFull guarantees bind mount-like consistency
- ConsistencyFull Consistency = "consistent"
- // ConsistencyCached mounts can cache read data and FS structure
- ConsistencyCached Consistency = "cached"
- // ConsistencyDelegated mounts can cache read and written data and structure
- ConsistencyDelegated Consistency = "delegated"
- // ConsistencyDefault provides "consistent" behavior unless overridden
- ConsistencyDefault Consistency = "default"
-)
-
-// BindOptions defines options specific to mounts of type "bind".
-type BindOptions struct {
- Propagation Propagation `json:",omitempty"`
- NonRecursive bool `json:",omitempty"`
- CreateMountpoint bool `json:",omitempty"`
- // ReadOnlyNonRecursive makes the mount non-recursively read-only, but still leaves the mount recursive
- // (unless NonRecursive is set to true in conjunction).
- ReadOnlyNonRecursive bool `json:",omitempty"`
- // ReadOnlyForceRecursive raises an error if the mount cannot be made recursively read-only.
- ReadOnlyForceRecursive bool `json:",omitempty"`
-}
-
-// VolumeOptions represents the options for a mount of type volume.
-type VolumeOptions struct {
- NoCopy bool `json:",omitempty"`
- Labels map[string]string `json:",omitempty"`
- Subpath string `json:",omitempty"`
- DriverConfig *Driver `json:",omitempty"`
-}
-
-type ImageOptions struct {
- Subpath string `json:",omitempty"`
-}
-
-// Driver represents a volume driver.
-type Driver struct {
- Name string `json:",omitempty"`
- Options map[string]string `json:",omitempty"`
-}
-
-// TmpfsOptions defines options specific to mounts of type "tmpfs".
-type TmpfsOptions struct {
- // Size sets the size of the tmpfs, in bytes.
- //
- // This will be converted to an operating system specific value
- // depending on the host. For example, on linux, it will be converted to
- // use a 'k', 'm' or 'g' syntax. BSD, though not widely supported with
- // docker, uses a straight byte value.
- //
- // Percentages are not supported.
- SizeBytes int64 `json:",omitempty"`
- // Mode of the tmpfs upon creation
- Mode os.FileMode `json:",omitempty"`
- // Options to be passed to the tmpfs mount. An array of arrays. Flag
- // options should be provided as 1-length arrays. Other types should be
- // provided as 2-length arrays, where the first item is the key and the
- // second the value.
- Options [][]string `json:",omitempty"`
- // TODO(stevvooe): There are several more tmpfs flags, specified in the
- // daemon, that are accepted. Only the most basic are added for now.
- //
- // From https://github.com/moby/sys/blob/mount/v0.1.1/mount/flags.go#L47-L56
- //
- // var validFlags = map[string]bool{
- // "": true,
- // "size": true, X
- // "mode": true, X
- // "uid": true,
- // "gid": true,
- // "nr_inodes": true,
- // "nr_blocks": true,
- // "mpol": true,
- // }
- //
- // Some of these may be straightforward to add, but others, such as
- // uid/gid have implications in a clustered system.
-}
-
-// ClusterOptions specifies options for a Cluster volume.
-type ClusterOptions struct {
- // intentionally empty
-}
diff --git a/vendor/github.com/docker/docker/api/types/network/create_response.go b/vendor/github.com/docker/docker/api/types/network/create_response.go
deleted file mode 100644
index c32b35bf..00000000
--- a/vendor/github.com/docker/docker/api/types/network/create_response.go
+++ /dev/null
@@ -1,19 +0,0 @@
-package network
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// CreateResponse NetworkCreateResponse
-//
-// OK response to NetworkCreate operation
-// swagger:model CreateResponse
-type CreateResponse struct {
-
- // The ID of the created network.
- // Required: true
- ID string `json:"Id"`
-
- // Warnings encountered when creating the container
- // Required: true
- Warning string `json:"Warning"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/network/endpoint.go b/vendor/github.com/docker/docker/api/types/network/endpoint.go
deleted file mode 100644
index cdc06c6c..00000000
--- a/vendor/github.com/docker/docker/api/types/network/endpoint.go
+++ /dev/null
@@ -1,151 +0,0 @@
-package network
-
-import (
- "errors"
- "fmt"
- "net"
-)
-
-// EndpointSettings stores the network endpoint details
-type EndpointSettings struct {
- // Configurations
- IPAMConfig *EndpointIPAMConfig
- Links []string
- Aliases []string // Aliases holds the list of extra, user-specified DNS names for this endpoint.
- // MacAddress may be used to specify a MAC address when the container is created.
- // Once the container is running, it becomes operational data (it may contain a
- // generated address).
- MacAddress string
- DriverOpts map[string]string
-
- // GwPriority determines which endpoint will provide the default gateway
- // for the container. The endpoint with the highest priority will be used.
- // If multiple endpoints have the same priority, they are lexicographically
- // sorted based on their network name, and the one that sorts first is picked.
- GwPriority int
- // Operational data
- NetworkID string
- EndpointID string
- Gateway string
- IPAddress string
- IPPrefixLen int
- IPv6Gateway string
- GlobalIPv6Address string
- GlobalIPv6PrefixLen int
- // DNSNames holds all the (non fully qualified) DNS names associated to this endpoint. First entry is used to
- // generate PTR records.
- DNSNames []string
-}
-
-// Copy makes a deep copy of `EndpointSettings`
-func (es *EndpointSettings) Copy() *EndpointSettings {
- epCopy := *es
- if es.IPAMConfig != nil {
- epCopy.IPAMConfig = es.IPAMConfig.Copy()
- }
-
- if es.Links != nil {
- links := make([]string, 0, len(es.Links))
- epCopy.Links = append(links, es.Links...)
- }
-
- if es.Aliases != nil {
- aliases := make([]string, 0, len(es.Aliases))
- epCopy.Aliases = append(aliases, es.Aliases...)
- }
-
- if len(es.DNSNames) > 0 {
- epCopy.DNSNames = make([]string, len(es.DNSNames))
- copy(epCopy.DNSNames, es.DNSNames)
- }
-
- return &epCopy
-}
-
-// EndpointIPAMConfig represents IPAM configurations for the endpoint
-type EndpointIPAMConfig struct {
- IPv4Address string `json:",omitempty"`
- IPv6Address string `json:",omitempty"`
- LinkLocalIPs []string `json:",omitempty"`
-}
-
-// Copy makes a copy of the endpoint ipam config
-func (cfg *EndpointIPAMConfig) Copy() *EndpointIPAMConfig {
- cfgCopy := *cfg
- cfgCopy.LinkLocalIPs = make([]string, 0, len(cfg.LinkLocalIPs))
- cfgCopy.LinkLocalIPs = append(cfgCopy.LinkLocalIPs, cfg.LinkLocalIPs...)
- return &cfgCopy
-}
-
-// NetworkSubnet describes a user-defined subnet for a specific network. It's only used to validate if an
-// EndpointIPAMConfig is valid for a specific network.
-type NetworkSubnet interface {
- // Contains checks whether the NetworkSubnet contains [addr].
- Contains(addr net.IP) bool
- // IsStatic checks whether the subnet was statically allocated (ie. user-defined).
- IsStatic() bool
-}
-
-// IsInRange checks whether static IP addresses are valid in a specific network.
-func (cfg *EndpointIPAMConfig) IsInRange(v4Subnets []NetworkSubnet, v6Subnets []NetworkSubnet) error {
- var errs []error
-
- if err := validateEndpointIPAddress(cfg.IPv4Address, v4Subnets); err != nil {
- errs = append(errs, err)
- }
- if err := validateEndpointIPAddress(cfg.IPv6Address, v6Subnets); err != nil {
- errs = append(errs, err)
- }
-
- return errJoin(errs...)
-}
-
-func validateEndpointIPAddress(epAddr string, ipamSubnets []NetworkSubnet) error {
- if epAddr == "" {
- return nil
- }
-
- var staticSubnet bool
- parsedAddr := net.ParseIP(epAddr)
- for _, subnet := range ipamSubnets {
- if subnet.IsStatic() {
- staticSubnet = true
- if subnet.Contains(parsedAddr) {
- return nil
- }
- }
- }
-
- if staticSubnet {
- return fmt.Errorf("no configured subnet or ip-range contain the IP address %s", epAddr)
- }
-
- return errors.New("user specified IP address is supported only when connecting to networks with user configured subnets")
-}
-
-// Validate checks whether cfg is valid.
-func (cfg *EndpointIPAMConfig) Validate() error {
- if cfg == nil {
- return nil
- }
-
- var errs []error
-
- if cfg.IPv4Address != "" {
- if addr := net.ParseIP(cfg.IPv4Address); addr == nil || addr.To4() == nil || addr.IsUnspecified() {
- errs = append(errs, fmt.Errorf("invalid IPv4 address: %s", cfg.IPv4Address))
- }
- }
- if cfg.IPv6Address != "" {
- if addr := net.ParseIP(cfg.IPv6Address); addr == nil || addr.To4() != nil || addr.IsUnspecified() {
- errs = append(errs, fmt.Errorf("invalid IPv6 address: %s", cfg.IPv6Address))
- }
- }
- for _, addr := range cfg.LinkLocalIPs {
- if parsed := net.ParseIP(addr); parsed == nil || parsed.IsUnspecified() {
- errs = append(errs, fmt.Errorf("invalid link-local IP address: %s", addr))
- }
- }
-
- return errJoin(errs...)
-}
diff --git a/vendor/github.com/docker/docker/api/types/network/ipam.go b/vendor/github.com/docker/docker/api/types/network/ipam.go
deleted file mode 100644
index f9a9ff9b..00000000
--- a/vendor/github.com/docker/docker/api/types/network/ipam.go
+++ /dev/null
@@ -1,173 +0,0 @@
-package network
-
-import (
- "errors"
- "fmt"
- "net/netip"
- "strings"
-)
-
-// IPAM represents IP Address Management
-type IPAM struct {
- Driver string
- Options map[string]string // Per network IPAM driver options
- Config []IPAMConfig
-}
-
-// IPAMConfig represents IPAM configurations
-type IPAMConfig struct {
- Subnet string `json:",omitempty"`
- IPRange string `json:",omitempty"`
- Gateway string `json:",omitempty"`
- AuxAddress map[string]string `json:"AuxiliaryAddresses,omitempty"`
-}
-
-type ipFamily string
-
-const (
- ip4 ipFamily = "IPv4"
- ip6 ipFamily = "IPv6"
-)
-
-// ValidateIPAM checks whether the network's IPAM passed as argument is valid. It returns a joinError of the list of
-// errors found.
-func ValidateIPAM(ipam *IPAM, enableIPv6 bool) error {
- if ipam == nil {
- return nil
- }
-
- var errs []error
- for _, cfg := range ipam.Config {
- subnet, err := netip.ParsePrefix(cfg.Subnet)
- if err != nil {
- errs = append(errs, fmt.Errorf("invalid subnet %s: invalid CIDR block notation", cfg.Subnet))
- continue
- }
- subnetFamily := ip4
- if subnet.Addr().Is6() {
- subnetFamily = ip6
- }
-
- if !enableIPv6 && subnetFamily == ip6 {
- continue
- }
-
- if subnet != subnet.Masked() {
- errs = append(errs, fmt.Errorf("invalid subnet %s: it should be %s", subnet, subnet.Masked()))
- }
-
- if ipRangeErrs := validateIPRange(cfg.IPRange, subnet, subnetFamily); len(ipRangeErrs) > 0 {
- errs = append(errs, ipRangeErrs...)
- }
-
- if err := validateAddress(cfg.Gateway, subnet, subnetFamily); err != nil {
- errs = append(errs, fmt.Errorf("invalid gateway %s: %w", cfg.Gateway, err))
- }
-
- for auxName, aux := range cfg.AuxAddress {
- if err := validateAddress(aux, subnet, subnetFamily); err != nil {
- errs = append(errs, fmt.Errorf("invalid auxiliary address %s: %w", auxName, err))
- }
- }
- }
-
- if err := errJoin(errs...); err != nil {
- return fmt.Errorf("invalid network config:\n%w", err)
- }
-
- return nil
-}
-
-func validateIPRange(ipRange string, subnet netip.Prefix, subnetFamily ipFamily) []error {
- if ipRange == "" {
- return nil
- }
- prefix, err := netip.ParsePrefix(ipRange)
- if err != nil {
- return []error{fmt.Errorf("invalid ip-range %s: invalid CIDR block notation", ipRange)}
- }
- family := ip4
- if prefix.Addr().Is6() {
- family = ip6
- }
-
- if family != subnetFamily {
- return []error{fmt.Errorf("invalid ip-range %s: parent subnet is an %s block", ipRange, subnetFamily)}
- }
-
- var errs []error
- if prefix.Bits() < subnet.Bits() {
- errs = append(errs, fmt.Errorf("invalid ip-range %s: CIDR block is bigger than its parent subnet %s", ipRange, subnet))
- }
- if prefix != prefix.Masked() {
- errs = append(errs, fmt.Errorf("invalid ip-range %s: it should be %s", prefix, prefix.Masked()))
- }
- if !subnet.Overlaps(prefix) {
- errs = append(errs, fmt.Errorf("invalid ip-range %s: parent subnet %s doesn't contain ip-range", ipRange, subnet))
- }
-
- return errs
-}
-
-func validateAddress(address string, subnet netip.Prefix, subnetFamily ipFamily) error {
- if address == "" {
- return nil
- }
- addr, err := netip.ParseAddr(address)
- if err != nil {
- return errors.New("invalid address")
- }
- family := ip4
- if addr.Is6() {
- family = ip6
- }
-
- if family != subnetFamily {
- return fmt.Errorf("parent subnet is an %s block", subnetFamily)
- }
- if !subnet.Contains(addr) {
- return fmt.Errorf("parent subnet %s doesn't contain this address", subnet)
- }
-
- return nil
-}
-
-func errJoin(errs ...error) error {
- n := 0
- for _, err := range errs {
- if err != nil {
- n++
- }
- }
- if n == 0 {
- return nil
- }
- e := &joinError{
- errs: make([]error, 0, n),
- }
- for _, err := range errs {
- if err != nil {
- e.errs = append(e.errs, err)
- }
- }
- return e
-}
-
-type joinError struct {
- errs []error
-}
-
-func (e *joinError) Error() string {
- if len(e.errs) == 1 {
- return strings.TrimSpace(e.errs[0].Error())
- }
- stringErrs := make([]string, 0, len(e.errs))
- for _, subErr := range e.errs {
- stringErrs = append(stringErrs, strings.ReplaceAll(subErr.Error(), "\n", "\n\t"))
- }
- return "* " + strings.Join(stringErrs, "\n* ")
-}
-
-func (e *joinError) Unwrap() []error {
- return e.errs
-}
diff --git a/vendor/github.com/docker/docker/api/types/network/network.go b/vendor/github.com/docker/docker/api/types/network/network.go
deleted file mode 100644
index 4a0cb479..00000000
--- a/vendor/github.com/docker/docker/api/types/network/network.go
+++ /dev/null
@@ -1,168 +0,0 @@
-package network
-
-import (
- "time"
-
- "github.com/docker/docker/api/types/filters"
-)
-
-const (
- // NetworkDefault is a platform-independent alias to choose the platform-specific default network stack.
- NetworkDefault = "default"
- // NetworkHost is the name of the predefined network used when the NetworkMode host is selected (only available on Linux)
- NetworkHost = "host"
- // NetworkNone is the name of the predefined network used when the NetworkMode none is selected (available on both Linux and Windows)
- NetworkNone = "none"
- // NetworkBridge is the name of the default network on Linux
- NetworkBridge = "bridge"
- // NetworkNat is the name of the default network on Windows
- NetworkNat = "nat"
-)
-
-// CreateRequest is the request message sent to the server for network create call.
-type CreateRequest struct {
- CreateOptions
- Name string // Name is the requested name of the network.
-
- // Deprecated: CheckDuplicate is deprecated since API v1.44, but it defaults to true when sent by the client
- // package to older daemons.
- CheckDuplicate *bool `json:",omitempty"`
-}
-
-// CreateOptions holds options to create a network.
-type CreateOptions struct {
- Driver string // Driver is the driver-name used to create the network (e.g. `bridge`, `overlay`)
- Scope string // Scope describes the level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level).
- EnableIPv4 *bool `json:",omitempty"` // EnableIPv4 represents whether to enable IPv4.
- EnableIPv6 *bool `json:",omitempty"` // EnableIPv6 represents whether to enable IPv6.
- IPAM *IPAM // IPAM is the network's IP Address Management.
- Internal bool // Internal represents if the network is used internal only.
- Attachable bool // Attachable represents if the global scope is manually attachable by regular containers from workers in swarm mode.
- Ingress bool // Ingress indicates the network is providing the routing-mesh for the swarm cluster.
- ConfigOnly bool // ConfigOnly creates a config-only network. Config-only networks are place-holder networks for network configurations to be used by other networks. ConfigOnly networks cannot be used directly to run containers or services.
- ConfigFrom *ConfigReference // ConfigFrom specifies the source which will provide the configuration for this network. The specified network must be a config-only network; see [CreateOptions.ConfigOnly].
- Options map[string]string // Options specifies the network-specific options to use for when creating the network.
- Labels map[string]string // Labels holds metadata specific to the network being created.
-}
-
-// ListOptions holds parameters to filter the list of networks with.
-type ListOptions struct {
- Filters filters.Args
-}
-
-// InspectOptions holds parameters to inspect network.
-type InspectOptions struct {
- Scope string
- Verbose bool
-}
-
-// ConnectOptions represents the data to be used to connect a container to the
-// network.
-type ConnectOptions struct {
- Container string
- EndpointConfig *EndpointSettings `json:",omitempty"`
-}
-
-// DisconnectOptions represents the data to be used to disconnect a container
-// from the network.
-type DisconnectOptions struct {
- Container string
- Force bool
-}
-
-// Inspect is the body of the "get network" http response message.
-type Inspect struct {
- Name string // Name is the name of the network
- ID string `json:"Id"` // ID uniquely identifies a network on a single machine
- Created time.Time // Created is the time the network created
- Scope string // Scope describes the level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level)
- Driver string // Driver is the Driver name used to create the network (e.g. `bridge`, `overlay`)
- EnableIPv4 bool // EnableIPv4 represents whether IPv4 is enabled
- EnableIPv6 bool // EnableIPv6 represents whether IPv6 is enabled
- IPAM IPAM // IPAM is the network's IP Address Management
- Internal bool // Internal represents if the network is used internal only
- Attachable bool // Attachable represents if the global scope is manually attachable by regular containers from workers in swarm mode.
- Ingress bool // Ingress indicates the network is providing the routing-mesh for the swarm cluster.
- ConfigFrom ConfigReference // ConfigFrom specifies the source which will provide the configuration for this network.
- ConfigOnly bool // ConfigOnly networks are place-holder networks for network configurations to be used by other networks. ConfigOnly networks cannot be used directly to run containers or services.
- Containers map[string]EndpointResource // Containers contains endpoints belonging to the network
- Options map[string]string // Options holds the network specific options to use for when creating the network
- Labels map[string]string // Labels holds metadata specific to the network being created
- Peers []PeerInfo `json:",omitempty"` // List of peer nodes for an overlay network
- Services map[string]ServiceInfo `json:",omitempty"`
-}
-
-// Summary is used as response when listing networks. It currently is an alias
-// for [Inspect], but may diverge in the future, as not all information may
-// be included when listing networks.
-type Summary = Inspect
-
-// Address represents an IP address
-type Address struct {
- Addr string
- PrefixLen int
-}
-
-// PeerInfo represents one peer of an overlay network
-type PeerInfo struct {
- Name string
- IP string
-}
-
-// Task carries the information about one backend task
-type Task struct {
- Name string
- EndpointID string
- EndpointIP string
- Info map[string]string
-}
-
-// ServiceInfo represents service parameters with the list of service's tasks
-type ServiceInfo struct {
- VIP string
- Ports []string
- LocalLBIndex int
- Tasks []Task
-}
-
-// EndpointResource contains network resources allocated and used for a
-// container in a network.
-type EndpointResource struct {
- Name string
- EndpointID string
- MacAddress string
- IPv4Address string
- IPv6Address string
-}
-
-// NetworkingConfig represents the container's networking configuration for each of its interfaces
-// Carries the networking configs specified in the `docker run` and `docker network connect` commands
-type NetworkingConfig struct {
- EndpointsConfig map[string]*EndpointSettings // Endpoint configs for each connecting network
-}
-
-// ConfigReference specifies the source which provides a network's configuration
-type ConfigReference struct {
- Network string
-}
-
-var acceptedFilters = map[string]bool{
- "dangling": true,
- "driver": true,
- "id": true,
- "label": true,
- "name": true,
- "scope": true,
- "type": true,
-}
-
-// ValidateFilters validates the list of filter args with the available filters.
-func ValidateFilters(filter filters.Args) error {
- return filter.Validate(acceptedFilters)
-}
-
-// PruneReport contains the response for Engine API:
-// POST "/networks/prune"
-type PruneReport struct {
- NetworksDeleted []string
-}
diff --git a/vendor/github.com/docker/docker/api/types/plugin.go b/vendor/github.com/docker/docker/api/types/plugin.go
deleted file mode 100644
index a9eff28a..00000000
--- a/vendor/github.com/docker/docker/api/types/plugin.go
+++ /dev/null
@@ -1,207 +0,0 @@
-package types
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// Plugin A plugin for the Engine API
-// swagger:model Plugin
-type Plugin struct {
-
- // config
- // Required: true
- Config PluginConfig `json:"Config"`
-
- // True if the plugin is running. False if the plugin is not running, only installed.
- // Required: true
- Enabled bool `json:"Enabled"`
-
- // Id
- ID string `json:"Id,omitempty"`
-
- // name
- // Required: true
- Name string `json:"Name"`
-
- // plugin remote reference used to push/pull the plugin
- PluginReference string `json:"PluginReference,omitempty"`
-
- // settings
- // Required: true
- Settings PluginSettings `json:"Settings"`
-}
-
-// PluginConfig The config of a plugin.
-// swagger:model PluginConfig
-type PluginConfig struct {
-
- // args
- // Required: true
- Args PluginConfigArgs `json:"Args"`
-
- // description
- // Required: true
- Description string `json:"Description"`
-
- // Docker Version used to create the plugin.
- //
- // Depending on how the plugin was created, this field may be empty or omitted.
- //
- // Deprecated: this field is no longer set, and will be removed in the next API version.
- DockerVersion string `json:"DockerVersion,omitempty"`
-
- // documentation
- // Required: true
- Documentation string `json:"Documentation"`
-
- // entrypoint
- // Required: true
- Entrypoint []string `json:"Entrypoint"`
-
- // env
- // Required: true
- Env []PluginEnv `json:"Env"`
-
- // interface
- // Required: true
- Interface PluginConfigInterface `json:"Interface"`
-
- // ipc host
- // Required: true
- IpcHost bool `json:"IpcHost"`
-
- // linux
- // Required: true
- Linux PluginConfigLinux `json:"Linux"`
-
- // mounts
- // Required: true
- Mounts []PluginMount `json:"Mounts"`
-
- // network
- // Required: true
- Network PluginConfigNetwork `json:"Network"`
-
- // pid host
- // Required: true
- PidHost bool `json:"PidHost"`
-
- // propagated mount
- // Required: true
- PropagatedMount string `json:"PropagatedMount"`
-
- // user
- User PluginConfigUser `json:"User,omitempty"`
-
- // work dir
- // Required: true
- WorkDir string `json:"WorkDir"`
-
- // rootfs
- Rootfs *PluginConfigRootfs `json:"rootfs,omitempty"`
-}
-
-// PluginConfigArgs plugin config args
-// swagger:model PluginConfigArgs
-type PluginConfigArgs struct {
-
- // description
- // Required: true
- Description string `json:"Description"`
-
- // name
- // Required: true
- Name string `json:"Name"`
-
- // settable
- // Required: true
- Settable []string `json:"Settable"`
-
- // value
- // Required: true
- Value []string `json:"Value"`
-}
-
-// PluginConfigInterface The interface between Docker and the plugin
-// swagger:model PluginConfigInterface
-type PluginConfigInterface struct {
-
- // Protocol to use for clients connecting to the plugin.
- ProtocolScheme string `json:"ProtocolScheme,omitempty"`
-
- // socket
- // Required: true
- Socket string `json:"Socket"`
-
- // types
- // Required: true
- Types []PluginInterfaceType `json:"Types"`
-}
-
-// PluginConfigLinux plugin config linux
-// swagger:model PluginConfigLinux
-type PluginConfigLinux struct {
-
- // allow all devices
- // Required: true
- AllowAllDevices bool `json:"AllowAllDevices"`
-
- // capabilities
- // Required: true
- Capabilities []string `json:"Capabilities"`
-
- // devices
- // Required: true
- Devices []PluginDevice `json:"Devices"`
-}
-
-// PluginConfigNetwork plugin config network
-// swagger:model PluginConfigNetwork
-type PluginConfigNetwork struct {
-
- // type
- // Required: true
- Type string `json:"Type"`
-}
-
-// PluginConfigRootfs plugin config rootfs
-// swagger:model PluginConfigRootfs
-type PluginConfigRootfs struct {
-
- // diff ids
- DiffIds []string `json:"diff_ids"`
-
- // type
- Type string `json:"type,omitempty"`
-}
-
-// PluginConfigUser plugin config user
-// swagger:model PluginConfigUser
-type PluginConfigUser struct {
-
- // g ID
- GID uint32 `json:"GID,omitempty"`
-
- // UID
- UID uint32 `json:"UID,omitempty"`
-}
-
-// PluginSettings Settings that can be modified by users.
-// swagger:model PluginSettings
-type PluginSettings struct {
-
- // args
- // Required: true
- Args []string `json:"Args"`
-
- // devices
- // Required: true
- Devices []PluginDevice `json:"Devices"`
-
- // env
- // Required: true
- Env []string `json:"Env"`
-
- // mounts
- // Required: true
- Mounts []PluginMount `json:"Mounts"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/plugin_device.go b/vendor/github.com/docker/docker/api/types/plugin_device.go
deleted file mode 100644
index 56990106..00000000
--- a/vendor/github.com/docker/docker/api/types/plugin_device.go
+++ /dev/null
@@ -1,25 +0,0 @@
-package types
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// PluginDevice plugin device
-// swagger:model PluginDevice
-type PluginDevice struct {
-
- // description
- // Required: true
- Description string `json:"Description"`
-
- // name
- // Required: true
- Name string `json:"Name"`
-
- // path
- // Required: true
- Path *string `json:"Path"`
-
- // settable
- // Required: true
- Settable []string `json:"Settable"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/plugin_env.go b/vendor/github.com/docker/docker/api/types/plugin_env.go
deleted file mode 100644
index 32962dc2..00000000
--- a/vendor/github.com/docker/docker/api/types/plugin_env.go
+++ /dev/null
@@ -1,25 +0,0 @@
-package types
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// PluginEnv plugin env
-// swagger:model PluginEnv
-type PluginEnv struct {
-
- // description
- // Required: true
- Description string `json:"Description"`
-
- // name
- // Required: true
- Name string `json:"Name"`
-
- // settable
- // Required: true
- Settable []string `json:"Settable"`
-
- // value
- // Required: true
- Value *string `json:"Value"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/plugin_interface_type.go b/vendor/github.com/docker/docker/api/types/plugin_interface_type.go
deleted file mode 100644
index c82f204e..00000000
--- a/vendor/github.com/docker/docker/api/types/plugin_interface_type.go
+++ /dev/null
@@ -1,21 +0,0 @@
-package types
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// PluginInterfaceType plugin interface type
-// swagger:model PluginInterfaceType
-type PluginInterfaceType struct {
-
- // capability
- // Required: true
- Capability string `json:"Capability"`
-
- // prefix
- // Required: true
- Prefix string `json:"Prefix"`
-
- // version
- // Required: true
- Version string `json:"Version"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/plugin_mount.go b/vendor/github.com/docker/docker/api/types/plugin_mount.go
deleted file mode 100644
index 5c031cf8..00000000
--- a/vendor/github.com/docker/docker/api/types/plugin_mount.go
+++ /dev/null
@@ -1,37 +0,0 @@
-package types
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// PluginMount plugin mount
-// swagger:model PluginMount
-type PluginMount struct {
-
- // description
- // Required: true
- Description string `json:"Description"`
-
- // destination
- // Required: true
- Destination string `json:"Destination"`
-
- // name
- // Required: true
- Name string `json:"Name"`
-
- // options
- // Required: true
- Options []string `json:"Options"`
-
- // settable
- // Required: true
- Settable []string `json:"Settable"`
-
- // source
- // Required: true
- Source *string `json:"Source"`
-
- // type
- // Required: true
- Type string `json:"Type"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/plugin_responses.go b/vendor/github.com/docker/docker/api/types/plugin_responses.go
deleted file mode 100644
index 18f743fc..00000000
--- a/vendor/github.com/docker/docker/api/types/plugin_responses.go
+++ /dev/null
@@ -1,71 +0,0 @@
-package types
-
-import (
- "encoding/json"
- "fmt"
- "sort"
-)
-
-// PluginsListResponse contains the response for the Engine API
-type PluginsListResponse []*Plugin
-
-// UnmarshalJSON implements json.Unmarshaler for PluginInterfaceType
-func (t *PluginInterfaceType) UnmarshalJSON(p []byte) error {
- versionIndex := len(p)
- prefixIndex := 0
- if len(p) < 2 || p[0] != '"' || p[len(p)-1] != '"' {
- return fmt.Errorf("%q is not a plugin interface type", p)
- }
- p = p[1 : len(p)-1]
-loop:
- for i, b := range p {
- switch b {
- case '.':
- prefixIndex = i
- case '/':
- versionIndex = i
- break loop
- }
- }
- t.Prefix = string(p[:prefixIndex])
- t.Capability = string(p[prefixIndex+1 : versionIndex])
- if versionIndex < len(p) {
- t.Version = string(p[versionIndex+1:])
- }
- return nil
-}
-
-// MarshalJSON implements json.Marshaler for PluginInterfaceType
-func (t *PluginInterfaceType) MarshalJSON() ([]byte, error) {
- return json.Marshal(t.String())
-}
-
-// String implements fmt.Stringer for PluginInterfaceType
-func (t PluginInterfaceType) String() string {
- return fmt.Sprintf("%s.%s/%s", t.Prefix, t.Capability, t.Version)
-}
-
-// PluginPrivilege describes a permission the user has to accept
-// upon installing a plugin.
-type PluginPrivilege struct {
- Name string
- Description string
- Value []string
-}
-
-// PluginPrivileges is a list of PluginPrivilege
-type PluginPrivileges []PluginPrivilege
-
-func (s PluginPrivileges) Len() int {
- return len(s)
-}
-
-func (s PluginPrivileges) Less(i, j int) bool {
- return s[i].Name < s[j].Name
-}
-
-func (s PluginPrivileges) Swap(i, j int) {
- sort.Strings(s[i].Value)
- sort.Strings(s[j].Value)
- s[i], s[j] = s[j], s[i]
-}
diff --git a/vendor/github.com/docker/docker/api/types/storage/driver_data.go b/vendor/github.com/docker/docker/api/types/storage/driver_data.go
deleted file mode 100644
index 009e2130..00000000
--- a/vendor/github.com/docker/docker/api/types/storage/driver_data.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package storage
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// DriverData Information about the storage driver used to store the container's and
-// image's filesystem.
-//
-// swagger:model DriverData
-type DriverData struct {
-
- // Low-level storage metadata, provided as key/value pairs.
- //
- // This information is driver-specific, and depends on the storage-driver
- // in use, and should be used for informational purposes only.
- //
- // Required: true
- Data map[string]string `json:"Data"`
-
- // Name of the storage driver.
- // Required: true
- Name string `json:"Name"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/strslice/strslice.go b/vendor/github.com/docker/docker/api/types/strslice/strslice.go
deleted file mode 100644
index bad493fb..00000000
--- a/vendor/github.com/docker/docker/api/types/strslice/strslice.go
+++ /dev/null
@@ -1,30 +0,0 @@
-package strslice
-
-import "encoding/json"
-
-// StrSlice represents a string or an array of strings.
-// We need to override the json decoder to accept both options.
-type StrSlice []string
-
-// UnmarshalJSON decodes the byte slice whether it's a string or an array of
-// strings. This method is needed to implement json.Unmarshaler.
-func (e *StrSlice) UnmarshalJSON(b []byte) error {
- if len(b) == 0 {
- // With no input, we preserve the existing value by returning nil and
- // leaving the target alone. This allows defining default values for
- // the type.
- return nil
- }
-
- p := make([]string, 0, 1)
- if err := json.Unmarshal(b, &p); err != nil {
- var s string
- if err := json.Unmarshal(b, &s); err != nil {
- return err
- }
- p = append(p, s)
- }
-
- *e = p
- return nil
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/common.go b/vendor/github.com/docker/docker/api/types/swarm/common.go
deleted file mode 100644
index b42812e0..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/common.go
+++ /dev/null
@@ -1,48 +0,0 @@
-package swarm
-
-import (
- "strconv"
- "time"
-)
-
-// Version represents the internal object version.
-type Version struct {
- Index uint64 `json:",omitempty"`
-}
-
-// String implements fmt.Stringer interface.
-func (v Version) String() string {
- return strconv.FormatUint(v.Index, 10)
-}
-
-// Meta is a base object inherited by most of the other once.
-type Meta struct {
- Version Version `json:",omitempty"`
- CreatedAt time.Time `json:",omitempty"`
- UpdatedAt time.Time `json:",omitempty"`
-}
-
-// Annotations represents how to describe an object.
-type Annotations struct {
- Name string `json:",omitempty"`
- Labels map[string]string `json:"Labels"`
-}
-
-// Driver represents a driver (network, logging, secrets backend).
-type Driver struct {
- Name string `json:",omitempty"`
- Options map[string]string `json:",omitempty"`
-}
-
-// TLSInfo represents the TLS information about what CA certificate is trusted,
-// and who the issuer for a TLS certificate is
-type TLSInfo struct {
- // TrustRoot is the trusted CA root certificate in PEM format
- TrustRoot string `json:",omitempty"`
-
- // CertIssuer is the raw subject bytes of the issuer
- CertIssuerSubject []byte `json:",omitempty"`
-
- // CertIssuerPublicKey is the raw public key bytes of the issuer
- CertIssuerPublicKey []byte `json:",omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/config.go b/vendor/github.com/docker/docker/api/types/swarm/config.go
deleted file mode 100644
index 80a6ffdb..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/config.go
+++ /dev/null
@@ -1,62 +0,0 @@
-package swarm
-
-import (
- "os"
-
- "github.com/docker/docker/api/types/filters"
-)
-
-// Config represents a config.
-type Config struct {
- ID string
- Meta
- Spec ConfigSpec
-}
-
-// ConfigSpec represents a config specification from a config in swarm
-type ConfigSpec struct {
- Annotations
-
- // Data is the data to store as a config.
- //
- // The maximum allowed size is 1000KB, as defined in [MaxConfigSize].
- //
- // [MaxConfigSize]: https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize
- Data []byte `json:",omitempty"`
-
- // Templating controls whether and how to evaluate the config payload as
- // a template. If it is not set, no templating is used.
- Templating *Driver `json:",omitempty"`
-}
-
-// ConfigReferenceFileTarget is a file target in a config reference
-type ConfigReferenceFileTarget struct {
- Name string
- UID string
- GID string
- Mode os.FileMode
-}
-
-// ConfigReferenceRuntimeTarget is a target for a config specifying that it
-// isn't mounted into the container but instead has some other purpose.
-type ConfigReferenceRuntimeTarget struct{}
-
-// ConfigReference is a reference to a config in swarm
-type ConfigReference struct {
- File *ConfigReferenceFileTarget `json:",omitempty"`
- Runtime *ConfigReferenceRuntimeTarget `json:",omitempty"`
- ConfigID string
- ConfigName string
-}
-
-// ConfigCreateResponse contains the information returned to a client
-// on the creation of a new config.
-type ConfigCreateResponse struct {
- // ID is the id of the created config.
- ID string
-}
-
-// ConfigListOptions holds parameters to list configs
-type ConfigListOptions struct {
- Filters filters.Args
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/container.go b/vendor/github.com/docker/docker/api/types/swarm/container.go
deleted file mode 100644
index f9416bac..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/container.go
+++ /dev/null
@@ -1,119 +0,0 @@
-package swarm
-
-import (
- "time"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/mount"
-)
-
-// DNSConfig specifies DNS related configurations in resolver configuration file (resolv.conf)
-// Detailed documentation is available in:
-// http://man7.org/linux/man-pages/man5/resolv.conf.5.html
-// `nameserver`, `search`, `options` have been supported.
-// TODO: `domain` is not supported yet.
-type DNSConfig struct {
- // Nameservers specifies the IP addresses of the name servers
- Nameservers []string `json:",omitempty"`
- // Search specifies the search list for host-name lookup
- Search []string `json:",omitempty"`
- // Options allows certain internal resolver variables to be modified
- Options []string `json:",omitempty"`
-}
-
-// SELinuxContext contains the SELinux labels of the container.
-type SELinuxContext struct {
- Disable bool
-
- User string
- Role string
- Type string
- Level string
-}
-
-// SeccompMode is the type used for the enumeration of possible seccomp modes
-// in SeccompOpts
-type SeccompMode string
-
-const (
- SeccompModeDefault SeccompMode = "default"
- SeccompModeUnconfined SeccompMode = "unconfined"
- SeccompModeCustom SeccompMode = "custom"
-)
-
-// SeccompOpts defines the options for configuring seccomp on a swarm-managed
-// container.
-type SeccompOpts struct {
- // Mode is the SeccompMode used for the container.
- Mode SeccompMode `json:",omitempty"`
- // Profile is the custom seccomp profile as a json object to be used with
- // the container. Mode should be set to SeccompModeCustom when using a
- // custom profile in this manner.
- Profile []byte `json:",omitempty"`
-}
-
-// AppArmorMode is type used for the enumeration of possible AppArmor modes in
-// AppArmorOpts
-type AppArmorMode string
-
-const (
- AppArmorModeDefault AppArmorMode = "default"
- AppArmorModeDisabled AppArmorMode = "disabled"
-)
-
-// AppArmorOpts defines the options for configuring AppArmor on a swarm-managed
-// container. Currently, custom AppArmor profiles are not supported.
-type AppArmorOpts struct {
- Mode AppArmorMode `json:",omitempty"`
-}
-
-// CredentialSpec for managed service account (Windows only)
-type CredentialSpec struct {
- Config string
- File string
- Registry string
-}
-
-// Privileges defines the security options for the container.
-type Privileges struct {
- CredentialSpec *CredentialSpec
- SELinuxContext *SELinuxContext
- Seccomp *SeccompOpts `json:",omitempty"`
- AppArmor *AppArmorOpts `json:",omitempty"`
- NoNewPrivileges bool
-}
-
-// ContainerSpec represents the spec of a container.
-type ContainerSpec struct {
- Image string `json:",omitempty"`
- Labels map[string]string `json:",omitempty"`
- Command []string `json:",omitempty"`
- Args []string `json:",omitempty"`
- Hostname string `json:",omitempty"`
- Env []string `json:",omitempty"`
- Dir string `json:",omitempty"`
- User string `json:",omitempty"`
- Groups []string `json:",omitempty"`
- Privileges *Privileges `json:",omitempty"`
- Init *bool `json:",omitempty"`
- StopSignal string `json:",omitempty"`
- TTY bool `json:",omitempty"`
- OpenStdin bool `json:",omitempty"`
- ReadOnly bool `json:",omitempty"`
- Mounts []mount.Mount `json:",omitempty"`
- StopGracePeriod *time.Duration `json:",omitempty"`
- Healthcheck *container.HealthConfig `json:",omitempty"`
- // The format of extra hosts on swarmkit is specified in:
- // http://man7.org/linux/man-pages/man5/hosts.5.html
- // IP_address canonical_hostname [aliases...]
- Hosts []string `json:",omitempty"`
- DNSConfig *DNSConfig `json:",omitempty"`
- Secrets []*SecretReference `json:",omitempty"`
- Configs []*ConfigReference `json:",omitempty"`
- Isolation container.Isolation `json:",omitempty"`
- Sysctls map[string]string `json:",omitempty"`
- CapabilityAdd []string `json:",omitempty"`
- CapabilityDrop []string `json:",omitempty"`
- Ulimits []*container.Ulimit `json:",omitempty"`
- OomScoreAdj int64 `json:",omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/network.go b/vendor/github.com/docker/docker/api/types/swarm/network.go
deleted file mode 100644
index 4b880723..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/network.go
+++ /dev/null
@@ -1,121 +0,0 @@
-package swarm
-
-import (
- "github.com/docker/docker/api/types/network"
-)
-
-// Endpoint represents an endpoint.
-type Endpoint struct {
- Spec EndpointSpec `json:",omitempty"`
- Ports []PortConfig `json:",omitempty"`
- VirtualIPs []EndpointVirtualIP `json:",omitempty"`
-}
-
-// EndpointSpec represents the spec of an endpoint.
-type EndpointSpec struct {
- Mode ResolutionMode `json:",omitempty"`
- Ports []PortConfig `json:",omitempty"`
-}
-
-// ResolutionMode represents a resolution mode.
-type ResolutionMode string
-
-const (
- // ResolutionModeVIP VIP
- ResolutionModeVIP ResolutionMode = "vip"
- // ResolutionModeDNSRR DNSRR
- ResolutionModeDNSRR ResolutionMode = "dnsrr"
-)
-
-// PortConfig represents the config of a port.
-type PortConfig struct {
- Name string `json:",omitempty"`
- Protocol PortConfigProtocol `json:",omitempty"`
- // TargetPort is the port inside the container
- TargetPort uint32 `json:",omitempty"`
- // PublishedPort is the port on the swarm hosts
- PublishedPort uint32 `json:",omitempty"`
- // PublishMode is the mode in which port is published
- PublishMode PortConfigPublishMode `json:",omitempty"`
-}
-
-// PortConfigPublishMode represents the mode in which the port is to
-// be published.
-type PortConfigPublishMode string
-
-const (
- // PortConfigPublishModeIngress is used for ports published
- // for ingress load balancing using routing mesh.
- PortConfigPublishModeIngress PortConfigPublishMode = "ingress"
- // PortConfigPublishModeHost is used for ports published
- // for direct host level access on the host where the task is running.
- PortConfigPublishModeHost PortConfigPublishMode = "host"
-)
-
-// PortConfigProtocol represents the protocol of a port.
-type PortConfigProtocol string
-
-const (
- // TODO(stevvooe): These should be used generally, not just for PortConfig.
-
- // PortConfigProtocolTCP TCP
- PortConfigProtocolTCP PortConfigProtocol = "tcp"
- // PortConfigProtocolUDP UDP
- PortConfigProtocolUDP PortConfigProtocol = "udp"
- // PortConfigProtocolSCTP SCTP
- PortConfigProtocolSCTP PortConfigProtocol = "sctp"
-)
-
-// EndpointVirtualIP represents the virtual ip of a port.
-type EndpointVirtualIP struct {
- NetworkID string `json:",omitempty"`
- Addr string `json:",omitempty"`
-}
-
-// Network represents a network.
-type Network struct {
- ID string
- Meta
- Spec NetworkSpec `json:",omitempty"`
- DriverState Driver `json:",omitempty"`
- IPAMOptions *IPAMOptions `json:",omitempty"`
-}
-
-// NetworkSpec represents the spec of a network.
-type NetworkSpec struct {
- Annotations
- DriverConfiguration *Driver `json:",omitempty"`
- IPv6Enabled bool `json:",omitempty"`
- Internal bool `json:",omitempty"`
- Attachable bool `json:",omitempty"`
- Ingress bool `json:",omitempty"`
- IPAMOptions *IPAMOptions `json:",omitempty"`
- ConfigFrom *network.ConfigReference `json:",omitempty"`
- Scope string `json:",omitempty"`
-}
-
-// NetworkAttachmentConfig represents the configuration of a network attachment.
-type NetworkAttachmentConfig struct {
- Target string `json:",omitempty"`
- Aliases []string `json:",omitempty"`
- DriverOpts map[string]string `json:",omitempty"`
-}
-
-// NetworkAttachment represents a network attachment.
-type NetworkAttachment struct {
- Network Network `json:",omitempty"`
- Addresses []string `json:",omitempty"`
-}
-
-// IPAMOptions represents ipam options.
-type IPAMOptions struct {
- Driver Driver `json:",omitempty"`
- Configs []IPAMConfig `json:",omitempty"`
-}
-
-// IPAMConfig represents ipam configuration.
-type IPAMConfig struct {
- Subnet string `json:",omitempty"`
- Range string `json:",omitempty"`
- Gateway string `json:",omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/node.go b/vendor/github.com/docker/docker/api/types/swarm/node.go
deleted file mode 100644
index 2018a031..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/node.go
+++ /dev/null
@@ -1,151 +0,0 @@
-package swarm
-
-import "github.com/docker/docker/api/types/filters"
-
-// Node represents a node.
-type Node struct {
- ID string
- Meta
- // Spec defines the desired state of the node as specified by the user.
- // The system will honor this and will *never* modify it.
- Spec NodeSpec `json:",omitempty"`
- // Description encapsulates the properties of the Node as reported by the
- // agent.
- Description NodeDescription `json:",omitempty"`
- // Status provides the current status of the node, as seen by the manager.
- Status NodeStatus `json:",omitempty"`
- // ManagerStatus provides the current status of the node's manager
- // component, if the node is a manager.
- ManagerStatus *ManagerStatus `json:",omitempty"`
-}
-
-// NodeSpec represents the spec of a node.
-type NodeSpec struct {
- Annotations
- Role NodeRole `json:",omitempty"`
- Availability NodeAvailability `json:",omitempty"`
-}
-
-// NodeRole represents the role of a node.
-type NodeRole string
-
-const (
- // NodeRoleWorker WORKER
- NodeRoleWorker NodeRole = "worker"
- // NodeRoleManager MANAGER
- NodeRoleManager NodeRole = "manager"
-)
-
-// NodeAvailability represents the availability of a node.
-type NodeAvailability string
-
-const (
- // NodeAvailabilityActive ACTIVE
- NodeAvailabilityActive NodeAvailability = "active"
- // NodeAvailabilityPause PAUSE
- NodeAvailabilityPause NodeAvailability = "pause"
- // NodeAvailabilityDrain DRAIN
- NodeAvailabilityDrain NodeAvailability = "drain"
-)
-
-// NodeDescription represents the description of a node.
-type NodeDescription struct {
- Hostname string `json:",omitempty"`
- Platform Platform `json:",omitempty"`
- Resources Resources `json:",omitempty"`
- Engine EngineDescription `json:",omitempty"`
- TLSInfo TLSInfo `json:",omitempty"`
- CSIInfo []NodeCSIInfo `json:",omitempty"`
-}
-
-// Platform represents the platform (Arch/OS).
-type Platform struct {
- Architecture string `json:",omitempty"`
- OS string `json:",omitempty"`
-}
-
-// EngineDescription represents the description of an engine.
-type EngineDescription struct {
- EngineVersion string `json:",omitempty"`
- Labels map[string]string `json:",omitempty"`
- Plugins []PluginDescription `json:",omitempty"`
-}
-
-// NodeCSIInfo represents information about a CSI plugin available on the node
-type NodeCSIInfo struct {
- // PluginName is the name of the CSI plugin.
- PluginName string `json:",omitempty"`
- // NodeID is the ID of the node as reported by the CSI plugin. This is
- // different from the swarm node ID.
- NodeID string `json:",omitempty"`
- // MaxVolumesPerNode is the maximum number of volumes that may be published
- // to this node
- MaxVolumesPerNode int64 `json:",omitempty"`
- // AccessibleTopology indicates the location of this node in the CSI
- // plugin's topology
- AccessibleTopology *Topology `json:",omitempty"`
-}
-
-// PluginDescription represents the description of an engine plugin.
-type PluginDescription struct {
- Type string `json:",omitempty"`
- Name string `json:",omitempty"`
-}
-
-// NodeStatus represents the status of a node.
-type NodeStatus struct {
- State NodeState `json:",omitempty"`
- Message string `json:",omitempty"`
- Addr string `json:",omitempty"`
-}
-
-// Reachability represents the reachability of a node.
-type Reachability string
-
-const (
- // ReachabilityUnknown UNKNOWN
- ReachabilityUnknown Reachability = "unknown"
- // ReachabilityUnreachable UNREACHABLE
- ReachabilityUnreachable Reachability = "unreachable"
- // ReachabilityReachable REACHABLE
- ReachabilityReachable Reachability = "reachable"
-)
-
-// ManagerStatus represents the status of a manager.
-type ManagerStatus struct {
- Leader bool `json:",omitempty"`
- Reachability Reachability `json:",omitempty"`
- Addr string `json:",omitempty"`
-}
-
-// NodeState represents the state of a node.
-type NodeState string
-
-const (
- // NodeStateUnknown UNKNOWN
- NodeStateUnknown NodeState = "unknown"
- // NodeStateDown DOWN
- NodeStateDown NodeState = "down"
- // NodeStateReady READY
- NodeStateReady NodeState = "ready"
- // NodeStateDisconnected DISCONNECTED
- NodeStateDisconnected NodeState = "disconnected"
-)
-
-// Topology defines the CSI topology of this node. This type is a duplicate of
-// github.com/docker/docker/api/types.Topology. Because the type definition
-// is so simple and to avoid complicated structure or circular imports, we just
-// duplicate it here. See that type for full documentation
-type Topology struct {
- Segments map[string]string `json:",omitempty"`
-}
-
-// NodeListOptions holds parameters to list nodes with.
-type NodeListOptions struct {
- Filters filters.Args
-}
-
-// NodeRemoveOptions holds parameters to remove nodes with.
-type NodeRemoveOptions struct {
- Force bool
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/runtime.go b/vendor/github.com/docker/docker/api/types/swarm/runtime.go
deleted file mode 100644
index 3fda4ca6..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/runtime.go
+++ /dev/null
@@ -1,37 +0,0 @@
-package swarm
-
-import "github.com/docker/docker/api/types/swarm/runtime"
-
-// RuntimeType is the type of runtime used for the TaskSpec
-type RuntimeType string
-
-// RuntimeURL is the proto type url
-type RuntimeURL string
-
-const (
- // RuntimeContainer is the container based runtime
- RuntimeContainer RuntimeType = "container"
- // RuntimePlugin is the plugin based runtime
- RuntimePlugin RuntimeType = "plugin"
- // RuntimeNetworkAttachment is the network attachment runtime
- RuntimeNetworkAttachment RuntimeType = "attachment"
-
- // RuntimeURLContainer is the proto url for the container type
- RuntimeURLContainer RuntimeURL = "types.docker.com/RuntimeContainer"
- // RuntimeURLPlugin is the proto url for the plugin type
- RuntimeURLPlugin RuntimeURL = "types.docker.com/RuntimePlugin"
-)
-
-// NetworkAttachmentSpec represents the runtime spec type for network
-// attachment tasks
-type NetworkAttachmentSpec struct {
- ContainerID string
-}
-
-// RuntimeSpec defines the base payload which clients can specify for creating
-// a service with the plugin runtime.
-type RuntimeSpec = runtime.PluginSpec
-
-// RuntimePrivilege describes a permission the user has to accept
-// upon installing a plugin.
-type RuntimePrivilege = runtime.PluginPrivilege
diff --git a/vendor/github.com/docker/docker/api/types/swarm/runtime/runtime.go b/vendor/github.com/docker/docker/api/types/swarm/runtime/runtime.go
deleted file mode 100644
index 95176b26..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/runtime/runtime.go
+++ /dev/null
@@ -1,27 +0,0 @@
-package runtime
-
-import "fmt"
-
-// PluginSpec defines the base payload which clients can specify for creating
-// a service with the plugin runtime.
-type PluginSpec struct {
- Name string `json:"name,omitempty"`
- Remote string `json:"remote,omitempty"`
- Privileges []*PluginPrivilege `json:"privileges,omitempty"`
- Disabled bool `json:"disabled,omitempty"`
- Env []string `json:"env,omitempty"`
-}
-
-// PluginPrivilege describes a permission the user has to accept
-// upon installing a plugin.
-type PluginPrivilege struct {
- Name string `json:"name,omitempty"`
- Description string `json:"description,omitempty"`
- Value []string `json:"value,omitempty"`
-}
-
-var (
- ErrInvalidLengthPlugin = fmt.Errorf("proto: negative length found during unmarshaling") // Deprecated: this error was only used internally and is no longer used.
- ErrIntOverflowPlugin = fmt.Errorf("proto: integer overflow") // Deprecated: this error was only used internally and is no longer used.
- ErrUnexpectedEndOfGroupPlugin = fmt.Errorf("proto: unexpected end of group") // Deprecated: this error was only used internally and is no longer used.
-)
diff --git a/vendor/github.com/docker/docker/api/types/swarm/secret.go b/vendor/github.com/docker/docker/api/types/swarm/secret.go
deleted file mode 100644
index d9482ab5..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/secret.go
+++ /dev/null
@@ -1,66 +0,0 @@
-package swarm
-
-import (
- "os"
-
- "github.com/docker/docker/api/types/filters"
-)
-
-// Secret represents a secret.
-type Secret struct {
- ID string
- Meta
- Spec SecretSpec
-}
-
-// SecretSpec represents a secret specification from a secret in swarm
-type SecretSpec struct {
- Annotations
-
- // Data is the data to store as a secret. It must be empty if a
- // [Driver] is used, in which case the data is loaded from an external
- // secret store. The maximum allowed size is 500KB, as defined in
- // [MaxSecretSize].
- //
- // This field is only used to create the secret, and is not returned
- // by other endpoints.
- //
- // [MaxSecretSize]: https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/api/validation#MaxSecretSize
- Data []byte `json:",omitempty"`
-
- // Driver is the name of the secrets driver used to fetch the secret's
- // value from an external secret store. If not set, the default built-in
- // store is used.
- Driver *Driver `json:",omitempty"`
-
- // Templating controls whether and how to evaluate the secret payload as
- // a template. If it is not set, no templating is used.
- Templating *Driver `json:",omitempty"`
-}
-
-// SecretReferenceFileTarget is a file target in a secret reference
-type SecretReferenceFileTarget struct {
- Name string
- UID string
- GID string
- Mode os.FileMode
-}
-
-// SecretReference is a reference to a secret in swarm
-type SecretReference struct {
- File *SecretReferenceFileTarget
- SecretID string
- SecretName string
-}
-
-// SecretCreateResponse contains the information returned to a client
-// on the creation of a new secret.
-type SecretCreateResponse struct {
- // ID is the id of the created secret.
- ID string
-}
-
-// SecretListOptions holds parameters to list secrets
-type SecretListOptions struct {
- Filters filters.Args
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/service.go b/vendor/github.com/docker/docker/api/types/swarm/service.go
deleted file mode 100644
index 56c660c1..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/service.go
+++ /dev/null
@@ -1,272 +0,0 @@
-package swarm
-
-import (
- "time"
-
- "github.com/docker/docker/api/types/filters"
-)
-
-// Service represents a service.
-type Service struct {
- ID string
- Meta
- Spec ServiceSpec `json:",omitempty"`
- PreviousSpec *ServiceSpec `json:",omitempty"`
- Endpoint Endpoint `json:",omitempty"`
- UpdateStatus *UpdateStatus `json:",omitempty"`
-
- // ServiceStatus is an optional, extra field indicating the number of
- // desired and running tasks. It is provided primarily as a shortcut to
- // calculating these values client-side, which otherwise would require
- // listing all tasks for a service, an operation that could be
- // computation and network expensive.
- ServiceStatus *ServiceStatus `json:",omitempty"`
-
- // JobStatus is the status of a Service which is in one of ReplicatedJob or
- // GlobalJob modes. It is absent on Replicated and Global services.
- JobStatus *JobStatus `json:",omitempty"`
-}
-
-// ServiceSpec represents the spec of a service.
-type ServiceSpec struct {
- Annotations
-
- // TaskTemplate defines how the service should construct new tasks when
- // orchestrating this service.
- TaskTemplate TaskSpec `json:",omitempty"`
- Mode ServiceMode `json:",omitempty"`
- UpdateConfig *UpdateConfig `json:",omitempty"`
- RollbackConfig *UpdateConfig `json:",omitempty"`
-
- // Networks specifies which networks the service should attach to.
- //
- // Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead.
- Networks []NetworkAttachmentConfig `json:",omitempty"`
- EndpointSpec *EndpointSpec `json:",omitempty"`
-}
-
-// ServiceMode represents the mode of a service.
-type ServiceMode struct {
- Replicated *ReplicatedService `json:",omitempty"`
- Global *GlobalService `json:",omitempty"`
- ReplicatedJob *ReplicatedJob `json:",omitempty"`
- GlobalJob *GlobalJob `json:",omitempty"`
-}
-
-// UpdateState is the state of a service update.
-type UpdateState string
-
-const (
- // UpdateStateUpdating is the updating state.
- UpdateStateUpdating UpdateState = "updating"
- // UpdateStatePaused is the paused state.
- UpdateStatePaused UpdateState = "paused"
- // UpdateStateCompleted is the completed state.
- UpdateStateCompleted UpdateState = "completed"
- // UpdateStateRollbackStarted is the state with a rollback in progress.
- UpdateStateRollbackStarted UpdateState = "rollback_started"
- // UpdateStateRollbackPaused is the state with a rollback in progress.
- UpdateStateRollbackPaused UpdateState = "rollback_paused"
- // UpdateStateRollbackCompleted is the state with a rollback in progress.
- UpdateStateRollbackCompleted UpdateState = "rollback_completed"
-)
-
-// UpdateStatus reports the status of a service update.
-type UpdateStatus struct {
- State UpdateState `json:",omitempty"`
- StartedAt *time.Time `json:",omitempty"`
- CompletedAt *time.Time `json:",omitempty"`
- Message string `json:",omitempty"`
-}
-
-// ReplicatedService is a kind of ServiceMode.
-type ReplicatedService struct {
- Replicas *uint64 `json:",omitempty"`
-}
-
-// GlobalService is a kind of ServiceMode.
-type GlobalService struct{}
-
-// ReplicatedJob is the a type of Service which executes a defined Tasks
-// in parallel until the specified number of Tasks have succeeded.
-type ReplicatedJob struct {
- // MaxConcurrent indicates the maximum number of Tasks that should be
- // executing simultaneously for this job at any given time. There may be
- // fewer Tasks that MaxConcurrent executing simultaneously; for example, if
- // there are fewer than MaxConcurrent tasks needed to reach
- // TotalCompletions.
- //
- // If this field is empty, it will default to a max concurrency of 1.
- MaxConcurrent *uint64 `json:",omitempty"`
-
- // TotalCompletions is the total number of Tasks desired to run to
- // completion.
- //
- // If this field is empty, the value of MaxConcurrent will be used.
- TotalCompletions *uint64 `json:",omitempty"`
-}
-
-// GlobalJob is the type of a Service which executes a Task on every Node
-// matching the Service's placement constraints. These tasks run to completion
-// and then exit.
-//
-// This type is deliberately empty.
-type GlobalJob struct{}
-
-const (
- // UpdateFailureActionPause PAUSE
- UpdateFailureActionPause = "pause"
- // UpdateFailureActionContinue CONTINUE
- UpdateFailureActionContinue = "continue"
- // UpdateFailureActionRollback ROLLBACK
- UpdateFailureActionRollback = "rollback"
-
- // UpdateOrderStopFirst STOP_FIRST
- UpdateOrderStopFirst = "stop-first"
- // UpdateOrderStartFirst START_FIRST
- UpdateOrderStartFirst = "start-first"
-)
-
-// UpdateConfig represents the update configuration.
-type UpdateConfig struct {
- // Maximum number of tasks to be updated in one iteration.
- // 0 means unlimited parallelism.
- Parallelism uint64
-
- // Amount of time between updates.
- Delay time.Duration `json:",omitempty"`
-
- // FailureAction is the action to take when an update failures.
- FailureAction string `json:",omitempty"`
-
- // Monitor indicates how long to monitor a task for failure after it is
- // created. If the task fails by ending up in one of the states
- // REJECTED, COMPLETED, or FAILED, within Monitor from its creation,
- // this counts as a failure. If it fails after Monitor, it does not
- // count as a failure. If Monitor is unspecified, a default value will
- // be used.
- Monitor time.Duration `json:",omitempty"`
-
- // MaxFailureRatio is the fraction of tasks that may fail during
- // an update before the failure action is invoked. Any task created by
- // the current update which ends up in one of the states REJECTED,
- // COMPLETED or FAILED within Monitor from its creation counts as a
- // failure. The number of failures is divided by the number of tasks
- // being updated, and if this fraction is greater than
- // MaxFailureRatio, the failure action is invoked.
- //
- // If the failure action is CONTINUE, there is no effect.
- // If the failure action is PAUSE, no more tasks will be updated until
- // another update is started.
- MaxFailureRatio float32
-
- // Order indicates the order of operations when rolling out an updated
- // task. Either the old task is shut down before the new task is
- // started, or the new task is started before the old task is shut down.
- Order string
-}
-
-// ServiceStatus represents the number of running tasks in a service and the
-// number of tasks desired to be running.
-type ServiceStatus struct {
- // RunningTasks is the number of tasks for the service actually in the
- // Running state
- RunningTasks uint64
-
- // DesiredTasks is the number of tasks desired to be running by the
- // service. For replicated services, this is the replica count. For global
- // services, this is computed by taking the number of tasks with desired
- // state of not-Shutdown.
- DesiredTasks uint64
-
- // CompletedTasks is the number of tasks in the state Completed, if this
- // service is in ReplicatedJob or GlobalJob mode. This field must be
- // cross-referenced with the service type, because the default value of 0
- // may mean that a service is not in a job mode, or it may mean that the
- // job has yet to complete any tasks.
- CompletedTasks uint64
-}
-
-// JobStatus is the status of a job-type service.
-type JobStatus struct {
- // JobIteration is a value increased each time a Job is executed,
- // successfully or otherwise. "Executed", in this case, means the job as a
- // whole has been started, not that an individual Task has been launched. A
- // job is "Executed" when its ServiceSpec is updated. JobIteration can be
- // used to disambiguate Tasks belonging to different executions of a job.
- //
- // Though JobIteration will increase with each subsequent execution, it may
- // not necessarily increase by 1, and so JobIteration should not be used to
- // keep track of the number of times a job has been executed.
- JobIteration Version
-
- // LastExecution is the time that the job was last executed, as observed by
- // Swarm manager.
- LastExecution time.Time `json:",omitempty"`
-}
-
-// ServiceCreateOptions contains the options to use when creating a service.
-type ServiceCreateOptions struct {
- // EncodedRegistryAuth is the encoded registry authorization credentials to
- // use when updating the service.
- //
- // This field follows the format of the X-Registry-Auth header.
- EncodedRegistryAuth string
-
- // QueryRegistry indicates whether the service update requires
- // contacting a registry. A registry may be contacted to retrieve
- // the image digest and manifest, which in turn can be used to update
- // platform or other information about the service.
- QueryRegistry bool
-}
-
-// Values for RegistryAuthFrom in ServiceUpdateOptions
-const (
- RegistryAuthFromSpec = "spec"
- RegistryAuthFromPreviousSpec = "previous-spec"
-)
-
-// ServiceUpdateOptions contains the options to be used for updating services.
-type ServiceUpdateOptions struct {
- // EncodedRegistryAuth is the encoded registry authorization credentials to
- // use when updating the service.
- //
- // This field follows the format of the X-Registry-Auth header.
- EncodedRegistryAuth string
-
- // TODO(stevvooe): Consider moving the version parameter of ServiceUpdate
- // into this field. While it does open API users up to racy writes, most
- // users may not need that level of consistency in practice.
-
- // RegistryAuthFrom specifies where to find the registry authorization
- // credentials if they are not given in EncodedRegistryAuth. Valid
- // values are "spec" and "previous-spec".
- RegistryAuthFrom string
-
- // Rollback indicates whether a server-side rollback should be
- // performed. When this is set, the provided spec will be ignored.
- // The valid values are "previous" and "none". An empty value is the
- // same as "none".
- Rollback string
-
- // QueryRegistry indicates whether the service update requires
- // contacting a registry. A registry may be contacted to retrieve
- // the image digest and manifest, which in turn can be used to update
- // platform or other information about the service.
- QueryRegistry bool
-}
-
-// ServiceListOptions holds parameters to list services with.
-type ServiceListOptions struct {
- Filters filters.Args
-
- // Status indicates whether the server should include the service task
- // count of running and desired tasks.
- Status bool
-}
-
-// ServiceInspectOptions holds parameters related to the "service inspect"
-// operation.
-type ServiceInspectOptions struct {
- InsertDefaults bool
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/service_create_response.go b/vendor/github.com/docker/docker/api/types/swarm/service_create_response.go
deleted file mode 100644
index 9a268ff1..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/service_create_response.go
+++ /dev/null
@@ -1,20 +0,0 @@
-package swarm
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// ServiceCreateResponse contains the information returned to a client on the
-// creation of a new service.
-//
-// swagger:model ServiceCreateResponse
-type ServiceCreateResponse struct {
-
- // The ID of the created service.
- ID string `json:"ID,omitempty"`
-
- // Optional warning message.
- //
- // FIXME(thaJeztah): this should have "omitempty" in the generated type.
- //
- Warnings []string `json:"Warnings"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/service_update_response.go b/vendor/github.com/docker/docker/api/types/swarm/service_update_response.go
deleted file mode 100644
index 0417467d..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/service_update_response.go
+++ /dev/null
@@ -1,12 +0,0 @@
-package swarm
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// ServiceUpdateResponse service update response
-// swagger:model ServiceUpdateResponse
-type ServiceUpdateResponse struct {
-
- // Optional warning messages
- Warnings []string `json:"Warnings"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/swarm.go b/vendor/github.com/docker/docker/api/types/swarm/swarm.go
deleted file mode 100644
index 38f3e666..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/swarm.go
+++ /dev/null
@@ -1,244 +0,0 @@
-package swarm
-
-import (
- "time"
-)
-
-// ClusterInfo represents info about the cluster for outputting in "info"
-// it contains the same information as "Swarm", but without the JoinTokens
-type ClusterInfo struct {
- ID string
- Meta
- Spec Spec
- TLSInfo TLSInfo
- RootRotationInProgress bool
- DefaultAddrPool []string
- SubnetSize uint32
- DataPathPort uint32
-}
-
-// Swarm represents a swarm.
-type Swarm struct {
- ClusterInfo
- JoinTokens JoinTokens
-}
-
-// JoinTokens contains the tokens workers and managers need to join the swarm.
-type JoinTokens struct {
- // Worker is the join token workers may use to join the swarm.
- Worker string
- // Manager is the join token managers may use to join the swarm.
- Manager string
-}
-
-// Spec represents the spec of a swarm.
-type Spec struct {
- Annotations
-
- Orchestration OrchestrationConfig `json:",omitempty"`
- Raft RaftConfig `json:",omitempty"`
- Dispatcher DispatcherConfig `json:",omitempty"`
- CAConfig CAConfig `json:",omitempty"`
- TaskDefaults TaskDefaults `json:",omitempty"`
- EncryptionConfig EncryptionConfig `json:",omitempty"`
-}
-
-// OrchestrationConfig represents orchestration configuration.
-type OrchestrationConfig struct {
- // TaskHistoryRetentionLimit is the number of historic tasks to keep per instance or
- // node. If negative, never remove completed or failed tasks.
- TaskHistoryRetentionLimit *int64 `json:",omitempty"`
-}
-
-// TaskDefaults parameterizes cluster-level task creation with default values.
-type TaskDefaults struct {
- // LogDriver selects the log driver to use for tasks created in the
- // orchestrator if unspecified by a service.
- //
- // Updating this value will only have an affect on new tasks. Old tasks
- // will continue use their previously configured log driver until
- // recreated.
- LogDriver *Driver `json:",omitempty"`
-}
-
-// EncryptionConfig controls at-rest encryption of data and keys.
-type EncryptionConfig struct {
- // AutoLockManagers specifies whether or not managers TLS keys and raft data
- // should be encrypted at rest in such a way that they must be unlocked
- // before the manager node starts up again.
- AutoLockManagers bool
-}
-
-// RaftConfig represents raft configuration.
-type RaftConfig struct {
- // SnapshotInterval is the number of log entries between snapshots.
- SnapshotInterval uint64 `json:",omitempty"`
-
- // KeepOldSnapshots is the number of snapshots to keep beyond the
- // current snapshot.
- KeepOldSnapshots *uint64 `json:",omitempty"`
-
- // LogEntriesForSlowFollowers is the number of log entries to keep
- // around to sync up slow followers after a snapshot is created.
- LogEntriesForSlowFollowers uint64 `json:",omitempty"`
-
- // ElectionTick is the number of ticks that a follower will wait for a message
- // from the leader before becoming a candidate and starting an election.
- // ElectionTick must be greater than HeartbeatTick.
- //
- // A tick currently defaults to one second, so these translate directly to
- // seconds currently, but this is NOT guaranteed.
- ElectionTick int
-
- // HeartbeatTick is the number of ticks between heartbeats. Every
- // HeartbeatTick ticks, the leader will send a heartbeat to the
- // followers.
- //
- // A tick currently defaults to one second, so these translate directly to
- // seconds currently, but this is NOT guaranteed.
- HeartbeatTick int
-}
-
-// DispatcherConfig represents dispatcher configuration.
-type DispatcherConfig struct {
- // HeartbeatPeriod defines how often agent should send heartbeats to
- // dispatcher.
- HeartbeatPeriod time.Duration `json:",omitempty"`
-}
-
-// CAConfig represents CA configuration.
-type CAConfig struct {
- // NodeCertExpiry is the duration certificates should be issued for
- NodeCertExpiry time.Duration `json:",omitempty"`
-
- // ExternalCAs is a list of CAs to which a manager node will make
- // certificate signing requests for node certificates.
- ExternalCAs []*ExternalCA `json:",omitempty"`
-
- // SigningCACert and SigningCAKey specify the desired signing root CA and
- // root CA key for the swarm. When inspecting the cluster, the key will
- // be redacted.
- SigningCACert string `json:",omitempty"`
- SigningCAKey string `json:",omitempty"`
-
- // If this value changes, and there is no specified signing cert and key,
- // then the swarm is forced to generate a new root certificate and key.
- ForceRotate uint64 `json:",omitempty"`
-}
-
-// ExternalCAProtocol represents type of external CA.
-type ExternalCAProtocol string
-
-// ExternalCAProtocolCFSSL CFSSL
-const ExternalCAProtocolCFSSL ExternalCAProtocol = "cfssl"
-
-// ExternalCA defines external CA to be used by the cluster.
-type ExternalCA struct {
- // Protocol is the protocol used by this external CA.
- Protocol ExternalCAProtocol
-
- // URL is the URL where the external CA can be reached.
- URL string
-
- // Options is a set of additional key/value pairs whose interpretation
- // depends on the specified CA type.
- Options map[string]string `json:",omitempty"`
-
- // CACert specifies which root CA is used by this external CA. This certificate must
- // be in PEM format.
- CACert string
-}
-
-// InitRequest is the request used to init a swarm.
-type InitRequest struct {
- ListenAddr string
- AdvertiseAddr string
- DataPathAddr string
- DataPathPort uint32
- ForceNewCluster bool
- Spec Spec
- AutoLockManagers bool
- Availability NodeAvailability
- DefaultAddrPool []string
- SubnetSize uint32
-}
-
-// JoinRequest is the request used to join a swarm.
-type JoinRequest struct {
- ListenAddr string
- AdvertiseAddr string
- DataPathAddr string
- RemoteAddrs []string
- JoinToken string // accept by secret
- Availability NodeAvailability
-}
-
-// UnlockRequest is the request used to unlock a swarm.
-type UnlockRequest struct {
- // UnlockKey is the unlock key in ASCII-armored format.
- UnlockKey string
-}
-
-// LocalNodeState represents the state of the local node.
-type LocalNodeState string
-
-const (
- // LocalNodeStateInactive INACTIVE
- LocalNodeStateInactive LocalNodeState = "inactive"
- // LocalNodeStatePending PENDING
- LocalNodeStatePending LocalNodeState = "pending"
- // LocalNodeStateActive ACTIVE
- LocalNodeStateActive LocalNodeState = "active"
- // LocalNodeStateError ERROR
- LocalNodeStateError LocalNodeState = "error"
- // LocalNodeStateLocked LOCKED
- LocalNodeStateLocked LocalNodeState = "locked"
-)
-
-// Info represents generic information about swarm.
-type Info struct {
- NodeID string
- NodeAddr string
-
- LocalNodeState LocalNodeState
- ControlAvailable bool
- Error string
-
- RemoteManagers []Peer
- Nodes int `json:",omitempty"`
- Managers int `json:",omitempty"`
-
- Cluster *ClusterInfo `json:",omitempty"`
-
- Warnings []string `json:",omitempty"`
-}
-
-// Status provides information about the current swarm status and role,
-// obtained from the "Swarm" header in the API response.
-type Status struct {
- // NodeState represents the state of the node.
- NodeState LocalNodeState
-
- // ControlAvailable indicates if the node is a swarm manager.
- ControlAvailable bool
-}
-
-// Peer represents a peer.
-type Peer struct {
- NodeID string
- Addr string
-}
-
-// UpdateFlags contains flags for SwarmUpdate.
-type UpdateFlags struct {
- RotateWorkerToken bool
- RotateManagerToken bool
- RotateManagerUnlockKey bool
-}
-
-// UnlockKeyResponse contains the response for Engine API:
-// GET /swarm/unlockkey
-type UnlockKeyResponse struct {
- // UnlockKey is the unlock key in ASCII-armored format.
- UnlockKey string
-}
diff --git a/vendor/github.com/docker/docker/api/types/swarm/task.go b/vendor/github.com/docker/docker/api/types/swarm/task.go
deleted file mode 100644
index e143f844..00000000
--- a/vendor/github.com/docker/docker/api/types/swarm/task.go
+++ /dev/null
@@ -1,230 +0,0 @@
-package swarm
-
-import (
- "time"
-
- "github.com/docker/docker/api/types/filters"
-)
-
-// TaskState represents the state of a task.
-type TaskState string
-
-const (
- // TaskStateNew NEW
- TaskStateNew TaskState = "new"
- // TaskStateAllocated ALLOCATED
- TaskStateAllocated TaskState = "allocated"
- // TaskStatePending PENDING
- TaskStatePending TaskState = "pending"
- // TaskStateAssigned ASSIGNED
- TaskStateAssigned TaskState = "assigned"
- // TaskStateAccepted ACCEPTED
- TaskStateAccepted TaskState = "accepted"
- // TaskStatePreparing PREPARING
- TaskStatePreparing TaskState = "preparing"
- // TaskStateReady READY
- TaskStateReady TaskState = "ready"
- // TaskStateStarting STARTING
- TaskStateStarting TaskState = "starting"
- // TaskStateRunning RUNNING
- TaskStateRunning TaskState = "running"
- // TaskStateComplete COMPLETE
- TaskStateComplete TaskState = "complete"
- // TaskStateShutdown SHUTDOWN
- TaskStateShutdown TaskState = "shutdown"
- // TaskStateFailed FAILED
- TaskStateFailed TaskState = "failed"
- // TaskStateRejected REJECTED
- TaskStateRejected TaskState = "rejected"
- // TaskStateRemove REMOVE
- TaskStateRemove TaskState = "remove"
- // TaskStateOrphaned ORPHANED
- TaskStateOrphaned TaskState = "orphaned"
-)
-
-// Task represents a task.
-type Task struct {
- ID string
- Meta
- Annotations
-
- Spec TaskSpec `json:",omitempty"`
- ServiceID string `json:",omitempty"`
- Slot int `json:",omitempty"`
- NodeID string `json:",omitempty"`
- Status TaskStatus `json:",omitempty"`
- DesiredState TaskState `json:",omitempty"`
- NetworksAttachments []NetworkAttachment `json:",omitempty"`
- GenericResources []GenericResource `json:",omitempty"`
-
- // JobIteration is the JobIteration of the Service that this Task was
- // spawned from, if the Service is a ReplicatedJob or GlobalJob. This is
- // used to determine which Tasks belong to which run of the job. This field
- // is absent if the Service mode is Replicated or Global.
- JobIteration *Version `json:",omitempty"`
-
- // Volumes is the list of VolumeAttachments for this task. It specifies
- // which particular volumes are to be used by this particular task, and
- // fulfilling what mounts in the spec.
- Volumes []VolumeAttachment
-}
-
-// TaskSpec represents the spec of a task.
-type TaskSpec struct {
- // ContainerSpec, NetworkAttachmentSpec, and PluginSpec are mutually exclusive.
- // PluginSpec is only used when the `Runtime` field is set to `plugin`
- // NetworkAttachmentSpec is used if the `Runtime` field is set to
- // `attachment`.
- ContainerSpec *ContainerSpec `json:",omitempty"`
- PluginSpec *RuntimeSpec `json:",omitempty"`
- NetworkAttachmentSpec *NetworkAttachmentSpec `json:",omitempty"`
-
- Resources *ResourceRequirements `json:",omitempty"`
- RestartPolicy *RestartPolicy `json:",omitempty"`
- Placement *Placement `json:",omitempty"`
- Networks []NetworkAttachmentConfig `json:",omitempty"`
-
- // LogDriver specifies the LogDriver to use for tasks created from this
- // spec. If not present, the one on cluster default on swarm.Spec will be
- // used, finally falling back to the engine default if not specified.
- LogDriver *Driver `json:",omitempty"`
-
- // ForceUpdate is a counter that triggers an update even if no relevant
- // parameters have been changed.
- ForceUpdate uint64
-
- Runtime RuntimeType `json:",omitempty"`
-}
-
-// Resources represents resources (CPU/Memory) which can be advertised by a
-// node and requested to be reserved for a task.
-type Resources struct {
- NanoCPUs int64 `json:",omitempty"`
- MemoryBytes int64 `json:",omitempty"`
- GenericResources []GenericResource `json:",omitempty"`
-}
-
-// Limit describes limits on resources which can be requested by a task.
-type Limit struct {
- NanoCPUs int64 `json:",omitempty"`
- MemoryBytes int64 `json:",omitempty"`
- Pids int64 `json:",omitempty"`
-}
-
-// GenericResource represents a "user defined" resource which can
-// be either an integer (e.g: SSD=3) or a string (e.g: SSD=sda1)
-type GenericResource struct {
- NamedResourceSpec *NamedGenericResource `json:",omitempty"`
- DiscreteResourceSpec *DiscreteGenericResource `json:",omitempty"`
-}
-
-// NamedGenericResource represents a "user defined" resource which is defined
-// as a string.
-// "Kind" is used to describe the Kind of a resource (e.g: "GPU", "FPGA", "SSD", ...)
-// Value is used to identify the resource (GPU="UUID-1", FPGA="/dev/sdb5", ...)
-type NamedGenericResource struct {
- Kind string `json:",omitempty"`
- Value string `json:",omitempty"`
-}
-
-// DiscreteGenericResource represents a "user defined" resource which is defined
-// as an integer
-// "Kind" is used to describe the Kind of a resource (e.g: "GPU", "FPGA", "SSD", ...)
-// Value is used to count the resource (SSD=5, HDD=3, ...)
-type DiscreteGenericResource struct {
- Kind string `json:",omitempty"`
- Value int64 `json:",omitempty"`
-}
-
-// ResourceRequirements represents resources requirements.
-type ResourceRequirements struct {
- Limits *Limit `json:",omitempty"`
- Reservations *Resources `json:",omitempty"`
-}
-
-// Placement represents orchestration parameters.
-type Placement struct {
- Constraints []string `json:",omitempty"`
- Preferences []PlacementPreference `json:",omitempty"`
- MaxReplicas uint64 `json:",omitempty"`
-
- // Platforms stores all the platforms that the image can run on.
- // This field is used in the platform filter for scheduling. If empty,
- // then the platform filter is off, meaning there are no scheduling restrictions.
- Platforms []Platform `json:",omitempty"`
-}
-
-// PlacementPreference provides a way to make the scheduler aware of factors
-// such as topology.
-type PlacementPreference struct {
- Spread *SpreadOver
-}
-
-// SpreadOver is a scheduling preference that instructs the scheduler to spread
-// tasks evenly over groups of nodes identified by labels.
-type SpreadOver struct {
- // label descriptor, such as engine.labels.az
- SpreadDescriptor string
-}
-
-// RestartPolicy represents the restart policy.
-type RestartPolicy struct {
- Condition RestartPolicyCondition `json:",omitempty"`
- Delay *time.Duration `json:",omitempty"`
- MaxAttempts *uint64 `json:",omitempty"`
- Window *time.Duration `json:",omitempty"`
-}
-
-// RestartPolicyCondition represents when to restart.
-type RestartPolicyCondition string
-
-const (
- // RestartPolicyConditionNone NONE
- RestartPolicyConditionNone RestartPolicyCondition = "none"
- // RestartPolicyConditionOnFailure ON_FAILURE
- RestartPolicyConditionOnFailure RestartPolicyCondition = "on-failure"
- // RestartPolicyConditionAny ANY
- RestartPolicyConditionAny RestartPolicyCondition = "any"
-)
-
-// TaskStatus represents the status of a task.
-type TaskStatus struct {
- Timestamp time.Time `json:",omitempty"`
- State TaskState `json:",omitempty"`
- Message string `json:",omitempty"`
- Err string `json:",omitempty"`
- ContainerStatus *ContainerStatus `json:",omitempty"`
- PortStatus PortStatus `json:",omitempty"`
-}
-
-// ContainerStatus represents the status of a container.
-type ContainerStatus struct {
- ContainerID string
- PID int
- ExitCode int
-}
-
-// PortStatus represents the port status of a task's host ports whose
-// service has published host ports
-type PortStatus struct {
- Ports []PortConfig `json:",omitempty"`
-}
-
-// VolumeAttachment contains the associating a Volume to a Task.
-type VolumeAttachment struct {
- // ID is the Swarmkit ID of the Volume. This is not the CSI VolumeId.
- ID string `json:",omitempty"`
-
- // Source, together with Target, indicates the Mount, as specified in the
- // ContainerSpec, that this volume fulfills.
- Source string `json:",omitempty"`
-
- // Target, together with Source, indicates the Mount, as specified
- // in the ContainerSpec, that this volume fulfills.
- Target string `json:",omitempty"`
-}
-
-// TaskListOptions holds parameters to list tasks with.
-type TaskListOptions struct {
- Filters filters.Args
-}
diff --git a/vendor/github.com/docker/docker/api/types/system/info.go b/vendor/github.com/docker/docker/api/types/system/info.go
deleted file mode 100644
index 0f39099d..00000000
--- a/vendor/github.com/docker/docker/api/types/system/info.go
+++ /dev/null
@@ -1,174 +0,0 @@
-package system
-
-import (
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/registry"
- "github.com/docker/docker/api/types/swarm"
-)
-
-// 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
- // KernelMemoryLimit is not supported on cgroups v2.
- //
- // Deprecated: This field is deprecated and will be removed in the next release.
- // Starting with kernel 6.12, the kernel has deprecated kernel memory tcp accounting
- 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
- 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"`
- FirewallBackend *FirewallInfo `json:"FirewallBackend,omitempty"`
- CDISpecDirs []string
- DiscoveredDevices []DeviceInfo `json:",omitempty"`
-
- Containerd *ContainerdInfo `json:",omitempty"`
-
- // 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
-}
-
-// ContainerdInfo holds information about the containerd instance used by the daemon.
-type ContainerdInfo struct {
- // Address is the path to the containerd socket.
- Address string `json:",omitempty"`
- // Namespaces is the containerd namespaces used by the daemon.
- Namespaces ContainerdNamespaces
-}
-
-// ContainerdNamespaces reflects the containerd namespaces used by the daemon.
-//
-// These namespaces can be configured in the daemon configuration, and are
-// considered to be used exclusively by the daemon,
-//
-// As these namespaces are considered to be exclusively accessed
-// by the daemon, it is not recommended to change these values,
-// or to change them to a value that is used by other systems,
-// such as cri-containerd.
-type ContainerdNamespaces struct {
- // Containers holds the default containerd namespace used for
- // containers managed by the daemon.
- //
- // The default namespace for containers is "moby", but will be
- // suffixed with the `.` of the remapped `root` if
- // user-namespaces are enabled and the containerd image-store
- // is used.
- Containers string
-
- // Plugins holds the default containerd namespace used for
- // plugins managed by the daemon.
- //
- // The default namespace for plugins is "moby", but will be
- // suffixed with the `.` of the remapped `root` if
- // user-namespaces are enabled and the containerd image-store
- // is used.
- Plugins string
-}
-
-// 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
-}
-
-// 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 is the actual commit ID or version of external tool.
- ID string
-
- // Expected is the commit ID of external tool expected by dockerd as set at build time.
- //
- // Deprecated: this field is no longer used in API v1.49, but kept for backward-compatibility with older API versions.
- Expected string `json:",omitempty"`
-}
-
-// NetworkAddressPool is a temp struct used by [Info] struct.
-type NetworkAddressPool struct {
- Base string
- Size int
-}
-
-// FirewallInfo describes the firewall backend.
-type FirewallInfo struct {
- // Driver is the name of the firewall backend driver.
- Driver string `json:"Driver"`
- // Info is a list of label/value pairs, containing information related to the firewall.
- Info [][2]string `json:"Info,omitempty"`
-}
-
-// DeviceInfo represents a discoverable device from a device driver.
-type DeviceInfo struct {
- // Source indicates the origin device driver.
- Source string `json:"Source"`
- // ID is the unique identifier for the device.
- // Example: CDI FQDN like "vendor.com/gpu=0", or other driver-specific device ID
- ID string `json:"ID"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/system/runtime.go b/vendor/github.com/docker/docker/api/types/system/runtime.go
deleted file mode 100644
index d077295a..00000000
--- a/vendor/github.com/docker/docker/api/types/system/runtime.go
+++ /dev/null
@@ -1,20 +0,0 @@
-package system
-
-// Runtime describes an OCI runtime
-type Runtime struct {
- // "Legacy" runtime configuration for runc-compatible runtimes.
-
- Path string `json:"path,omitempty"`
- Args []string `json:"runtimeArgs,omitempty"`
-
- // Shimv2 runtime configuration. Mutually exclusive with the legacy config above.
-
- Type string `json:"runtimeType,omitempty"`
- Options map[string]interface{} `json:"options,omitempty"`
-}
-
-// RuntimeWithStatus extends [Runtime] to hold [RuntimeStatus].
-type RuntimeWithStatus struct {
- Runtime
- Status map[string]string `json:"status,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/system/security_opts.go b/vendor/github.com/docker/docker/api/types/system/security_opts.go
deleted file mode 100644
index edff3eb1..00000000
--- a/vendor/github.com/docker/docker/api/types/system/security_opts.go
+++ /dev/null
@@ -1,48 +0,0 @@
-package system
-
-import (
- "errors"
- "fmt"
- "strings"
-)
-
-// SecurityOpt contains the name and options of a security option
-type SecurityOpt struct {
- Name string
- Options []KeyValue
-}
-
-// DecodeSecurityOptions decodes a security options string slice to a
-// type-safe [SecurityOpt].
-func DecodeSecurityOptions(opts []string) ([]SecurityOpt, error) {
- so := []SecurityOpt{}
- for _, opt := range opts {
- // support output from a < 1.13 docker daemon
- if !strings.Contains(opt, "=") {
- so = append(so, SecurityOpt{Name: opt})
- continue
- }
- secopt := SecurityOpt{}
- for _, s := range strings.Split(opt, ",") {
- k, v, ok := strings.Cut(s, "=")
- if !ok {
- return nil, fmt.Errorf("invalid security option %q", s)
- }
- if k == "" || v == "" {
- return nil, errors.New("invalid empty security option")
- }
- if k == "name" {
- secopt.Name = v
- continue
- }
- secopt.Options = append(secopt.Options, KeyValue{Key: k, Value: v})
- }
- so = append(so, secopt)
- }
- return so, nil
-}
-
-// KeyValue holds a key/value pair.
-type KeyValue struct {
- Key, Value string
-}
diff --git a/vendor/github.com/docker/docker/api/types/time/timestamp.go b/vendor/github.com/docker/docker/api/types/time/timestamp.go
deleted file mode 100644
index 0e1df38a..00000000
--- a/vendor/github.com/docker/docker/api/types/time/timestamp.go
+++ /dev/null
@@ -1,131 +0,0 @@
-package time
-
-import (
- "fmt"
- "math"
- "strconv"
- "strings"
- "time"
-)
-
-// These are additional predefined layouts for use in Time.Format and Time.Parse
-// with --since and --until parameters for `docker logs` and `docker events`
-const (
- rFC3339Local = "2006-01-02T15:04:05" // RFC3339 with local timezone
- rFC3339NanoLocal = "2006-01-02T15:04:05.999999999" // RFC3339Nano with local timezone
- dateWithZone = "2006-01-02Z07:00" // RFC3339 with time at 00:00:00
- dateLocal = "2006-01-02" // RFC3339 with local timezone and time at 00:00:00
-)
-
-// GetTimestamp tries to parse given string as golang duration,
-// then RFC3339 time and finally as a Unix timestamp. If
-// any of these were successful, it returns a Unix timestamp
-// as string otherwise returns the given value back.
-// In case of duration input, the returned timestamp is computed
-// as the given reference time minus the amount of the duration.
-func GetTimestamp(value string, reference time.Time) (string, error) {
- if d, err := time.ParseDuration(value); value != "0" && err == nil {
- return strconv.FormatInt(reference.Add(-d).Unix(), 10), nil
- }
-
- var format string
- // if the string has a Z or a + or three dashes use parse otherwise use parseinlocation
- parseInLocation := !strings.ContainsAny(value, "zZ+") && strings.Count(value, "-") != 3
-
- if strings.Contains(value, ".") {
- if parseInLocation {
- format = rFC3339NanoLocal
- } else {
- format = time.RFC3339Nano
- }
- } else if strings.Contains(value, "T") {
- // we want the number of colons in the T portion of the timestamp
- tcolons := strings.Count(value, ":")
- // if parseInLocation is off and we have a +/- zone offset (not Z) then
- // there will be an extra colon in the input for the tz offset subtract that
- // colon from the tcolons count
- if !parseInLocation && !strings.ContainsAny(value, "zZ") && tcolons > 0 {
- tcolons--
- }
- if parseInLocation {
- switch tcolons {
- case 0:
- format = "2006-01-02T15"
- case 1:
- format = "2006-01-02T15:04"
- default:
- format = rFC3339Local
- }
- } else {
- switch tcolons {
- case 0:
- format = "2006-01-02T15Z07:00"
- case 1:
- format = "2006-01-02T15:04Z07:00"
- default:
- format = time.RFC3339
- }
- }
- } else if parseInLocation {
- format = dateLocal
- } else {
- format = dateWithZone
- }
-
- var t time.Time
- var err error
-
- if parseInLocation {
- t, err = time.ParseInLocation(format, value, time.FixedZone(reference.Zone()))
- } else {
- t, err = time.Parse(format, value)
- }
-
- if err != nil {
- // if there is a `-` then it's an RFC3339 like timestamp
- if strings.Contains(value, "-") {
- return "", err // was probably an RFC3339 like timestamp but the parser failed with an error
- }
- if _, _, err := parseTimestamp(value); err != nil {
- return "", fmt.Errorf("failed to parse value as time or duration: %q", value)
- }
- return value, nil // unix timestamp in and out case (meaning: the value passed at the command line is already in the right format for passing to the server)
- }
-
- return fmt.Sprintf("%d.%09d", t.Unix(), int64(t.Nanosecond())), nil
-}
-
-// ParseTimestamps returns seconds and nanoseconds from a timestamp that has
-// the format ("%d.%09d", time.Unix(), int64(time.Nanosecond())).
-// If the incoming nanosecond portion is longer than 9 digits it is truncated.
-// The expectation is that the seconds and nanoseconds will be used to create a
-// time variable. For example:
-//
-// seconds, nanoseconds, _ := ParseTimestamp("1136073600.000000001",0)
-// since := time.Unix(seconds, nanoseconds)
-//
-// returns seconds as defaultSeconds if value == ""
-func ParseTimestamps(value string, defaultSeconds int64) (seconds int64, nanoseconds int64, _ error) {
- if value == "" {
- return defaultSeconds, 0, nil
- }
- return parseTimestamp(value)
-}
-
-func parseTimestamp(value string) (seconds int64, nanoseconds int64, _ error) {
- s, n, ok := strings.Cut(value, ".")
- sec, err := strconv.ParseInt(s, 10, 64)
- if err != nil {
- return sec, 0, err
- }
- if !ok {
- return sec, 0, nil
- }
- nsec, err := strconv.ParseInt(n, 10, 64)
- if err != nil {
- return sec, nsec, err
- }
- // should already be in nanoseconds but just in case convert n to nanoseconds
- nsec = int64(float64(nsec) * math.Pow(float64(10), float64(9-len(n))))
- return sec, nsec, nil
-}
diff --git a/vendor/github.com/docker/docker/api/types/types.go b/vendor/github.com/docker/docker/api/types/types.go
deleted file mode 100644
index 8bbadeb2..00000000
--- a/vendor/github.com/docker/docker/api/types/types.go
+++ /dev/null
@@ -1,103 +0,0 @@
-package types
-
-import (
- "github.com/docker/docker/api/types/build"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/image"
- "github.com/docker/docker/api/types/swarm"
- "github.com/docker/docker/api/types/volume"
-)
-
-const (
- // MediaTypeRawStream is vendor specific MIME-Type set for raw TTY streams
- MediaTypeRawStream = "application/vnd.docker.raw-stream"
-
- // MediaTypeMultiplexedStream is vendor specific MIME-Type set for stdin/stdout/stderr multiplexed streams
- MediaTypeMultiplexedStream = "application/vnd.docker.multiplexed-stream"
-)
-
-// Ping contains response of Engine API:
-// GET "/_ping"
-type Ping struct {
- APIVersion string
- OSType string
- Experimental bool
- BuilderVersion build.BuilderVersion
-
- // SwarmStatus provides information about the current swarm status of the
- // engine, obtained from the "Swarm" header in the API response.
- //
- // It can be a nil struct if the API version does not provide this header
- // in the ping response, or if an error occurred, in which case the client
- // should use other ways to get the current swarm status, such as the /swarm
- // endpoint.
- SwarmStatus *swarm.Status
-}
-
-// ComponentVersion describes the version information for a specific component.
-type ComponentVersion struct {
- Name string
- Version string
- Details map[string]string `json:",omitempty"`
-}
-
-// Version contains response of Engine API:
-// GET "/version"
-type Version struct {
- Platform struct{ Name string } `json:",omitempty"`
- Components []ComponentVersion `json:",omitempty"`
-
- // The following fields are deprecated, they relate to the Engine component and are kept for backwards compatibility
-
- Version string
- APIVersion string `json:"ApiVersion"`
- MinAPIVersion string `json:"MinAPIVersion,omitempty"`
- GitCommit string
- GoVersion string
- Os string
- Arch string
- KernelVersion string `json:",omitempty"`
- Experimental bool `json:",omitempty"`
- BuildTime string `json:",omitempty"`
-}
-
-// DiskUsageObject represents an object type used for disk usage query filtering.
-type DiskUsageObject string
-
-const (
- // ContainerObject represents a container DiskUsageObject.
- ContainerObject DiskUsageObject = "container"
- // ImageObject represents an image DiskUsageObject.
- ImageObject DiskUsageObject = "image"
- // VolumeObject represents a volume DiskUsageObject.
- VolumeObject DiskUsageObject = "volume"
- // BuildCacheObject represents a build-cache DiskUsageObject.
- BuildCacheObject DiskUsageObject = "build-cache"
-)
-
-// DiskUsageOptions holds parameters for system disk usage query.
-type DiskUsageOptions struct {
- // Types specifies what object types to include in the response. If empty,
- // all object types are returned.
- Types []DiskUsageObject
-}
-
-// DiskUsage contains response of Engine API:
-// GET "/system/df"
-type DiskUsage struct {
- LayersSize int64
- Images []*image.Summary
- Containers []*container.Summary
- Volumes []*volume.Volume
- BuildCache []*build.CacheRecord
- BuilderSize int64 `json:",omitempty"` // Deprecated: deprecated in API 1.38, and no longer used since API 1.40.
-}
-
-// PushResult contains the tag, manifest digest, and manifest size from the
-// push. It's used to signal this information to the trust code in the client
-// so it can sign the manifest if necessary.
-type PushResult struct {
- Tag string
- Digest string
- Size int
-}
diff --git a/vendor/github.com/docker/docker/api/types/types_deprecated.go b/vendor/github.com/docker/docker/api/types/types_deprecated.go
deleted file mode 100644
index c9c20b87..00000000
--- a/vendor/github.com/docker/docker/api/types/types_deprecated.go
+++ /dev/null
@@ -1,242 +0,0 @@
-package types
-
-import (
- "context"
-
- "github.com/docker/docker/api/types/build"
- "github.com/docker/docker/api/types/common"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/image"
- "github.com/docker/docker/api/types/storage"
- "github.com/docker/docker/api/types/swarm"
-)
-
-// IDResponse Response to an API call that returns just an Id.
-//
-// Deprecated: use either [container.CommitResponse] or [container.ExecCreateResponse]. It will be removed in the next release.
-type IDResponse = common.IDResponse
-
-// ContainerJSONBase contains response of Engine API GET "/containers/{name:.*}/json"
-// for API version 1.18 and older.
-//
-// Deprecated: use [container.InspectResponse] or [container.ContainerJSONBase]. It will be removed in the next release.
-type ContainerJSONBase = container.ContainerJSONBase
-
-// ContainerJSON is the response for the GET "/containers/{name:.*}/json"
-// endpoint.
-//
-// Deprecated: use [container.InspectResponse]. It will be removed in the next release.
-type ContainerJSON = container.InspectResponse
-
-// Container contains response of Engine API:
-// GET "/containers/json"
-//
-// Deprecated: use [container.Summary].
-type Container = container.Summary
-
-// ContainerState stores container's running state
-//
-// Deprecated: use [container.State].
-type ContainerState = container.State
-
-// NetworkSettings exposes the network settings in the api.
-//
-// Deprecated: use [container.NetworkSettings].
-type NetworkSettings = container.NetworkSettings
-
-// NetworkSettingsBase holds networking state for a container when inspecting it.
-//
-// Deprecated: [container.NetworkSettingsBase] will be removed in v29. Prefer
-// accessing the fields it contains through [container.NetworkSettings].
-type NetworkSettingsBase = container.NetworkSettingsBase //nolint:staticcheck // ignore SA1019: NetworkSettingsBase is deprecated in v28.4.
-
-// DefaultNetworkSettings holds network information
-// during the 2 release deprecation period.
-// It will be removed in Docker 1.11.
-//
-// Deprecated: use [container.DefaultNetworkSettings].
-type DefaultNetworkSettings = container.DefaultNetworkSettings //nolint:staticcheck // ignore SA1019: DefaultNetworkSettings is deprecated in v28.4.
-
-// SummaryNetworkSettings provides a summary of container's networks
-// in /containers/json.
-//
-// Deprecated: use [container.NetworkSettingsSummary].
-type SummaryNetworkSettings = container.NetworkSettingsSummary
-
-// Health states
-const (
- NoHealthcheck = container.NoHealthcheck // Deprecated: use [container.NoHealthcheck].
- Starting = container.Starting // Deprecated: use [container.Starting].
- Healthy = container.Healthy // Deprecated: use [container.Healthy].
- Unhealthy = container.Unhealthy // Deprecated: use [container.Unhealthy].
-)
-
-// Health stores information about the container's healthcheck results.
-//
-// Deprecated: use [container.Health].
-type Health = container.Health
-
-// HealthcheckResult stores information about a single run of a healthcheck probe.
-//
-// Deprecated: use [container.HealthcheckResult].
-type HealthcheckResult = container.HealthcheckResult
-
-// MountPoint represents a mount point configuration inside the container.
-// This is used for reporting the mountpoints in use by a container.
-//
-// Deprecated: use [container.MountPoint].
-type MountPoint = container.MountPoint
-
-// Port An open port on a container
-//
-// Deprecated: use [container.Port].
-type Port = container.Port
-
-// GraphDriverData Information about the storage driver used to store the container's and
-// image's filesystem.
-//
-// Deprecated: use [storage.DriverData].
-type GraphDriverData = storage.DriverData
-
-// RootFS returns Image's RootFS description including the layer IDs.
-//
-// Deprecated: use [image.RootFS].
-type RootFS = image.RootFS
-
-// ImageInspect contains response of Engine API:
-// GET "/images/{name:.*}/json"
-//
-// Deprecated: use [image.InspectResponse].
-type ImageInspect = image.InspectResponse
-
-// RequestPrivilegeFunc is a function interface that clients can supply to
-// retry operations after getting an authorization error.
-// This function returns the registry authentication header value in base64
-// format, or an error if the privilege request fails.
-//
-// Deprecated: moved to [github.com/docker/docker/api/types/registry.RequestAuthConfig].
-type RequestPrivilegeFunc func(context.Context) (string, error)
-
-// SecretCreateResponse contains the information returned to a client
-// on the creation of a new secret.
-//
-// Deprecated: use [swarm.SecretCreateResponse].
-type SecretCreateResponse = swarm.SecretCreateResponse
-
-// SecretListOptions holds parameters to list secrets
-//
-// Deprecated: use [swarm.SecretListOptions].
-type SecretListOptions = swarm.SecretListOptions
-
-// ConfigCreateResponse contains the information returned to a client
-// on the creation of a new config.
-//
-// Deprecated: use [swarm.ConfigCreateResponse].
-type ConfigCreateResponse = swarm.ConfigCreateResponse
-
-// ConfigListOptions holds parameters to list configs
-//
-// Deprecated: use [swarm.ConfigListOptions].
-type ConfigListOptions = swarm.ConfigListOptions
-
-// NodeListOptions holds parameters to list nodes with.
-//
-// Deprecated: use [swarm.NodeListOptions].
-type NodeListOptions = swarm.NodeListOptions
-
-// NodeRemoveOptions holds parameters to remove nodes with.
-//
-// Deprecated: use [swarm.NodeRemoveOptions].
-type NodeRemoveOptions = swarm.NodeRemoveOptions
-
-// TaskListOptions holds parameters to list tasks with.
-//
-// Deprecated: use [swarm.TaskListOptions].
-type TaskListOptions = swarm.TaskListOptions
-
-// ServiceCreateOptions contains the options to use when creating a service.
-//
-// Deprecated: use [swarm.ServiceCreateOptions].
-type ServiceCreateOptions = swarm.ServiceCreateOptions
-
-// ServiceUpdateOptions contains the options to be used for updating services.
-//
-// Deprecated: use [swarm.ServiceCreateOptions].
-type ServiceUpdateOptions = swarm.ServiceUpdateOptions
-
-const (
- RegistryAuthFromSpec = swarm.RegistryAuthFromSpec // Deprecated: use [swarm.RegistryAuthFromSpec].
- RegistryAuthFromPreviousSpec = swarm.RegistryAuthFromPreviousSpec // Deprecated: use [swarm.RegistryAuthFromPreviousSpec].
-)
-
-// ServiceListOptions holds parameters to list services with.
-//
-// Deprecated: use [swarm.ServiceListOptions].
-type ServiceListOptions = swarm.ServiceListOptions
-
-// ServiceInspectOptions holds parameters related to the "service inspect"
-// operation.
-//
-// Deprecated: use [swarm.ServiceInspectOptions].
-type ServiceInspectOptions = swarm.ServiceInspectOptions
-
-// SwarmUnlockKeyResponse contains the response for Engine API:
-// GET /swarm/unlockkey
-//
-// Deprecated: use [swarm.UnlockKeyResponse].
-type SwarmUnlockKeyResponse = swarm.UnlockKeyResponse
-
-// BuildCache contains information about a build cache record.
-//
-// Deprecated: deprecated in API 1.49. Use [build.CacheRecord] instead.
-type BuildCache = build.CacheRecord
-
-// BuildCachePruneOptions hold parameters to prune the build cache
-//
-// Deprecated: use [build.CachePruneOptions].
-type BuildCachePruneOptions = build.CachePruneOptions
-
-// BuildCachePruneReport contains the response for Engine API:
-// POST "/build/prune"
-//
-// Deprecated: use [build.CachePruneReport].
-type BuildCachePruneReport = build.CachePruneReport
-
-// BuildResult contains the image id of a successful build/
-//
-// Deprecated: use [build.Result].
-type BuildResult = build.Result
-
-// ImageBuildOptions holds the information
-// necessary to build images.
-//
-// Deprecated: use [build.ImageBuildOptions].
-type ImageBuildOptions = build.ImageBuildOptions
-
-// ImageBuildOutput defines configuration for exporting a build result
-//
-// Deprecated: use [build.ImageBuildOutput].
-type ImageBuildOutput = build.ImageBuildOutput
-
-// ImageBuildResponse holds information
-// returned by a server after building
-// an image.
-//
-// Deprecated: use [build.ImageBuildResponse].
-type ImageBuildResponse = build.ImageBuildResponse
-
-// BuilderVersion sets the version of underlying builder to use
-//
-// Deprecated: use [build.BuilderVersion].
-type BuilderVersion = build.BuilderVersion
-
-const (
- // BuilderV1 is the first generation builder in docker daemon
- //
- // Deprecated: use [build.BuilderV1].
- BuilderV1 = build.BuilderV1
- // BuilderBuildKit is builder based on moby/buildkit project
- //
- // Deprecated: use [build.BuilderBuildKit].
- BuilderBuildKit = build.BuilderBuildKit
-)
diff --git a/vendor/github.com/docker/docker/api/types/volume/cluster_volume.go b/vendor/github.com/docker/docker/api/types/volume/cluster_volume.go
deleted file mode 100644
index 618a4816..00000000
--- a/vendor/github.com/docker/docker/api/types/volume/cluster_volume.go
+++ /dev/null
@@ -1,420 +0,0 @@
-package volume
-
-import (
- "github.com/docker/docker/api/types/swarm"
-)
-
-// ClusterVolume contains options and information specific to, and only present
-// on, Swarm CSI cluster volumes.
-type ClusterVolume struct {
- // ID is the Swarm ID of the volume. Because cluster volumes are Swarm
- // objects, they have an ID, unlike non-cluster volumes, which only have a
- // Name. This ID can be used to refer to the cluster volume.
- ID string
-
- // Meta is the swarm metadata about this volume.
- swarm.Meta
-
- // Spec is the cluster-specific options from which this volume is derived.
- Spec ClusterVolumeSpec
-
- // PublishStatus contains the status of the volume as it pertains to its
- // publishing on Nodes.
- PublishStatus []*PublishStatus `json:",omitempty"`
-
- // Info is information about the global status of the volume.
- Info *Info `json:",omitempty"`
-}
-
-// ClusterVolumeSpec contains the spec used to create this volume.
-type ClusterVolumeSpec struct {
- // Group defines the volume group of this volume. Volumes belonging to the
- // same group can be referred to by group name when creating Services.
- // Referring to a volume by group instructs swarm to treat volumes in that
- // group interchangeably for the purpose of scheduling. Volumes with an
- // empty string for a group technically all belong to the same, emptystring
- // group.
- Group string `json:",omitempty"`
-
- // AccessMode defines how the volume is used by tasks.
- AccessMode *AccessMode `json:",omitempty"`
-
- // AccessibilityRequirements specifies where in the cluster a volume must
- // be accessible from.
- //
- // This field must be empty if the plugin does not support
- // VOLUME_ACCESSIBILITY_CONSTRAINTS capabilities. If it is present but the
- // plugin does not support it, volume will not be created.
- //
- // If AccessibilityRequirements is empty, but the plugin does support
- // VOLUME_ACCESSIBILITY_CONSTRAINTS, then Swarmkit will assume the entire
- // cluster is a valid target for the volume.
- AccessibilityRequirements *TopologyRequirement `json:",omitempty"`
-
- // CapacityRange defines the desired capacity that the volume should be
- // created with. If nil, the plugin will decide the capacity.
- CapacityRange *CapacityRange `json:",omitempty"`
-
- // Secrets defines Swarm Secrets that are passed to the CSI storage plugin
- // when operating on this volume.
- Secrets []Secret `json:",omitempty"`
-
- // Availability is the Volume's desired availability. Analogous to Node
- // Availability, this allows the user to take volumes offline in order to
- // update or delete them.
- Availability Availability `json:",omitempty"`
-}
-
-// Availability specifies the availability of the volume.
-type Availability string
-
-const (
- // AvailabilityActive indicates that the volume is active and fully
- // schedulable on the cluster.
- AvailabilityActive Availability = "active"
-
- // AvailabilityPause indicates that no new workloads should use the
- // volume, but existing workloads can continue to use it.
- AvailabilityPause Availability = "pause"
-
- // AvailabilityDrain indicates that all workloads using this volume
- // should be rescheduled, and the volume unpublished from all nodes.
- AvailabilityDrain Availability = "drain"
-)
-
-// AccessMode defines the access mode of a volume.
-type AccessMode struct {
- // Scope defines the set of nodes this volume can be used on at one time.
- Scope Scope `json:",omitempty"`
-
- // Sharing defines the number and way that different tasks can use this
- // volume at one time.
- Sharing SharingMode `json:",omitempty"`
-
- // MountVolume defines options for using this volume as a Mount-type
- // volume.
- //
- // Either BlockVolume or MountVolume, but not both, must be present.
- MountVolume *TypeMount `json:",omitempty"`
-
- // BlockVolume defines options for using this volume as a Block-type
- // volume.
- //
- // Either BlockVolume or MountVolume, but not both, must be present.
- BlockVolume *TypeBlock `json:",omitempty"`
-}
-
-// Scope defines the Scope of a Cluster Volume. This is how many nodes a
-// Volume can be accessed simultaneously on.
-type Scope string
-
-const (
- // ScopeSingleNode indicates the volume can be used on one node at a
- // time.
- ScopeSingleNode Scope = "single"
-
- // ScopeMultiNode indicates the volume can be used on many nodes at
- // the same time.
- ScopeMultiNode Scope = "multi"
-)
-
-// SharingMode defines the Sharing of a Cluster Volume. This is how Tasks using a
-// Volume at the same time can use it.
-type SharingMode string
-
-const (
- // SharingNone indicates that only one Task may use the Volume at a
- // time.
- SharingNone SharingMode = "none"
-
- // SharingReadOnly indicates that the Volume may be shared by any
- // number of Tasks, but they must be read-only.
- SharingReadOnly SharingMode = "readonly"
-
- // SharingOneWriter indicates that the Volume may be shared by any
- // number of Tasks, but all after the first must be read-only.
- SharingOneWriter SharingMode = "onewriter"
-
- // SharingAll means that the Volume may be shared by any number of
- // Tasks, as readers or writers.
- SharingAll SharingMode = "all"
-)
-
-// TypeBlock defines options for using a volume as a block-type volume.
-//
-// Intentionally empty.
-type TypeBlock struct{}
-
-// TypeMount contains options for using a volume as a Mount-type
-// volume.
-type TypeMount struct {
- // FsType specifies the filesystem type for the mount volume. Optional.
- FsType string `json:",omitempty"`
-
- // MountFlags defines flags to pass when mounting the volume. Optional.
- MountFlags []string `json:",omitempty"`
-}
-
-// TopologyRequirement expresses the user's requirements for a volume's
-// accessible topology.
-type TopologyRequirement struct {
- // Requisite specifies a list of Topologies, at least one of which the
- // volume must be accessible from.
- //
- // Taken verbatim from the CSI Spec:
- //
- // Specifies the list of topologies the provisioned volume MUST be
- // accessible from.
- // This field is OPTIONAL. If TopologyRequirement is specified either
- // requisite or preferred or both MUST be specified.
- //
- // If requisite is specified, the provisioned volume MUST be
- // accessible from at least one of the requisite topologies.
- //
- // Given
- // x = number of topologies provisioned volume is accessible from
- // n = number of requisite topologies
- // The CO MUST ensure n >= 1. The SP MUST ensure x >= 1
- // If x==n, then the SP MUST make the provisioned volume available to
- // all topologies from the list of requisite topologies. If it is
- // unable to do so, the SP MUST fail the CreateVolume call.
- // For example, if a volume should be accessible from a single zone,
- // and requisite =
- // {"region": "R1", "zone": "Z2"}
- // then the provisioned volume MUST be accessible from the "region"
- // "R1" and the "zone" "Z2".
- // Similarly, if a volume should be accessible from two zones, and
- // requisite =
- // {"region": "R1", "zone": "Z2"},
- // {"region": "R1", "zone": "Z3"}
- // then the provisioned volume MUST be accessible from the "region"
- // "R1" and both "zone" "Z2" and "zone" "Z3".
- //
- // If xn, then the SP MUST make the provisioned volume available from
- // all topologies from the list of requisite topologies and MAY choose
- // the remaining x-n unique topologies from the list of all possible
- // topologies. If it is unable to do so, the SP MUST fail the
- // CreateVolume call.
- // For example, if a volume should be accessible from two zones, and
- // requisite =
- // {"region": "R1", "zone": "Z2"}
- // then the provisioned volume MUST be accessible from the "region"
- // "R1" and the "zone" "Z2" and the SP may select the second zone
- // independently, e.g. "R1/Z4".
- Requisite []Topology `json:",omitempty"`
-
- // Preferred is a list of Topologies that the volume should attempt to be
- // provisioned in.
- //
- // Taken from the CSI spec:
- //
- // Specifies the list of topologies the CO would prefer the volume to
- // be provisioned in.
- //
- // This field is OPTIONAL. If TopologyRequirement is specified either
- // requisite or preferred or both MUST be specified.
- //
- // An SP MUST attempt to make the provisioned volume available using
- // the preferred topologies in order from first to last.
- //
- // If requisite is specified, all topologies in preferred list MUST
- // also be present in the list of requisite topologies.
- //
- // If the SP is unable to make the provisioned volume available
- // from any of the preferred topologies, the SP MAY choose a topology
- // from the list of requisite topologies.
- // If the list of requisite topologies is not specified, then the SP
- // MAY choose from the list of all possible topologies.
- // If the list of requisite topologies is specified and the SP is
- // unable to make the provisioned volume available from any of the
- // requisite topologies it MUST fail the CreateVolume call.
- //
- // Example 1:
- // Given a volume should be accessible from a single zone, and
- // requisite =
- // {"region": "R1", "zone": "Z2"},
- // {"region": "R1", "zone": "Z3"}
- // preferred =
- // {"region": "R1", "zone": "Z3"}
- // then the SP SHOULD first attempt to make the provisioned volume
- // available from "zone" "Z3" in the "region" "R1" and fall back to
- // "zone" "Z2" in the "region" "R1" if that is not possible.
- //
- // Example 2:
- // Given a volume should be accessible from a single zone, and
- // requisite =
- // {"region": "R1", "zone": "Z2"},
- // {"region": "R1", "zone": "Z3"},
- // {"region": "R1", "zone": "Z4"},
- // {"region": "R1", "zone": "Z5"}
- // preferred =
- // {"region": "R1", "zone": "Z4"},
- // {"region": "R1", "zone": "Z2"}
- // then the SP SHOULD first attempt to make the provisioned volume
- // accessible from "zone" "Z4" in the "region" "R1" and fall back to
- // "zone" "Z2" in the "region" "R1" if that is not possible. If that
- // is not possible, the SP may choose between either the "zone"
- // "Z3" or "Z5" in the "region" "R1".
- //
- // Example 3:
- // Given a volume should be accessible from TWO zones (because an
- // opaque parameter in CreateVolumeRequest, for example, specifies
- // the volume is accessible from two zones, aka synchronously
- // replicated), and
- // requisite =
- // {"region": "R1", "zone": "Z2"},
- // {"region": "R1", "zone": "Z3"},
- // {"region": "R1", "zone": "Z4"},
- // {"region": "R1", "zone": "Z5"}
- // preferred =
- // {"region": "R1", "zone": "Z5"},
- // {"region": "R1", "zone": "Z3"}
- // then the SP SHOULD first attempt to make the provisioned volume
- // accessible from the combination of the two "zones" "Z5" and "Z3" in
- // the "region" "R1". If that's not possible, it should fall back to
- // a combination of "Z5" and other possibilities from the list of
- // requisite. If that's not possible, it should fall back to a
- // combination of "Z3" and other possibilities from the list of
- // requisite. If that's not possible, it should fall back to a
- // combination of other possibilities from the list of requisite.
- Preferred []Topology `json:",omitempty"`
-}
-
-// Topology is a map of topological domains to topological segments.
-//
-// This description is taken verbatim from the CSI Spec:
-//
-// A topological domain is a sub-division of a cluster, like "region",
-// "zone", "rack", etc.
-// A topological segment is a specific instance of a topological domain,
-// like "zone3", "rack3", etc.
-// For example {"com.company/zone": "Z1", "com.company/rack": "R3"}
-// Valid keys have two segments: an OPTIONAL prefix and name, separated
-// by a slash (/), for example: "com.company.example/zone".
-// The key name segment is REQUIRED. The prefix is OPTIONAL.
-// The key name MUST be 63 characters or less, begin and end with an
-// alphanumeric character ([a-z0-9A-Z]), and contain only dashes (-),
-// underscores (_), dots (.), or alphanumerics in between, for example
-// "zone".
-// The key prefix MUST be 63 characters or less, begin and end with a
-// lower-case alphanumeric character ([a-z0-9]), contain only
-// dashes (-), dots (.), or lower-case alphanumerics in between, and
-// follow domain name notation format
-// (https://tools.ietf.org/html/rfc1035#section-2.3.1).
-// The key prefix SHOULD include the plugin's host company name and/or
-// the plugin name, to minimize the possibility of collisions with keys
-// from other plugins.
-// If a key prefix is specified, it MUST be identical across all
-// topology keys returned by the SP (across all RPCs).
-// Keys MUST be case-insensitive. Meaning the keys "Zone" and "zone"
-// MUST not both exist.
-// Each value (topological segment) MUST contain 1 or more strings.
-// Each string MUST be 63 characters or less and begin and end with an
-// alphanumeric character with '-', '_', '.', or alphanumerics in
-// between.
-type Topology struct {
- Segments map[string]string `json:",omitempty"`
-}
-
-// CapacityRange describes the minimum and maximum capacity a volume should be
-// created with
-type CapacityRange struct {
- // RequiredBytes specifies that a volume must be at least this big. The
- // value of 0 indicates an unspecified minimum.
- RequiredBytes int64
-
- // LimitBytes specifies that a volume must not be bigger than this. The
- // value of 0 indicates an unspecified maximum
- LimitBytes int64
-}
-
-// Secret represents a Swarm Secret value that must be passed to the CSI
-// storage plugin when operating on this Volume. It represents one key-value
-// pair of possibly many.
-type Secret struct {
- // Key is the name of the key of the key-value pair passed to the plugin.
- Key string
-
- // Secret is the swarm Secret object from which to read data. This can be a
- // Secret name or ID. The Secret data is retrieved by Swarm and used as the
- // value of the key-value pair passed to the plugin.
- Secret string
-}
-
-// PublishState represents the state of a Volume as it pertains to its
-// use on a particular Node.
-type PublishState string
-
-const (
- // StatePending indicates that the volume should be published on
- // this node, but the call to ControllerPublishVolume has not been
- // successfully completed yet and the result recorded by swarmkit.
- StatePending PublishState = "pending-publish"
-
- // StatePublished means the volume is published successfully to the node.
- StatePublished PublishState = "published"
-
- // StatePendingNodeUnpublish indicates that the Volume should be
- // unpublished on the Node, and we're waiting for confirmation that it has
- // done so. After the Node has confirmed that the Volume has been
- // unpublished, the state will move to StatePendingUnpublish.
- StatePendingNodeUnpublish PublishState = "pending-node-unpublish"
-
- // StatePendingUnpublish means the volume is still published to the node
- // by the controller, awaiting the operation to unpublish it.
- StatePendingUnpublish PublishState = "pending-controller-unpublish"
-)
-
-// PublishStatus represents the status of the volume as published to an
-// individual node
-type PublishStatus struct {
- // NodeID is the ID of the swarm node this Volume is published to.
- NodeID string `json:",omitempty"`
-
- // State is the publish state of the volume.
- State PublishState `json:",omitempty"`
-
- // PublishContext is the PublishContext returned by the CSI plugin when
- // a volume is published.
- PublishContext map[string]string `json:",omitempty"`
-}
-
-// Info contains information about the Volume as a whole as provided by
-// the CSI storage plugin.
-type Info struct {
- // CapacityBytes is the capacity of the volume in bytes. A value of 0
- // indicates that the capacity is unknown.
- CapacityBytes int64 `json:",omitempty"`
-
- // VolumeContext is the context originating from the CSI storage plugin
- // when the Volume is created.
- VolumeContext map[string]string `json:",omitempty"`
-
- // VolumeID is the ID of the Volume as seen by the CSI storage plugin. This
- // is distinct from the Volume's Swarm ID, which is the ID used by all of
- // the Docker Engine to refer to the Volume. If this field is blank, then
- // the Volume has not been successfully created yet.
- VolumeID string `json:",omitempty"`
-
- // AccessibleTopology is the topology this volume is actually accessible
- // from.
- AccessibleTopology []Topology `json:",omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/volume/create_options.go b/vendor/github.com/docker/docker/api/types/volume/create_options.go
deleted file mode 100644
index 37c41a60..00000000
--- a/vendor/github.com/docker/docker/api/types/volume/create_options.go
+++ /dev/null
@@ -1,29 +0,0 @@
-package volume
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// CreateOptions VolumeConfig
-//
-// Volume configuration
-// swagger:model CreateOptions
-type CreateOptions struct {
-
- // cluster volume spec
- ClusterVolumeSpec *ClusterVolumeSpec `json:"ClusterVolumeSpec,omitempty"`
-
- // 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, Docker generates a name.
- //
- Name string `json:"Name,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/volume/disk_usage.go b/vendor/github.com/docker/docker/api/types/volume/disk_usage.go
deleted file mode 100644
index 88974303..00000000
--- a/vendor/github.com/docker/docker/api/types/volume/disk_usage.go
+++ /dev/null
@@ -1,10 +0,0 @@
-package volume
-
-// DiskUsage contains disk usage for volumes.
-//
-// Deprecated: this type is no longer used and will be removed in the next release.
-type DiskUsage struct {
- TotalSize int64
- Reclaimable int64
- Items []*Volume
-}
diff --git a/vendor/github.com/docker/docker/api/types/volume/list_response.go b/vendor/github.com/docker/docker/api/types/volume/list_response.go
deleted file mode 100644
index ca5192a2..00000000
--- a/vendor/github.com/docker/docker/api/types/volume/list_response.go
+++ /dev/null
@@ -1,18 +0,0 @@
-package volume
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// ListResponse VolumeListResponse
-//
-// Volume list response
-// swagger:model ListResponse
-type ListResponse struct {
-
- // List of volumes
- Volumes []*Volume `json:"Volumes"`
-
- // Warnings that occurred when fetching the list of volumes.
- //
- Warnings []string `json:"Warnings"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/volume/options.go b/vendor/github.com/docker/docker/api/types/volume/options.go
deleted file mode 100644
index 875524fb..00000000
--- a/vendor/github.com/docker/docker/api/types/volume/options.go
+++ /dev/null
@@ -1,15 +0,0 @@
-package volume
-
-import "github.com/docker/docker/api/types/filters"
-
-// ListOptions holds parameters to list volumes.
-type ListOptions struct {
- Filters filters.Args
-}
-
-// PruneReport contains the response for Engine API:
-// POST "/volumes/prune"
-type PruneReport struct {
- VolumesDeleted []string
- SpaceReclaimed uint64
-}
diff --git a/vendor/github.com/docker/docker/api/types/volume/volume.go b/vendor/github.com/docker/docker/api/types/volume/volume.go
deleted file mode 100644
index ea7d555e..00000000
--- a/vendor/github.com/docker/docker/api/types/volume/volume.go
+++ /dev/null
@@ -1,75 +0,0 @@
-package volume
-
-// This file was generated by the swagger tool.
-// Editing this file might prove futile when you re-run the swagger generate command
-
-// Volume volume
-// swagger:model Volume
-type Volume struct {
-
- // cluster volume
- ClusterVolume *ClusterVolume `json:"ClusterVolume,omitempty"`
-
- // Date/Time the volume was created.
- CreatedAt string `json:"CreatedAt,omitempty"`
-
- // Name of the volume driver used by the volume.
- // Required: true
- Driver string `json:"Driver"`
-
- // User-defined key/value metadata.
- // Required: true
- Labels map[string]string `json:"Labels"`
-
- // Mount path of the volume on the host.
- // Required: true
- Mountpoint string `json:"Mountpoint"`
-
- // Name of the volume.
- // Required: true
- Name string `json:"Name"`
-
- // The driver specific options used when creating the volume.
- //
- // Required: true
- Options map[string]string `json:"Options"`
-
- // The level at which the volume exists. Either `global` for cluster-wide,
- // or `local` for machine level.
- //
- // Required: true
- Scope string `json:"Scope"`
-
- // Low-level details about the volume, provided by the volume driver.
- // Details are returned as a map with key/value pairs:
- // `{"key":"value","key2":"value2"}`.
- //
- // The `Status` field is optional, and is omitted if the volume driver
- // does not support this feature.
- //
- Status map[string]interface{} `json:"Status,omitempty"`
-
- // usage data
- UsageData *UsageData `json:"UsageData,omitempty"`
-}
-
-// UsageData Usage details about the volume. This information is used by the
-// `GET /system/df` endpoint, and omitted in other endpoints.
-//
-// swagger:model UsageData
-type UsageData struct {
-
- // The number of containers referencing this volume. This field
- // is set to `-1` if the reference-count is not available.
- //
- // Required: true
- RefCount int64 `json:"RefCount"`
-
- // Amount of disk space used by the volume (in bytes). This information
- // is only available for volumes created with the `"local"` volume
- // driver. For volumes created with other volume drivers, this field
- // is set to `-1` ("not available")
- //
- // Required: true
- Size int64 `json:"Size"`
-}
diff --git a/vendor/github.com/docker/docker/api/types/volume/volume_update.go b/vendor/github.com/docker/docker/api/types/volume/volume_update.go
deleted file mode 100644
index c26ed44c..00000000
--- a/vendor/github.com/docker/docker/api/types/volume/volume_update.go
+++ /dev/null
@@ -1,7 +0,0 @@
-package volume
-
-// UpdateOptions is configuration to update a Volume with.
-type UpdateOptions struct {
- // Spec is the ClusterVolumeSpec to update the volume to.
- Spec *ClusterVolumeSpec `json:"Spec,omitempty"`
-}
diff --git a/vendor/github.com/docker/docker/client/README.md b/vendor/github.com/docker/docker/client/README.md
deleted file mode 100644
index f8af3ab9..00000000
--- a/vendor/github.com/docker/docker/client/README.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# Go client for the Docker Engine API
-
-The `docker` command uses this package to communicate with the daemon. It can
-also be used by your own Go applications to do anything the command-line
-interface does – running containers, pulling images, managing swarms, etc.
-
-For example, to list all containers (the equivalent of `docker ps --all`):
-
-```go
-package main
-
-import (
- "context"
- "fmt"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/client"
-)
-
-func main() {
- apiClient, err := client.NewClientWithOpts(client.FromEnv)
- if err != nil {
- panic(err)
- }
- defer apiClient.Close()
-
- containers, err := apiClient.ContainerList(context.Background(), container.ListOptions{All: true})
- if err != nil {
- panic(err)
- }
-
- for _, ctr := range containers {
- fmt.Printf("%s %s (status: %s)\n", ctr.ID, ctr.Image, ctr.Status)
- }
-}
-```
-
-[Full documentation is available on pkg.go.dev.](https://pkg.go.dev/github.com/docker/docker/client)
diff --git a/vendor/github.com/docker/docker/client/build_cancel.go b/vendor/github.com/docker/docker/client/build_cancel.go
deleted file mode 100644
index a5eeb817..00000000
--- a/vendor/github.com/docker/docker/client/build_cancel.go
+++ /dev/null
@@ -1,16 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-)
-
-// BuildCancel requests the daemon to cancel the ongoing build request.
-func (cli *Client) BuildCancel(ctx context.Context, id string) error {
- query := url.Values{}
- query.Set("id", id)
-
- resp, err := cli.post(ctx, "/build/cancel", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/build_prune.go b/vendor/github.com/docker/docker/client/build_prune.go
deleted file mode 100644
index 6f0f59e3..00000000
--- a/vendor/github.com/docker/docker/client/build_prune.go
+++ /dev/null
@@ -1,56 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
- "strconv"
-
- "github.com/docker/docker/api/types/build"
- "github.com/docker/docker/api/types/filters"
- "github.com/pkg/errors"
-)
-
-// BuildCachePrune requests the daemon to delete unused cache data
-func (cli *Client) BuildCachePrune(ctx context.Context, opts build.CachePruneOptions) (*build.CachePruneReport, error) {
- if err := cli.NewVersionError(ctx, "1.31", "build prune"); err != nil {
- return nil, err
- }
-
- query := url.Values{}
- if opts.All {
- query.Set("all", "1")
- }
-
- if opts.KeepStorage != 0 {
- query.Set("keep-storage", strconv.Itoa(int(opts.KeepStorage)))
- }
- if opts.ReservedSpace != 0 {
- query.Set("reserved-space", strconv.Itoa(int(opts.ReservedSpace)))
- }
- if opts.MaxUsedSpace != 0 {
- query.Set("max-used-space", strconv.Itoa(int(opts.MaxUsedSpace)))
- }
- if opts.MinFreeSpace != 0 {
- query.Set("min-free-space", strconv.Itoa(int(opts.MinFreeSpace)))
- }
- f, err := filters.ToJSON(opts.Filters)
- if err != nil {
- return nil, errors.Wrap(err, "prune could not marshal filters option")
- }
- query.Set("filters", f)
-
- resp, err := cli.post(ctx, "/build/prune", query, nil, nil)
- defer ensureReaderClosed(resp)
-
- if err != nil {
- return nil, err
- }
-
- report := build.CachePruneReport{}
- if err := json.NewDecoder(resp.Body).Decode(&report); err != nil {
- return nil, errors.Wrap(err, "error retrieving disk usage")
- }
-
- return &report, nil
-}
diff --git a/vendor/github.com/docker/docker/client/checkpoint.go b/vendor/github.com/docker/docker/client/checkpoint.go
deleted file mode 100644
index d020574c..00000000
--- a/vendor/github.com/docker/docker/client/checkpoint.go
+++ /dev/null
@@ -1,18 +0,0 @@
-package client
-
-import (
- "context"
-
- "github.com/docker/docker/api/types/checkpoint"
-)
-
-// CheckpointAPIClient defines API client methods for the checkpoints.
-//
-// Experimental: checkpoint and restore is still an experimental feature,
-// and only available if the daemon is running with experimental features
-// enabled.
-type CheckpointAPIClient interface {
- CheckpointCreate(ctx context.Context, container string, options checkpoint.CreateOptions) error
- CheckpointDelete(ctx context.Context, container string, options checkpoint.DeleteOptions) error
- CheckpointList(ctx context.Context, container string, options checkpoint.ListOptions) ([]checkpoint.Summary, error)
-}
diff --git a/vendor/github.com/docker/docker/client/checkpoint_create.go b/vendor/github.com/docker/docker/client/checkpoint_create.go
deleted file mode 100644
index 961a5fe6..00000000
--- a/vendor/github.com/docker/docker/client/checkpoint_create.go
+++ /dev/null
@@ -1,19 +0,0 @@
-package client
-
-import (
- "context"
-
- "github.com/docker/docker/api/types/checkpoint"
-)
-
-// CheckpointCreate creates a checkpoint from the given container with the given name
-func (cli *Client) CheckpointCreate(ctx context.Context, containerID string, options checkpoint.CreateOptions) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- resp, err := cli.post(ctx, "/containers/"+containerID+"/checkpoints", nil, options, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/checkpoint_delete.go b/vendor/github.com/docker/docker/client/checkpoint_delete.go
deleted file mode 100644
index 4c51b25f..00000000
--- a/vendor/github.com/docker/docker/client/checkpoint_delete.go
+++ /dev/null
@@ -1,25 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/checkpoint"
-)
-
-// CheckpointDelete deletes the checkpoint with the given name from the given container
-func (cli *Client) CheckpointDelete(ctx context.Context, containerID string, options checkpoint.DeleteOptions) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if options.CheckpointDir != "" {
- query.Set("dir", options.CheckpointDir)
- }
-
- resp, err := cli.delete(ctx, "/containers/"+containerID+"/checkpoints/"+options.CheckpointID, query, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/checkpoint_list.go b/vendor/github.com/docker/docker/client/checkpoint_list.go
deleted file mode 100644
index 8164c766..00000000
--- a/vendor/github.com/docker/docker/client/checkpoint_list.go
+++ /dev/null
@@ -1,28 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/checkpoint"
-)
-
-// CheckpointList returns the checkpoints of the given container in the docker host
-func (cli *Client) CheckpointList(ctx context.Context, container string, options checkpoint.ListOptions) ([]checkpoint.Summary, error) {
- var checkpoints []checkpoint.Summary
-
- query := url.Values{}
- if options.CheckpointDir != "" {
- query.Set("dir", options.CheckpointDir)
- }
-
- resp, err := cli.get(ctx, "/containers/"+container+"/checkpoints", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return checkpoints, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&checkpoints)
- return checkpoints, err
-}
diff --git a/vendor/github.com/docker/docker/client/client.go b/vendor/github.com/docker/docker/client/client.go
deleted file mode 100644
index 8acfb7f4..00000000
--- a/vendor/github.com/docker/docker/client/client.go
+++ /dev/null
@@ -1,476 +0,0 @@
-/*
-Package client is a Go client for the Docker Engine API.
-
-For more information about the Engine API, see the documentation:
-https://docs.docker.com/reference/api/engine/
-
-# Usage
-
-You use the library by constructing a client object using [NewClientWithOpts]
-and calling methods on it. The client can be configured from environment
-variables by passing the [FromEnv] option, or configured manually by passing any
-of the other available [Opts].
-
-For example, to list running containers (the equivalent of "docker ps"):
-
- package main
-
- import (
- "context"
- "fmt"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/client"
- )
-
- func main() {
- cli, err := client.NewClientWithOpts(client.FromEnv)
- if err != nil {
- panic(err)
- }
-
- containers, err := cli.ContainerList(context.Background(), container.ListOptions{})
- if err != nil {
- panic(err)
- }
-
- for _, ctr := range containers {
- fmt.Printf("%s %s\n", ctr.ID, ctr.Image)
- }
- }
-*/
-package client
-
-import (
- "context"
- "crypto/tls"
- "net"
- "net/http"
- "net/url"
- "path"
- "strings"
- "sync"
- "sync/atomic"
- "time"
-
- "github.com/docker/docker/api"
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/versions"
- "github.com/docker/go-connections/sockets"
- "github.com/pkg/errors"
- "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
-)
-
-// DummyHost is a hostname used for local communication.
-//
-// It acts as a valid formatted hostname for local connections (such as "unix://"
-// or "npipe://") which do not require a hostname. It should never be resolved,
-// but uses the special-purpose ".localhost" TLD (as defined in [RFC 2606, Section 2]
-// and [RFC 6761, Section 6.3]).
-//
-// [RFC 7230, Section 5.4] defines that an empty header must be used for such
-// cases:
-//
-// If the authority component is missing or undefined for the target URI,
-// then a client MUST send a Host header field with an empty field-value.
-//
-// However, [Go stdlib] enforces the semantics of HTTP(S) over TCP, does not
-// allow an empty header to be used, and requires req.URL.Scheme to be either
-// "http" or "https".
-//
-// For further details, refer to:
-//
-// - https://github.com/docker/engine-api/issues/189
-// - https://github.com/golang/go/issues/13624
-// - https://github.com/golang/go/issues/61076
-// - https://github.com/moby/moby/issues/45935
-//
-// [RFC 2606, Section 2]: https://www.rfc-editor.org/rfc/rfc2606.html#section-2
-// [RFC 6761, Section 6.3]: https://www.rfc-editor.org/rfc/rfc6761#section-6.3
-// [RFC 7230, Section 5.4]: https://datatracker.ietf.org/doc/html/rfc7230#section-5.4
-// [Go stdlib]: https://github.com/golang/go/blob/6244b1946bc2101b01955468f1be502dbadd6807/src/net/http/transport.go#L558-L569
-const DummyHost = "api.moby.localhost"
-
-// fallbackAPIVersion is the version to fallback to if API-version negotiation
-// fails. This version is the highest version of the API before API-version
-// negotiation was introduced. If negotiation fails (or no API version was
-// included in the API response), we assume the API server uses the most
-// recent version before negotiation was introduced.
-const fallbackAPIVersion = "1.24"
-
-// Ensure that Client always implements APIClient.
-var _ APIClient = &Client{}
-
-// Client is the API client that performs all operations
-// against a docker server.
-type Client struct {
- // scheme sets the scheme for the client
- scheme string
- // host holds the server address to connect to
- host string
- // proto holds the client protocol i.e. unix.
- proto string
- // addr holds the client address.
- addr string
- // basePath holds the path to prepend to the requests.
- basePath string
- // client used to send and receive http requests.
- client *http.Client
- // version of the server to talk to.
- version string
- // userAgent is the User-Agent header to use for HTTP requests. It takes
- // precedence over User-Agent headers set in customHTTPHeaders, and other
- // header variables. When set to an empty string, the User-Agent header
- // is removed, and no header is sent.
- userAgent *string
- // custom HTTP headers configured by users.
- customHTTPHeaders map[string]string
- // manualOverride is set to true when the version was set by users.
- manualOverride bool
-
- // negotiateVersion indicates if the client should automatically negotiate
- // the API version to use when making requests. API version negotiation is
- // performed on the first request, after which negotiated is set to "true"
- // so that subsequent requests do not re-negotiate.
- negotiateVersion bool
-
- // negotiated indicates that API version negotiation took place
- negotiated atomic.Bool
-
- // negotiateLock is used to single-flight the version negotiation process
- negotiateLock sync.Mutex
-
- traceOpts []otelhttp.Option
-
- // When the client transport is an *http.Transport (default) we need to do some extra things (like closing idle connections).
- // Store the original transport as the http.Client transport will be wrapped with tracing libs.
- baseTransport *http.Transport
-}
-
-// ErrRedirect is the error returned by checkRedirect when the request is non-GET.
-var ErrRedirect = errors.New("unexpected redirect in response")
-
-// CheckRedirect specifies the policy for dealing with redirect responses. It
-// can be set on [http.Client.CheckRedirect] to prevent HTTP redirects for
-// non-GET requests. It returns an [ErrRedirect] for non-GET request, otherwise
-// returns a [http.ErrUseLastResponse], which is special-cased by http.Client
-// to use the last response.
-//
-// Go 1.8 changed behavior for HTTP redirects (specifically 301, 307, and 308)
-// in the client. The client (and by extension API client) can be made to send
-// a request like "POST /containers//start" where what would normally be in the
-// name section of the URL is empty. This triggers an HTTP 301 from the daemon.
-//
-// In go 1.8 this 301 is converted to a GET request, and ends up getting
-// a 404 from the daemon. This behavior change manifests in the client in that
-// before, the 301 was not followed and the client did not generate an error,
-// but now results in a message like "Error response from daemon: page not found".
-func CheckRedirect(_ *http.Request, via []*http.Request) error {
- if via[0].Method == http.MethodGet {
- return http.ErrUseLastResponse
- }
- return ErrRedirect
-}
-
-// NewClientWithOpts initializes a new API client with a default HTTPClient, and
-// default API host and version. It also initializes the custom HTTP headers to
-// add to each request.
-//
-// It takes an optional list of [Opt] functional arguments, which are applied in
-// the order they're provided, which allows modifying the defaults when creating
-// the client. For example, the following initializes a client that configures
-// itself with values from environment variables ([FromEnv]), and has automatic
-// API version negotiation enabled ([WithAPIVersionNegotiation]).
-//
-// cli, err := client.NewClientWithOpts(
-// client.FromEnv,
-// client.WithAPIVersionNegotiation(),
-// )
-func NewClientWithOpts(ops ...Opt) (*Client, error) {
- hostURL, err := ParseHostURL(DefaultDockerHost)
- if err != nil {
- return nil, err
- }
-
- client, err := defaultHTTPClient(hostURL)
- if err != nil {
- return nil, err
- }
- c := &Client{
- host: DefaultDockerHost,
- version: api.DefaultVersion,
- client: client,
- proto: hostURL.Scheme,
- addr: hostURL.Host,
-
- traceOpts: []otelhttp.Option{
- otelhttp.WithSpanNameFormatter(func(_ string, req *http.Request) string {
- return req.Method + " " + req.URL.Path
- }),
- },
- }
-
- for _, op := range ops {
- if err := op(c); err != nil {
- return nil, err
- }
- }
-
- if tr, ok := c.client.Transport.(*http.Transport); ok {
- // Store the base transport before we wrap it in tracing libs below
- // This is used, as an example, to close idle connections when the client is closed
- c.baseTransport = tr
- }
-
- if c.scheme == "" {
- // TODO(stevvooe): This isn't really the right way to write clients in Go.
- // `NewClient` should probably only take an `*http.Client` and work from there.
- // Unfortunately, the model of having a host-ish/url-thingy as the connection
- // string has us confusing protocol and transport layers. We continue doing
- // this to avoid breaking existing clients but this should be addressed.
- if c.tlsConfig() != nil {
- c.scheme = "https"
- } else {
- c.scheme = "http"
- }
- }
-
- c.client.Transport = otelhttp.NewTransport(c.client.Transport, c.traceOpts...)
-
- return c, nil
-}
-
-func (cli *Client) tlsConfig() *tls.Config {
- if cli.baseTransport == nil {
- return nil
- }
- return cli.baseTransport.TLSClientConfig
-}
-
-func defaultHTTPClient(hostURL *url.URL) (*http.Client, error) {
- transport := &http.Transport{}
- // Necessary to prevent long-lived processes using the
- // client from leaking connections due to idle connections
- // not being released.
- // TODO: see if we can also address this from the server side,
- // or in go-connections.
- // see: https://github.com/moby/moby/issues/45539
- transport.MaxIdleConns = 6
- transport.IdleConnTimeout = 30 * time.Second
- err := sockets.ConfigureTransport(transport, hostURL.Scheme, hostURL.Host)
- if err != nil {
- return nil, err
- }
- return &http.Client{
- Transport: transport,
- CheckRedirect: CheckRedirect,
- }, nil
-}
-
-// Close the transport used by the client
-func (cli *Client) Close() error {
- if cli.baseTransport != nil {
- cli.baseTransport.CloseIdleConnections()
- return nil
- }
- return nil
-}
-
-// checkVersion manually triggers API version negotiation (if configured).
-// This allows for version-dependent code to use the same version as will
-// be negotiated when making the actual requests, and for which cases
-// we cannot do the negotiation lazily.
-func (cli *Client) checkVersion(ctx context.Context) error {
- if !cli.manualOverride && cli.negotiateVersion && !cli.negotiated.Load() {
- // Ensure exclusive write access to version and negotiated fields
- cli.negotiateLock.Lock()
- defer cli.negotiateLock.Unlock()
-
- // May have been set during last execution of critical zone
- if cli.negotiated.Load() {
- return nil
- }
-
- ping, err := cli.Ping(ctx)
- if err != nil {
- return err
- }
- cli.negotiateAPIVersionPing(ping)
- }
- return nil
-}
-
-// getAPIPath returns the versioned request path to call the API.
-// It appends the query parameters to the path if they are not empty.
-func (cli *Client) getAPIPath(ctx context.Context, p string, query url.Values) string {
- var apiPath string
- _ = cli.checkVersion(ctx)
- if cli.version != "" {
- apiPath = path.Join(cli.basePath, "/v"+strings.TrimPrefix(cli.version, "v"), p)
- } else {
- apiPath = path.Join(cli.basePath, p)
- }
- return (&url.URL{Path: apiPath, RawQuery: query.Encode()}).String()
-}
-
-// ClientVersion returns the API version used by this client.
-func (cli *Client) ClientVersion() string {
- return cli.version
-}
-
-// NegotiateAPIVersion queries the API and updates the version to match the API
-// version. NegotiateAPIVersion downgrades the client's API version to match the
-// APIVersion if the ping version is lower than the default version. If the API
-// version reported by the server is higher than the maximum version supported
-// by the client, it uses the client's maximum version.
-//
-// If a manual override is in place, either through the "DOCKER_API_VERSION"
-// ([EnvOverrideAPIVersion]) environment variable, or if the client is initialized
-// with a fixed version ([WithVersion]), no negotiation is performed.
-//
-// If the API server's ping response does not contain an API version, or if the
-// client did not get a successful ping response, it assumes it is connected with
-// an old daemon that does not support API version negotiation, in which case it
-// downgrades to the latest version of the API before version negotiation was
-// added (1.24).
-func (cli *Client) NegotiateAPIVersion(ctx context.Context) {
- if !cli.manualOverride {
- // Avoid concurrent modification of version-related fields
- cli.negotiateLock.Lock()
- defer cli.negotiateLock.Unlock()
-
- ping, err := cli.Ping(ctx)
- if err != nil {
- // FIXME(thaJeztah): Ping returns an error when failing to connect to the API; we should not swallow the error here, and instead returning it.
- return
- }
- cli.negotiateAPIVersionPing(ping)
- }
-}
-
-// NegotiateAPIVersionPing downgrades the client's API version to match the
-// APIVersion in the ping response. If the API version in pingResponse is higher
-// than the maximum version supported by the client, it uses the client's maximum
-// version.
-//
-// If a manual override is in place, either through the "DOCKER_API_VERSION"
-// ([EnvOverrideAPIVersion]) environment variable, or if the client is initialized
-// with a fixed version ([WithVersion]), no negotiation is performed.
-//
-// If the API server's ping response does not contain an API version, we assume
-// we are connected with an old daemon without API version negotiation support,
-// and downgrade to the latest version of the API before version negotiation was
-// added (1.24).
-func (cli *Client) NegotiateAPIVersionPing(pingResponse types.Ping) {
- if !cli.manualOverride {
- // Avoid concurrent modification of version-related fields
- cli.negotiateLock.Lock()
- defer cli.negotiateLock.Unlock()
-
- cli.negotiateAPIVersionPing(pingResponse)
- }
-}
-
-// negotiateAPIVersionPing queries the API and updates the version to match the
-// API version from the ping response.
-func (cli *Client) negotiateAPIVersionPing(pingResponse types.Ping) {
- // default to the latest version before versioning headers existed
- if pingResponse.APIVersion == "" {
- pingResponse.APIVersion = fallbackAPIVersion
- }
-
- // if the client is not initialized with a version, start with the latest supported version
- if cli.version == "" {
- cli.version = api.DefaultVersion
- }
-
- // if server version is lower than the client version, downgrade
- if versions.LessThan(pingResponse.APIVersion, cli.version) {
- cli.version = pingResponse.APIVersion
- }
-
- // Store the results, so that automatic API version negotiation (if enabled)
- // won't be performed on the next request.
- if cli.negotiateVersion {
- cli.negotiated.Store(true)
- }
-}
-
-// DaemonHost returns the host address used by the client
-func (cli *Client) DaemonHost() string {
- return cli.host
-}
-
-// HTTPClient returns a copy of the HTTP client bound to the server
-func (cli *Client) HTTPClient() *http.Client {
- c := *cli.client
- return &c
-}
-
-// ParseHostURL parses a url string, validates the string is a host url, and
-// returns the parsed URL
-func ParseHostURL(host string) (*url.URL, error) {
- proto, addr, ok := strings.Cut(host, "://")
- if !ok || addr == "" {
- return nil, errors.Errorf("unable to parse docker host `%s`", host)
- }
-
- var basePath string
- if proto == "tcp" {
- parsed, err := url.Parse("tcp://" + addr)
- if err != nil {
- return nil, err
- }
- addr = parsed.Host
- basePath = parsed.Path
- }
- return &url.URL{
- Scheme: proto,
- Host: addr,
- Path: basePath,
- }, nil
-}
-
-func (cli *Client) dialerFromTransport() func(context.Context, string, string) (net.Conn, error) {
- if cli.baseTransport == nil || cli.baseTransport.DialContext == nil {
- return nil
- }
-
- if cli.baseTransport.TLSClientConfig != nil {
- // When using a tls config we don't use the configured dialer but instead a fallback dialer...
- // Note: It seems like this should use the normal dialer and wrap the returned net.Conn in a tls.Conn
- // I honestly don't know why it doesn't do that, but it doesn't and such a change is entirely unrelated to the change in this commit.
- return nil
- }
- return cli.baseTransport.DialContext
-}
-
-// Dialer returns a dialer for a raw stream connection, with an HTTP/1.1 header,
-// that can be used for proxying the daemon connection. It is used by
-// ["docker dial-stdio"].
-//
-// ["docker dial-stdio"]: https://github.com/docker/cli/pull/1014
-func (cli *Client) Dialer() func(context.Context) (net.Conn, error) {
- return cli.dialer()
-}
-
-func (cli *Client) dialer() func(context.Context) (net.Conn, error) {
- return func(ctx context.Context) (net.Conn, error) {
- if dialFn := cli.dialerFromTransport(); dialFn != nil {
- return dialFn(ctx, cli.proto, cli.addr)
- }
- switch cli.proto {
- case "unix":
- return net.Dial(cli.proto, cli.addr)
- case "npipe":
- ctx, cancel := context.WithTimeout(ctx, 32*time.Second)
- defer cancel()
- return dialPipeContext(ctx, cli.addr)
- default:
- if tlsConfig := cli.tlsConfig(); tlsConfig != nil {
- return tls.Dial(cli.proto, cli.addr, tlsConfig)
- }
- return net.Dial(cli.proto, cli.addr)
- }
- }
-}
diff --git a/vendor/github.com/docker/docker/client/client_deprecated.go b/vendor/github.com/docker/docker/client/client_deprecated.go
deleted file mode 100644
index 9e366ce2..00000000
--- a/vendor/github.com/docker/docker/client/client_deprecated.go
+++ /dev/null
@@ -1,27 +0,0 @@
-package client
-
-import "net/http"
-
-// NewClient initializes a new API client for the given host and API version.
-// It uses the given http client as transport.
-// It also initializes the custom http headers to add to each request.
-//
-// It won't send any version information if the version number is empty. It is
-// highly recommended that you set a version or your client may break if the
-// server is upgraded.
-//
-// Deprecated: use [NewClientWithOpts] passing the [WithHost], [WithVersion],
-// [WithHTTPClient] and [WithHTTPHeaders] options. We recommend enabling API
-// version negotiation by passing the [WithAPIVersionNegotiation] option instead
-// of WithVersion.
-func NewClient(host string, version string, client *http.Client, httpHeaders map[string]string) (*Client, error) {
- return NewClientWithOpts(WithHost(host), WithVersion(version), WithHTTPClient(client), WithHTTPHeaders(httpHeaders))
-}
-
-// NewEnvClient initializes a new API client based on environment variables.
-// See FromEnv for a list of support environment variables.
-//
-// Deprecated: use [NewClientWithOpts] passing the [FromEnv] option.
-func NewEnvClient() (*Client, error) {
- return NewClientWithOpts(FromEnv)
-}
diff --git a/vendor/github.com/docker/docker/client/client_interfaces.go b/vendor/github.com/docker/docker/client/client_interfaces.go
deleted file mode 100644
index df7aad43..00000000
--- a/vendor/github.com/docker/docker/client/client_interfaces.go
+++ /dev/null
@@ -1,237 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net"
- "net/http"
-
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/build"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/events"
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/image"
- "github.com/docker/docker/api/types/network"
- "github.com/docker/docker/api/types/registry"
- "github.com/docker/docker/api/types/swarm"
- "github.com/docker/docker/api/types/system"
- "github.com/docker/docker/api/types/volume"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-// CommonAPIClient is the common methods between stable and experimental versions of APIClient.
-//
-// Deprecated: use [APIClient] instead. This type will be an alias for [APIClient] in the next release, and removed after.
-type CommonAPIClient = stableAPIClient
-
-// APIClient is an interface that clients that talk with a docker server must implement.
-type APIClient interface {
- stableAPIClient
- CheckpointAPIClient // CheckpointAPIClient is still experimental.
-}
-
-type stableAPIClient interface {
- ConfigAPIClient
- ContainerAPIClient
- DistributionAPIClient
- ImageAPIClient
- NetworkAPIClient
- PluginAPIClient
- SystemAPIClient
- VolumeAPIClient
- ClientVersion() string
- DaemonHost() string
- HTTPClient() *http.Client
- ServerVersion(ctx context.Context) (types.Version, error)
- NegotiateAPIVersion(ctx context.Context)
- NegotiateAPIVersionPing(types.Ping)
- HijackDialer
- Dialer() func(context.Context) (net.Conn, error)
- Close() error
- SwarmManagementAPIClient
-}
-
-// SwarmManagementAPIClient defines all methods for managing Swarm-specific
-// objects.
-type SwarmManagementAPIClient interface {
- SwarmAPIClient
- NodeAPIClient
- ServiceAPIClient
- SecretAPIClient
- ConfigAPIClient
-}
-
-// HijackDialer defines methods for a hijack dialer.
-type HijackDialer interface {
- DialHijack(ctx context.Context, url, proto string, meta map[string][]string) (net.Conn, error)
-}
-
-// ContainerAPIClient defines API client methods for the containers
-type ContainerAPIClient interface {
- ContainerAttach(ctx context.Context, container string, options container.AttachOptions) (types.HijackedResponse, error)
- ContainerCommit(ctx context.Context, container string, options container.CommitOptions) (container.CommitResponse, error)
- ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, platform *ocispec.Platform, containerName string) (container.CreateResponse, error)
- ContainerDiff(ctx context.Context, container string) ([]container.FilesystemChange, error)
- ContainerExecAttach(ctx context.Context, execID string, options container.ExecAttachOptions) (types.HijackedResponse, error)
- ContainerExecCreate(ctx context.Context, container string, options container.ExecOptions) (container.ExecCreateResponse, error)
- ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error)
- ContainerExecResize(ctx context.Context, execID string, options container.ResizeOptions) error
- ContainerExecStart(ctx context.Context, execID string, options container.ExecStartOptions) error
- ContainerExport(ctx context.Context, container string) (io.ReadCloser, error)
- ContainerInspect(ctx context.Context, container string) (container.InspectResponse, error)
- ContainerInspectWithRaw(ctx context.Context, container string, getSize bool) (container.InspectResponse, []byte, error)
- ContainerKill(ctx context.Context, container, signal string) error
- ContainerList(ctx context.Context, options container.ListOptions) ([]container.Summary, error)
- ContainerLogs(ctx context.Context, container string, options container.LogsOptions) (io.ReadCloser, error)
- ContainerPause(ctx context.Context, container string) error
- ContainerRemove(ctx context.Context, container string, options container.RemoveOptions) error
- ContainerRename(ctx context.Context, container, newContainerName string) error
- ContainerResize(ctx context.Context, container string, options container.ResizeOptions) error
- ContainerRestart(ctx context.Context, container string, options container.StopOptions) error
- ContainerStatPath(ctx context.Context, container, path string) (container.PathStat, error)
- ContainerStats(ctx context.Context, container string, stream bool) (container.StatsResponseReader, error)
- ContainerStatsOneShot(ctx context.Context, container string) (container.StatsResponseReader, error)
- ContainerStart(ctx context.Context, container string, options container.StartOptions) error
- ContainerStop(ctx context.Context, container string, options container.StopOptions) error
- ContainerTop(ctx context.Context, container string, arguments []string) (container.TopResponse, error)
- ContainerUnpause(ctx context.Context, container string) error
- ContainerUpdate(ctx context.Context, container string, updateConfig container.UpdateConfig) (container.UpdateResponse, error)
- ContainerWait(ctx context.Context, container string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error)
- CopyFromContainer(ctx context.Context, container, srcPath string) (io.ReadCloser, container.PathStat, error)
- CopyToContainer(ctx context.Context, container, path string, content io.Reader, options container.CopyToContainerOptions) error
- ContainersPrune(ctx context.Context, pruneFilters filters.Args) (container.PruneReport, error)
-}
-
-// DistributionAPIClient defines API client methods for the registry
-type DistributionAPIClient interface {
- DistributionInspect(ctx context.Context, image, encodedRegistryAuth string) (registry.DistributionInspect, error)
-}
-
-// ImageAPIClient defines API client methods for the images
-type ImageAPIClient interface {
- ImageBuild(ctx context.Context, context io.Reader, options build.ImageBuildOptions) (build.ImageBuildResponse, error)
- BuildCachePrune(ctx context.Context, opts build.CachePruneOptions) (*build.CachePruneReport, error)
- BuildCancel(ctx context.Context, id string) error
- ImageCreate(ctx context.Context, parentReference string, options image.CreateOptions) (io.ReadCloser, error)
- ImageImport(ctx context.Context, source image.ImportSource, ref string, options image.ImportOptions) (io.ReadCloser, error)
-
- ImageList(ctx context.Context, options image.ListOptions) ([]image.Summary, error)
- ImagePull(ctx context.Context, ref string, options image.PullOptions) (io.ReadCloser, error)
- ImagePush(ctx context.Context, ref string, options image.PushOptions) (io.ReadCloser, error)
- ImageRemove(ctx context.Context, image string, options image.RemoveOptions) ([]image.DeleteResponse, error)
- ImageSearch(ctx context.Context, term string, options registry.SearchOptions) ([]registry.SearchResult, error)
- ImageTag(ctx context.Context, image, ref string) error
- ImagesPrune(ctx context.Context, pruneFilter filters.Args) (image.PruneReport, error)
-
- ImageInspect(ctx context.Context, image string, _ ...ImageInspectOption) (image.InspectResponse, error)
- ImageHistory(ctx context.Context, image string, _ ...ImageHistoryOption) ([]image.HistoryResponseItem, error)
- ImageLoad(ctx context.Context, input io.Reader, _ ...ImageLoadOption) (image.LoadResponse, error)
- ImageSave(ctx context.Context, images []string, _ ...ImageSaveOption) (io.ReadCloser, error)
-
- ImageAPIClientDeprecated
-}
-
-// ImageAPIClientDeprecated defines deprecated methods of the ImageAPIClient.
-type ImageAPIClientDeprecated interface {
- // ImageInspectWithRaw returns the image information and its raw representation.
- //
- // Deprecated: Use [Client.ImageInspect] instead. Raw response can be obtained using the [ImageInspectWithRawResponse] option.
- ImageInspectWithRaw(ctx context.Context, image string) (image.InspectResponse, []byte, error)
-}
-
-// NetworkAPIClient defines API client methods for the networks
-type NetworkAPIClient interface {
- NetworkConnect(ctx context.Context, network, container string, config *network.EndpointSettings) error
- NetworkCreate(ctx context.Context, name string, options network.CreateOptions) (network.CreateResponse, error)
- NetworkDisconnect(ctx context.Context, network, container string, force bool) error
- NetworkInspect(ctx context.Context, network string, options network.InspectOptions) (network.Inspect, error)
- NetworkInspectWithRaw(ctx context.Context, network string, options network.InspectOptions) (network.Inspect, []byte, error)
- NetworkList(ctx context.Context, options network.ListOptions) ([]network.Summary, error)
- NetworkRemove(ctx context.Context, network string) error
- NetworksPrune(ctx context.Context, pruneFilter filters.Args) (network.PruneReport, error)
-}
-
-// NodeAPIClient defines API client methods for the nodes
-type NodeAPIClient interface {
- NodeInspectWithRaw(ctx context.Context, nodeID string) (swarm.Node, []byte, error)
- NodeList(ctx context.Context, options swarm.NodeListOptions) ([]swarm.Node, error)
- NodeRemove(ctx context.Context, nodeID string, options swarm.NodeRemoveOptions) error
- NodeUpdate(ctx context.Context, nodeID string, version swarm.Version, node swarm.NodeSpec) error
-}
-
-// PluginAPIClient defines API client methods for the plugins
-type PluginAPIClient interface {
- PluginList(ctx context.Context, filter filters.Args) (types.PluginsListResponse, error)
- PluginRemove(ctx context.Context, name string, options types.PluginRemoveOptions) error
- PluginEnable(ctx context.Context, name string, options types.PluginEnableOptions) error
- PluginDisable(ctx context.Context, name string, options types.PluginDisableOptions) error
- PluginInstall(ctx context.Context, name string, options types.PluginInstallOptions) (io.ReadCloser, error)
- PluginUpgrade(ctx context.Context, name string, options types.PluginInstallOptions) (io.ReadCloser, error)
- PluginPush(ctx context.Context, name string, registryAuth string) (io.ReadCloser, error)
- PluginSet(ctx context.Context, name string, args []string) error
- PluginInspectWithRaw(ctx context.Context, name string) (*types.Plugin, []byte, error)
- PluginCreate(ctx context.Context, createContext io.Reader, options types.PluginCreateOptions) error
-}
-
-// ServiceAPIClient defines API client methods for the services
-type ServiceAPIClient interface {
- ServiceCreate(ctx context.Context, service swarm.ServiceSpec, options swarm.ServiceCreateOptions) (swarm.ServiceCreateResponse, error)
- ServiceInspectWithRaw(ctx context.Context, serviceID string, options swarm.ServiceInspectOptions) (swarm.Service, []byte, error)
- ServiceList(ctx context.Context, options swarm.ServiceListOptions) ([]swarm.Service, error)
- ServiceRemove(ctx context.Context, serviceID string) error
- ServiceUpdate(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options swarm.ServiceUpdateOptions) (swarm.ServiceUpdateResponse, error)
- ServiceLogs(ctx context.Context, serviceID string, options container.LogsOptions) (io.ReadCloser, error)
- TaskLogs(ctx context.Context, taskID string, options container.LogsOptions) (io.ReadCloser, error)
- TaskInspectWithRaw(ctx context.Context, taskID string) (swarm.Task, []byte, error)
- TaskList(ctx context.Context, options swarm.TaskListOptions) ([]swarm.Task, error)
-}
-
-// SwarmAPIClient defines API client methods for the swarm
-type SwarmAPIClient interface {
- SwarmInit(ctx context.Context, req swarm.InitRequest) (string, error)
- SwarmJoin(ctx context.Context, req swarm.JoinRequest) error
- SwarmGetUnlockKey(ctx context.Context) (swarm.UnlockKeyResponse, error)
- SwarmUnlock(ctx context.Context, req swarm.UnlockRequest) error
- SwarmLeave(ctx context.Context, force bool) error
- SwarmInspect(ctx context.Context) (swarm.Swarm, error)
- SwarmUpdate(ctx context.Context, version swarm.Version, swarm swarm.Spec, flags swarm.UpdateFlags) error
-}
-
-// SystemAPIClient defines API client methods for the system
-type SystemAPIClient interface {
- Events(ctx context.Context, options events.ListOptions) (<-chan events.Message, <-chan error)
- Info(ctx context.Context) (system.Info, error)
- RegistryLogin(ctx context.Context, auth registry.AuthConfig) (registry.AuthenticateOKBody, error)
- DiskUsage(ctx context.Context, options types.DiskUsageOptions) (types.DiskUsage, error)
- Ping(ctx context.Context) (types.Ping, error)
-}
-
-// VolumeAPIClient defines API client methods for the volumes
-type VolumeAPIClient interface {
- VolumeCreate(ctx context.Context, options volume.CreateOptions) (volume.Volume, error)
- VolumeInspect(ctx context.Context, volumeID string) (volume.Volume, error)
- VolumeInspectWithRaw(ctx context.Context, volumeID string) (volume.Volume, []byte, error)
- VolumeList(ctx context.Context, options volume.ListOptions) (volume.ListResponse, error)
- VolumeRemove(ctx context.Context, volumeID string, force bool) error
- VolumesPrune(ctx context.Context, pruneFilter filters.Args) (volume.PruneReport, error)
- VolumeUpdate(ctx context.Context, volumeID string, version swarm.Version, options volume.UpdateOptions) error
-}
-
-// SecretAPIClient defines API client methods for secrets
-type SecretAPIClient interface {
- SecretList(ctx context.Context, options swarm.SecretListOptions) ([]swarm.Secret, error)
- SecretCreate(ctx context.Context, secret swarm.SecretSpec) (swarm.SecretCreateResponse, error)
- SecretRemove(ctx context.Context, id string) error
- SecretInspectWithRaw(ctx context.Context, name string) (swarm.Secret, []byte, error)
- SecretUpdate(ctx context.Context, id string, version swarm.Version, secret swarm.SecretSpec) error
-}
-
-// ConfigAPIClient defines API client methods for configs
-type ConfigAPIClient interface {
- ConfigList(ctx context.Context, options swarm.ConfigListOptions) ([]swarm.Config, error)
- ConfigCreate(ctx context.Context, config swarm.ConfigSpec) (swarm.ConfigCreateResponse, error)
- ConfigRemove(ctx context.Context, id string) error
- ConfigInspectWithRaw(ctx context.Context, name string) (swarm.Config, []byte, error)
- ConfigUpdate(ctx context.Context, id string, version swarm.Version, config swarm.ConfigSpec) error
-}
diff --git a/vendor/github.com/docker/docker/client/client_unix.go b/vendor/github.com/docker/docker/client/client_unix.go
deleted file mode 100644
index 1fb9fbfb..00000000
--- a/vendor/github.com/docker/docker/client/client_unix.go
+++ /dev/null
@@ -1,18 +0,0 @@
-//go:build !windows
-
-package client
-
-import (
- "context"
- "net"
- "syscall"
-)
-
-// DefaultDockerHost defines OS-specific default host if the DOCKER_HOST
-// (EnvOverrideHost) environment variable is unset or empty.
-const DefaultDockerHost = "unix:///var/run/docker.sock"
-
-// dialPipeContext connects to a Windows named pipe. It is not supported on non-Windows.
-func dialPipeContext(_ context.Context, _ string) (net.Conn, error) {
- return nil, syscall.EAFNOSUPPORT
-}
diff --git a/vendor/github.com/docker/docker/client/client_windows.go b/vendor/github.com/docker/docker/client/client_windows.go
deleted file mode 100644
index b471c061..00000000
--- a/vendor/github.com/docker/docker/client/client_windows.go
+++ /dev/null
@@ -1,17 +0,0 @@
-package client
-
-import (
- "context"
- "net"
-
- "github.com/Microsoft/go-winio"
-)
-
-// DefaultDockerHost defines OS-specific default host if the DOCKER_HOST
-// (EnvOverrideHost) environment variable is unset or empty.
-const DefaultDockerHost = "npipe:////./pipe/docker_engine"
-
-// dialPipeContext connects to a Windows named pipe. It is not supported on non-Windows.
-func dialPipeContext(ctx context.Context, addr string) (net.Conn, error) {
- return winio.DialPipeContext(ctx, addr)
-}
diff --git a/vendor/github.com/docker/docker/client/config_create.go b/vendor/github.com/docker/docker/client/config_create.go
deleted file mode 100644
index a39168e2..00000000
--- a/vendor/github.com/docker/docker/client/config_create.go
+++ /dev/null
@@ -1,24 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// ConfigCreate creates a new config.
-func (cli *Client) ConfigCreate(ctx context.Context, config swarm.ConfigSpec) (swarm.ConfigCreateResponse, error) {
- var response swarm.ConfigCreateResponse
- if err := cli.NewVersionError(ctx, "1.30", "config create"); err != nil {
- return response, err
- }
- resp, err := cli.post(ctx, "/configs/create", nil, config, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return response, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/config_inspect.go b/vendor/github.com/docker/docker/client/config_inspect.go
deleted file mode 100644
index a9f0a8b0..00000000
--- a/vendor/github.com/docker/docker/client/config_inspect.go
+++ /dev/null
@@ -1,37 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "io"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// ConfigInspectWithRaw returns the config information with raw data
-func (cli *Client) ConfigInspectWithRaw(ctx context.Context, id string) (swarm.Config, []byte, error) {
- id, err := trimID("contig", id)
- if err != nil {
- return swarm.Config{}, nil, err
- }
- if err := cli.NewVersionError(ctx, "1.30", "config inspect"); err != nil {
- return swarm.Config{}, nil, err
- }
- resp, err := cli.get(ctx, "/configs/"+id, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.Config{}, nil, err
- }
-
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return swarm.Config{}, nil, err
- }
-
- var config swarm.Config
- rdr := bytes.NewReader(body)
- err = json.NewDecoder(rdr).Decode(&config)
-
- return config, body, err
-}
diff --git a/vendor/github.com/docker/docker/client/config_list.go b/vendor/github.com/docker/docker/client/config_list.go
deleted file mode 100644
index 6f8a1c21..00000000
--- a/vendor/github.com/docker/docker/client/config_list.go
+++ /dev/null
@@ -1,37 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/swarm"
-)
-
-// ConfigList returns the list of configs.
-func (cli *Client) ConfigList(ctx context.Context, options swarm.ConfigListOptions) ([]swarm.Config, error) {
- if err := cli.NewVersionError(ctx, "1.30", "config list"); err != nil {
- return nil, err
- }
- query := url.Values{}
-
- if options.Filters.Len() > 0 {
- filterJSON, err := filters.ToJSON(options.Filters)
- if err != nil {
- return nil, err
- }
-
- query.Set("filters", filterJSON)
- }
-
- resp, err := cli.get(ctx, "/configs", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var configs []swarm.Config
- err = json.NewDecoder(resp.Body).Decode(&configs)
- return configs, err
-}
diff --git a/vendor/github.com/docker/docker/client/config_remove.go b/vendor/github.com/docker/docker/client/config_remove.go
deleted file mode 100644
index 99d33b1c..00000000
--- a/vendor/github.com/docker/docker/client/config_remove.go
+++ /dev/null
@@ -1,17 +0,0 @@
-package client
-
-import "context"
-
-// ConfigRemove removes a config.
-func (cli *Client) ConfigRemove(ctx context.Context, id string) error {
- id, err := trimID("config", id)
- if err != nil {
- return err
- }
- if err := cli.NewVersionError(ctx, "1.30", "config remove"); err != nil {
- return err
- }
- resp, err := cli.delete(ctx, "/configs/"+id, nil, nil)
- defer ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/config_update.go b/vendor/github.com/docker/docker/client/config_update.go
deleted file mode 100644
index 9bc137f7..00000000
--- a/vendor/github.com/docker/docker/client/config_update.go
+++ /dev/null
@@ -1,24 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// ConfigUpdate attempts to update a config
-func (cli *Client) ConfigUpdate(ctx context.Context, id string, version swarm.Version, config swarm.ConfigSpec) error {
- id, err := trimID("config", id)
- if err != nil {
- return err
- }
- if err := cli.NewVersionError(ctx, "1.30", "config update"); err != nil {
- return err
- }
- query := url.Values{}
- query.Set("version", version.String())
- resp, err := cli.post(ctx, "/configs/"+id+"/update", query, config, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_attach.go b/vendor/github.com/docker/docker/client/container_attach.go
deleted file mode 100644
index 1fb3493e..00000000
--- a/vendor/github.com/docker/docker/client/container_attach.go
+++ /dev/null
@@ -1,65 +0,0 @@
-package client
-
-import (
- "context"
- "net/http"
- "net/url"
-
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerAttach attaches a connection to a container in the server.
-// It returns a types.HijackedConnection with the hijacked connection
-// and the a reader to get output. It's up to the called to close
-// the hijacked connection by calling types.HijackedResponse.Close.
-//
-// The stream format on the response will be in one of two formats:
-//
-// If the container is using a TTY, there is only a single stream (stdout), and
-// data is copied directly from the container output stream, no extra
-// multiplexing or headers.
-//
-// If the container is *not* using a TTY, streams for stdout and stderr are
-// multiplexed.
-// The format of the multiplexed stream is as follows:
-//
-// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT}
-//
-// STREAM_TYPE can be 1 for stdout and 2 for stderr
-//
-// SIZE1, SIZE2, SIZE3, and SIZE4 are four bytes of uint32 encoded as big endian.
-// This is the size of OUTPUT.
-//
-// You can use github.com/docker/docker/pkg/stdcopy.StdCopy to demultiplex this
-// stream.
-func (cli *Client) ContainerAttach(ctx context.Context, containerID string, options container.AttachOptions) (types.HijackedResponse, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return types.HijackedResponse{}, err
- }
-
- query := url.Values{}
- if options.Stream {
- query.Set("stream", "1")
- }
- if options.Stdin {
- query.Set("stdin", "1")
- }
- if options.Stdout {
- query.Set("stdout", "1")
- }
- if options.Stderr {
- query.Set("stderr", "1")
- }
- if options.DetachKeys != "" {
- query.Set("detachKeys", options.DetachKeys)
- }
- if options.Logs {
- query.Set("logs", "1")
- }
-
- return cli.postHijacked(ctx, "/containers/"+containerID+"/attach", query, nil, http.Header{
- "Content-Type": {"text/plain"},
- })
-}
diff --git a/vendor/github.com/docker/docker/client/container_commit.go b/vendor/github.com/docker/docker/client/container_commit.go
deleted file mode 100644
index 2b5b9852..00000000
--- a/vendor/github.com/docker/docker/client/container_commit.go
+++ /dev/null
@@ -1,60 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "errors"
- "net/url"
-
- "github.com/distribution/reference"
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerCommit applies changes to a container and creates a new tagged image.
-func (cli *Client) ContainerCommit(ctx context.Context, containerID string, options container.CommitOptions) (container.CommitResponse, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.CommitResponse{}, err
- }
-
- var repository, tag string
- if options.Reference != "" {
- ref, err := reference.ParseNormalizedNamed(options.Reference)
- if err != nil {
- return container.CommitResponse{}, err
- }
-
- if _, isCanonical := ref.(reference.Canonical); isCanonical {
- return container.CommitResponse{}, errors.New("refusing to create a tag with a digest reference")
- }
- ref = reference.TagNameOnly(ref)
-
- if tagged, ok := ref.(reference.Tagged); ok {
- tag = tagged.Tag()
- }
- repository = ref.Name()
- }
-
- query := url.Values{}
- query.Set("container", containerID)
- query.Set("repo", repository)
- query.Set("tag", tag)
- query.Set("comment", options.Comment)
- query.Set("author", options.Author)
- for _, change := range options.Changes {
- query.Add("changes", change)
- }
- if !options.Pause {
- query.Set("pause", "0")
- }
-
- var response container.CommitResponse
- resp, err := cli.post(ctx, "/commit", query, options.Config, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return response, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/container_copy.go b/vendor/github.com/docker/docker/client/container_copy.go
deleted file mode 100644
index 7c4130dc..00000000
--- a/vendor/github.com/docker/docker/client/container_copy.go
+++ /dev/null
@@ -1,104 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/base64"
- "encoding/json"
- "fmt"
- "io"
- "net/http"
- "net/url"
- "path/filepath"
- "strings"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerStatPath returns stat information about a path inside the container filesystem.
-func (cli *Client) ContainerStatPath(ctx context.Context, containerID, path string) (container.PathStat, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.PathStat{}, err
- }
-
- query := url.Values{}
- query.Set("path", filepath.ToSlash(path)) // Normalize the paths used in the API.
-
- resp, err := cli.head(ctx, "/containers/"+containerID+"/archive", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return container.PathStat{}, err
- }
- return getContainerPathStatFromHeader(resp.Header)
-}
-
-// CopyToContainer copies content into the container filesystem.
-// Note that `content` must be a Reader for a TAR archive
-func (cli *Client) CopyToContainer(ctx context.Context, containerID, dstPath string, content io.Reader, options container.CopyToContainerOptions) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- query.Set("path", filepath.ToSlash(dstPath)) // Normalize the paths used in the API.
- // Do not allow for an existing directory to be overwritten by a non-directory and vice versa.
- if !options.AllowOverwriteDirWithFile {
- query.Set("noOverwriteDirNonDir", "true")
- }
-
- if options.CopyUIDGID {
- query.Set("copyUIDGID", "true")
- }
-
- response, err := cli.putRaw(ctx, "/containers/"+containerID+"/archive", query, content, nil)
- defer ensureReaderClosed(response)
- if err != nil {
- return err
- }
-
- return nil
-}
-
-// CopyFromContainer gets the content from the container and returns it as a Reader
-// for a TAR archive to manipulate it in the host. It's up to the caller to close the reader.
-func (cli *Client) CopyFromContainer(ctx context.Context, containerID, srcPath string) (io.ReadCloser, container.PathStat, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return nil, container.PathStat{}, err
- }
-
- query := make(url.Values, 1)
- query.Set("path", filepath.ToSlash(srcPath)) // Normalize the paths used in the API.
-
- resp, err := cli.get(ctx, "/containers/"+containerID+"/archive", query, nil)
- if err != nil {
- return nil, container.PathStat{}, err
- }
-
- // In order to get the copy behavior right, we need to know information
- // about both the source and the destination. The response headers include
- // stat info about the source that we can use in deciding exactly how to
- // copy it locally. Along with the stat info about the local destination,
- // we have everything we need to handle the multiple possibilities there
- // can be when copying a file/dir from one location to another file/dir.
- stat, err := getContainerPathStatFromHeader(resp.Header)
- if err != nil {
- return nil, stat, fmt.Errorf("unable to get resource stat from response: %s", err)
- }
- return resp.Body, stat, err
-}
-
-func getContainerPathStatFromHeader(header http.Header) (container.PathStat, error) {
- var stat container.PathStat
-
- encodedStat := header.Get("X-Docker-Container-Path-Stat")
- statDecoder := base64.NewDecoder(base64.StdEncoding, strings.NewReader(encodedStat))
-
- err := json.NewDecoder(statDecoder).Decode(&stat)
- if err != nil {
- err = fmt.Errorf("unable to decode container path stat header: %s", err)
- }
-
- return stat, err
-}
diff --git a/vendor/github.com/docker/docker/client/container_create.go b/vendor/github.com/docker/docker/client/container_create.go
deleted file mode 100644
index 0625cb12..00000000
--- a/vendor/github.com/docker/docker/client/container_create.go
+++ /dev/null
@@ -1,168 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "errors"
- "net/url"
- "path"
- "sort"
- "strings"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/network"
- "github.com/docker/docker/api/types/versions"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-// ContainerCreate creates a new container based on the given configuration.
-// It can be associated with a name, but it's not mandatory.
-func (cli *Client) ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, platform *ocispec.Platform, containerName string) (container.CreateResponse, error) {
- var response container.CreateResponse
-
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return response, err
- }
-
- if err := cli.NewVersionError(ctx, "1.25", "stop timeout"); config != nil && config.StopTimeout != nil && err != nil {
- return response, err
- }
- if err := cli.NewVersionError(ctx, "1.41", "specify container image platform"); platform != nil && err != nil {
- return response, err
- }
- if err := cli.NewVersionError(ctx, "1.44", "specify health-check start interval"); config != nil && config.Healthcheck != nil && config.Healthcheck.StartInterval != 0 && err != nil {
- return response, err
- }
- if err := cli.NewVersionError(ctx, "1.44", "specify mac-address per network"); hasEndpointSpecificMacAddress(networkingConfig) && err != nil {
- return response, err
- }
-
- if hostConfig != nil {
- if versions.LessThan(cli.ClientVersion(), "1.25") {
- // When using API 1.24 and under, the client is responsible for removing the container
- hostConfig.AutoRemove = false
- }
- if versions.GreaterThanOrEqualTo(cli.ClientVersion(), "1.42") || versions.LessThan(cli.ClientVersion(), "1.40") {
- // KernelMemory was added in API 1.40, and deprecated in API 1.42
- hostConfig.KernelMemory = 0
- }
- if platform != nil && platform.OS == "linux" && versions.LessThan(cli.ClientVersion(), "1.42") {
- // When using API under 1.42, the Linux daemon doesn't respect the ConsoleSize
- hostConfig.ConsoleSize = [2]uint{0, 0}
- }
- if versions.LessThan(cli.ClientVersion(), "1.44") {
- for _, m := range hostConfig.Mounts {
- if m.BindOptions != nil {
- // ReadOnlyNonRecursive can be safely ignored when API < 1.44
- if m.BindOptions.ReadOnlyForceRecursive {
- return response, errors.New("bind-recursive=readonly requires API v1.44 or later")
- }
- if m.BindOptions.NonRecursive && versions.LessThan(cli.ClientVersion(), "1.40") {
- return response, errors.New("bind-recursive=disabled requires API v1.40 or later")
- }
- }
- }
- }
-
- hostConfig.CapAdd = normalizeCapabilities(hostConfig.CapAdd)
- hostConfig.CapDrop = normalizeCapabilities(hostConfig.CapDrop)
- }
-
- // Since API 1.44, the container-wide MacAddress is deprecated and will trigger a WARNING if it's specified.
- if versions.GreaterThanOrEqualTo(cli.ClientVersion(), "1.44") {
- config.MacAddress = "" //nolint:staticcheck // ignore SA1019: field is deprecated, but still used on API < v1.44.
- }
-
- query := url.Values{}
- if p := formatPlatform(platform); p != "" {
- query.Set("platform", p)
- }
-
- if containerName != "" {
- query.Set("name", containerName)
- }
-
- body := container.CreateRequest{
- Config: config,
- HostConfig: hostConfig,
- NetworkingConfig: networkingConfig,
- }
-
- resp, err := cli.post(ctx, "/containers/create", query, body, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return response, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
-
-// formatPlatform returns a formatted string representing platform (e.g. linux/arm/v7).
-//
-// Similar to containerd's platforms.Format(), but does allow components to be
-// omitted (e.g. pass "architecture" only, without "os":
-// https://github.com/containerd/containerd/blob/v1.5.2/platforms/platforms.go#L243-L263
-func formatPlatform(platform *ocispec.Platform) string {
- if platform == nil {
- return ""
- }
- return path.Join(platform.OS, platform.Architecture, platform.Variant)
-}
-
-// hasEndpointSpecificMacAddress checks whether one of the endpoint in networkingConfig has a MacAddress defined.
-func hasEndpointSpecificMacAddress(networkingConfig *network.NetworkingConfig) bool {
- if networkingConfig == nil {
- return false
- }
- for _, endpoint := range networkingConfig.EndpointsConfig {
- if endpoint.MacAddress != "" {
- return true
- }
- }
- return false
-}
-
-// allCapabilities is a magic value for "all capabilities"
-const allCapabilities = "ALL"
-
-// normalizeCapabilities normalizes capabilities to their canonical form,
-// removes duplicates, and sorts the results.
-//
-// It is similar to [github.com/docker/docker/oci/caps.NormalizeLegacyCapabilities],
-// but performs no validation based on supported capabilities.
-func normalizeCapabilities(caps []string) []string {
- var normalized []string
-
- unique := make(map[string]struct{})
- for _, c := range caps {
- c = normalizeCap(c)
- if _, ok := unique[c]; ok {
- continue
- }
- unique[c] = struct{}{}
- normalized = append(normalized, c)
- }
-
- sort.Strings(normalized)
- return normalized
-}
-
-// normalizeCap normalizes a capability to its canonical format by upper-casing
-// and adding a "CAP_" prefix (if not yet present). It also accepts the "ALL"
-// magic-value.
-func normalizeCap(cap string) string {
- cap = strings.ToUpper(cap)
- if cap == allCapabilities {
- return cap
- }
- if !strings.HasPrefix(cap, "CAP_") {
- cap = "CAP_" + cap
- }
- return cap
-}
diff --git a/vendor/github.com/docker/docker/client/container_diff.go b/vendor/github.com/docker/docker/client/container_diff.go
deleted file mode 100644
index 3848e311..00000000
--- a/vendor/github.com/docker/docker/client/container_diff.go
+++ /dev/null
@@ -1,30 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerDiff shows differences in a container filesystem since it was started.
-func (cli *Client) ContainerDiff(ctx context.Context, containerID string) ([]container.FilesystemChange, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return nil, err
- }
-
- resp, err := cli.get(ctx, "/containers/"+containerID+"/changes", url.Values{}, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var changes []container.FilesystemChange
- err = json.NewDecoder(resp.Body).Decode(&changes)
- if err != nil {
- return nil, err
- }
- return changes, err
-}
diff --git a/vendor/github.com/docker/docker/client/container_exec.go b/vendor/github.com/docker/docker/client/container_exec.go
deleted file mode 100644
index 8abbf892..00000000
--- a/vendor/github.com/docker/docker/client/container_exec.go
+++ /dev/null
@@ -1,81 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/http"
-
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/versions"
-)
-
-// ContainerExecCreate creates a new exec configuration to run an exec process.
-func (cli *Client) ContainerExecCreate(ctx context.Context, containerID string, options container.ExecOptions) (container.ExecCreateResponse, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.ExecCreateResponse{}, err
- }
-
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return container.ExecCreateResponse{}, err
- }
-
- if err := cli.NewVersionError(ctx, "1.25", "env"); len(options.Env) != 0 && err != nil {
- return container.ExecCreateResponse{}, err
- }
- if versions.LessThan(cli.ClientVersion(), "1.42") {
- options.ConsoleSize = nil
- }
-
- resp, err := cli.post(ctx, "/containers/"+containerID+"/exec", nil, options, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return container.ExecCreateResponse{}, err
- }
-
- var response container.ExecCreateResponse
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
-
-// ContainerExecStart starts an exec process already created in the docker host.
-func (cli *Client) ContainerExecStart(ctx context.Context, execID string, config container.ExecStartOptions) error {
- if versions.LessThan(cli.ClientVersion(), "1.42") {
- config.ConsoleSize = nil
- }
- resp, err := cli.post(ctx, "/exec/"+execID+"/start", nil, config, nil)
- ensureReaderClosed(resp)
- return err
-}
-
-// ContainerExecAttach attaches a connection to an exec process in the server.
-// It returns a types.HijackedConnection with the hijacked connection
-// and the a reader to get output. It's up to the called to close
-// the hijacked connection by calling types.HijackedResponse.Close.
-func (cli *Client) ContainerExecAttach(ctx context.Context, execID string, config container.ExecAttachOptions) (types.HijackedResponse, error) {
- if versions.LessThan(cli.ClientVersion(), "1.42") {
- config.ConsoleSize = nil
- }
- return cli.postHijacked(ctx, "/exec/"+execID+"/start", nil, config, http.Header{
- "Content-Type": {"application/json"},
- })
-}
-
-// ContainerExecInspect returns information about a specific exec process on the docker host.
-func (cli *Client) ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error) {
- var response container.ExecInspect
- resp, err := cli.get(ctx, "/exec/"+execID+"/json", nil, nil)
- if err != nil {
- return response, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&response)
- ensureReaderClosed(resp)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/container_export.go b/vendor/github.com/docker/docker/client/container_export.go
deleted file mode 100644
index 3fc4d570..00000000
--- a/vendor/github.com/docker/docker/client/container_export.go
+++ /dev/null
@@ -1,24 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/url"
-)
-
-// ContainerExport retrieves the raw contents of a container
-// and returns them as an io.ReadCloser. It's up to the caller
-// to close the stream.
-func (cli *Client) ContainerExport(ctx context.Context, containerID string) (io.ReadCloser, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return nil, err
- }
-
- resp, err := cli.get(ctx, "/containers/"+containerID+"/export", url.Values{}, nil)
- if err != nil {
- return nil, err
- }
-
- return resp.Body, nil
-}
diff --git a/vendor/github.com/docker/docker/client/container_inspect.go b/vendor/github.com/docker/docker/client/container_inspect.go
deleted file mode 100644
index 18ccdf23..00000000
--- a/vendor/github.com/docker/docker/client/container_inspect.go
+++ /dev/null
@@ -1,57 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "io"
- "net/url"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerInspect returns the container information.
-func (cli *Client) ContainerInspect(ctx context.Context, containerID string) (container.InspectResponse, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.InspectResponse{}, err
- }
-
- resp, err := cli.get(ctx, "/containers/"+containerID+"/json", nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return container.InspectResponse{}, err
- }
-
- var response container.InspectResponse
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
-
-// ContainerInspectWithRaw returns the container information and its raw representation.
-func (cli *Client) ContainerInspectWithRaw(ctx context.Context, containerID string, getSize bool) (container.InspectResponse, []byte, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.InspectResponse{}, nil, err
- }
-
- query := url.Values{}
- if getSize {
- query.Set("size", "1")
- }
- resp, err := cli.get(ctx, "/containers/"+containerID+"/json", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return container.InspectResponse{}, nil, err
- }
-
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return container.InspectResponse{}, nil, err
- }
-
- var response container.InspectResponse
- rdr := bytes.NewReader(body)
- err = json.NewDecoder(rdr).Decode(&response)
- return response, body, err
-}
diff --git a/vendor/github.com/docker/docker/client/container_kill.go b/vendor/github.com/docker/docker/client/container_kill.go
deleted file mode 100644
index 251ae479..00000000
--- a/vendor/github.com/docker/docker/client/container_kill.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-)
-
-// ContainerKill terminates the container process but does not remove the container from the docker host.
-func (cli *Client) ContainerKill(ctx context.Context, containerID, signal string) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if signal != "" {
- query.Set("signal", signal)
- }
-
- resp, err := cli.post(ctx, "/containers/"+containerID+"/kill", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_list.go b/vendor/github.com/docker/docker/client/container_list.go
deleted file mode 100644
index e17b14ac..00000000
--- a/vendor/github.com/docker/docker/client/container_list.go
+++ /dev/null
@@ -1,56 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
- "strconv"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/filters"
-)
-
-// ContainerList returns the list of containers in the docker host.
-func (cli *Client) ContainerList(ctx context.Context, options container.ListOptions) ([]container.Summary, error) {
- query := url.Values{}
-
- if options.All {
- query.Set("all", "1")
- }
-
- if options.Limit > 0 {
- query.Set("limit", strconv.Itoa(options.Limit))
- }
-
- if options.Since != "" {
- query.Set("since", options.Since)
- }
-
- if options.Before != "" {
- query.Set("before", options.Before)
- }
-
- if options.Size {
- query.Set("size", "1")
- }
-
- if options.Filters.Len() > 0 {
- //nolint:staticcheck // ignore SA1019 for old code
- filterJSON, err := filters.ToParamWithVersion(cli.version, options.Filters)
- if err != nil {
- return nil, err
- }
-
- query.Set("filters", filterJSON)
- }
-
- resp, err := cli.get(ctx, "/containers/json", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var containers []container.Summary
- err = json.NewDecoder(resp.Body).Decode(&containers)
- return containers, err
-}
diff --git a/vendor/github.com/docker/docker/client/container_logs.go b/vendor/github.com/docker/docker/client/container_logs.go
deleted file mode 100644
index 3ea1f68d..00000000
--- a/vendor/github.com/docker/docker/client/container_logs.go
+++ /dev/null
@@ -1,85 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/url"
- "time"
-
- "github.com/docker/docker/api/types/container"
- timetypes "github.com/docker/docker/api/types/time"
- "github.com/pkg/errors"
-)
-
-// ContainerLogs returns the logs generated by a container in an io.ReadCloser.
-// It's up to the caller to close the stream.
-//
-// The stream format on the response will be in one of two formats:
-//
-// If the container is using a TTY, there is only a single stream (stdout), and
-// data is copied directly from the container output stream, no extra
-// multiplexing or headers.
-//
-// If the container is *not* using a TTY, streams for stdout and stderr are
-// multiplexed.
-// The format of the multiplexed stream is as follows:
-//
-// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT}
-//
-// STREAM_TYPE can be 1 for stdout and 2 for stderr
-//
-// SIZE1, SIZE2, SIZE3, and SIZE4 are four bytes of uint32 encoded as big endian.
-// This is the size of OUTPUT.
-//
-// You can use github.com/docker/docker/pkg/stdcopy.StdCopy to demultiplex this
-// stream.
-func (cli *Client) ContainerLogs(ctx context.Context, containerID string, options container.LogsOptions) (io.ReadCloser, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return nil, err
- }
-
- query := url.Values{}
- if options.ShowStdout {
- query.Set("stdout", "1")
- }
-
- if options.ShowStderr {
- query.Set("stderr", "1")
- }
-
- if options.Since != "" {
- ts, err := timetypes.GetTimestamp(options.Since, time.Now())
- if err != nil {
- return nil, errors.Wrap(err, `invalid value for "since"`)
- }
- query.Set("since", ts)
- }
-
- if options.Until != "" {
- ts, err := timetypes.GetTimestamp(options.Until, time.Now())
- if err != nil {
- return nil, errors.Wrap(err, `invalid value for "until"`)
- }
- query.Set("until", ts)
- }
-
- if options.Timestamps {
- query.Set("timestamps", "1")
- }
-
- if options.Details {
- query.Set("details", "1")
- }
-
- if options.Follow {
- query.Set("follow", "1")
- }
- query.Set("tail", options.Tail)
-
- resp, err := cli.get(ctx, "/containers/"+containerID+"/logs", query, nil)
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
diff --git a/vendor/github.com/docker/docker/client/container_pause.go b/vendor/github.com/docker/docker/client/container_pause.go
deleted file mode 100644
index 59b3e2d8..00000000
--- a/vendor/github.com/docker/docker/client/container_pause.go
+++ /dev/null
@@ -1,15 +0,0 @@
-package client
-
-import "context"
-
-// ContainerPause pauses the main process of a given container without terminating it.
-func (cli *Client) ContainerPause(ctx context.Context, containerID string) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- resp, err := cli.post(ctx, "/containers/"+containerID+"/pause", nil, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_prune.go b/vendor/github.com/docker/docker/client/container_prune.go
deleted file mode 100644
index 84fb6bc2..00000000
--- a/vendor/github.com/docker/docker/client/container_prune.go
+++ /dev/null
@@ -1,35 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "fmt"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/filters"
-)
-
-// ContainersPrune requests the daemon to delete unused data
-func (cli *Client) ContainersPrune(ctx context.Context, pruneFilters filters.Args) (container.PruneReport, error) {
- if err := cli.NewVersionError(ctx, "1.25", "container prune"); err != nil {
- return container.PruneReport{}, err
- }
-
- query, err := getFiltersQuery(pruneFilters)
- if err != nil {
- return container.PruneReport{}, err
- }
-
- resp, err := cli.post(ctx, "/containers/prune", query, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return container.PruneReport{}, err
- }
-
- var report container.PruneReport
- if err := json.NewDecoder(resp.Body).Decode(&report); err != nil {
- return container.PruneReport{}, fmt.Errorf("Error retrieving disk usage: %v", err)
- }
-
- return report, nil
-}
diff --git a/vendor/github.com/docker/docker/client/container_remove.go b/vendor/github.com/docker/docker/client/container_remove.go
deleted file mode 100644
index b1a2ce6b..00000000
--- a/vendor/github.com/docker/docker/client/container_remove.go
+++ /dev/null
@@ -1,32 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerRemove kills and removes a container from the docker host.
-func (cli *Client) ContainerRemove(ctx context.Context, containerID string, options container.RemoveOptions) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if options.RemoveVolumes {
- query.Set("v", "1")
- }
- if options.RemoveLinks {
- query.Set("link", "1")
- }
-
- if options.Force {
- query.Set("force", "1")
- }
-
- resp, err := cli.delete(ctx, "/containers/"+containerID, query, nil)
- defer ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_rename.go b/vendor/github.com/docker/docker/client/container_rename.go
deleted file mode 100644
index 4c030228..00000000
--- a/vendor/github.com/docker/docker/client/container_rename.go
+++ /dev/null
@@ -1,20 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-)
-
-// ContainerRename changes the name of a given container.
-func (cli *Client) ContainerRename(ctx context.Context, containerID, newContainerName string) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- query.Set("name", newContainerName)
- resp, err := cli.post(ctx, "/containers/"+containerID+"/rename", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_resize.go b/vendor/github.com/docker/docker/client/container_resize.go
deleted file mode 100644
index 56b7368b..00000000
--- a/vendor/github.com/docker/docker/client/container_resize.go
+++ /dev/null
@@ -1,38 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
- "strconv"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerResize changes the size of the tty for a container.
-func (cli *Client) ContainerResize(ctx context.Context, containerID string, options container.ResizeOptions) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
- return cli.resize(ctx, "/containers/"+containerID, options.Height, options.Width)
-}
-
-// ContainerExecResize changes the size of the tty for an exec process running inside a container.
-func (cli *Client) ContainerExecResize(ctx context.Context, execID string, options container.ResizeOptions) error {
- execID, err := trimID("exec", execID)
- if err != nil {
- return err
- }
- return cli.resize(ctx, "/exec/"+execID, options.Height, options.Width)
-}
-
-func (cli *Client) resize(ctx context.Context, basePath string, height, width uint) error {
- // FIXME(thaJeztah): the API / backend accepts uint32, but container.ResizeOptions uses uint.
- query := url.Values{}
- query.Set("h", strconv.FormatUint(uint64(height), 10))
- query.Set("w", strconv.FormatUint(uint64(width), 10))
-
- resp, err := cli.post(ctx, basePath+"/resize", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_restart.go b/vendor/github.com/docker/docker/client/container_restart.go
deleted file mode 100644
index 5af07bfc..00000000
--- a/vendor/github.com/docker/docker/client/container_restart.go
+++ /dev/null
@@ -1,41 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
- "strconv"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/versions"
-)
-
-// ContainerRestart stops and starts a container again.
-// It makes the daemon wait for the container to be up again for
-// a specific amount of time, given the timeout.
-func (cli *Client) ContainerRestart(ctx context.Context, containerID string, options container.StopOptions) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if options.Timeout != nil {
- query.Set("t", strconv.Itoa(*options.Timeout))
- }
- if options.Signal != "" {
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return err
- }
- if versions.GreaterThanOrEqualTo(cli.version, "1.42") {
- query.Set("signal", options.Signal)
- }
- }
- resp, err := cli.post(ctx, "/containers/"+containerID+"/restart", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_start.go b/vendor/github.com/docker/docker/client/container_start.go
deleted file mode 100644
index c7206e32..00000000
--- a/vendor/github.com/docker/docker/client/container_start.go
+++ /dev/null
@@ -1,28 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerStart sends a request to the docker daemon to start a container.
-func (cli *Client) ContainerStart(ctx context.Context, containerID string, options container.StartOptions) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if options.CheckpointID != "" {
- query.Set("checkpoint", options.CheckpointID)
- }
- if options.CheckpointDir != "" {
- query.Set("checkpoint-dir", options.CheckpointDir)
- }
-
- resp, err := cli.post(ctx, "/containers/"+containerID+"/start", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_stats.go b/vendor/github.com/docker/docker/client/container_stats.go
deleted file mode 100644
index 076954f4..00000000
--- a/vendor/github.com/docker/docker/client/container_stats.go
+++ /dev/null
@@ -1,56 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerStats returns near realtime stats for a given container.
-// It's up to the caller to close the io.ReadCloser returned.
-func (cli *Client) ContainerStats(ctx context.Context, containerID string, stream bool) (container.StatsResponseReader, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.StatsResponseReader{}, err
- }
-
- query := url.Values{}
- query.Set("stream", "0")
- if stream {
- query.Set("stream", "1")
- }
-
- resp, err := cli.get(ctx, "/containers/"+containerID+"/stats", query, nil)
- if err != nil {
- return container.StatsResponseReader{}, err
- }
-
- return container.StatsResponseReader{
- Body: resp.Body,
- OSType: resp.Header.Get("Ostype"),
- }, nil
-}
-
-// ContainerStatsOneShot gets a single stat entry from a container.
-// It differs from `ContainerStats` in that the API should not wait to prime the stats
-func (cli *Client) ContainerStatsOneShot(ctx context.Context, containerID string) (container.StatsResponseReader, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.StatsResponseReader{}, err
- }
-
- query := url.Values{}
- query.Set("stream", "0")
- query.Set("one-shot", "1")
-
- resp, err := cli.get(ctx, "/containers/"+containerID+"/stats", query, nil)
- if err != nil {
- return container.StatsResponseReader{}, err
- }
-
- return container.StatsResponseReader{
- Body: resp.Body,
- OSType: resp.Header.Get("Ostype"),
- }, nil
-}
diff --git a/vendor/github.com/docker/docker/client/container_stop.go b/vendor/github.com/docker/docker/client/container_stop.go
deleted file mode 100644
index 175b9c8b..00000000
--- a/vendor/github.com/docker/docker/client/container_stop.go
+++ /dev/null
@@ -1,45 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
- "strconv"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/versions"
-)
-
-// ContainerStop stops a container. In case the container fails to stop
-// gracefully within a time frame specified by the timeout argument,
-// it is forcefully terminated (killed).
-//
-// If the timeout is nil, the container's StopTimeout value is used, if set,
-// otherwise the engine default. A negative timeout value can be specified,
-// meaning no timeout, i.e. no forceful termination is performed.
-func (cli *Client) ContainerStop(ctx context.Context, containerID string, options container.StopOptions) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if options.Timeout != nil {
- query.Set("t", strconv.Itoa(*options.Timeout))
- }
- if options.Signal != "" {
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return err
- }
- if versions.GreaterThanOrEqualTo(cli.version, "1.42") {
- query.Set("signal", options.Signal)
- }
- }
- resp, err := cli.post(ctx, "/containers/"+containerID+"/stop", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_top.go b/vendor/github.com/docker/docker/client/container_top.go
deleted file mode 100644
index 5770f9d4..00000000
--- a/vendor/github.com/docker/docker/client/container_top.go
+++ /dev/null
@@ -1,33 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
- "strings"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerTop shows process information from within a container.
-func (cli *Client) ContainerTop(ctx context.Context, containerID string, arguments []string) (container.TopResponse, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.TopResponse{}, err
- }
-
- query := url.Values{}
- if len(arguments) > 0 {
- query.Set("ps_args", strings.Join(arguments, " "))
- }
-
- resp, err := cli.get(ctx, "/containers/"+containerID+"/top", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return container.TopResponse{}, err
- }
-
- var response container.TopResponse
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/container_unpause.go b/vendor/github.com/docker/docker/client/container_unpause.go
deleted file mode 100644
index c95f6e3a..00000000
--- a/vendor/github.com/docker/docker/client/container_unpause.go
+++ /dev/null
@@ -1,15 +0,0 @@
-package client
-
-import "context"
-
-// ContainerUnpause resumes the process execution within a container
-func (cli *Client) ContainerUnpause(ctx context.Context, containerID string) error {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return err
- }
-
- resp, err := cli.post(ctx, "/containers/"+containerID+"/unpause", nil, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/container_update.go b/vendor/github.com/docker/docker/client/container_update.go
deleted file mode 100644
index 10e966d0..00000000
--- a/vendor/github.com/docker/docker/client/container_update.go
+++ /dev/null
@@ -1,26 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types/container"
-)
-
-// ContainerUpdate updates the resources of a container.
-func (cli *Client) ContainerUpdate(ctx context.Context, containerID string, updateConfig container.UpdateConfig) (container.UpdateResponse, error) {
- containerID, err := trimID("container", containerID)
- if err != nil {
- return container.UpdateResponse{}, err
- }
-
- resp, err := cli.post(ctx, "/containers/"+containerID+"/update", nil, updateConfig, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return container.UpdateResponse{}, err
- }
-
- var response container.UpdateResponse
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/container_wait.go b/vendor/github.com/docker/docker/client/container_wait.go
deleted file mode 100644
index 75c03a12..00000000
--- a/vendor/github.com/docker/docker/client/container_wait.go
+++ /dev/null
@@ -1,122 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "errors"
- "io"
- "net/url"
-
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/versions"
-)
-
-const containerWaitErrorMsgLimit = 2 * 1024 /* Max: 2KiB */
-
-// ContainerWait waits until the specified container is in a certain state
-// indicated by the given condition, either "not-running" (default),
-// "next-exit", or "removed".
-//
-// If this client's API version is before 1.30, condition is ignored and
-// ContainerWait will return immediately with the two channels, as the server
-// will wait as if the condition were "not-running".
-//
-// If this client's API version is at least 1.30, ContainerWait blocks until
-// the request has been acknowledged by the server (with a response header),
-// then returns two channels on which the caller can wait for the exit status
-// of the container or an error if there was a problem either beginning the
-// wait request or in getting the response. This allows the caller to
-// synchronize ContainerWait with other calls, such as specifying a
-// "next-exit" condition before issuing a ContainerStart request.
-func (cli *Client) ContainerWait(ctx context.Context, containerID string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error) {
- resultC := make(chan container.WaitResponse)
- errC := make(chan error, 1)
-
- containerID, err := trimID("container", containerID)
- if err != nil {
- errC <- err
- return resultC, errC
- }
-
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- errC <- err
- return resultC, errC
- }
- if versions.LessThan(cli.ClientVersion(), "1.30") {
- return cli.legacyContainerWait(ctx, containerID)
- }
-
- query := url.Values{}
- if condition != "" {
- query.Set("condition", string(condition))
- }
-
- resp, err := cli.post(ctx, "/containers/"+containerID+"/wait", query, nil, nil)
- if err != nil {
- defer ensureReaderClosed(resp)
- errC <- err
- return resultC, errC
- }
-
- go func() {
- defer ensureReaderClosed(resp)
-
- responseText := bytes.NewBuffer(nil)
- stream := io.TeeReader(resp.Body, responseText)
-
- var res container.WaitResponse
- if err := json.NewDecoder(stream).Decode(&res); err != nil {
- // NOTE(nicks): The /wait API does not work well with HTTP proxies.
- // At any time, the proxy could cut off the response stream.
- //
- // But because the HTTP status has already been written, the proxy's
- // only option is to write a plaintext error message.
- //
- // If there's a JSON parsing error, read the real error message
- // off the body and send it to the client.
- if errors.As(err, new(*json.SyntaxError)) {
- _, _ = io.ReadAll(io.LimitReader(stream, containerWaitErrorMsgLimit))
- errC <- errors.New(responseText.String())
- } else {
- errC <- err
- }
- return
- }
-
- resultC <- res
- }()
-
- return resultC, errC
-}
-
-// legacyContainerWait returns immediately and doesn't have an option to wait
-// until the container is removed.
-func (cli *Client) legacyContainerWait(ctx context.Context, containerID string) (<-chan container.WaitResponse, <-chan error) {
- resultC := make(chan container.WaitResponse)
- errC := make(chan error)
-
- go func() {
- resp, err := cli.post(ctx, "/containers/"+containerID+"/wait", nil, nil, nil)
- if err != nil {
- errC <- err
- return
- }
- defer ensureReaderClosed(resp)
-
- var res container.WaitResponse
- if err := json.NewDecoder(resp.Body).Decode(&res); err != nil {
- errC <- err
- return
- }
-
- resultC <- res
- }()
-
- return resultC, errC
-}
diff --git a/vendor/github.com/docker/docker/client/disk_usage.go b/vendor/github.com/docker/docker/client/disk_usage.go
deleted file mode 100644
index 729e1057..00000000
--- a/vendor/github.com/docker/docker/client/disk_usage.go
+++ /dev/null
@@ -1,33 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "fmt"
- "net/url"
-
- "github.com/docker/docker/api/types"
-)
-
-// DiskUsage requests the current data usage from the daemon
-func (cli *Client) DiskUsage(ctx context.Context, options types.DiskUsageOptions) (types.DiskUsage, error) {
- var query url.Values
- if len(options.Types) > 0 {
- query = url.Values{}
- for _, t := range options.Types {
- query.Add("type", string(t))
- }
- }
-
- resp, err := cli.get(ctx, "/system/df", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return types.DiskUsage{}, err
- }
-
- var du types.DiskUsage
- if err := json.NewDecoder(resp.Body).Decode(&du); err != nil {
- return types.DiskUsage{}, fmt.Errorf("Error retrieving disk usage: %v", err)
- }
- return du, nil
-}
diff --git a/vendor/github.com/docker/docker/client/distribution_inspect.go b/vendor/github.com/docker/docker/client/distribution_inspect.go
deleted file mode 100644
index 693c4121..00000000
--- a/vendor/github.com/docker/docker/client/distribution_inspect.go
+++ /dev/null
@@ -1,39 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/http"
- "net/url"
-
- "github.com/docker/docker/api/types/registry"
-)
-
-// DistributionInspect returns the image digest with the full manifest.
-func (cli *Client) DistributionInspect(ctx context.Context, imageRef, encodedRegistryAuth string) (registry.DistributionInspect, error) {
- if imageRef == "" {
- return registry.DistributionInspect{}, objectNotFoundError{object: "distribution", id: imageRef}
- }
-
- if err := cli.NewVersionError(ctx, "1.30", "distribution inspect"); err != nil {
- return registry.DistributionInspect{}, err
- }
-
- var headers http.Header
- if encodedRegistryAuth != "" {
- headers = http.Header{
- registry.AuthHeader: {encodedRegistryAuth},
- }
- }
-
- // Contact the registry to retrieve digest and platform information
- resp, err := cli.get(ctx, "/distribution/"+imageRef+"/json", url.Values{}, headers)
- defer ensureReaderClosed(resp)
- if err != nil {
- return registry.DistributionInspect{}, err
- }
-
- var distributionInspect registry.DistributionInspect
- err = json.NewDecoder(resp.Body).Decode(&distributionInspect)
- return distributionInspect, err
-}
diff --git a/vendor/github.com/docker/docker/client/envvars.go b/vendor/github.com/docker/docker/client/envvars.go
deleted file mode 100644
index abe122d1..00000000
--- a/vendor/github.com/docker/docker/client/envvars.go
+++ /dev/null
@@ -1,90 +0,0 @@
-package client
-
-const (
- // EnvOverrideHost is the name of the environment variable that can be used
- // to override the default host to connect to (DefaultDockerHost).
- //
- // This env-var is read by FromEnv and WithHostFromEnv and when set to a
- // non-empty value, takes precedence over the default host (which is platform
- // specific), or any host already set.
- EnvOverrideHost = "DOCKER_HOST"
-
- // EnvOverrideAPIVersion is the name of the environment variable that can
- // be used to override the API version to use. Value should be
- // formatted as MAJOR.MINOR, for example, "1.19".
- //
- // This env-var is read by FromEnv and WithVersionFromEnv and when set to a
- // non-empty value, takes precedence over API version negotiation.
- //
- // This environment variable should be used for debugging purposes only, as
- // it can set the client to use an incompatible (or invalid) API version.
- EnvOverrideAPIVersion = "DOCKER_API_VERSION"
-
- // EnvOverrideCertPath is the name of the environment variable that can be
- // used to specify the directory from which to load the TLS certificates
- // (ca.pem, cert.pem, key.pem) from. These certificates are used to configure
- // the Client for a TCP connection protected by TLS client authentication.
- //
- // TLS certificate verification is enabled by default if the Client is configured
- // to use a TLS connection. Refer to EnvTLSVerify below to learn how to
- // disable verification for testing purposes.
- //
- // WARNING: Access to the remote API is equivalent to root access to the
- // host where the daemon runs. Do not expose the API without protection,
- // and only if needed. Make sure you are familiar with the "daemon attack
- // surface" (https://docs.docker.com/go/attack-surface/).
- //
- // For local access to the API, it is recommended to connect with the daemon
- // using the default local socket connection (on Linux), or the named pipe
- // (on Windows).
- //
- // If you need to access the API of a remote daemon, consider using an SSH
- // (ssh://) connection, which is easier to set up, and requires no additional
- // configuration if the host is accessible using ssh.
- //
- // If you cannot use the alternatives above, and you must expose the API over
- // a TCP connection, refer to https://docs.docker.com/engine/security/protect-access/
- // to learn how to configure the daemon and client to use a TCP connection
- // with TLS client authentication. Make sure you know the differences between
- // a regular TLS connection and a TLS connection protected by TLS client
- // authentication, and verify that the API cannot be accessed by other clients.
- EnvOverrideCertPath = "DOCKER_CERT_PATH"
-
- // EnvTLSVerify is the name of the environment variable that can be used to
- // enable or disable TLS certificate verification. When set to a non-empty
- // value, TLS certificate verification is enabled, and the client is configured
- // to use a TLS connection, using certificates from the default directories
- // (within `~/.docker`); refer to EnvOverrideCertPath above for additional
- // details.
- //
- // WARNING: Access to the remote API is equivalent to root access to the
- // host where the daemon runs. Do not expose the API without protection,
- // and only if needed. Make sure you are familiar with the "daemon attack
- // surface" (https://docs.docker.com/go/attack-surface/).
- //
- // Before setting up your client and daemon to use a TCP connection with TLS
- // client authentication, consider using one of the alternatives mentioned
- // in EnvOverrideCertPath above.
- //
- // Disabling TLS certificate verification (for testing purposes)
- //
- // TLS certificate verification is enabled by default if the Client is configured
- // to use a TLS connection, and it is highly recommended to keep verification
- // enabled to prevent machine-in-the-middle attacks. Refer to the documentation
- // at https://docs.docker.com/engine/security/protect-access/ and pages linked
- // from that page to learn how to configure the daemon and client to use a
- // TCP connection with TLS client authentication enabled.
- //
- // Set the "DOCKER_TLS_VERIFY" environment to an empty string ("") to
- // disable TLS certificate verification. Disabling verification is insecure,
- // so should only be done for testing purposes. From the Go documentation
- // (https://pkg.go.dev/crypto/tls#Config):
- //
- // InsecureSkipVerify controls whether a client verifies the server's
- // certificate chain and host name. If InsecureSkipVerify is true, crypto/tls
- // accepts any certificate presented by the server and any host name in that
- // certificate. In this mode, TLS is susceptible to machine-in-the-middle
- // attacks unless custom verification is used. This should be used only for
- // testing or in combination with VerifyConnection or VerifyPeerCertificate.
- EnvTLSVerify = "DOCKER_TLS_VERIFY"
-)
diff --git a/vendor/github.com/docker/docker/client/errors.go b/vendor/github.com/docker/docker/client/errors.go
deleted file mode 100644
index 9e3a2538..00000000
--- a/vendor/github.com/docker/docker/client/errors.go
+++ /dev/null
@@ -1,129 +0,0 @@
-package client
-
-import (
- "context"
- "errors"
- "fmt"
- "net/http"
-
- cerrdefs "github.com/containerd/errdefs"
- "github.com/containerd/errdefs/pkg/errhttp"
- "github.com/docker/docker/api/types/versions"
-)
-
-// errConnectionFailed implements an error returned when connection failed.
-type errConnectionFailed struct {
- error
-}
-
-// Error returns a string representation of an errConnectionFailed
-func (e errConnectionFailed) Error() string {
- return e.error.Error()
-}
-
-func (e errConnectionFailed) Unwrap() error {
- return e.error
-}
-
-// IsErrConnectionFailed returns true if the error is caused by connection failed.
-func IsErrConnectionFailed(err error) bool {
- return errors.As(err, &errConnectionFailed{})
-}
-
-// ErrorConnectionFailed returns an error with host in the error message when connection to docker daemon failed.
-//
-// Deprecated: this function was only used internally, and will be removed in the next release.
-func ErrorConnectionFailed(host string) error {
- return connectionFailed(host)
-}
-
-// connectionFailed returns an error with host in the error message when connection
-// to docker daemon failed.
-func connectionFailed(host string) error {
- var err error
- if host == "" {
- err = errors.New("Cannot connect to the Docker daemon. Is the docker daemon running on this host?")
- } else {
- err = fmt.Errorf("Cannot connect to the Docker daemon at %s. Is the docker daemon running?", host)
- }
- return errConnectionFailed{error: err}
-}
-
-// IsErrNotFound returns true if the error is a NotFound error, which is returned
-// by the API when some object is not found. It is an alias for [cerrdefs.IsNotFound].
-//
-// Deprecated: use [cerrdefs.IsNotFound] instead.
-func IsErrNotFound(err error) bool {
- return cerrdefs.IsNotFound(err)
-}
-
-type objectNotFoundError struct {
- object string
- id string
-}
-
-func (e objectNotFoundError) NotFound() {}
-
-func (e objectNotFoundError) Error() string {
- return fmt.Sprintf("Error: No such %s: %s", e.object, e.id)
-}
-
-// NewVersionError returns an error if the APIVersion required is less than the
-// current supported version.
-//
-// It performs API-version negotiation if the Client is configured with this
-// option, otherwise it assumes the latest API version is used.
-func (cli *Client) NewVersionError(ctx context.Context, APIrequired, feature string) error {
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return err
- }
- if cli.version != "" && versions.LessThan(cli.version, APIrequired) {
- return fmt.Errorf("%q requires API version %s, but the Docker daemon API version is %s", feature, APIrequired, cli.version)
- }
- return nil
-}
-
-type httpError struct {
- err error
- errdef error
-}
-
-func (e *httpError) Error() string {
- return e.err.Error()
-}
-
-func (e *httpError) Unwrap() error {
- return e.err
-}
-
-func (e *httpError) Is(target error) bool {
- return errors.Is(e.errdef, target)
-}
-
-// httpErrorFromStatusCode creates an errdef error, based on the provided HTTP status-code
-func httpErrorFromStatusCode(err error, statusCode int) error {
- if err == nil {
- return nil
- }
- base := errhttp.ToNative(statusCode)
- if base != nil {
- return &httpError{err: err, errdef: base}
- }
-
- switch {
- case statusCode >= http.StatusOK && statusCode < http.StatusBadRequest:
- // it's a client error
- return err
- case statusCode >= http.StatusBadRequest && statusCode < http.StatusInternalServerError:
- return &httpError{err: err, errdef: cerrdefs.ErrInvalidArgument}
- case statusCode >= http.StatusInternalServerError && statusCode < 600:
- return &httpError{err: err, errdef: cerrdefs.ErrInternal}
- default:
- return &httpError{err: err, errdef: cerrdefs.ErrUnknown}
- }
-}
diff --git a/vendor/github.com/docker/docker/client/events.go b/vendor/github.com/docker/docker/client/events.go
deleted file mode 100644
index 498fe463..00000000
--- a/vendor/github.com/docker/docker/client/events.go
+++ /dev/null
@@ -1,100 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
- "time"
-
- "github.com/docker/docker/api/types/events"
- "github.com/docker/docker/api/types/filters"
- timetypes "github.com/docker/docker/api/types/time"
-)
-
-// Events returns a stream of events in the daemon. It's up to the caller to close the stream
-// by cancelling the context. Once the stream has been completely read an io.EOF error will
-// be sent over the error channel. If an error is sent all processing will be stopped. It's up
-// to the caller to reopen the stream in the event of an error by reinvoking this method.
-func (cli *Client) Events(ctx context.Context, options events.ListOptions) (<-chan events.Message, <-chan error) {
- messages := make(chan events.Message)
- errs := make(chan error, 1)
-
- started := make(chan struct{})
- go func() {
- defer close(errs)
-
- query, err := buildEventsQueryParams(cli.version, options)
- if err != nil {
- close(started)
- errs <- err
- return
- }
-
- resp, err := cli.get(ctx, "/events", query, nil)
- if err != nil {
- close(started)
- errs <- err
- return
- }
- defer resp.Body.Close()
-
- decoder := json.NewDecoder(resp.Body)
-
- close(started)
- for {
- select {
- case <-ctx.Done():
- errs <- ctx.Err()
- return
- default:
- var event events.Message
- if err := decoder.Decode(&event); err != nil {
- errs <- err
- return
- }
-
- select {
- case messages <- event:
- case <-ctx.Done():
- errs <- ctx.Err()
- return
- }
- }
- }
- }()
- <-started
-
- return messages, errs
-}
-
-func buildEventsQueryParams(cliVersion string, options events.ListOptions) (url.Values, error) {
- query := url.Values{}
- ref := time.Now()
-
- if options.Since != "" {
- ts, err := timetypes.GetTimestamp(options.Since, ref)
- if err != nil {
- return nil, err
- }
- query.Set("since", ts)
- }
-
- if options.Until != "" {
- ts, err := timetypes.GetTimestamp(options.Until, ref)
- if err != nil {
- return nil, err
- }
- query.Set("until", ts)
- }
-
- if options.Filters.Len() > 0 {
- //nolint:staticcheck // ignore SA1019 for old code
- filterJSON, err := filters.ToParamWithVersion(cliVersion, options.Filters)
- if err != nil {
- return nil, err
- }
- query.Set("filters", filterJSON)
- }
-
- return query, nil
-}
diff --git a/vendor/github.com/docker/docker/client/hijack.go b/vendor/github.com/docker/docker/client/hijack.go
deleted file mode 100644
index 01d121a6..00000000
--- a/vendor/github.com/docker/docker/client/hijack.go
+++ /dev/null
@@ -1,139 +0,0 @@
-package client
-
-import (
- "bufio"
- "context"
- "fmt"
- "net"
- "net/http"
- "net/url"
- "time"
-
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/versions"
- "github.com/pkg/errors"
- "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
-)
-
-// postHijacked sends a POST request and hijacks the connection.
-func (cli *Client) postHijacked(ctx context.Context, path string, query url.Values, body interface{}, headers map[string][]string) (types.HijackedResponse, error) {
- bodyEncoded, err := encodeData(body)
- if err != nil {
- return types.HijackedResponse{}, err
- }
- req, err := cli.buildRequest(ctx, http.MethodPost, cli.getAPIPath(ctx, path, query), bodyEncoded, headers)
- if err != nil {
- return types.HijackedResponse{}, err
- }
- conn, mediaType, err := setupHijackConn(cli.dialer(), req, "tcp")
- if err != nil {
- return types.HijackedResponse{}, err
- }
-
- if versions.LessThan(cli.ClientVersion(), "1.42") {
- // Prior to 1.42, Content-Type is always set to raw-stream and not relevant
- mediaType = ""
- }
-
- return types.NewHijackedResponse(conn, mediaType), nil
-}
-
-// DialHijack returns a hijacked connection with negotiated protocol proto.
-func (cli *Client) DialHijack(ctx context.Context, url, proto string, meta map[string][]string) (net.Conn, error) {
- req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, http.NoBody)
- if err != nil {
- return nil, err
- }
- req = cli.addHeaders(req, meta)
-
- conn, _, err := setupHijackConn(cli.Dialer(), req, proto)
- return conn, err
-}
-
-func setupHijackConn(dialer func(context.Context) (net.Conn, error), req *http.Request, proto string) (_ net.Conn, _ string, retErr error) {
- ctx := req.Context()
- req.Header.Set("Connection", "Upgrade")
- req.Header.Set("Upgrade", proto)
-
- conn, err := dialer(ctx)
- if err != nil {
- return nil, "", errors.Wrap(err, "cannot connect to the Docker daemon. Is 'docker daemon' running on this host?")
- }
- defer func() {
- if retErr != nil {
- conn.Close()
- }
- }()
-
- // When we set up a TCP connection for hijack, there could be long periods
- // of inactivity (a long running command with no output) that in certain
- // network setups may cause ECONNTIMEOUT, leaving the client in an unknown
- // state. Setting TCP KeepAlive on the socket connection will prohibit
- // ECONNTIMEOUT unless the socket connection truly is broken
- if tcpConn, ok := conn.(*net.TCPConn); ok {
- _ = tcpConn.SetKeepAlive(true)
- _ = tcpConn.SetKeepAlivePeriod(30 * time.Second)
- }
-
- hc := &hijackedConn{conn, bufio.NewReader(conn)}
-
- // Server hijacks the connection, error 'connection closed' expected
- resp, err := otelhttp.NewTransport(hc).RoundTrip(req)
- if err != nil {
- return nil, "", err
- }
- if resp.StatusCode != http.StatusSwitchingProtocols {
- _ = resp.Body.Close()
- return nil, "", fmt.Errorf("unable to upgrade to %s, received %d", proto, resp.StatusCode)
- }
-
- if hc.r.Buffered() > 0 {
- // If there is buffered content, wrap the connection. We return an
- // object that implements CloseWrite if the underlying connection
- // implements it.
- if _, ok := hc.Conn.(types.CloseWriter); ok {
- conn = &hijackedConnCloseWriter{hc}
- } else {
- conn = hc
- }
- } else {
- hc.r.Reset(nil)
- }
-
- return conn, resp.Header.Get("Content-Type"), nil
-}
-
-// hijackedConn wraps a net.Conn and is returned by setupHijackConn in the case
-// that a) there was already buffered data in the http layer when Hijack() was
-// called, and b) the underlying net.Conn does *not* implement CloseWrite().
-// hijackedConn does not implement CloseWrite() either.
-type hijackedConn struct {
- net.Conn
- r *bufio.Reader
-}
-
-func (c *hijackedConn) RoundTrip(req *http.Request) (*http.Response, error) {
- if err := req.Write(c.Conn); err != nil {
- return nil, err
- }
- return http.ReadResponse(c.r, req)
-}
-
-func (c *hijackedConn) Read(b []byte) (int, error) {
- return c.r.Read(b)
-}
-
-// hijackedConnCloseWriter is a hijackedConn which additionally implements
-// CloseWrite(). It is returned by setupHijackConn in the case that a) there
-// was already buffered data in the http layer when Hijack() was called, and b)
-// the underlying net.Conn *does* implement CloseWrite().
-type hijackedConnCloseWriter struct {
- *hijackedConn
-}
-
-var _ types.CloseWriter = &hijackedConnCloseWriter{}
-
-func (c *hijackedConnCloseWriter) CloseWrite() error {
- conn := c.Conn.(types.CloseWriter)
- return conn.CloseWrite()
-}
diff --git a/vendor/github.com/docker/docker/client/image_build.go b/vendor/github.com/docker/docker/client/image_build.go
deleted file mode 100644
index 1ed0878b..00000000
--- a/vendor/github.com/docker/docker/client/image_build.go
+++ /dev/null
@@ -1,182 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/base64"
- "encoding/json"
- "io"
- "net/http"
- "net/url"
- "strconv"
- "strings"
-
- "github.com/docker/docker/api/types/build"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/network"
-)
-
-// ImageBuild sends a request to the daemon to build images.
-// The Body in the response implements an io.ReadCloser and it's up to the caller to
-// close it.
-func (cli *Client) ImageBuild(ctx context.Context, buildContext io.Reader, options build.ImageBuildOptions) (build.ImageBuildResponse, error) {
- query, err := cli.imageBuildOptionsToQuery(ctx, options)
- if err != nil {
- return build.ImageBuildResponse{}, err
- }
-
- buf, err := json.Marshal(options.AuthConfigs)
- if err != nil {
- return build.ImageBuildResponse{}, err
- }
-
- headers := http.Header{}
- headers.Add("X-Registry-Config", base64.URLEncoding.EncodeToString(buf))
- headers.Set("Content-Type", "application/x-tar")
-
- resp, err := cli.postRaw(ctx, "/build", query, buildContext, headers)
- if err != nil {
- return build.ImageBuildResponse{}, err
- }
-
- return build.ImageBuildResponse{
- Body: resp.Body,
- OSType: resp.Header.Get("Ostype"),
- }, nil
-}
-
-func (cli *Client) imageBuildOptionsToQuery(ctx context.Context, options build.ImageBuildOptions) (url.Values, error) {
- query := url.Values{}
- if len(options.Tags) > 0 {
- query["t"] = options.Tags
- }
- if len(options.SecurityOpt) > 0 {
- query["securityopt"] = options.SecurityOpt
- }
- if len(options.ExtraHosts) > 0 {
- query["extrahosts"] = options.ExtraHosts
- }
- if options.SuppressOutput {
- query.Set("q", "1")
- }
- if options.RemoteContext != "" {
- query.Set("remote", options.RemoteContext)
- }
- if options.NoCache {
- query.Set("nocache", "1")
- }
- if !options.Remove {
- // only send value when opting out because the daemon's default is
- // to remove intermediate containers after a successful build,
- //
- // TODO(thaJeztah): deprecate "Remove" option, and provide a "NoRemove" or "Keep" option instead.
- query.Set("rm", "0")
- }
-
- if options.ForceRemove {
- query.Set("forcerm", "1")
- }
-
- if options.PullParent {
- query.Set("pull", "1")
- }
-
- if options.Squash {
- if err := cli.NewVersionError(ctx, "1.25", "squash"); err != nil {
- return query, err
- }
- query.Set("squash", "1")
- }
-
- if !container.Isolation.IsDefault(options.Isolation) {
- query.Set("isolation", string(options.Isolation))
- }
-
- if options.CPUSetCPUs != "" {
- query.Set("cpusetcpus", options.CPUSetCPUs)
- }
- if options.NetworkMode != "" && options.NetworkMode != network.NetworkDefault {
- query.Set("networkmode", options.NetworkMode)
- }
- if options.CPUSetMems != "" {
- query.Set("cpusetmems", options.CPUSetMems)
- }
- if options.CPUShares != 0 {
- query.Set("cpushares", strconv.FormatInt(options.CPUShares, 10))
- }
- if options.CPUQuota != 0 {
- query.Set("cpuquota", strconv.FormatInt(options.CPUQuota, 10))
- }
- if options.CPUPeriod != 0 {
- query.Set("cpuperiod", strconv.FormatInt(options.CPUPeriod, 10))
- }
- if options.Memory != 0 {
- query.Set("memory", strconv.FormatInt(options.Memory, 10))
- }
- if options.MemorySwap != 0 {
- query.Set("memswap", strconv.FormatInt(options.MemorySwap, 10))
- }
- if options.CgroupParent != "" {
- query.Set("cgroupparent", options.CgroupParent)
- }
- if options.ShmSize != 0 {
- query.Set("shmsize", strconv.FormatInt(options.ShmSize, 10))
- }
- if options.Dockerfile != "" {
- query.Set("dockerfile", options.Dockerfile)
- }
- if options.Target != "" {
- query.Set("target", options.Target)
- }
- if len(options.Ulimits) != 0 {
- ulimitsJSON, err := json.Marshal(options.Ulimits)
- if err != nil {
- return query, err
- }
- query.Set("ulimits", string(ulimitsJSON))
- }
- if len(options.BuildArgs) != 0 {
- buildArgsJSON, err := json.Marshal(options.BuildArgs)
- if err != nil {
- return query, err
- }
- query.Set("buildargs", string(buildArgsJSON))
- }
- if len(options.Labels) != 0 {
- labelsJSON, err := json.Marshal(options.Labels)
- if err != nil {
- return query, err
- }
- query.Set("labels", string(labelsJSON))
- }
- if len(options.CacheFrom) != 0 {
- cacheFromJSON, err := json.Marshal(options.CacheFrom)
- if err != nil {
- return query, err
- }
- query.Set("cachefrom", string(cacheFromJSON))
- }
- if options.SessionID != "" {
- query.Set("session", options.SessionID)
- }
- if options.Platform != "" {
- if err := cli.NewVersionError(ctx, "1.32", "platform"); err != nil {
- return query, err
- }
- query.Set("platform", strings.ToLower(options.Platform))
- }
- if options.BuildID != "" {
- query.Set("buildid", options.BuildID)
- }
- if options.Version != "" {
- query.Set("version", string(options.Version))
- }
-
- if options.Outputs != nil {
- outputsJSON, err := json.Marshal(options.Outputs)
- if err != nil {
- return query, err
- }
- query.Set("outputs", string(outputsJSON))
- }
- return query, nil
-}
diff --git a/vendor/github.com/docker/docker/client/image_create.go b/vendor/github.com/docker/docker/client/image_create.go
deleted file mode 100644
index 1e044d77..00000000
--- a/vendor/github.com/docker/docker/client/image_create.go
+++ /dev/null
@@ -1,40 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/http"
- "net/url"
- "strings"
-
- "github.com/distribution/reference"
- "github.com/docker/docker/api/types/image"
- "github.com/docker/docker/api/types/registry"
-)
-
-// ImageCreate creates a new image based on the parent options.
-// It returns the JSON content in the response body.
-func (cli *Client) ImageCreate(ctx context.Context, parentReference string, options image.CreateOptions) (io.ReadCloser, error) {
- ref, err := reference.ParseNormalizedNamed(parentReference)
- if err != nil {
- return nil, err
- }
-
- query := url.Values{}
- query.Set("fromImage", ref.Name())
- query.Set("tag", getAPITagFromNamedRef(ref))
- if options.Platform != "" {
- query.Set("platform", strings.ToLower(options.Platform))
- }
- resp, err := cli.tryImageCreate(ctx, query, options.RegistryAuth)
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
-
-func (cli *Client) tryImageCreate(ctx context.Context, query url.Values, registryAuth string) (*http.Response, error) {
- return cli.post(ctx, "/images/create", query, nil, http.Header{
- registry.AuthHeader: {registryAuth},
- })
-}
diff --git a/vendor/github.com/docker/docker/client/image_history.go b/vendor/github.com/docker/docker/client/image_history.go
deleted file mode 100644
index fce8b80e..00000000
--- a/vendor/github.com/docker/docker/client/image_history.go
+++ /dev/null
@@ -1,56 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "fmt"
- "net/url"
-
- "github.com/docker/docker/api/types/image"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-// ImageHistoryWithPlatform sets the platform for the image history operation.
-func ImageHistoryWithPlatform(platform ocispec.Platform) ImageHistoryOption {
- return imageHistoryOptionFunc(func(opt *imageHistoryOpts) error {
- if opt.apiOptions.Platform != nil {
- return fmt.Errorf("platform already set to %s", *opt.apiOptions.Platform)
- }
- opt.apiOptions.Platform = &platform
- return nil
- })
-}
-
-// ImageHistory returns the changes in an image in history format.
-func (cli *Client) ImageHistory(ctx context.Context, imageID string, historyOpts ...ImageHistoryOption) ([]image.HistoryResponseItem, error) {
- query := url.Values{}
-
- var opts imageHistoryOpts
- for _, o := range historyOpts {
- if err := o.Apply(&opts); err != nil {
- return nil, err
- }
- }
-
- if opts.apiOptions.Platform != nil {
- if err := cli.NewVersionError(ctx, "1.48", "platform"); err != nil {
- return nil, err
- }
-
- p, err := encodePlatform(opts.apiOptions.Platform)
- if err != nil {
- return nil, err
- }
- query.Set("platform", p)
- }
-
- resp, err := cli.get(ctx, "/images/"+imageID+"/history", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var history []image.HistoryResponseItem
- err = json.NewDecoder(resp.Body).Decode(&history)
- return history, err
-}
diff --git a/vendor/github.com/docker/docker/client/image_history_opts.go b/vendor/github.com/docker/docker/client/image_history_opts.go
deleted file mode 100644
index 6d3494dd..00000000
--- a/vendor/github.com/docker/docker/client/image_history_opts.go
+++ /dev/null
@@ -1,19 +0,0 @@
-package client
-
-import (
- "github.com/docker/docker/api/types/image"
-)
-
-// ImageHistoryOption is a type representing functional options for the image history operation.
-type ImageHistoryOption interface {
- Apply(*imageHistoryOpts) error
-}
-type imageHistoryOptionFunc func(opt *imageHistoryOpts) error
-
-func (f imageHistoryOptionFunc) Apply(o *imageHistoryOpts) error {
- return f(o)
-}
-
-type imageHistoryOpts struct {
- apiOptions image.HistoryOptions
-}
diff --git a/vendor/github.com/docker/docker/client/image_import.go b/vendor/github.com/docker/docker/client/image_import.go
deleted file mode 100644
index 5236dbc6..00000000
--- a/vendor/github.com/docker/docker/client/image_import.go
+++ /dev/null
@@ -1,48 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/url"
- "strings"
-
- "github.com/distribution/reference"
- "github.com/docker/docker/api/types/image"
-)
-
-// ImageImport creates a new image based on the source options.
-// It returns the JSON content in the response body.
-func (cli *Client) ImageImport(ctx context.Context, source image.ImportSource, ref string, options image.ImportOptions) (io.ReadCloser, error) {
- if ref != "" {
- // Check if the given image name can be resolved
- if _, err := reference.ParseNormalizedNamed(ref); err != nil {
- return nil, err
- }
- }
-
- query := url.Values{}
- if source.SourceName != "" {
- query.Set("fromSrc", source.SourceName)
- }
- if ref != "" {
- query.Set("repo", ref)
- }
- if options.Tag != "" {
- query.Set("tag", options.Tag)
- }
- if options.Message != "" {
- query.Set("message", options.Message)
- }
- if options.Platform != "" {
- query.Set("platform", strings.ToLower(options.Platform))
- }
- for _, change := range options.Changes {
- query.Add("changes", change)
- }
-
- resp, err := cli.postRaw(ctx, "/images/create", query, source.Source, nil)
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
diff --git a/vendor/github.com/docker/docker/client/image_inspect.go b/vendor/github.com/docker/docker/client/image_inspect.go
deleted file mode 100644
index 4c350031..00000000
--- a/vendor/github.com/docker/docker/client/image_inspect.go
+++ /dev/null
@@ -1,76 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "fmt"
- "io"
- "net/url"
-
- "github.com/docker/docker/api/types/image"
-)
-
-// ImageInspect returns the image information.
-func (cli *Client) ImageInspect(ctx context.Context, imageID string, inspectOpts ...ImageInspectOption) (image.InspectResponse, error) {
- if imageID == "" {
- return image.InspectResponse{}, objectNotFoundError{object: "image", id: imageID}
- }
-
- var opts imageInspectOpts
- for _, opt := range inspectOpts {
- if err := opt.Apply(&opts); err != nil {
- return image.InspectResponse{}, fmt.Errorf("error applying image inspect option: %w", err)
- }
- }
-
- query := url.Values{}
- if opts.apiOptions.Manifests {
- if err := cli.NewVersionError(ctx, "1.48", "manifests"); err != nil {
- return image.InspectResponse{}, err
- }
- query.Set("manifests", "1")
- }
-
- if opts.apiOptions.Platform != nil {
- if err := cli.NewVersionError(ctx, "1.49", "platform"); err != nil {
- return image.InspectResponse{}, err
- }
- platform, err := encodePlatform(opts.apiOptions.Platform)
- if err != nil {
- return image.InspectResponse{}, err
- }
- query.Set("platform", platform)
- }
-
- resp, err := cli.get(ctx, "/images/"+imageID+"/json", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return image.InspectResponse{}, err
- }
-
- buf := opts.raw
- if buf == nil {
- buf = &bytes.Buffer{}
- }
-
- if _, err := io.Copy(buf, resp.Body); err != nil {
- return image.InspectResponse{}, err
- }
-
- var response image.InspectResponse
- err = json.Unmarshal(buf.Bytes(), &response)
- return response, err
-}
-
-// ImageInspectWithRaw returns the image information and its raw representation.
-//
-// Deprecated: Use [Client.ImageInspect] instead. Raw response can be obtained using the [ImageInspectWithRawResponse] option.
-func (cli *Client) ImageInspectWithRaw(ctx context.Context, imageID string) (image.InspectResponse, []byte, error) {
- var buf bytes.Buffer
- resp, err := cli.ImageInspect(ctx, imageID, ImageInspectWithRawResponse(&buf))
- if err != nil {
- return image.InspectResponse{}, nil, err
- }
- return resp, buf.Bytes(), err
-}
diff --git a/vendor/github.com/docker/docker/client/image_inspect_opts.go b/vendor/github.com/docker/docker/client/image_inspect_opts.go
deleted file mode 100644
index 655cbf0b..00000000
--- a/vendor/github.com/docker/docker/client/image_inspect_opts.go
+++ /dev/null
@@ -1,62 +0,0 @@
-package client
-
-import (
- "bytes"
-
- "github.com/docker/docker/api/types/image"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-// ImageInspectOption is a type representing functional options for the image inspect operation.
-type ImageInspectOption interface {
- Apply(*imageInspectOpts) error
-}
-type imageInspectOptionFunc func(opt *imageInspectOpts) error
-
-func (f imageInspectOptionFunc) Apply(o *imageInspectOpts) error {
- return f(o)
-}
-
-// ImageInspectWithRawResponse instructs the client to additionally store the
-// raw inspect response in the provided buffer.
-func ImageInspectWithRawResponse(raw *bytes.Buffer) ImageInspectOption {
- return imageInspectOptionFunc(func(opts *imageInspectOpts) error {
- opts.raw = raw
- return nil
- })
-}
-
-// ImageInspectWithManifests sets manifests API option for the image inspect operation.
-// This option is only available for API version 1.48 and up.
-// With this option set, the image inspect operation response will have the
-// [image.InspectResponse.Manifests] field populated if the server is multi-platform capable.
-func ImageInspectWithManifests(manifests bool) ImageInspectOption {
- return imageInspectOptionFunc(func(clientOpts *imageInspectOpts) error {
- clientOpts.apiOptions.Manifests = manifests
- return nil
- })
-}
-
-// ImageInspectWithPlatform sets platform API option for the image inspect operation.
-// This option is only available for API version 1.49 and up.
-// With this option set, the image inspect operation will return information for the
-// specified platform variant of the multi-platform image.
-func ImageInspectWithPlatform(platform *ocispec.Platform) ImageInspectOption {
- return imageInspectOptionFunc(func(clientOpts *imageInspectOpts) error {
- clientOpts.apiOptions.Platform = platform
- return nil
- })
-}
-
-// ImageInspectWithAPIOpts sets the API options for the image inspect operation.
-func ImageInspectWithAPIOpts(opts image.InspectOptions) ImageInspectOption {
- return imageInspectOptionFunc(func(clientOpts *imageInspectOpts) error {
- clientOpts.apiOptions = opts
- return nil
- })
-}
-
-type imageInspectOpts struct {
- raw *bytes.Buffer
- apiOptions image.InspectOptions
-}
diff --git a/vendor/github.com/docker/docker/client/image_list.go b/vendor/github.com/docker/docker/client/image_list.go
deleted file mode 100644
index ec0a2ad5..00000000
--- a/vendor/github.com/docker/docker/client/image_list.go
+++ /dev/null
@@ -1,67 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/image"
- "github.com/docker/docker/api/types/versions"
-)
-
-// ImageList returns a list of images in the docker host.
-//
-// Experimental: Setting the [options.Manifest] will populate
-// [image.Summary.Manifests] with information about image manifests.
-// This is experimental and might change in the future without any backward
-// compatibility.
-func (cli *Client) ImageList(ctx context.Context, options image.ListOptions) ([]image.Summary, error) {
- var images []image.Summary
-
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return images, err
- }
-
- query := url.Values{}
-
- optionFilters := options.Filters
- referenceFilters := optionFilters.Get("reference")
- if versions.LessThan(cli.version, "1.25") && len(referenceFilters) > 0 {
- query.Set("filter", referenceFilters[0])
- for _, filterValue := range referenceFilters {
- optionFilters.Del("reference", filterValue)
- }
- }
- if optionFilters.Len() > 0 {
- //nolint:staticcheck // ignore SA1019 for old code
- filterJSON, err := filters.ToParamWithVersion(cli.version, optionFilters)
- if err != nil {
- return images, err
- }
- query.Set("filters", filterJSON)
- }
- if options.All {
- query.Set("all", "1")
- }
- if options.SharedSize && versions.GreaterThanOrEqualTo(cli.version, "1.42") {
- query.Set("shared-size", "1")
- }
- if options.Manifests && versions.GreaterThanOrEqualTo(cli.version, "1.47") {
- query.Set("manifests", "1")
- }
-
- resp, err := cli.get(ctx, "/images/json", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return images, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&images)
- return images, err
-}
diff --git a/vendor/github.com/docker/docker/client/image_load.go b/vendor/github.com/docker/docker/client/image_load.go
deleted file mode 100644
index 079002e9..00000000
--- a/vendor/github.com/docker/docker/client/image_load.go
+++ /dev/null
@@ -1,54 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/http"
- "net/url"
-
- "github.com/docker/docker/api/types/image"
-)
-
-// ImageLoad loads an image in the docker host from the client host.
-// It's up to the caller to close the io.ReadCloser in the
-// ImageLoadResponse returned by this function.
-//
-// Platform is an optional parameter that specifies the platform to load from
-// the provided multi-platform image. This is only has effect if the input image
-// is a multi-platform image.
-func (cli *Client) ImageLoad(ctx context.Context, input io.Reader, loadOpts ...ImageLoadOption) (image.LoadResponse, error) {
- var opts imageLoadOpts
- for _, opt := range loadOpts {
- if err := opt.Apply(&opts); err != nil {
- return image.LoadResponse{}, err
- }
- }
-
- query := url.Values{}
- query.Set("quiet", "0")
- if opts.apiOptions.Quiet {
- query.Set("quiet", "1")
- }
- if len(opts.apiOptions.Platforms) > 0 {
- if err := cli.NewVersionError(ctx, "1.48", "platform"); err != nil {
- return image.LoadResponse{}, err
- }
-
- p, err := encodePlatforms(opts.apiOptions.Platforms...)
- if err != nil {
- return image.LoadResponse{}, err
- }
- query["platform"] = p
- }
-
- resp, err := cli.postRaw(ctx, "/images/load", query, input, http.Header{
- "Content-Type": {"application/x-tar"},
- })
- if err != nil {
- return image.LoadResponse{}, err
- }
- return image.LoadResponse{
- Body: resp.Body,
- JSON: resp.Header.Get("Content-Type") == "application/json",
- }, nil
-}
diff --git a/vendor/github.com/docker/docker/client/image_load_opts.go b/vendor/github.com/docker/docker/client/image_load_opts.go
deleted file mode 100644
index ebcedd41..00000000
--- a/vendor/github.com/docker/docker/client/image_load_opts.go
+++ /dev/null
@@ -1,41 +0,0 @@
-package client
-
-import (
- "fmt"
-
- "github.com/docker/docker/api/types/image"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-// ImageLoadOption is a type representing functional options for the image load operation.
-type ImageLoadOption interface {
- Apply(*imageLoadOpts) error
-}
-type imageLoadOptionFunc func(opt *imageLoadOpts) error
-
-func (f imageLoadOptionFunc) Apply(o *imageLoadOpts) error {
- return f(o)
-}
-
-type imageLoadOpts struct {
- apiOptions image.LoadOptions
-}
-
-// ImageLoadWithQuiet sets the quiet option for the image load operation.
-func ImageLoadWithQuiet(quiet bool) ImageLoadOption {
- return imageLoadOptionFunc(func(opt *imageLoadOpts) error {
- opt.apiOptions.Quiet = quiet
- return nil
- })
-}
-
-// ImageLoadWithPlatforms sets the platforms to be loaded from the image.
-func ImageLoadWithPlatforms(platforms ...ocispec.Platform) ImageLoadOption {
- return imageLoadOptionFunc(func(opt *imageLoadOpts) error {
- if opt.apiOptions.Platforms != nil {
- return fmt.Errorf("platforms already set to %v", opt.apiOptions.Platforms)
- }
- opt.apiOptions.Platforms = platforms
- return nil
- })
-}
diff --git a/vendor/github.com/docker/docker/client/image_prune.go b/vendor/github.com/docker/docker/client/image_prune.go
deleted file mode 100644
index 52e8bcf5..00000000
--- a/vendor/github.com/docker/docker/client/image_prune.go
+++ /dev/null
@@ -1,35 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "fmt"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/image"
-)
-
-// ImagesPrune requests the daemon to delete unused data
-func (cli *Client) ImagesPrune(ctx context.Context, pruneFilters filters.Args) (image.PruneReport, error) {
- if err := cli.NewVersionError(ctx, "1.25", "image prune"); err != nil {
- return image.PruneReport{}, err
- }
-
- query, err := getFiltersQuery(pruneFilters)
- if err != nil {
- return image.PruneReport{}, err
- }
-
- resp, err := cli.post(ctx, "/images/prune", query, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return image.PruneReport{}, err
- }
-
- var report image.PruneReport
- if err := json.NewDecoder(resp.Body).Decode(&report); err != nil {
- return image.PruneReport{}, fmt.Errorf("Error retrieving disk usage: %v", err)
- }
-
- return report, nil
-}
diff --git a/vendor/github.com/docker/docker/client/image_pull.go b/vendor/github.com/docker/docker/client/image_pull.go
deleted file mode 100644
index ab7606b4..00000000
--- a/vendor/github.com/docker/docker/client/image_pull.go
+++ /dev/null
@@ -1,64 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/url"
- "strings"
-
- cerrdefs "github.com/containerd/errdefs"
- "github.com/distribution/reference"
- "github.com/docker/docker/api/types/image"
-)
-
-// ImagePull requests the docker host to pull an image from a remote registry.
-// It executes the privileged function if the operation is unauthorized
-// and it tries one more time.
-// It's up to the caller to handle the io.ReadCloser and close it properly.
-//
-// FIXME(vdemeester): there is currently used in a few way in docker/docker
-// - if not in trusted content, ref is used to pass the whole reference, and tag is empty
-// - if in trusted content, ref is used to pass the reference name, and tag for the digest
-func (cli *Client) ImagePull(ctx context.Context, refStr string, options image.PullOptions) (io.ReadCloser, error) {
- ref, err := reference.ParseNormalizedNamed(refStr)
- if err != nil {
- return nil, err
- }
-
- query := url.Values{}
- query.Set("fromImage", ref.Name())
- if !options.All {
- query.Set("tag", getAPITagFromNamedRef(ref))
- }
- if options.Platform != "" {
- query.Set("platform", strings.ToLower(options.Platform))
- }
-
- resp, err := cli.tryImageCreate(ctx, query, options.RegistryAuth)
- if cerrdefs.IsUnauthorized(err) && options.PrivilegeFunc != nil {
- newAuthHeader, privilegeErr := options.PrivilegeFunc(ctx)
- if privilegeErr != nil {
- return nil, privilegeErr
- }
- resp, err = cli.tryImageCreate(ctx, query, newAuthHeader)
- }
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
-
-// getAPITagFromNamedRef returns a tag from the specified reference.
-// This function is necessary as long as the docker "server" api expects
-// digests to be sent as tags and makes a distinction between the name
-// and tag/digest part of a reference.
-func getAPITagFromNamedRef(ref reference.Named) string {
- if digested, ok := ref.(reference.Digested); ok {
- return digested.Digest().String()
- }
- ref = reference.TagNameOnly(ref)
- if tagged, ok := ref.(reference.Tagged); ok {
- return tagged.Tag()
- }
- return ""
-}
diff --git a/vendor/github.com/docker/docker/client/image_push.go b/vendor/github.com/docker/docker/client/image_push.go
deleted file mode 100644
index 8dbe0b1e..00000000
--- a/vendor/github.com/docker/docker/client/image_push.go
+++ /dev/null
@@ -1,81 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "io"
- "net/http"
- "net/url"
-
- cerrdefs "github.com/containerd/errdefs"
- "github.com/distribution/reference"
- "github.com/docker/docker/api/types/image"
- "github.com/docker/docker/api/types/registry"
-)
-
-// ImagePush requests the docker host to push an image to a remote registry.
-// It executes the privileged function if the operation is unauthorized
-// and it tries one more time.
-// It's up to the caller to handle the io.ReadCloser and close it properly.
-func (cli *Client) ImagePush(ctx context.Context, image string, options image.PushOptions) (io.ReadCloser, error) {
- ref, err := reference.ParseNormalizedNamed(image)
- if err != nil {
- return nil, err
- }
-
- if _, isCanonical := ref.(reference.Canonical); isCanonical {
- return nil, errors.New("cannot push a digest reference")
- }
-
- query := url.Values{}
- if !options.All {
- ref = reference.TagNameOnly(ref)
- if tagged, ok := ref.(reference.Tagged); ok {
- query.Set("tag", tagged.Tag())
- }
- }
-
- if options.Platform != nil {
- if err := cli.NewVersionError(ctx, "1.46", "platform"); err != nil {
- return nil, err
- }
-
- p := *options.Platform
- pJson, err := json.Marshal(p)
- if err != nil {
- return nil, fmt.Errorf("invalid platform: %v", err)
- }
-
- query.Set("platform", string(pJson))
- }
-
- resp, err := cli.tryImagePush(ctx, ref.Name(), query, options.RegistryAuth)
- if cerrdefs.IsUnauthorized(err) && options.PrivilegeFunc != nil {
- newAuthHeader, privilegeErr := options.PrivilegeFunc(ctx)
- if privilegeErr != nil {
- return nil, privilegeErr
- }
- resp, err = cli.tryImagePush(ctx, ref.Name(), query, newAuthHeader)
- }
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
-
-func (cli *Client) tryImagePush(ctx context.Context, imageID string, query url.Values, registryAuth string) (*http.Response, error) {
- // Always send a body (which may be an empty JSON document ("{}")) to prevent
- // EOF errors on older daemons which had faulty fallback code for handling
- // authentication in the body when no auth-header was set, resulting in;
- //
- // Error response from daemon: bad parameters and missing X-Registry-Auth: invalid X-Registry-Auth header: EOF
- //
- // We use [http.NoBody], which gets marshaled to an empty JSON document.
- //
- // see: https://github.com/moby/moby/commit/ea29dffaa541289591aa44fa85d2a596ce860e16
- return cli.post(ctx, "/images/"+imageID+"/push", query, http.NoBody, http.Header{
- registry.AuthHeader: {registryAuth},
- })
-}
diff --git a/vendor/github.com/docker/docker/client/image_remove.go b/vendor/github.com/docker/docker/client/image_remove.go
deleted file mode 100644
index 8f357c72..00000000
--- a/vendor/github.com/docker/docker/client/image_remove.go
+++ /dev/null
@@ -1,39 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/image"
-)
-
-// ImageRemove removes an image from the docker host.
-func (cli *Client) ImageRemove(ctx context.Context, imageID string, options image.RemoveOptions) ([]image.DeleteResponse, error) {
- query := url.Values{}
-
- if options.Force {
- query.Set("force", "1")
- }
- if !options.PruneChildren {
- query.Set("noprune", "1")
- }
-
- if len(options.Platforms) > 0 {
- p, err := encodePlatforms(options.Platforms...)
- if err != nil {
- return nil, err
- }
- query["platforms"] = p
- }
-
- resp, err := cli.delete(ctx, "/images/"+imageID, query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var dels []image.DeleteResponse
- err = json.NewDecoder(resp.Body).Decode(&dels)
- return dels, err
-}
diff --git a/vendor/github.com/docker/docker/client/image_save.go b/vendor/github.com/docker/docker/client/image_save.go
deleted file mode 100644
index d2102bec..00000000
--- a/vendor/github.com/docker/docker/client/image_save.go
+++ /dev/null
@@ -1,41 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/url"
-)
-
-// ImageSave retrieves one or more images from the docker host as an io.ReadCloser.
-//
-// Platforms is an optional parameter that specifies the platforms to save from the image.
-// This is only has effect if the input image is a multi-platform image.
-func (cli *Client) ImageSave(ctx context.Context, imageIDs []string, saveOpts ...ImageSaveOption) (io.ReadCloser, error) {
- var opts imageSaveOpts
- for _, opt := range saveOpts {
- if err := opt.Apply(&opts); err != nil {
- return nil, err
- }
- }
-
- query := url.Values{
- "names": imageIDs,
- }
-
- if len(opts.apiOptions.Platforms) > 0 {
- if err := cli.NewVersionError(ctx, "1.48", "platform"); err != nil {
- return nil, err
- }
- p, err := encodePlatforms(opts.apiOptions.Platforms...)
- if err != nil {
- return nil, err
- }
- query["platform"] = p
- }
-
- resp, err := cli.get(ctx, "/images/get", query, nil)
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
diff --git a/vendor/github.com/docker/docker/client/image_save_opts.go b/vendor/github.com/docker/docker/client/image_save_opts.go
deleted file mode 100644
index acd8f282..00000000
--- a/vendor/github.com/docker/docker/client/image_save_opts.go
+++ /dev/null
@@ -1,33 +0,0 @@
-package client
-
-import (
- "fmt"
-
- "github.com/docker/docker/api/types/image"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-type ImageSaveOption interface {
- Apply(*imageSaveOpts) error
-}
-
-type imageSaveOptionFunc func(opt *imageSaveOpts) error
-
-func (f imageSaveOptionFunc) Apply(o *imageSaveOpts) error {
- return f(o)
-}
-
-// ImageSaveWithPlatforms sets the platforms to be saved from the image.
-func ImageSaveWithPlatforms(platforms ...ocispec.Platform) ImageSaveOption {
- return imageSaveOptionFunc(func(opt *imageSaveOpts) error {
- if opt.apiOptions.Platforms != nil {
- return fmt.Errorf("platforms already set to %v", opt.apiOptions.Platforms)
- }
- opt.apiOptions.Platforms = platforms
- return nil
- })
-}
-
-type imageSaveOpts struct {
- apiOptions image.SaveOptions
-}
diff --git a/vendor/github.com/docker/docker/client/image_search.go b/vendor/github.com/docker/docker/client/image_search.go
deleted file mode 100644
index 8f5343b9..00000000
--- a/vendor/github.com/docker/docker/client/image_search.go
+++ /dev/null
@@ -1,54 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/http"
- "net/url"
- "strconv"
-
- cerrdefs "github.com/containerd/errdefs"
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/registry"
-)
-
-// ImageSearch makes the docker host search by a term in a remote registry.
-// The list of results is not sorted in any fashion.
-func (cli *Client) ImageSearch(ctx context.Context, term string, options registry.SearchOptions) ([]registry.SearchResult, error) {
- var results []registry.SearchResult
- query := url.Values{}
- query.Set("term", term)
- if options.Limit > 0 {
- query.Set("limit", strconv.Itoa(options.Limit))
- }
-
- if options.Filters.Len() > 0 {
- filterJSON, err := filters.ToJSON(options.Filters)
- if err != nil {
- return results, err
- }
- query.Set("filters", filterJSON)
- }
-
- resp, err := cli.tryImageSearch(ctx, query, options.RegistryAuth)
- defer ensureReaderClosed(resp)
- if cerrdefs.IsUnauthorized(err) && options.PrivilegeFunc != nil {
- newAuthHeader, privilegeErr := options.PrivilegeFunc(ctx)
- if privilegeErr != nil {
- return results, privilegeErr
- }
- resp, err = cli.tryImageSearch(ctx, query, newAuthHeader)
- }
- if err != nil {
- return results, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&results)
- return results, err
-}
-
-func (cli *Client) tryImageSearch(ctx context.Context, query url.Values, registryAuth string) (*http.Response, error) {
- return cli.get(ctx, "/images/search", query, http.Header{
- registry.AuthHeader: {registryAuth},
- })
-}
diff --git a/vendor/github.com/docker/docker/client/image_tag.go b/vendor/github.com/docker/docker/client/image_tag.go
deleted file mode 100644
index 2bfafc51..00000000
--- a/vendor/github.com/docker/docker/client/image_tag.go
+++ /dev/null
@@ -1,37 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/distribution/reference"
- "github.com/pkg/errors"
-)
-
-// ImageTag tags an image in the docker host
-func (cli *Client) ImageTag(ctx context.Context, source, target string) error {
- if _, err := reference.ParseAnyReference(source); err != nil {
- return errors.Wrapf(err, "Error parsing reference: %q is not a valid repository/tag", source)
- }
-
- ref, err := reference.ParseNormalizedNamed(target)
- if err != nil {
- return errors.Wrapf(err, "Error parsing reference: %q is not a valid repository/tag", target)
- }
-
- if _, isCanonical := ref.(reference.Canonical); isCanonical {
- return errors.New("refusing to create a tag with a digest reference")
- }
-
- ref = reference.TagNameOnly(ref)
-
- query := url.Values{}
- query.Set("repo", ref.Name())
- if tagged, ok := ref.(reference.Tagged); ok {
- query.Set("tag", tagged.Tag())
- }
-
- resp, err := cli.post(ctx, "/images/"+source+"/tag", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/info.go b/vendor/github.com/docker/docker/client/info.go
deleted file mode 100644
index ed85d7f8..00000000
--- a/vendor/github.com/docker/docker/client/info.go
+++ /dev/null
@@ -1,26 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "fmt"
- "net/url"
-
- "github.com/docker/docker/api/types/system"
-)
-
-// Info returns information about the docker server.
-func (cli *Client) Info(ctx context.Context) (system.Info, error) {
- var info system.Info
- resp, err := cli.get(ctx, "/info", url.Values{}, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return info, err
- }
-
- if err := json.NewDecoder(resp.Body).Decode(&info); err != nil {
- return info, fmt.Errorf("Error reading remote info: %v", err)
- }
-
- return info, nil
-}
diff --git a/vendor/github.com/docker/docker/client/login.go b/vendor/github.com/docker/docker/client/login.go
deleted file mode 100644
index 2d7f1790..00000000
--- a/vendor/github.com/docker/docker/client/login.go
+++ /dev/null
@@ -1,24 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/registry"
-)
-
-// RegistryLogin authenticates the docker server with a given docker registry.
-// It returns unauthorizedError when the authentication fails.
-func (cli *Client) RegistryLogin(ctx context.Context, auth registry.AuthConfig) (registry.AuthenticateOKBody, error) {
- resp, err := cli.post(ctx, "/auth", url.Values{}, auth, nil)
- defer ensureReaderClosed(resp)
-
- if err != nil {
- return registry.AuthenticateOKBody{}, err
- }
-
- var response registry.AuthenticateOKBody
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/network_connect.go b/vendor/github.com/docker/docker/client/network_connect.go
deleted file mode 100644
index f7526c5d..00000000
--- a/vendor/github.com/docker/docker/client/network_connect.go
+++ /dev/null
@@ -1,28 +0,0 @@
-package client
-
-import (
- "context"
-
- "github.com/docker/docker/api/types/network"
-)
-
-// NetworkConnect connects a container to an existent network in the docker host.
-func (cli *Client) NetworkConnect(ctx context.Context, networkID, containerID string, config *network.EndpointSettings) error {
- networkID, err := trimID("network", networkID)
- if err != nil {
- return err
- }
-
- containerID, err = trimID("container", containerID)
- if err != nil {
- return err
- }
-
- nc := network.ConnectOptions{
- Container: containerID,
- EndpointConfig: config,
- }
- resp, err := cli.post(ctx, "/networks/"+networkID+"/connect", nil, nc, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/network_create.go b/vendor/github.com/docker/docker/client/network_create.go
deleted file mode 100644
index 6a7f2ea5..00000000
--- a/vendor/github.com/docker/docker/client/network_create.go
+++ /dev/null
@@ -1,40 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types/network"
- "github.com/docker/docker/api/types/versions"
-)
-
-// NetworkCreate creates a new network in the docker host.
-func (cli *Client) NetworkCreate(ctx context.Context, name string, options network.CreateOptions) (network.CreateResponse, error) {
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return network.CreateResponse{}, err
- }
-
- networkCreateRequest := network.CreateRequest{
- CreateOptions: options,
- Name: name,
- }
- if versions.LessThan(cli.version, "1.44") {
- enabled := true
- networkCreateRequest.CheckDuplicate = &enabled //nolint:staticcheck // ignore SA1019: CheckDuplicate is deprecated since API v1.44.
- }
-
- resp, err := cli.post(ctx, "/networks/create", nil, networkCreateRequest, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return network.CreateResponse{}, err
- }
-
- var response network.CreateResponse
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/network_disconnect.go b/vendor/github.com/docker/docker/client/network_disconnect.go
deleted file mode 100644
index 55f9b6a2..00000000
--- a/vendor/github.com/docker/docker/client/network_disconnect.go
+++ /dev/null
@@ -1,28 +0,0 @@
-package client
-
-import (
- "context"
-
- "github.com/docker/docker/api/types/network"
-)
-
-// NetworkDisconnect disconnects a container from an existent network in the docker host.
-func (cli *Client) NetworkDisconnect(ctx context.Context, networkID, containerID string, force bool) error {
- networkID, err := trimID("network", networkID)
- if err != nil {
- return err
- }
-
- containerID, err = trimID("container", containerID)
- if err != nil {
- return err
- }
-
- nd := network.DisconnectOptions{
- Container: containerID,
- Force: force,
- }
- resp, err := cli.post(ctx, "/networks/"+networkID+"/disconnect", nil, nd, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/network_inspect.go b/vendor/github.com/docker/docker/client/network_inspect.go
deleted file mode 100644
index 734ec102..00000000
--- a/vendor/github.com/docker/docker/client/network_inspect.go
+++ /dev/null
@@ -1,47 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "io"
- "net/url"
-
- "github.com/docker/docker/api/types/network"
-)
-
-// NetworkInspect returns the information for a specific network configured in the docker host.
-func (cli *Client) NetworkInspect(ctx context.Context, networkID string, options network.InspectOptions) (network.Inspect, error) {
- networkResource, _, err := cli.NetworkInspectWithRaw(ctx, networkID, options)
- return networkResource, err
-}
-
-// NetworkInspectWithRaw returns the information for a specific network configured in the docker host and its raw representation.
-func (cli *Client) NetworkInspectWithRaw(ctx context.Context, networkID string, options network.InspectOptions) (network.Inspect, []byte, error) {
- networkID, err := trimID("network", networkID)
- if err != nil {
- return network.Inspect{}, nil, err
- }
- query := url.Values{}
- if options.Verbose {
- query.Set("verbose", "true")
- }
- if options.Scope != "" {
- query.Set("scope", options.Scope)
- }
-
- resp, err := cli.get(ctx, "/networks/"+networkID, query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return network.Inspect{}, nil, err
- }
-
- raw, err := io.ReadAll(resp.Body)
- if err != nil {
- return network.Inspect{}, nil, err
- }
-
- var nw network.Inspect
- err = json.NewDecoder(bytes.NewReader(raw)).Decode(&nw)
- return nw, raw, err
-}
diff --git a/vendor/github.com/docker/docker/client/network_list.go b/vendor/github.com/docker/docker/client/network_list.go
deleted file mode 100644
index 8d933619..00000000
--- a/vendor/github.com/docker/docker/client/network_list.go
+++ /dev/null
@@ -1,32 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/network"
-)
-
-// NetworkList returns the list of networks configured in the docker host.
-func (cli *Client) NetworkList(ctx context.Context, options network.ListOptions) ([]network.Summary, error) {
- query := url.Values{}
- if options.Filters.Len() > 0 {
- //nolint:staticcheck // ignore SA1019 for old code
- filterJSON, err := filters.ToParamWithVersion(cli.version, options.Filters)
- if err != nil {
- return nil, err
- }
-
- query.Set("filters", filterJSON)
- }
- var networkResources []network.Summary
- resp, err := cli.get(ctx, "/networks", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return networkResources, err
- }
- err = json.NewDecoder(resp.Body).Decode(&networkResources)
- return networkResources, err
-}
diff --git a/vendor/github.com/docker/docker/client/network_prune.go b/vendor/github.com/docker/docker/client/network_prune.go
deleted file mode 100644
index 7835fe90..00000000
--- a/vendor/github.com/docker/docker/client/network_prune.go
+++ /dev/null
@@ -1,35 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "fmt"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/network"
-)
-
-// NetworksPrune requests the daemon to delete unused networks
-func (cli *Client) NetworksPrune(ctx context.Context, pruneFilters filters.Args) (network.PruneReport, error) {
- if err := cli.NewVersionError(ctx, "1.25", "network prune"); err != nil {
- return network.PruneReport{}, err
- }
-
- query, err := getFiltersQuery(pruneFilters)
- if err != nil {
- return network.PruneReport{}, err
- }
-
- resp, err := cli.post(ctx, "/networks/prune", query, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return network.PruneReport{}, err
- }
-
- var report network.PruneReport
- if err := json.NewDecoder(resp.Body).Decode(&report); err != nil {
- return network.PruneReport{}, fmt.Errorf("Error retrieving network prune report: %v", err)
- }
-
- return report, nil
-}
diff --git a/vendor/github.com/docker/docker/client/network_remove.go b/vendor/github.com/docker/docker/client/network_remove.go
deleted file mode 100644
index 9b164d3e..00000000
--- a/vendor/github.com/docker/docker/client/network_remove.go
+++ /dev/null
@@ -1,14 +0,0 @@
-package client
-
-import "context"
-
-// NetworkRemove removes an existent network from the docker host.
-func (cli *Client) NetworkRemove(ctx context.Context, networkID string) error {
- networkID, err := trimID("network", networkID)
- if err != nil {
- return err
- }
- resp, err := cli.delete(ctx, "/networks/"+networkID, nil, nil)
- defer ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/node_inspect.go b/vendor/github.com/docker/docker/client/node_inspect.go
deleted file mode 100644
index dd1f1f8a..00000000
--- a/vendor/github.com/docker/docker/client/node_inspect.go
+++ /dev/null
@@ -1,33 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "io"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// NodeInspectWithRaw returns the node information.
-func (cli *Client) NodeInspectWithRaw(ctx context.Context, nodeID string) (swarm.Node, []byte, error) {
- nodeID, err := trimID("node", nodeID)
- if err != nil {
- return swarm.Node{}, nil, err
- }
- resp, err := cli.get(ctx, "/nodes/"+nodeID, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.Node{}, nil, err
- }
-
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return swarm.Node{}, nil, err
- }
-
- var response swarm.Node
- rdr := bytes.NewReader(body)
- err = json.NewDecoder(rdr).Decode(&response)
- return response, body, err
-}
diff --git a/vendor/github.com/docker/docker/client/node_list.go b/vendor/github.com/docker/docker/client/node_list.go
deleted file mode 100644
index 3b393ffe..00000000
--- a/vendor/github.com/docker/docker/client/node_list.go
+++ /dev/null
@@ -1,34 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/swarm"
-)
-
-// NodeList returns the list of nodes.
-func (cli *Client) NodeList(ctx context.Context, options swarm.NodeListOptions) ([]swarm.Node, error) {
- query := url.Values{}
-
- if options.Filters.Len() > 0 {
- filterJSON, err := filters.ToJSON(options.Filters)
- if err != nil {
- return nil, err
- }
-
- query.Set("filters", filterJSON)
- }
-
- resp, err := cli.get(ctx, "/nodes", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var nodes []swarm.Node
- err = json.NewDecoder(resp.Body).Decode(&nodes)
- return nodes, err
-}
diff --git a/vendor/github.com/docker/docker/client/node_remove.go b/vendor/github.com/docker/docker/client/node_remove.go
deleted file mode 100644
index 644fe138..00000000
--- a/vendor/github.com/docker/docker/client/node_remove.go
+++ /dev/null
@@ -1,25 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// NodeRemove removes a Node.
-func (cli *Client) NodeRemove(ctx context.Context, nodeID string, options swarm.NodeRemoveOptions) error {
- nodeID, err := trimID("node", nodeID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if options.Force {
- query.Set("force", "1")
- }
-
- resp, err := cli.delete(ctx, "/nodes/"+nodeID, query, nil)
- defer ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/node_update.go b/vendor/github.com/docker/docker/client/node_update.go
deleted file mode 100644
index 62af964c..00000000
--- a/vendor/github.com/docker/docker/client/node_update.go
+++ /dev/null
@@ -1,22 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// NodeUpdate updates a Node.
-func (cli *Client) NodeUpdate(ctx context.Context, nodeID string, version swarm.Version, node swarm.NodeSpec) error {
- nodeID, err := trimID("node", nodeID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- query.Set("version", version.String())
- resp, err := cli.post(ctx, "/nodes/"+nodeID+"/update", query, node, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/options.go b/vendor/github.com/docker/docker/client/options.go
deleted file mode 100644
index 6f68fc2b..00000000
--- a/vendor/github.com/docker/docker/client/options.go
+++ /dev/null
@@ -1,240 +0,0 @@
-package client
-
-import (
- "context"
- "net"
- "net/http"
- "os"
- "path/filepath"
- "strings"
- "time"
-
- "github.com/docker/go-connections/sockets"
- "github.com/docker/go-connections/tlsconfig"
- "github.com/pkg/errors"
- "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
- "go.opentelemetry.io/otel/trace"
-)
-
-// Opt is a configuration option to initialize a [Client].
-type Opt func(*Client) error
-
-// FromEnv configures the client with values from environment variables. It
-// is the equivalent of using the [WithTLSClientConfigFromEnv], [WithHostFromEnv],
-// and [WithVersionFromEnv] options.
-//
-// FromEnv uses the following environment variables:
-//
-// - DOCKER_HOST ([EnvOverrideHost]) to set the URL to the docker server.
-// - DOCKER_API_VERSION ([EnvOverrideAPIVersion]) to set the version of the
-// API to use, leave empty for latest.
-// - DOCKER_CERT_PATH ([EnvOverrideCertPath]) to specify the directory from
-// which to load the TLS certificates ("ca.pem", "cert.pem", "key.pem').
-// - DOCKER_TLS_VERIFY ([EnvTLSVerify]) to enable or disable TLS verification
-// (off by default).
-func FromEnv(c *Client) error {
- ops := []Opt{
- WithTLSClientConfigFromEnv(),
- WithHostFromEnv(),
- WithVersionFromEnv(),
- }
- for _, op := range ops {
- if err := op(c); err != nil {
- return err
- }
- }
- return nil
-}
-
-// WithDialContext applies the dialer to the client transport. This can be
-// used to set the Timeout and KeepAlive settings of the client. It returns
-// an error if the client does not have a [http.Transport] configured.
-func WithDialContext(dialContext func(ctx context.Context, network, addr string) (net.Conn, error)) Opt {
- return func(c *Client) error {
- if transport, ok := c.client.Transport.(*http.Transport); ok {
- transport.DialContext = dialContext
- return nil
- }
- return errors.Errorf("cannot apply dialer to transport: %T", c.client.Transport)
- }
-}
-
-// WithHost overrides the client host with the specified one.
-func WithHost(host string) Opt {
- return func(c *Client) error {
- hostURL, err := ParseHostURL(host)
- if err != nil {
- return err
- }
- c.host = host
- c.proto = hostURL.Scheme
- c.addr = hostURL.Host
- c.basePath = hostURL.Path
- if transport, ok := c.client.Transport.(*http.Transport); ok {
- return sockets.ConfigureTransport(transport, c.proto, c.addr)
- }
- return errors.Errorf("cannot apply host to transport: %T", c.client.Transport)
- }
-}
-
-// WithHostFromEnv overrides the client host with the host specified in the
-// DOCKER_HOST ([EnvOverrideHost]) environment variable. If DOCKER_HOST is not set,
-// or set to an empty value, the host is not modified.
-func WithHostFromEnv() Opt {
- return func(c *Client) error {
- if host := os.Getenv(EnvOverrideHost); host != "" {
- return WithHost(host)(c)
- }
- return nil
- }
-}
-
-// WithHTTPClient overrides the client's HTTP client with the specified one.
-func WithHTTPClient(client *http.Client) Opt {
- return func(c *Client) error {
- if client != nil {
- c.client = client
- }
- return nil
- }
-}
-
-// WithTimeout configures the time limit for requests made by the HTTP client.
-func WithTimeout(timeout time.Duration) Opt {
- return func(c *Client) error {
- c.client.Timeout = timeout
- return nil
- }
-}
-
-// WithUserAgent configures the User-Agent header to use for HTTP requests.
-// It overrides any User-Agent set in headers. When set to an empty string,
-// the User-Agent header is removed, and no header is sent.
-func WithUserAgent(ua string) Opt {
- return func(c *Client) error {
- c.userAgent = &ua
- return nil
- }
-}
-
-// WithHTTPHeaders appends custom HTTP headers to the client's default headers.
-// It does not allow for built-in headers (such as "User-Agent", if set) to
-// be overridden. Also see [WithUserAgent].
-func WithHTTPHeaders(headers map[string]string) Opt {
- return func(c *Client) error {
- c.customHTTPHeaders = headers
- return nil
- }
-}
-
-// WithScheme overrides the client scheme with the specified one.
-func WithScheme(scheme string) Opt {
- return func(c *Client) error {
- c.scheme = scheme
- return nil
- }
-}
-
-// WithTLSClientConfig applies a TLS config to the client transport.
-func WithTLSClientConfig(cacertPath, certPath, keyPath string) Opt {
- return func(c *Client) error {
- transport, ok := c.client.Transport.(*http.Transport)
- if !ok {
- return errors.Errorf("cannot apply tls config to transport: %T", c.client.Transport)
- }
- config, err := tlsconfig.Client(tlsconfig.Options{
- CAFile: cacertPath,
- CertFile: certPath,
- KeyFile: keyPath,
- ExclusiveRootPools: true,
- })
- if err != nil {
- return errors.Wrap(err, "failed to create tls config")
- }
- transport.TLSClientConfig = config
- return nil
- }
-}
-
-// WithTLSClientConfigFromEnv configures the client's TLS settings with the
-// settings in the DOCKER_CERT_PATH ([EnvOverrideCertPath]) and DOCKER_TLS_VERIFY
-// ([EnvTLSVerify]) environment variables. If DOCKER_CERT_PATH is not set or empty,
-// TLS configuration is not modified.
-//
-// WithTLSClientConfigFromEnv uses the following environment variables:
-//
-// - DOCKER_CERT_PATH ([EnvOverrideCertPath]) to specify the directory from
-// which to load the TLS certificates ("ca.pem", "cert.pem", "key.pem").
-// - DOCKER_TLS_VERIFY ([EnvTLSVerify]) to enable or disable TLS verification
-// (off by default).
-func WithTLSClientConfigFromEnv() Opt {
- return func(c *Client) error {
- dockerCertPath := os.Getenv(EnvOverrideCertPath)
- if dockerCertPath == "" {
- return nil
- }
- tlsc, err := tlsconfig.Client(tlsconfig.Options{
- CAFile: filepath.Join(dockerCertPath, "ca.pem"),
- CertFile: filepath.Join(dockerCertPath, "cert.pem"),
- KeyFile: filepath.Join(dockerCertPath, "key.pem"),
- InsecureSkipVerify: os.Getenv(EnvTLSVerify) == "",
- })
- if err != nil {
- return err
- }
-
- c.client = &http.Client{
- Transport: &http.Transport{TLSClientConfig: tlsc},
- CheckRedirect: CheckRedirect,
- }
- return nil
- }
-}
-
-// WithVersion overrides the client version with the specified one. If an empty
-// version is provided, the value is ignored to allow version negotiation
-// (see [WithAPIVersionNegotiation]).
-func WithVersion(version string) Opt {
- return func(c *Client) error {
- if v := strings.TrimPrefix(version, "v"); v != "" {
- c.version = v
- c.manualOverride = true
- }
- return nil
- }
-}
-
-// WithVersionFromEnv overrides the client version with the version specified in
-// the DOCKER_API_VERSION ([EnvOverrideAPIVersion]) environment variable.
-// If DOCKER_API_VERSION is not set, or set to an empty value, the version
-// is not modified.
-func WithVersionFromEnv() Opt {
- return func(c *Client) error {
- return WithVersion(os.Getenv(EnvOverrideAPIVersion))(c)
- }
-}
-
-// WithAPIVersionNegotiation enables automatic API version negotiation for the client.
-// With this option enabled, the client automatically negotiates the API version
-// to use when making requests. API version negotiation is performed on the first
-// request; subsequent requests do not re-negotiate.
-func WithAPIVersionNegotiation() Opt {
- return func(c *Client) error {
- c.negotiateVersion = true
- return nil
- }
-}
-
-// WithTraceProvider sets the trace provider for the client.
-// If this is not set then the global trace provider will be used.
-func WithTraceProvider(provider trace.TracerProvider) Opt {
- return WithTraceOptions(otelhttp.WithTracerProvider(provider))
-}
-
-// WithTraceOptions sets tracing span options for the client.
-func WithTraceOptions(opts ...otelhttp.Option) Opt {
- return func(c *Client) error {
- c.traceOpts = append(c.traceOpts, opts...)
- return nil
- }
-}
diff --git a/vendor/github.com/docker/docker/client/ping.go b/vendor/github.com/docker/docker/client/ping.go
deleted file mode 100644
index 385fdf05..00000000
--- a/vendor/github.com/docker/docker/client/ping.go
+++ /dev/null
@@ -1,81 +0,0 @@
-package client
-
-import (
- "context"
- "net/http"
- "path"
- "strings"
-
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/build"
- "github.com/docker/docker/api/types/swarm"
-)
-
-// Ping pings the server and returns the value of the "Docker-Experimental",
-// "Builder-Version", "OS-Type" & "API-Version" headers. It attempts to use
-// a HEAD request on the endpoint, but falls back to GET if HEAD is not supported
-// by the daemon. It ignores internal server errors returned by the API, which
-// may be returned if the daemon is in an unhealthy state, but returns errors
-// for other non-success status codes, failing to connect to the API, or failing
-// to parse the API response.
-func (cli *Client) Ping(ctx context.Context) (types.Ping, error) {
- var ping types.Ping
-
- // Using cli.buildRequest() + cli.doRequest() instead of cli.sendRequest()
- // because ping requests are used during API version negotiation, so we want
- // to hit the non-versioned /_ping endpoint, not /v1.xx/_ping
- req, err := cli.buildRequest(ctx, http.MethodHead, path.Join(cli.basePath, "/_ping"), nil, nil)
- if err != nil {
- return ping, err
- }
- resp, err := cli.doRequest(req)
- if err != nil {
- if IsErrConnectionFailed(err) {
- return ping, err
- }
- // We managed to connect, but got some error; continue and try GET request.
- } else {
- defer ensureReaderClosed(resp)
- switch resp.StatusCode {
- case http.StatusOK, http.StatusInternalServerError:
- // Server handled the request, so parse the response
- return parsePingResponse(cli, resp)
- }
- }
-
- // HEAD failed; fallback to GET.
- req.Method = http.MethodGet
- resp, err = cli.doRequest(req)
- defer ensureReaderClosed(resp)
- if err != nil {
- return ping, err
- }
- return parsePingResponse(cli, resp)
-}
-
-func parsePingResponse(cli *Client, resp *http.Response) (types.Ping, error) {
- if resp == nil {
- return types.Ping{}, nil
- }
-
- var ping types.Ping
- if resp.Header == nil {
- return ping, cli.checkResponseErr(resp)
- }
- ping.APIVersion = resp.Header.Get("Api-Version")
- ping.OSType = resp.Header.Get("Ostype")
- if resp.Header.Get("Docker-Experimental") == "true" {
- ping.Experimental = true
- }
- if bv := resp.Header.Get("Builder-Version"); bv != "" {
- ping.BuilderVersion = build.BuilderVersion(bv)
- }
- if si := resp.Header.Get("Swarm"); si != "" {
- state, role, _ := strings.Cut(si, "/")
- ping.SwarmStatus = &swarm.Status{
- NodeState: swarm.LocalNodeState(state),
- ControlAvailable: role == "manager",
- }
- }
- return ping, cli.checkResponseErr(resp)
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_create.go b/vendor/github.com/docker/docker/client/plugin_create.go
deleted file mode 100644
index eaba7ee6..00000000
--- a/vendor/github.com/docker/docker/client/plugin_create.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/http"
- "net/url"
-
- "github.com/docker/docker/api/types"
-)
-
-// PluginCreate creates a plugin
-func (cli *Client) PluginCreate(ctx context.Context, createContext io.Reader, createOptions types.PluginCreateOptions) error {
- headers := http.Header(make(map[string][]string))
- headers.Set("Content-Type", "application/x-tar")
-
- query := url.Values{}
- query.Set("name", createOptions.RepoName)
-
- resp, err := cli.postRaw(ctx, "/plugins/create", query, createContext, headers)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_disable.go b/vendor/github.com/docker/docker/client/plugin_disable.go
deleted file mode 100644
index 4049b1b6..00000000
--- a/vendor/github.com/docker/docker/client/plugin_disable.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types"
-)
-
-// PluginDisable disables a plugin
-func (cli *Client) PluginDisable(ctx context.Context, name string, options types.PluginDisableOptions) error {
- name, err := trimID("plugin", name)
- if err != nil {
- return err
- }
- query := url.Values{}
- if options.Force {
- query.Set("force", "1")
- }
- resp, err := cli.post(ctx, "/plugins/"+name+"/disable", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_enable.go b/vendor/github.com/docker/docker/client/plugin_enable.go
deleted file mode 100644
index 61185693..00000000
--- a/vendor/github.com/docker/docker/client/plugin_enable.go
+++ /dev/null
@@ -1,23 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
- "strconv"
-
- "github.com/docker/docker/api/types"
-)
-
-// PluginEnable enables a plugin
-func (cli *Client) PluginEnable(ctx context.Context, name string, options types.PluginEnableOptions) error {
- name, err := trimID("plugin", name)
- if err != nil {
- return err
- }
- query := url.Values{}
- query.Set("timeout", strconv.Itoa(options.Timeout))
-
- resp, err := cli.post(ctx, "/plugins/"+name+"/enable", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_inspect.go b/vendor/github.com/docker/docker/client/plugin_inspect.go
deleted file mode 100644
index eaedeb8a..00000000
--- a/vendor/github.com/docker/docker/client/plugin_inspect.go
+++ /dev/null
@@ -1,32 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "io"
-
- "github.com/docker/docker/api/types"
-)
-
-// PluginInspectWithRaw inspects an existing plugin
-func (cli *Client) PluginInspectWithRaw(ctx context.Context, name string) (*types.Plugin, []byte, error) {
- name, err := trimID("plugin", name)
- if err != nil {
- return nil, nil, err
- }
- resp, err := cli.get(ctx, "/plugins/"+name+"/json", nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, nil, err
- }
-
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return nil, nil, err
- }
- var p types.Plugin
- rdr := bytes.NewReader(body)
- err = json.NewDecoder(rdr).Decode(&p)
- return &p, body, err
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_install.go b/vendor/github.com/docker/docker/client/plugin_install.go
deleted file mode 100644
index 5fd2ff21..00000000
--- a/vendor/github.com/docker/docker/client/plugin_install.go
+++ /dev/null
@@ -1,117 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "io"
- "net/http"
- "net/url"
-
- cerrdefs "github.com/containerd/errdefs"
- "github.com/distribution/reference"
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/registry"
- "github.com/pkg/errors"
-)
-
-// PluginInstall installs a plugin
-func (cli *Client) PluginInstall(ctx context.Context, name string, options types.PluginInstallOptions) (_ io.ReadCloser, retErr error) {
- query := url.Values{}
- if _, err := reference.ParseNormalizedNamed(options.RemoteRef); err != nil {
- return nil, errors.Wrap(err, "invalid remote reference")
- }
- query.Set("remote", options.RemoteRef)
-
- privileges, err := cli.checkPluginPermissions(ctx, query, options)
- if err != nil {
- return nil, err
- }
-
- // set name for plugin pull, if empty should default to remote reference
- query.Set("name", name)
-
- resp, err := cli.tryPluginPull(ctx, query, privileges, options.RegistryAuth)
- if err != nil {
- return nil, err
- }
-
- name = resp.Header.Get("Docker-Plugin-Name")
-
- pr, pw := io.Pipe()
- go func() { // todo: the client should probably be designed more around the actual api
- _, err := io.Copy(pw, resp.Body)
- if err != nil {
- _ = pw.CloseWithError(err)
- return
- }
- defer func() {
- if retErr != nil {
- delResp, _ := cli.delete(ctx, "/plugins/"+name, nil, nil)
- ensureReaderClosed(delResp)
- }
- }()
- if len(options.Args) > 0 {
- if err := cli.PluginSet(ctx, name, options.Args); err != nil {
- _ = pw.CloseWithError(err)
- return
- }
- }
-
- if options.Disabled {
- _ = pw.Close()
- return
- }
-
- enableErr := cli.PluginEnable(ctx, name, types.PluginEnableOptions{Timeout: 0})
- _ = pw.CloseWithError(enableErr)
- }()
- return pr, nil
-}
-
-func (cli *Client) tryPluginPrivileges(ctx context.Context, query url.Values, registryAuth string) (*http.Response, error) {
- return cli.get(ctx, "/plugins/privileges", query, http.Header{
- registry.AuthHeader: {registryAuth},
- })
-}
-
-func (cli *Client) tryPluginPull(ctx context.Context, query url.Values, privileges types.PluginPrivileges, registryAuth string) (*http.Response, error) {
- return cli.post(ctx, "/plugins/pull", query, privileges, http.Header{
- registry.AuthHeader: {registryAuth},
- })
-}
-
-func (cli *Client) checkPluginPermissions(ctx context.Context, query url.Values, options types.PluginInstallOptions) (types.PluginPrivileges, error) {
- resp, err := cli.tryPluginPrivileges(ctx, query, options.RegistryAuth)
- if cerrdefs.IsUnauthorized(err) && options.PrivilegeFunc != nil {
- // todo: do inspect before to check existing name before checking privileges
- newAuthHeader, privilegeErr := options.PrivilegeFunc(ctx)
- if privilegeErr != nil {
- ensureReaderClosed(resp)
- return nil, privilegeErr
- }
- options.RegistryAuth = newAuthHeader
- resp, err = cli.tryPluginPrivileges(ctx, query, options.RegistryAuth)
- }
- if err != nil {
- ensureReaderClosed(resp)
- return nil, err
- }
-
- var privileges types.PluginPrivileges
- if err := json.NewDecoder(resp.Body).Decode(&privileges); err != nil {
- ensureReaderClosed(resp)
- return nil, err
- }
- ensureReaderClosed(resp)
-
- if !options.AcceptAllPermissions && options.AcceptPermissionsFunc != nil && len(privileges) > 0 {
- accept, err := options.AcceptPermissionsFunc(ctx, privileges)
- if err != nil {
- return nil, err
- }
- if !accept {
- return nil, errors.Errorf("permission denied while installing plugin %s", options.RemoteRef)
- }
- }
- return privileges, nil
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_list.go b/vendor/github.com/docker/docker/client/plugin_list.go
deleted file mode 100644
index f314e17f..00000000
--- a/vendor/github.com/docker/docker/client/plugin_list.go
+++ /dev/null
@@ -1,33 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/filters"
-)
-
-// PluginList returns the installed plugins
-func (cli *Client) PluginList(ctx context.Context, filter filters.Args) (types.PluginsListResponse, error) {
- var plugins types.PluginsListResponse
- query := url.Values{}
-
- if filter.Len() > 0 {
- //nolint:staticcheck // ignore SA1019 for old code
- filterJSON, err := filters.ToParamWithVersion(cli.version, filter)
- if err != nil {
- return plugins, err
- }
- query.Set("filters", filterJSON)
- }
- resp, err := cli.get(ctx, "/plugins", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return plugins, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&plugins)
- return plugins, err
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_push.go b/vendor/github.com/docker/docker/client/plugin_push.go
deleted file mode 100644
index 4574dcdd..00000000
--- a/vendor/github.com/docker/docker/client/plugin_push.go
+++ /dev/null
@@ -1,24 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/http"
-
- "github.com/docker/docker/api/types/registry"
-)
-
-// PluginPush pushes a plugin to a registry
-func (cli *Client) PluginPush(ctx context.Context, name string, registryAuth string) (io.ReadCloser, error) {
- name, err := trimID("plugin", name)
- if err != nil {
- return nil, err
- }
- resp, err := cli.post(ctx, "/plugins/"+name+"/push", nil, nil, http.Header{
- registry.AuthHeader: {registryAuth},
- })
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_remove.go b/vendor/github.com/docker/docker/client/plugin_remove.go
deleted file mode 100644
index 2ba0a8cc..00000000
--- a/vendor/github.com/docker/docker/client/plugin_remove.go
+++ /dev/null
@@ -1,25 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types"
-)
-
-// PluginRemove removes a plugin
-func (cli *Client) PluginRemove(ctx context.Context, name string, options types.PluginRemoveOptions) error {
- name, err := trimID("plugin", name)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if options.Force {
- query.Set("force", "1")
- }
-
- resp, err := cli.delete(ctx, "/plugins/"+name, query, nil)
- defer ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_set.go b/vendor/github.com/docker/docker/client/plugin_set.go
deleted file mode 100644
index f0e4a0c3..00000000
--- a/vendor/github.com/docker/docker/client/plugin_set.go
+++ /dev/null
@@ -1,17 +0,0 @@
-package client
-
-import (
- "context"
-)
-
-// PluginSet modifies settings for an existing plugin
-func (cli *Client) PluginSet(ctx context.Context, name string, args []string) error {
- name, err := trimID("plugin", name)
- if err != nil {
- return err
- }
-
- resp, err := cli.post(ctx, "/plugins/"+name+"/set", nil, args, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/plugin_upgrade.go b/vendor/github.com/docker/docker/client/plugin_upgrade.go
deleted file mode 100644
index cd0cf4d2..00000000
--- a/vendor/github.com/docker/docker/client/plugin_upgrade.go
+++ /dev/null
@@ -1,47 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/http"
- "net/url"
-
- "github.com/distribution/reference"
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/registry"
- "github.com/pkg/errors"
-)
-
-// PluginUpgrade upgrades a plugin
-func (cli *Client) PluginUpgrade(ctx context.Context, name string, options types.PluginInstallOptions) (io.ReadCloser, error) {
- name, err := trimID("plugin", name)
- if err != nil {
- return nil, err
- }
-
- if err := cli.NewVersionError(ctx, "1.26", "plugin upgrade"); err != nil {
- return nil, err
- }
- query := url.Values{}
- if _, err := reference.ParseNormalizedNamed(options.RemoteRef); err != nil {
- return nil, errors.Wrap(err, "invalid remote reference")
- }
- query.Set("remote", options.RemoteRef)
-
- privileges, err := cli.checkPluginPermissions(ctx, query, options)
- if err != nil {
- return nil, err
- }
-
- resp, err := cli.tryPluginUpgrade(ctx, query, privileges, name, options.RegistryAuth)
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
-
-func (cli *Client) tryPluginUpgrade(ctx context.Context, query url.Values, privileges types.PluginPrivileges, name, registryAuth string) (*http.Response, error) {
- return cli.post(ctx, "/plugins/"+name+"/upgrade", query, privileges, http.Header{
- registry.AuthHeader: {registryAuth},
- })
-}
diff --git a/vendor/github.com/docker/docker/client/request.go b/vendor/github.com/docker/docker/client/request.go
deleted file mode 100644
index 254138fc..00000000
--- a/vendor/github.com/docker/docker/client/request.go
+++ /dev/null
@@ -1,322 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "fmt"
- "io"
- "net"
- "net/http"
- "net/url"
- "os"
- "reflect"
- "strings"
-
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/versions"
- "github.com/pkg/errors"
-)
-
-// head sends an http request to the docker API using the method HEAD.
-func (cli *Client) head(ctx context.Context, path string, query url.Values, headers http.Header) (*http.Response, error) {
- return cli.sendRequest(ctx, http.MethodHead, path, query, nil, headers)
-}
-
-// get sends an http request to the docker API using the method GET with a specific Go context.
-func (cli *Client) get(ctx context.Context, path string, query url.Values, headers http.Header) (*http.Response, error) {
- return cli.sendRequest(ctx, http.MethodGet, path, query, nil, headers)
-}
-
-// post sends an http request to the docker API using the method POST with a specific Go context.
-func (cli *Client) post(ctx context.Context, path string, query url.Values, obj interface{}, headers http.Header) (*http.Response, error) {
- body, headers, err := encodeBody(obj, headers)
- if err != nil {
- return nil, err
- }
- return cli.sendRequest(ctx, http.MethodPost, path, query, body, headers)
-}
-
-func (cli *Client) postRaw(ctx context.Context, path string, query url.Values, body io.Reader, headers http.Header) (*http.Response, error) {
- return cli.sendRequest(ctx, http.MethodPost, path, query, body, headers)
-}
-
-func (cli *Client) put(ctx context.Context, path string, query url.Values, obj interface{}, headers http.Header) (*http.Response, error) {
- body, headers, err := encodeBody(obj, headers)
- if err != nil {
- return nil, err
- }
- return cli.putRaw(ctx, path, query, body, headers)
-}
-
-// putRaw sends an http request to the docker API using the method PUT.
-func (cli *Client) putRaw(ctx context.Context, path string, query url.Values, body io.Reader, headers http.Header) (*http.Response, error) {
- // PUT requests are expected to always have a body (apparently)
- // so explicitly pass an empty body to sendRequest to signal that
- // it should set the Content-Type header if not already present.
- if body == nil {
- body = http.NoBody
- }
- return cli.sendRequest(ctx, http.MethodPut, path, query, body, headers)
-}
-
-// delete sends an http request to the docker API using the method DELETE.
-func (cli *Client) delete(ctx context.Context, path string, query url.Values, headers http.Header) (*http.Response, error) {
- return cli.sendRequest(ctx, http.MethodDelete, path, query, nil, headers)
-}
-
-func encodeBody(obj interface{}, headers http.Header) (io.Reader, http.Header, error) {
- if obj == nil {
- return nil, headers, nil
- }
- // encoding/json encodes a nil pointer as the JSON document `null`,
- // irrespective of whether the type implements json.Marshaler or encoding.TextMarshaler.
- // That is almost certainly not what the caller intended as the request body.
- if reflect.TypeOf(obj).Kind() == reflect.Ptr && reflect.ValueOf(obj).IsNil() {
- return nil, headers, nil
- }
-
- body, err := encodeData(obj)
- if err != nil {
- return nil, headers, err
- }
- if headers == nil {
- headers = make(map[string][]string)
- }
- headers["Content-Type"] = []string{"application/json"}
- return body, headers, nil
-}
-
-func (cli *Client) buildRequest(ctx context.Context, method, path string, body io.Reader, headers http.Header) (*http.Request, error) {
- req, err := http.NewRequestWithContext(ctx, method, path, body)
- if err != nil {
- return nil, err
- }
- req = cli.addHeaders(req, headers)
- req.URL.Scheme = cli.scheme
- req.URL.Host = cli.addr
-
- if cli.proto == "unix" || cli.proto == "npipe" {
- // Override host header for non-tcp connections.
- req.Host = DummyHost
- }
-
- if body != nil && req.Header.Get("Content-Type") == "" {
- req.Header.Set("Content-Type", "text/plain")
- }
- return req, nil
-}
-
-func (cli *Client) sendRequest(ctx context.Context, method, path string, query url.Values, body io.Reader, headers http.Header) (*http.Response, error) {
- req, err := cli.buildRequest(ctx, method, cli.getAPIPath(ctx, path, query), body, headers)
- if err != nil {
- return nil, err
- }
-
- resp, err := cli.doRequest(req)
- switch {
- case errors.Is(err, context.Canceled), errors.Is(err, context.DeadlineExceeded):
- return nil, err
- case err == nil:
- return resp, cli.checkResponseErr(resp)
- default:
- return resp, err
- }
-}
-
-func (cli *Client) doRequest(req *http.Request) (*http.Response, error) {
- resp, err := cli.client.Do(req)
- if err != nil {
- if cli.scheme != "https" && strings.Contains(err.Error(), "malformed HTTP response") {
- return nil, errConnectionFailed{fmt.Errorf("%v.\n* Are you trying to connect to a TLS-enabled daemon without TLS?", err)}
- }
-
- if cli.scheme == "https" && strings.Contains(err.Error(), "bad certificate") {
- return nil, errConnectionFailed{errors.Wrap(err, "the server probably has client authentication (--tlsverify) enabled; check your TLS client certification settings")}
- }
-
- // Don't decorate context sentinel errors; users may be comparing to
- // them directly.
- if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
- return nil, err
- }
-
- var uErr *url.Error
- if errors.As(err, &uErr) {
- var nErr *net.OpError
- if errors.As(uErr.Err, &nErr) {
- if os.IsPermission(nErr.Err) {
- return nil, errConnectionFailed{errors.Wrapf(err, "permission denied while trying to connect to the Docker daemon socket at %v", cli.host)}
- }
- }
- }
-
- var nErr net.Error
- if errors.As(err, &nErr) {
- // FIXME(thaJeztah): any net.Error should be considered a connection error (but we should include the original error)?
- if nErr.Timeout() {
- return nil, connectionFailed(cli.host)
- }
- if strings.Contains(nErr.Error(), "connection refused") || strings.Contains(nErr.Error(), "dial unix") {
- return nil, connectionFailed(cli.host)
- }
- }
-
- // Although there's not a strongly typed error for this in go-winio,
- // lots of people are using the default configuration for the docker
- // daemon on Windows where the daemon is listening on a named pipe
- // `//./pipe/docker_engine, and the client must be running elevated.
- // Give users a clue rather than the not-overly useful message
- // such as `error during connect: Get http://%2F%2F.%2Fpipe%2Fdocker_engine/v1.26/info:
- // open //./pipe/docker_engine: The system cannot find the file specified.`.
- // Note we can't string compare "The system cannot find the file specified" as
- // this is localised - for example in French the error would be
- // `open //./pipe/docker_engine: Le fichier spécifié est introuvable.`
- if strings.Contains(err.Error(), `open //./pipe/docker_engine`) {
- // Checks if client is running with elevated privileges
- if f, elevatedErr := os.Open(`\\.\PHYSICALDRIVE0`); elevatedErr != nil {
- err = errors.Wrap(err, "in the default daemon configuration on Windows, the docker client must be run with elevated privileges to connect")
- } else {
- _ = f.Close()
- err = errors.Wrap(err, "this error may indicate that the docker daemon is not running")
- }
- }
-
- return nil, errConnectionFailed{errors.Wrap(err, "error during connect")}
- }
-
- return resp, nil
-}
-
-func (cli *Client) checkResponseErr(serverResp *http.Response) (retErr error) {
- if serverResp == nil {
- return nil
- }
- if serverResp.StatusCode >= http.StatusOK && serverResp.StatusCode < http.StatusBadRequest {
- return nil
- }
- defer func() {
- retErr = httpErrorFromStatusCode(retErr, serverResp.StatusCode)
- }()
-
- var body []byte
- var err error
- var reqURL string
- if serverResp.Request != nil {
- reqURL = serverResp.Request.URL.String()
- }
- statusMsg := serverResp.Status
- if statusMsg == "" {
- statusMsg = http.StatusText(serverResp.StatusCode)
- }
- if serverResp.Body != nil {
- bodyMax := 1 * 1024 * 1024 // 1 MiB
- bodyR := &io.LimitedReader{
- R: serverResp.Body,
- N: int64(bodyMax),
- }
- body, err = io.ReadAll(bodyR)
- if err != nil {
- return err
- }
- if bodyR.N == 0 {
- if reqURL != "" {
- return fmt.Errorf("request returned %s with a message (> %d bytes) for API route and version %s, check if the server supports the requested API version", statusMsg, bodyMax, reqURL)
- }
- return fmt.Errorf("request returned %s with a message (> %d bytes); check if the server supports the requested API version", statusMsg, bodyMax)
- }
- }
- if len(body) == 0 {
- if reqURL != "" {
- return fmt.Errorf("request returned %s for API route and version %s, check if the server supports the requested API version", statusMsg, reqURL)
- }
- return fmt.Errorf("request returned %s; check if the server supports the requested API version", statusMsg)
- }
-
- var daemonErr error
- if serverResp.Header.Get("Content-Type") == "application/json" {
- var errorResponse types.ErrorResponse
- if err := json.Unmarshal(body, &errorResponse); err != nil {
- return errors.Wrap(err, "Error reading JSON")
- }
- if errorResponse.Message == "" {
- // Error-message is empty, which means that we successfully parsed the
- // JSON-response (no error produced), but it didn't contain an error
- // message. This could either be because the response was empty, or
- // the response was valid JSON, but not with the expected schema
- // ([types.ErrorResponse]).
- //
- // We cannot use "strict" JSON handling (json.NewDecoder with DisallowUnknownFields)
- // due to the API using an open schema (we must anticipate fields
- // being added to [types.ErrorResponse] in the future, and not
- // reject those responses.
- //
- // For these cases, we construct an error with the status-code
- // returned, but we could consider returning (a truncated version
- // of) the actual response as-is.
- //
- // TODO(thaJeztah): consider adding a log.Debug to allow clients to debug the actual response when enabling debug logging.
- daemonErr = fmt.Errorf(`API returned a %d (%s) but provided no error-message`,
- serverResp.StatusCode,
- http.StatusText(serverResp.StatusCode),
- )
- } else {
- daemonErr = errors.New(strings.TrimSpace(errorResponse.Message))
- }
- } else {
- // Fall back to returning the response as-is for API versions < 1.24
- // that didn't support JSON error responses, and for situations
- // where a plain text error is returned. This branch may also catch
- // situations where a proxy is involved, returning a HTML response.
- daemonErr = errors.New(strings.TrimSpace(string(body)))
- }
- return errors.Wrap(daemonErr, "Error response from daemon")
-}
-
-func (cli *Client) addHeaders(req *http.Request, headers http.Header) *http.Request {
- // Add CLI Config's HTTP Headers BEFORE we set the Docker headers
- // then the user can't change OUR headers
- for k, v := range cli.customHTTPHeaders {
- if versions.LessThan(cli.version, "1.25") && http.CanonicalHeaderKey(k) == "User-Agent" {
- continue
- }
- req.Header.Set(k, v)
- }
-
- for k, v := range headers {
- req.Header[http.CanonicalHeaderKey(k)] = v
- }
-
- if cli.userAgent != nil {
- if *cli.userAgent == "" {
- req.Header.Del("User-Agent")
- } else {
- req.Header.Set("User-Agent", *cli.userAgent)
- }
- }
- return req
-}
-
-func encodeData(data interface{}) (*bytes.Buffer, error) {
- params := bytes.NewBuffer(nil)
- if data != nil {
- if err := json.NewEncoder(params).Encode(data); err != nil {
- return nil, err
- }
- }
- return params, nil
-}
-
-func ensureReaderClosed(response *http.Response) {
- if response != nil && response.Body != nil {
- // Drain up to 512 bytes and close the body to let the Transport reuse the connection
- // see https://github.com/google/go-github/pull/317/files#r57536827
- //
- // TODO(thaJeztah): see if this optimization is still needed, or already implemented in stdlib,
- // and check if context-cancellation should handle this as well. If still needed, consider
- // wrapping response.Body, or returning a "closer()" from [Client.sendRequest] and related
- // methods.
- _, _ = io.CopyN(io.Discard, response.Body, 512)
- _ = response.Body.Close()
- }
-}
diff --git a/vendor/github.com/docker/docker/client/secret_create.go b/vendor/github.com/docker/docker/client/secret_create.go
deleted file mode 100644
index be4a1da4..00000000
--- a/vendor/github.com/docker/docker/client/secret_create.go
+++ /dev/null
@@ -1,24 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SecretCreate creates a new secret.
-func (cli *Client) SecretCreate(ctx context.Context, secret swarm.SecretSpec) (swarm.SecretCreateResponse, error) {
- if err := cli.NewVersionError(ctx, "1.25", "secret create"); err != nil {
- return swarm.SecretCreateResponse{}, err
- }
- resp, err := cli.post(ctx, "/secrets/create", nil, secret, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.SecretCreateResponse{}, err
- }
-
- var response swarm.SecretCreateResponse
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/secret_inspect.go b/vendor/github.com/docker/docker/client/secret_inspect.go
deleted file mode 100644
index f44c00e7..00000000
--- a/vendor/github.com/docker/docker/client/secret_inspect.go
+++ /dev/null
@@ -1,37 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "io"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SecretInspectWithRaw returns the secret information with raw data
-func (cli *Client) SecretInspectWithRaw(ctx context.Context, id string) (swarm.Secret, []byte, error) {
- id, err := trimID("secret", id)
- if err != nil {
- return swarm.Secret{}, nil, err
- }
- if err := cli.NewVersionError(ctx, "1.25", "secret inspect"); err != nil {
- return swarm.Secret{}, nil, err
- }
- resp, err := cli.get(ctx, "/secrets/"+id, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.Secret{}, nil, err
- }
-
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return swarm.Secret{}, nil, err
- }
-
- var secret swarm.Secret
- rdr := bytes.NewReader(body)
- err = json.NewDecoder(rdr).Decode(&secret)
-
- return secret, body, err
-}
diff --git a/vendor/github.com/docker/docker/client/secret_list.go b/vendor/github.com/docker/docker/client/secret_list.go
deleted file mode 100644
index 2e37bda2..00000000
--- a/vendor/github.com/docker/docker/client/secret_list.go
+++ /dev/null
@@ -1,37 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SecretList returns the list of secrets.
-func (cli *Client) SecretList(ctx context.Context, options swarm.SecretListOptions) ([]swarm.Secret, error) {
- if err := cli.NewVersionError(ctx, "1.25", "secret list"); err != nil {
- return nil, err
- }
- query := url.Values{}
-
- if options.Filters.Len() > 0 {
- filterJSON, err := filters.ToJSON(options.Filters)
- if err != nil {
- return nil, err
- }
-
- query.Set("filters", filterJSON)
- }
-
- resp, err := cli.get(ctx, "/secrets", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var secrets []swarm.Secret
- err = json.NewDecoder(resp.Body).Decode(&secrets)
- return secrets, err
-}
diff --git a/vendor/github.com/docker/docker/client/secret_remove.go b/vendor/github.com/docker/docker/client/secret_remove.go
deleted file mode 100644
index d1044aaf..00000000
--- a/vendor/github.com/docker/docker/client/secret_remove.go
+++ /dev/null
@@ -1,17 +0,0 @@
-package client
-
-import "context"
-
-// SecretRemove removes a secret.
-func (cli *Client) SecretRemove(ctx context.Context, id string) error {
- id, err := trimID("secret", id)
- if err != nil {
- return err
- }
- if err := cli.NewVersionError(ctx, "1.25", "secret remove"); err != nil {
- return err
- }
- resp, err := cli.delete(ctx, "/secrets/"+id, nil, nil)
- defer ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/secret_update.go b/vendor/github.com/docker/docker/client/secret_update.go
deleted file mode 100644
index a0aff7cb..00000000
--- a/vendor/github.com/docker/docker/client/secret_update.go
+++ /dev/null
@@ -1,24 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SecretUpdate attempts to update a secret.
-func (cli *Client) SecretUpdate(ctx context.Context, id string, version swarm.Version, secret swarm.SecretSpec) error {
- id, err := trimID("secret", id)
- if err != nil {
- return err
- }
- if err := cli.NewVersionError(ctx, "1.25", "secret update"); err != nil {
- return err
- }
- query := url.Values{}
- query.Set("version", version.String())
- resp, err := cli.post(ctx, "/secrets/"+id+"/update", query, secret, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/service_create.go b/vendor/github.com/docker/docker/client/service_create.go
deleted file mode 100644
index db7566a8..00000000
--- a/vendor/github.com/docker/docker/client/service_create.go
+++ /dev/null
@@ -1,212 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "fmt"
- "net/http"
- "strings"
-
- "github.com/distribution/reference"
- "github.com/docker/docker/api/types/registry"
- "github.com/docker/docker/api/types/swarm"
- "github.com/docker/docker/api/types/versions"
- "github.com/opencontainers/go-digest"
- "github.com/pkg/errors"
-)
-
-// ServiceCreate creates a new service.
-func (cli *Client) ServiceCreate(ctx context.Context, service swarm.ServiceSpec, options swarm.ServiceCreateOptions) (swarm.ServiceCreateResponse, error) {
- var response swarm.ServiceCreateResponse
-
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return response, err
- }
-
- // Make sure containerSpec is not nil when no runtime is set or the runtime is set to container
- if service.TaskTemplate.ContainerSpec == nil && (service.TaskTemplate.Runtime == "" || service.TaskTemplate.Runtime == swarm.RuntimeContainer) {
- service.TaskTemplate.ContainerSpec = &swarm.ContainerSpec{}
- }
-
- if err := validateServiceSpec(service); err != nil {
- return response, err
- }
- if versions.LessThan(cli.version, "1.30") {
- if err := validateAPIVersion(service, cli.version); err != nil {
- return response, err
- }
- }
-
- // ensure that the image is tagged
- var resolveWarning string
- switch {
- case service.TaskTemplate.ContainerSpec != nil:
- if taggedImg := imageWithTagString(service.TaskTemplate.ContainerSpec.Image); taggedImg != "" {
- service.TaskTemplate.ContainerSpec.Image = taggedImg
- }
- if options.QueryRegistry {
- resolveWarning = resolveContainerSpecImage(ctx, cli, &service.TaskTemplate, options.EncodedRegistryAuth)
- }
- case service.TaskTemplate.PluginSpec != nil:
- if taggedImg := imageWithTagString(service.TaskTemplate.PluginSpec.Remote); taggedImg != "" {
- service.TaskTemplate.PluginSpec.Remote = taggedImg
- }
- if options.QueryRegistry {
- resolveWarning = resolvePluginSpecRemote(ctx, cli, &service.TaskTemplate, options.EncodedRegistryAuth)
- }
- }
-
- headers := http.Header{}
- if versions.LessThan(cli.version, "1.30") {
- // the custom "version" header was used by engine API before 20.10
- // (API 1.30) to switch between client- and server-side lookup of
- // image digests.
- headers["version"] = []string{cli.version}
- }
- if options.EncodedRegistryAuth != "" {
- headers[registry.AuthHeader] = []string{options.EncodedRegistryAuth}
- }
- resp, err := cli.post(ctx, "/services/create", nil, service, headers)
- defer ensureReaderClosed(resp)
- if err != nil {
- return response, err
- }
-
- err = json.NewDecoder(resp.Body).Decode(&response)
- if resolveWarning != "" {
- response.Warnings = append(response.Warnings, resolveWarning)
- }
-
- return response, err
-}
-
-func resolveContainerSpecImage(ctx context.Context, cli DistributionAPIClient, taskSpec *swarm.TaskSpec, encodedAuth string) string {
- var warning string
- if img, imgPlatforms, err := imageDigestAndPlatforms(ctx, cli, taskSpec.ContainerSpec.Image, encodedAuth); err != nil {
- warning = digestWarning(taskSpec.ContainerSpec.Image)
- } else {
- taskSpec.ContainerSpec.Image = img
- if len(imgPlatforms) > 0 {
- if taskSpec.Placement == nil {
- taskSpec.Placement = &swarm.Placement{}
- }
- taskSpec.Placement.Platforms = imgPlatforms
- }
- }
- return warning
-}
-
-func resolvePluginSpecRemote(ctx context.Context, cli DistributionAPIClient, taskSpec *swarm.TaskSpec, encodedAuth string) string {
- var warning string
- if img, imgPlatforms, err := imageDigestAndPlatforms(ctx, cli, taskSpec.PluginSpec.Remote, encodedAuth); err != nil {
- warning = digestWarning(taskSpec.PluginSpec.Remote)
- } else {
- taskSpec.PluginSpec.Remote = img
- if len(imgPlatforms) > 0 {
- if taskSpec.Placement == nil {
- taskSpec.Placement = &swarm.Placement{}
- }
- taskSpec.Placement.Platforms = imgPlatforms
- }
- }
- return warning
-}
-
-func imageDigestAndPlatforms(ctx context.Context, cli DistributionAPIClient, image, encodedAuth string) (string, []swarm.Platform, error) {
- distributionInspect, err := cli.DistributionInspect(ctx, image, encodedAuth)
- var platforms []swarm.Platform
- if err != nil {
- return "", nil, err
- }
-
- imageWithDigest := imageWithDigestString(image, distributionInspect.Descriptor.Digest)
-
- if len(distributionInspect.Platforms) > 0 {
- platforms = make([]swarm.Platform, 0, len(distributionInspect.Platforms))
- for _, p := range distributionInspect.Platforms {
- // clear architecture field for arm. This is a temporary patch to address
- // https://github.com/docker/swarmkit/issues/2294. The issue is that while
- // image manifests report "arm" as the architecture, the node reports
- // something like "armv7l" (includes the variant), which causes arm images
- // to stop working with swarm mode. This patch removes the architecture
- // constraint for arm images to ensure tasks get scheduled.
- arch := p.Architecture
- if strings.ToLower(arch) == "arm" {
- arch = ""
- }
- platforms = append(platforms, swarm.Platform{
- Architecture: arch,
- OS: p.OS,
- })
- }
- }
- return imageWithDigest, platforms, err
-}
-
-// imageWithDigestString takes an image string and a digest, and updates
-// the image string if it didn't originally contain a digest. It returns
-// image unmodified in other situations.
-func imageWithDigestString(image string, dgst digest.Digest) string {
- namedRef, err := reference.ParseNormalizedNamed(image)
- if err == nil {
- if _, isCanonical := namedRef.(reference.Canonical); !isCanonical {
- // ensure that image gets a default tag if none is provided
- img, err := reference.WithDigest(namedRef, dgst)
- if err == nil {
- return reference.FamiliarString(img)
- }
- }
- }
- return image
-}
-
-// imageWithTagString takes an image string, and returns a tagged image
-// string, adding a 'latest' tag if one was not provided. It returns an
-// empty string if a canonical reference was provided
-func imageWithTagString(image string) string {
- namedRef, err := reference.ParseNormalizedNamed(image)
- if err == nil {
- return reference.FamiliarString(reference.TagNameOnly(namedRef))
- }
- return ""
-}
-
-// digestWarning constructs a formatted warning string using the
-// image name that could not be pinned by digest. The formatting
-// is hardcoded, but could me made smarter in the future
-func digestWarning(image string) string {
- return fmt.Sprintf("image %s could not be accessed on a registry to record\nits digest. Each node will access %s independently,\npossibly leading to different nodes running different\nversions of the image.\n", image, image)
-}
-
-func validateServiceSpec(s swarm.ServiceSpec) error {
- if s.TaskTemplate.ContainerSpec != nil && s.TaskTemplate.PluginSpec != nil {
- return errors.New("must not specify both a container spec and a plugin spec in the task template")
- }
- if s.TaskTemplate.PluginSpec != nil && s.TaskTemplate.Runtime != swarm.RuntimePlugin {
- return errors.New("mismatched runtime with plugin spec")
- }
- if s.TaskTemplate.ContainerSpec != nil && (s.TaskTemplate.Runtime != "" && s.TaskTemplate.Runtime != swarm.RuntimeContainer) {
- return errors.New("mismatched runtime with container spec")
- }
- return nil
-}
-
-func validateAPIVersion(c swarm.ServiceSpec, apiVersion string) error {
- for _, m := range c.TaskTemplate.ContainerSpec.Mounts {
- if m.BindOptions != nil {
- if m.BindOptions.NonRecursive && versions.LessThan(apiVersion, "1.40") {
- return errors.Errorf("bind-recursive=disabled requires API v1.40 or later")
- }
- // ReadOnlyNonRecursive can be safely ignored when API < 1.44
- if m.BindOptions.ReadOnlyForceRecursive && versions.LessThan(apiVersion, "1.44") {
- return errors.Errorf("bind-recursive=readonly requires API v1.44 or later")
- }
- }
- }
- return nil
-}
diff --git a/vendor/github.com/docker/docker/client/service_inspect.go b/vendor/github.com/docker/docker/client/service_inspect.go
deleted file mode 100644
index cb25ade1..00000000
--- a/vendor/github.com/docker/docker/client/service_inspect.go
+++ /dev/null
@@ -1,38 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "fmt"
- "io"
- "net/url"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// ServiceInspectWithRaw returns the service information and the raw data.
-func (cli *Client) ServiceInspectWithRaw(ctx context.Context, serviceID string, opts swarm.ServiceInspectOptions) (swarm.Service, []byte, error) {
- serviceID, err := trimID("service", serviceID)
- if err != nil {
- return swarm.Service{}, nil, err
- }
-
- query := url.Values{}
- query.Set("insertDefaults", fmt.Sprintf("%v", opts.InsertDefaults))
- resp, err := cli.get(ctx, "/services/"+serviceID, query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.Service{}, nil, err
- }
-
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return swarm.Service{}, nil, err
- }
-
- var response swarm.Service
- rdr := bytes.NewReader(body)
- err = json.NewDecoder(rdr).Decode(&response)
- return response, body, err
-}
diff --git a/vendor/github.com/docker/docker/client/service_list.go b/vendor/github.com/docker/docker/client/service_list.go
deleted file mode 100644
index 26b25ff0..00000000
--- a/vendor/github.com/docker/docker/client/service_list.go
+++ /dev/null
@@ -1,38 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/swarm"
-)
-
-// ServiceList returns the list of services.
-func (cli *Client) ServiceList(ctx context.Context, options swarm.ServiceListOptions) ([]swarm.Service, error) {
- query := url.Values{}
-
- if options.Filters.Len() > 0 {
- filterJSON, err := filters.ToJSON(options.Filters)
- if err != nil {
- return nil, err
- }
-
- query.Set("filters", filterJSON)
- }
-
- if options.Status {
- query.Set("status", "true")
- }
-
- resp, err := cli.get(ctx, "/services", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var services []swarm.Service
- err = json.NewDecoder(resp.Body).Decode(&services)
- return services, err
-}
diff --git a/vendor/github.com/docker/docker/client/service_logs.go b/vendor/github.com/docker/docker/client/service_logs.go
deleted file mode 100644
index 8bf04082..00000000
--- a/vendor/github.com/docker/docker/client/service_logs.go
+++ /dev/null
@@ -1,57 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/url"
- "time"
-
- "github.com/docker/docker/api/types/container"
- timetypes "github.com/docker/docker/api/types/time"
- "github.com/pkg/errors"
-)
-
-// ServiceLogs returns the logs generated by a service in an io.ReadCloser.
-// It's up to the caller to close the stream.
-func (cli *Client) ServiceLogs(ctx context.Context, serviceID string, options container.LogsOptions) (io.ReadCloser, error) {
- serviceID, err := trimID("service", serviceID)
- if err != nil {
- return nil, err
- }
-
- query := url.Values{}
- if options.ShowStdout {
- query.Set("stdout", "1")
- }
-
- if options.ShowStderr {
- query.Set("stderr", "1")
- }
-
- if options.Since != "" {
- ts, err := timetypes.GetTimestamp(options.Since, time.Now())
- if err != nil {
- return nil, errors.Wrap(err, `invalid value for "since"`)
- }
- query.Set("since", ts)
- }
-
- if options.Timestamps {
- query.Set("timestamps", "1")
- }
-
- if options.Details {
- query.Set("details", "1")
- }
-
- if options.Follow {
- query.Set("follow", "1")
- }
- query.Set("tail", options.Tail)
-
- resp, err := cli.get(ctx, "/services/"+serviceID+"/logs", query, nil)
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
diff --git a/vendor/github.com/docker/docker/client/service_remove.go b/vendor/github.com/docker/docker/client/service_remove.go
deleted file mode 100644
index 0c7cc571..00000000
--- a/vendor/github.com/docker/docker/client/service_remove.go
+++ /dev/null
@@ -1,15 +0,0 @@
-package client
-
-import "context"
-
-// ServiceRemove kills and removes a service.
-func (cli *Client) ServiceRemove(ctx context.Context, serviceID string) error {
- serviceID, err := trimID("service", serviceID)
- if err != nil {
- return err
- }
-
- resp, err := cli.delete(ctx, "/services/"+serviceID, nil, nil)
- defer ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/service_update.go b/vendor/github.com/docker/docker/client/service_update.go
deleted file mode 100644
index 278e305d..00000000
--- a/vendor/github.com/docker/docker/client/service_update.go
+++ /dev/null
@@ -1,89 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/http"
- "net/url"
-
- "github.com/docker/docker/api/types/registry"
- "github.com/docker/docker/api/types/swarm"
- "github.com/docker/docker/api/types/versions"
-)
-
-// ServiceUpdate updates a Service. The version number is required to avoid conflicting writes.
-// It should be the value as set *before* the update. You can find this value in the Meta field
-// of swarm.Service, which can be found using ServiceInspectWithRaw.
-func (cli *Client) ServiceUpdate(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options swarm.ServiceUpdateOptions) (swarm.ServiceUpdateResponse, error) {
- serviceID, err := trimID("service", serviceID)
- if err != nil {
- return swarm.ServiceUpdateResponse{}, err
- }
-
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return swarm.ServiceUpdateResponse{}, err
- }
-
- query := url.Values{}
- if options.RegistryAuthFrom != "" {
- query.Set("registryAuthFrom", options.RegistryAuthFrom)
- }
-
- if options.Rollback != "" {
- query.Set("rollback", options.Rollback)
- }
-
- query.Set("version", version.String())
-
- if err := validateServiceSpec(service); err != nil {
- return swarm.ServiceUpdateResponse{}, err
- }
-
- // ensure that the image is tagged
- var resolveWarning string
- switch {
- case service.TaskTemplate.ContainerSpec != nil:
- if taggedImg := imageWithTagString(service.TaskTemplate.ContainerSpec.Image); taggedImg != "" {
- service.TaskTemplate.ContainerSpec.Image = taggedImg
- }
- if options.QueryRegistry {
- resolveWarning = resolveContainerSpecImage(ctx, cli, &service.TaskTemplate, options.EncodedRegistryAuth)
- }
- case service.TaskTemplate.PluginSpec != nil:
- if taggedImg := imageWithTagString(service.TaskTemplate.PluginSpec.Remote); taggedImg != "" {
- service.TaskTemplate.PluginSpec.Remote = taggedImg
- }
- if options.QueryRegistry {
- resolveWarning = resolvePluginSpecRemote(ctx, cli, &service.TaskTemplate, options.EncodedRegistryAuth)
- }
- }
-
- headers := http.Header{}
- if versions.LessThan(cli.version, "1.30") {
- // the custom "version" header was used by engine API before 20.10
- // (API 1.30) to switch between client- and server-side lookup of
- // image digests.
- headers["version"] = []string{cli.version}
- }
- if options.EncodedRegistryAuth != "" {
- headers[registry.AuthHeader] = []string{options.EncodedRegistryAuth}
- }
- resp, err := cli.post(ctx, "/services/"+serviceID+"/update", query, service, headers)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.ServiceUpdateResponse{}, err
- }
-
- var response swarm.ServiceUpdateResponse
- err = json.NewDecoder(resp.Body).Decode(&response)
- if resolveWarning != "" {
- response.Warnings = append(response.Warnings, resolveWarning)
- }
-
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/swarm_get_unlock_key.go b/vendor/github.com/docker/docker/client/swarm_get_unlock_key.go
deleted file mode 100644
index 41151f6c..00000000
--- a/vendor/github.com/docker/docker/client/swarm_get_unlock_key.go
+++ /dev/null
@@ -1,21 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SwarmGetUnlockKey retrieves the swarm's unlock key.
-func (cli *Client) SwarmGetUnlockKey(ctx context.Context) (swarm.UnlockKeyResponse, error) {
- resp, err := cli.get(ctx, "/swarm/unlockkey", nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.UnlockKeyResponse{}, err
- }
-
- var response swarm.UnlockKeyResponse
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/swarm_init.go b/vendor/github.com/docker/docker/client/swarm_init.go
deleted file mode 100644
index 7f291654..00000000
--- a/vendor/github.com/docker/docker/client/swarm_init.go
+++ /dev/null
@@ -1,21 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SwarmInit initializes the swarm.
-func (cli *Client) SwarmInit(ctx context.Context, req swarm.InitRequest) (string, error) {
- resp, err := cli.post(ctx, "/swarm/init", nil, req, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return "", err
- }
-
- var response string
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/swarm_inspect.go b/vendor/github.com/docker/docker/client/swarm_inspect.go
deleted file mode 100644
index 597693bd..00000000
--- a/vendor/github.com/docker/docker/client/swarm_inspect.go
+++ /dev/null
@@ -1,21 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SwarmInspect inspects the swarm.
-func (cli *Client) SwarmInspect(ctx context.Context) (swarm.Swarm, error) {
- resp, err := cli.get(ctx, "/swarm", nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.Swarm{}, err
- }
-
- var response swarm.Swarm
- err = json.NewDecoder(resp.Body).Decode(&response)
- return response, err
-}
diff --git a/vendor/github.com/docker/docker/client/swarm_join.go b/vendor/github.com/docker/docker/client/swarm_join.go
deleted file mode 100644
index 446d4d04..00000000
--- a/vendor/github.com/docker/docker/client/swarm_join.go
+++ /dev/null
@@ -1,14 +0,0 @@
-package client
-
-import (
- "context"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SwarmJoin joins the swarm.
-func (cli *Client) SwarmJoin(ctx context.Context, req swarm.JoinRequest) error {
- resp, err := cli.post(ctx, "/swarm/join", nil, req, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/swarm_leave.go b/vendor/github.com/docker/docker/client/swarm_leave.go
deleted file mode 100644
index 709e5adb..00000000
--- a/vendor/github.com/docker/docker/client/swarm_leave.go
+++ /dev/null
@@ -1,17 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-)
-
-// SwarmLeave leaves the swarm.
-func (cli *Client) SwarmLeave(ctx context.Context, force bool) error {
- query := url.Values{}
- if force {
- query.Set("force", "1")
- }
- resp, err := cli.post(ctx, "/swarm/leave", query, nil, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/swarm_unlock.go b/vendor/github.com/docker/docker/client/swarm_unlock.go
deleted file mode 100644
index e3c756b6..00000000
--- a/vendor/github.com/docker/docker/client/swarm_unlock.go
+++ /dev/null
@@ -1,14 +0,0 @@
-package client
-
-import (
- "context"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SwarmUnlock unlocks locked swarm.
-func (cli *Client) SwarmUnlock(ctx context.Context, req swarm.UnlockRequest) error {
- resp, err := cli.post(ctx, "/swarm/unlock", nil, req, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/swarm_update.go b/vendor/github.com/docker/docker/client/swarm_update.go
deleted file mode 100644
index 309ab194..00000000
--- a/vendor/github.com/docker/docker/client/swarm_update.go
+++ /dev/null
@@ -1,21 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
- "strconv"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// SwarmUpdate updates the swarm.
-func (cli *Client) SwarmUpdate(ctx context.Context, version swarm.Version, swarm swarm.Spec, flags swarm.UpdateFlags) error {
- query := url.Values{}
- query.Set("version", version.String())
- query.Set("rotateWorkerToken", strconv.FormatBool(flags.RotateWorkerToken))
- query.Set("rotateManagerToken", strconv.FormatBool(flags.RotateManagerToken))
- query.Set("rotateManagerUnlockKey", strconv.FormatBool(flags.RotateManagerUnlockKey))
- resp, err := cli.post(ctx, "/swarm/update", query, swarm, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/task_inspect.go b/vendor/github.com/docker/docker/client/task_inspect.go
deleted file mode 100644
index ca3924fc..00000000
--- a/vendor/github.com/docker/docker/client/task_inspect.go
+++ /dev/null
@@ -1,34 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "io"
-
- "github.com/docker/docker/api/types/swarm"
-)
-
-// TaskInspectWithRaw returns the task information and its raw representation.
-func (cli *Client) TaskInspectWithRaw(ctx context.Context, taskID string) (swarm.Task, []byte, error) {
- taskID, err := trimID("task", taskID)
- if err != nil {
- return swarm.Task{}, nil, err
- }
-
- resp, err := cli.get(ctx, "/tasks/"+taskID, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return swarm.Task{}, nil, err
- }
-
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return swarm.Task{}, nil, err
- }
-
- var response swarm.Task
- rdr := bytes.NewReader(body)
- err = json.NewDecoder(rdr).Decode(&response)
- return response, body, err
-}
diff --git a/vendor/github.com/docker/docker/client/task_list.go b/vendor/github.com/docker/docker/client/task_list.go
deleted file mode 100644
index de743e99..00000000
--- a/vendor/github.com/docker/docker/client/task_list.go
+++ /dev/null
@@ -1,34 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/swarm"
-)
-
-// TaskList returns the list of tasks.
-func (cli *Client) TaskList(ctx context.Context, options swarm.TaskListOptions) ([]swarm.Task, error) {
- query := url.Values{}
-
- if options.Filters.Len() > 0 {
- filterJSON, err := filters.ToJSON(options.Filters)
- if err != nil {
- return nil, err
- }
-
- query.Set("filters", filterJSON)
- }
-
- resp, err := cli.get(ctx, "/tasks", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return nil, err
- }
-
- var tasks []swarm.Task
- err = json.NewDecoder(resp.Body).Decode(&tasks)
- return tasks, err
-}
diff --git a/vendor/github.com/docker/docker/client/task_logs.go b/vendor/github.com/docker/docker/client/task_logs.go
deleted file mode 100644
index baa55528..00000000
--- a/vendor/github.com/docker/docker/client/task_logs.go
+++ /dev/null
@@ -1,51 +0,0 @@
-package client
-
-import (
- "context"
- "io"
- "net/url"
- "time"
-
- "github.com/docker/docker/api/types/container"
- timetypes "github.com/docker/docker/api/types/time"
-)
-
-// TaskLogs returns the logs generated by a task in an io.ReadCloser.
-// It's up to the caller to close the stream.
-func (cli *Client) TaskLogs(ctx context.Context, taskID string, options container.LogsOptions) (io.ReadCloser, error) {
- query := url.Values{}
- if options.ShowStdout {
- query.Set("stdout", "1")
- }
-
- if options.ShowStderr {
- query.Set("stderr", "1")
- }
-
- if options.Since != "" {
- ts, err := timetypes.GetTimestamp(options.Since, time.Now())
- if err != nil {
- return nil, err
- }
- query.Set("since", ts)
- }
-
- if options.Timestamps {
- query.Set("timestamps", "1")
- }
-
- if options.Details {
- query.Set("details", "1")
- }
-
- if options.Follow {
- query.Set("follow", "1")
- }
- query.Set("tail", options.Tail)
-
- resp, err := cli.get(ctx, "/tasks/"+taskID+"/logs", query, nil)
- if err != nil {
- return nil, err
- }
- return resp.Body, nil
-}
diff --git a/vendor/github.com/docker/docker/client/utils.go b/vendor/github.com/docker/docker/client/utils.go
deleted file mode 100644
index 7b82f185..00000000
--- a/vendor/github.com/docker/docker/client/utils.go
+++ /dev/null
@@ -1,83 +0,0 @@
-package client
-
-import (
- "encoding/json"
- "fmt"
- "net/url"
- "strings"
-
- cerrdefs "github.com/containerd/errdefs"
- "github.com/docker/docker/api/types/filters"
- ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-)
-
-type emptyIDError string
-
-func (e emptyIDError) InvalidParameter() {}
-
-func (e emptyIDError) Error() string {
- return "invalid " + string(e) + " name or ID: value is empty"
-}
-
-// trimID trims the given object-ID / name, returning an error if it's empty.
-func trimID(objType, id string) (string, error) {
- id = strings.TrimSpace(id)
- if id == "" {
- return "", emptyIDError(objType)
- }
- return id, nil
-}
-
-// getFiltersQuery returns a url query with "filters" query term, based on the
-// filters provided.
-func getFiltersQuery(f filters.Args) (url.Values, error) {
- query := url.Values{}
- if f.Len() > 0 {
- filterJSON, err := filters.ToJSON(f)
- if err != nil {
- return query, err
- }
- query.Set("filters", filterJSON)
- }
- return query, nil
-}
-
-// encodePlatforms marshals the given platform(s) to JSON format, to
-// be used for query-parameters for filtering / selecting platforms.
-func encodePlatforms(platform ...ocispec.Platform) ([]string, error) {
- if len(platform) == 0 {
- return []string{}, nil
- }
- if len(platform) == 1 {
- p, err := encodePlatform(&platform[0])
- if err != nil {
- return nil, err
- }
- return []string{p}, nil
- }
-
- seen := make(map[string]struct{}, len(platform))
- out := make([]string, 0, len(platform))
- for i := range platform {
- p, err := encodePlatform(&platform[i])
- if err != nil {
- return nil, err
- }
- if _, ok := seen[p]; !ok {
- out = append(out, p)
- seen[p] = struct{}{}
- }
- }
- return out, nil
-}
-
-// encodePlatform marshals the given platform to JSON format, to
-// be used for query-parameters for filtering / selecting platforms. It
-// is used as a helper for encodePlatforms,
-func encodePlatform(platform *ocispec.Platform) (string, error) {
- p, err := json.Marshal(platform)
- if err != nil {
- return "", fmt.Errorf("%w: invalid platform: %v", cerrdefs.ErrInvalidArgument, err)
- }
- return string(p), nil
-}
diff --git a/vendor/github.com/docker/docker/client/version.go b/vendor/github.com/docker/docker/client/version.go
deleted file mode 100644
index 046af16c..00000000
--- a/vendor/github.com/docker/docker/client/version.go
+++ /dev/null
@@ -1,21 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types"
-)
-
-// ServerVersion returns information of the docker client and server host.
-func (cli *Client) ServerVersion(ctx context.Context) (types.Version, error) {
- resp, err := cli.get(ctx, "/version", nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return types.Version{}, err
- }
-
- var server types.Version
- err = json.NewDecoder(resp.Body).Decode(&server)
- return server, err
-}
diff --git a/vendor/github.com/docker/docker/client/volume_create.go b/vendor/github.com/docker/docker/client/volume_create.go
deleted file mode 100644
index 1aad3f47..00000000
--- a/vendor/github.com/docker/docker/client/volume_create.go
+++ /dev/null
@@ -1,21 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
-
- "github.com/docker/docker/api/types/volume"
-)
-
-// VolumeCreate creates a volume in the docker host.
-func (cli *Client) VolumeCreate(ctx context.Context, options volume.CreateOptions) (volume.Volume, error) {
- resp, err := cli.post(ctx, "/volumes/create", nil, options, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return volume.Volume{}, err
- }
-
- var vol volume.Volume
- err = json.NewDecoder(resp.Body).Decode(&vol)
- return vol, err
-}
diff --git a/vendor/github.com/docker/docker/client/volume_inspect.go b/vendor/github.com/docker/docker/client/volume_inspect.go
deleted file mode 100644
index 389a4a71..00000000
--- a/vendor/github.com/docker/docker/client/volume_inspect.go
+++ /dev/null
@@ -1,40 +0,0 @@
-package client
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "io"
-
- "github.com/docker/docker/api/types/volume"
-)
-
-// VolumeInspect returns the information about a specific volume in the docker host.
-func (cli *Client) VolumeInspect(ctx context.Context, volumeID string) (volume.Volume, error) {
- vol, _, err := cli.VolumeInspectWithRaw(ctx, volumeID)
- return vol, err
-}
-
-// VolumeInspectWithRaw returns the information about a specific volume in the docker host and its raw representation
-func (cli *Client) VolumeInspectWithRaw(ctx context.Context, volumeID string) (volume.Volume, []byte, error) {
- volumeID, err := trimID("volume", volumeID)
- if err != nil {
- return volume.Volume{}, nil, err
- }
-
- resp, err := cli.get(ctx, "/volumes/"+volumeID, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return volume.Volume{}, nil, err
- }
-
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return volume.Volume{}, nil, err
- }
-
- var vol volume.Volume
- rdr := bytes.NewReader(body)
- err = json.NewDecoder(rdr).Decode(&vol)
- return vol, body, err
-}
diff --git a/vendor/github.com/docker/docker/client/volume_list.go b/vendor/github.com/docker/docker/client/volume_list.go
deleted file mode 100644
index 61ed518c..00000000
--- a/vendor/github.com/docker/docker/client/volume_list.go
+++ /dev/null
@@ -1,33 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "net/url"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/volume"
-)
-
-// VolumeList returns the volumes configured in the docker host.
-func (cli *Client) VolumeList(ctx context.Context, options volume.ListOptions) (volume.ListResponse, error) {
- query := url.Values{}
-
- if options.Filters.Len() > 0 {
- //nolint:staticcheck // ignore SA1019 for old code
- filterJSON, err := filters.ToParamWithVersion(cli.version, options.Filters)
- if err != nil {
- return volume.ListResponse{}, err
- }
- query.Set("filters", filterJSON)
- }
- resp, err := cli.get(ctx, "/volumes", query, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return volume.ListResponse{}, err
- }
-
- var volumes volume.ListResponse
- err = json.NewDecoder(resp.Body).Decode(&volumes)
- return volumes, err
-}
diff --git a/vendor/github.com/docker/docker/client/volume_prune.go b/vendor/github.com/docker/docker/client/volume_prune.go
deleted file mode 100644
index e22f0072..00000000
--- a/vendor/github.com/docker/docker/client/volume_prune.go
+++ /dev/null
@@ -1,35 +0,0 @@
-package client
-
-import (
- "context"
- "encoding/json"
- "fmt"
-
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/volume"
-)
-
-// VolumesPrune requests the daemon to delete unused data
-func (cli *Client) VolumesPrune(ctx context.Context, pruneFilters filters.Args) (volume.PruneReport, error) {
- if err := cli.NewVersionError(ctx, "1.25", "volume prune"); err != nil {
- return volume.PruneReport{}, err
- }
-
- query, err := getFiltersQuery(pruneFilters)
- if err != nil {
- return volume.PruneReport{}, err
- }
-
- resp, err := cli.post(ctx, "/volumes/prune", query, nil, nil)
- defer ensureReaderClosed(resp)
- if err != nil {
- return volume.PruneReport{}, err
- }
-
- var report volume.PruneReport
- if err := json.NewDecoder(resp.Body).Decode(&report); err != nil {
- return volume.PruneReport{}, fmt.Errorf("Error retrieving volume prune report: %v", err)
- }
-
- return report, nil
-}
diff --git a/vendor/github.com/docker/docker/client/volume_remove.go b/vendor/github.com/docker/docker/client/volume_remove.go
deleted file mode 100644
index e2a53fa9..00000000
--- a/vendor/github.com/docker/docker/client/volume_remove.go
+++ /dev/null
@@ -1,34 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/versions"
-)
-
-// VolumeRemove removes a volume from the docker host.
-func (cli *Client) VolumeRemove(ctx context.Context, volumeID string, force bool) error {
- volumeID, err := trimID("volume", volumeID)
- if err != nil {
- return err
- }
-
- query := url.Values{}
- if force {
- // Make sure we negotiated (if the client is configured to do so),
- // as code below contains API-version specific handling of options.
- //
- // Normally, version-negotiation (if enabled) would not happen until
- // the API request is made.
- if err := cli.checkVersion(ctx); err != nil {
- return err
- }
- if versions.GreaterThanOrEqualTo(cli.version, "1.25") {
- query.Set("force", "1")
- }
- }
- resp, err := cli.delete(ctx, "/volumes/"+volumeID, query, nil)
- defer ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/docker/client/volume_update.go b/vendor/github.com/docker/docker/client/volume_update.go
deleted file mode 100644
index 879932f0..00000000
--- a/vendor/github.com/docker/docker/client/volume_update.go
+++ /dev/null
@@ -1,28 +0,0 @@
-package client
-
-import (
- "context"
- "net/url"
-
- "github.com/docker/docker/api/types/swarm"
- "github.com/docker/docker/api/types/volume"
-)
-
-// VolumeUpdate updates a volume. This only works for Cluster Volumes, and
-// only some fields can be updated.
-func (cli *Client) VolumeUpdate(ctx context.Context, volumeID string, version swarm.Version, options volume.UpdateOptions) error {
- volumeID, err := trimID("volume", volumeID)
- if err != nil {
- return err
- }
- if err := cli.NewVersionError(ctx, "1.42", "volume update"); err != nil {
- return err
- }
-
- query := url.Values{}
- query.Set("version", version.String())
-
- resp, err := cli.put(ctx, "/volumes/"+volumeID, query, options, nil)
- ensureReaderClosed(resp)
- return err
-}
diff --git a/vendor/github.com/docker/go-connections/nat/nat.go b/vendor/github.com/docker/go-connections/nat/nat.go
deleted file mode 100644
index d46c06a2..00000000
--- a/vendor/github.com/docker/go-connections/nat/nat.go
+++ /dev/null
@@ -1,237 +0,0 @@
-// Package nat is a convenience package for manipulation of strings describing network ports.
-package nat
-
-import (
- "errors"
- "fmt"
- "net"
- "strconv"
- "strings"
-)
-
-// PortBinding represents a binding between a Host IP address and a Host Port
-type PortBinding struct {
- // HostIP is the host IP Address
- HostIP string `json:"HostIp"`
- // HostPort is the host port number
- HostPort string
-}
-
-// PortMap is a collection of PortBinding indexed by Port
-type PortMap map[Port][]PortBinding
-
-// PortSet is a collection of structs indexed by Port
-type PortSet map[Port]struct{}
-
-// Port is a string containing port number and protocol in the format "80/tcp"
-type Port string
-
-// NewPort creates a new instance of a Port given a protocol and port number or port range
-func NewPort(proto, portOrRange string) (Port, error) {
- start, end, err := parsePortRange(portOrRange)
- if err != nil {
- return "", err
- }
- if start == end {
- return Port(fmt.Sprintf("%d/%s", start, proto)), nil
- }
- return Port(fmt.Sprintf("%d-%d/%s", start, end, proto)), nil
-}
-
-// ParsePort parses the port number string and returns an int
-func ParsePort(rawPort string) (int, error) {
- if rawPort == "" {
- return 0, nil
- }
- port, err := parsePortNumber(rawPort)
- if err != nil {
- return 0, fmt.Errorf("invalid port '%s': %w", rawPort, err)
- }
- return port, nil
-}
-
-// ParsePortRangeToInt parses the port range string and returns start/end ints
-func ParsePortRangeToInt(rawPort string) (startPort, endPort int, _ error) {
- if rawPort == "" {
- // TODO(thaJeztah): consider making this an error; this was kept to keep existing behavior.
- return 0, 0, nil
- }
- return parsePortRange(rawPort)
-}
-
-// Proto returns the protocol of a Port
-func (p Port) Proto() string {
- _, proto, _ := strings.Cut(string(p), "/")
- if proto == "" {
- proto = "tcp"
- }
- return proto
-}
-
-// Port returns the port number of a Port
-func (p Port) Port() string {
- port, _, _ := strings.Cut(string(p), "/")
- return port
-}
-
-// Int returns the port number of a Port as an int. It assumes [Port]
-// is valid, and returns 0 otherwise.
-func (p Port) Int() int {
- // We don't need to check for an error because we're going to
- // assume that any error would have been found, and reported, in [NewPort]
- port, _ := parsePortNumber(p.Port())
- return port
-}
-
-// Range returns the start/end port numbers of a Port range as ints
-func (p Port) Range() (int, int, error) {
- portRange := p.Port()
- if portRange == "" {
- return 0, 0, nil
- }
- return parsePortRange(portRange)
-}
-
-// SplitProtoPort splits a port(range) and protocol, formatted as "/[]"
-// "/[]". It returns an empty string for both if
-// no port(range) is provided. If a port(range) is provided, but no protocol,
-// the default ("tcp") protocol is returned.
-//
-// SplitProtoPort does not validate or normalize the returned values.
-func SplitProtoPort(rawPort string) (proto string, port string) {
- port, proto, _ = strings.Cut(rawPort, "/")
- if port == "" {
- return "", ""
- }
- if proto == "" {
- proto = "tcp"
- }
- return proto, port
-}
-
-func validateProto(proto string) error {
- switch proto {
- case "tcp", "udp", "sctp":
- // All good
- return nil
- default:
- return errors.New("invalid proto: " + proto)
- }
-}
-
-// ParsePortSpecs receives port specs in the format of ip:public:private/proto and parses
-// these in to the internal types
-func ParsePortSpecs(ports []string) (map[Port]struct{}, map[Port][]PortBinding, error) {
- var (
- exposedPorts = make(map[Port]struct{}, len(ports))
- bindings = make(map[Port][]PortBinding)
- )
- for _, p := range ports {
- portMappings, err := ParsePortSpec(p)
- if err != nil {
- return nil, nil, err
- }
-
- for _, pm := range portMappings {
- port := pm.Port
- if _, ok := exposedPorts[port]; !ok {
- exposedPorts[port] = struct{}{}
- }
- bindings[port] = append(bindings[port], pm.Binding)
- }
- }
- return exposedPorts, bindings, nil
-}
-
-// PortMapping is a data object mapping a Port to a PortBinding
-type PortMapping struct {
- Port Port
- Binding PortBinding
-}
-
-func (p *PortMapping) String() string {
- return net.JoinHostPort(p.Binding.HostIP, p.Binding.HostPort+":"+string(p.Port))
-}
-
-func splitParts(rawport string) (hostIP, hostPort, containerPort string) {
- parts := strings.Split(rawport, ":")
-
- switch len(parts) {
- case 1:
- return "", "", parts[0]
- case 2:
- return "", parts[0], parts[1]
- case 3:
- return parts[0], parts[1], parts[2]
- default:
- n := len(parts)
- return strings.Join(parts[:n-2], ":"), parts[n-2], parts[n-1]
- }
-}
-
-// ParsePortSpec parses a port specification string into a slice of PortMappings
-func ParsePortSpec(rawPort string) ([]PortMapping, error) {
- ip, hostPort, containerPort := splitParts(rawPort)
- proto, containerPort := SplitProtoPort(containerPort)
- if containerPort == "" {
- return nil, fmt.Errorf("no port specified: %s", rawPort)
- }
-
- proto = strings.ToLower(proto)
- if err := validateProto(proto); err != nil {
- return nil, err
- }
-
- if ip != "" && ip[0] == '[' {
- // Strip [] from IPV6 addresses
- rawIP, _, err := net.SplitHostPort(ip + ":")
- if err != nil {
- return nil, fmt.Errorf("invalid IP address %v: %w", ip, err)
- }
- ip = rawIP
- }
- if ip != "" && net.ParseIP(ip) == nil {
- return nil, errors.New("invalid IP address: " + ip)
- }
-
- startPort, endPort, err := parsePortRange(containerPort)
- if err != nil {
- return nil, errors.New("invalid containerPort: " + containerPort)
- }
-
- var startHostPort, endHostPort int
- if hostPort != "" {
- startHostPort, endHostPort, err = parsePortRange(hostPort)
- if err != nil {
- return nil, errors.New("invalid hostPort: " + hostPort)
- }
- if (endPort - startPort) != (endHostPort - startHostPort) {
- // Allow host port range iff containerPort is not a range.
- // In this case, use the host port range as the dynamic
- // host port range to allocate into.
- if endPort != startPort {
- return nil, fmt.Errorf("invalid ranges specified for container and host Ports: %s and %s", containerPort, hostPort)
- }
- }
- }
-
- count := endPort - startPort + 1
- ports := make([]PortMapping, 0, count)
-
- for i := range count {
- hPort := ""
- if hostPort != "" {
- hPort = strconv.Itoa(startHostPort + i)
- // Set hostPort to a range only if there is a single container port
- // and a dynamic host port.
- if count == 1 && startHostPort != endHostPort {
- hPort += "-" + strconv.Itoa(endHostPort)
- }
- }
- ports = append(ports, PortMapping{
- Port: Port(strconv.Itoa(startPort+i) + "/" + proto),
- Binding: PortBinding{HostIP: ip, HostPort: hPort},
- })
- }
- return ports, nil
-}
diff --git a/vendor/github.com/docker/go-connections/nat/parse.go b/vendor/github.com/docker/go-connections/nat/parse.go
deleted file mode 100644
index f6f86bd0..00000000
--- a/vendor/github.com/docker/go-connections/nat/parse.go
+++ /dev/null
@@ -1,60 +0,0 @@
-package nat
-
-import (
- "errors"
- "fmt"
- "strconv"
- "strings"
-)
-
-// ParsePortRange parses and validates the specified string as a port range (e.g., "8000-9000").
-func ParsePortRange(ports string) (startPort, endPort uint64, _ error) {
- start, end, err := parsePortRange(ports)
- return uint64(start), uint64(end), err
-}
-
-// parsePortRange parses and validates the specified string as a port range (e.g., "8000-9000").
-func parsePortRange(ports string) (startPort, endPort int, _ error) {
- if ports == "" {
- return 0, 0, errors.New("empty string specified for ports")
- }
- start, end, ok := strings.Cut(ports, "-")
-
- startPort, err := parsePortNumber(start)
- if err != nil {
- return 0, 0, fmt.Errorf("invalid start port '%s': %w", start, err)
- }
- if !ok || start == end {
- return startPort, startPort, nil
- }
-
- endPort, err = parsePortNumber(end)
- if err != nil {
- return 0, 0, fmt.Errorf("invalid end port '%s': %w", end, err)
- }
- if endPort < startPort {
- return 0, 0, errors.New("invalid port range: " + ports)
- }
- return startPort, endPort, nil
-}
-
-// parsePortNumber parses rawPort into an int, unwrapping strconv errors
-// and returning a single "out of range" error for any value outside 0–65535.
-func parsePortNumber(rawPort string) (int, error) {
- if rawPort == "" {
- return 0, errors.New("value is empty")
- }
- port, err := strconv.ParseInt(rawPort, 10, 0)
- if err != nil {
- var numErr *strconv.NumError
- if errors.As(err, &numErr) {
- err = numErr.Err
- }
- return 0, err
- }
- if port < 0 || port > 65535 {
- return 0, errors.New("value out of range (0–65535)")
- }
-
- return int(port), nil
-}
diff --git a/vendor/github.com/docker/go-connections/nat/sort.go b/vendor/github.com/docker/go-connections/nat/sort.go
deleted file mode 100644
index b983d011..00000000
--- a/vendor/github.com/docker/go-connections/nat/sort.go
+++ /dev/null
@@ -1,108 +0,0 @@
-package nat
-
-import (
- "sort"
- "strings"
-)
-
-type portSorter struct {
- ports []Port
- by func(i, j Port) bool
-}
-
-func (s *portSorter) Len() int {
- return len(s.ports)
-}
-
-func (s *portSorter) Swap(i, j int) {
- s.ports[i], s.ports[j] = s.ports[j], s.ports[i]
-}
-
-func (s *portSorter) Less(i, j int) bool {
- ip := s.ports[i]
- jp := s.ports[j]
-
- return s.by(ip, jp)
-}
-
-// Sort sorts a list of ports using the provided predicate
-// This function should compare `i` and `j`, returning true if `i` is
-// considered to be less than `j`
-func Sort(ports []Port, predicate func(i, j Port) bool) {
- s := &portSorter{ports, predicate}
- sort.Sort(s)
-}
-
-type portMapEntry struct {
- port Port
- binding *PortBinding
- portInt int
- portProto string
-}
-
-type portMapSorter []portMapEntry
-
-func (s portMapSorter) Len() int { return len(s) }
-func (s portMapSorter) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
-
-// Less sorts the port so that the order is:
-// 1. port with larger specified bindings
-// 2. larger port
-// 3. port with tcp protocol
-func (s portMapSorter) Less(i, j int) bool {
- pi, pj := s[i].portInt, s[j].portInt
- var hpi, hpj int
- if s[i].binding != nil {
- hpi = toInt(s[i].binding.HostPort)
- }
- if s[j].binding != nil {
- hpj = toInt(s[j].binding.HostPort)
- }
- return hpi > hpj || pi > pj || (pi == pj && strings.EqualFold(s[i].portProto, "tcp"))
-}
-
-// SortPortMap sorts the list of ports and their respected mapping. The ports
-// will explicit HostPort will be placed first.
-func SortPortMap(ports []Port, bindings map[Port][]PortBinding) {
- s := portMapSorter{}
- for _, p := range ports {
- portInt, portProto := p.Int(), p.Proto()
- if binding, ok := bindings[p]; ok && len(binding) > 0 {
- for _, b := range binding {
- s = append(s, portMapEntry{
- port: p, binding: &b,
- portInt: portInt, portProto: portProto,
- })
- }
- bindings[p] = []PortBinding{}
- } else {
- s = append(s, portMapEntry{
- port: p,
- portInt: portInt, portProto: portProto,
- })
- }
- }
-
- sort.Sort(s)
- var (
- i int
- pm = make(map[Port]struct{})
- )
- // reorder ports
- for _, entry := range s {
- if _, ok := pm[entry.port]; !ok {
- ports[i] = entry.port
- pm[entry.port] = struct{}{}
- i++
- }
- // reorder bindings for this port
- if entry.binding != nil {
- bindings[entry.port] = append(bindings[entry.port], *entry.binding)
- }
- }
-}
-
-func toInt(s string) int {
- i, _, _ := parsePortRange(s)
- return i
-}
diff --git a/vendor/github.com/moby/moby/api/pkg/authconfig/authconfig.go b/vendor/github.com/moby/moby/api/pkg/authconfig/authconfig.go
new file mode 100644
index 00000000..d1b0105a
--- /dev/null
+++ b/vendor/github.com/moby/moby/api/pkg/authconfig/authconfig.go
@@ -0,0 +1,96 @@
+package authconfig
+
+import (
+ "bytes"
+ "encoding/base64"
+ "encoding/json"
+ "errors"
+ "fmt"
+ "io"
+
+ "github.com/moby/moby/api/types/registry"
+)
+
+// Encode serializes the auth configuration as a base64url encoded
+// ([RFC4648, section 5]) JSON string for sending through the X-Registry-Auth header.
+//
+// [RFC4648, section 5]: https://tools.ietf.org/html/rfc4648#section-5
+func Encode(authConfig registry.AuthConfig) (string, error) {
+ // Older daemons (or registries) may not handle an empty string,
+ // which resulted in an "io.EOF" when unmarshaling or decoding.
+ //
+ // FIXME(thaJeztah): find exactly what code-paths are impacted by this.
+ // if authConfig == (AuthConfig{}) { return "", nil }
+ buf, err := json.Marshal(authConfig)
+ if err != nil {
+ return "", errInvalidParameter{err}
+ }
+ return base64.URLEncoding.EncodeToString(buf), nil
+}
+
+// Decode decodes base64url encoded ([RFC4648, section 5]) JSON
+// authentication information as sent through the X-Registry-Auth header.
+//
+// This function always returns an [AuthConfig], even if an error occurs. It is up
+// to the caller to decide if authentication is required, and if the error can
+// be ignored.
+//
+// [RFC4648, section 5]: https://tools.ietf.org/html/rfc4648#section-5
+func Decode(authEncoded string) (*registry.AuthConfig, error) {
+ if authEncoded == "" {
+ return ®istry.AuthConfig{}, nil
+ }
+
+ decoded, err := base64.URLEncoding.DecodeString(authEncoded)
+ if err != nil {
+ var e base64.CorruptInputError
+ if errors.As(err, &e) {
+ return ®istry.AuthConfig{}, invalid(errors.New("must be a valid base64url-encoded string"))
+ }
+ return ®istry.AuthConfig{}, invalid(err)
+ }
+
+ if bytes.Equal(decoded, []byte("{}")) {
+ return ®istry.AuthConfig{}, nil
+ }
+
+ return decode(bytes.NewReader(decoded))
+}
+
+// DecodeRequestBody decodes authentication information as sent as JSON in the
+// body of a request. This function is to provide backward compatibility with old
+// clients and API versions. Current clients and API versions expect authentication
+// to be provided through the X-Registry-Auth header.
+//
+// Like [Decode], this function always returns an [AuthConfig], even if an
+// error occurs. It is up to the caller to decide if authentication is required,
+// and if the error can be ignored.
+func DecodeRequestBody(r io.ReadCloser) (*registry.AuthConfig, error) {
+ return decode(r)
+}
+
+func decode(r io.Reader) (*registry.AuthConfig, error) {
+ authConfig := ®istry.AuthConfig{}
+ dec := json.NewDecoder(r)
+ if err := dec.Decode(authConfig); err != nil {
+ // always return an (empty) AuthConfig to increase compatibility with
+ // the existing API.
+ return ®istry.AuthConfig{}, invalid(fmt.Errorf("invalid JSON: %w", err))
+ }
+ if dec.More() {
+ return ®istry.AuthConfig{}, invalid(errors.New("multiple JSON documents not allowed"))
+ }
+ return authConfig, nil
+}
+
+func invalid(err error) error {
+ return errInvalidParameter{fmt.Errorf("invalid X-Registry-Auth header: %w", err)}
+}
+
+type errInvalidParameter struct{ error }
+
+func (errInvalidParameter) InvalidParameter() {}
+
+func (e errInvalidParameter) Cause() error { return e.error }
+
+func (e errInvalidParameter) Unwrap() error { return e.error }
diff --git a/vendor/github.com/docker/docker/pkg/stdcopy/stdcopy.go b/vendor/github.com/moby/moby/api/pkg/stdcopy/stdcopy.go
similarity index 50%
rename from vendor/github.com/docker/docker/pkg/stdcopy/stdcopy.go
rename to vendor/github.com/moby/moby/api/pkg/stdcopy/stdcopy.go
index 611432a6..948c6b67 100644
--- a/vendor/github.com/docker/docker/pkg/stdcopy/stdcopy.go
+++ b/vendor/github.com/moby/moby/api/pkg/stdcopy/stdcopy.go
@@ -1,12 +1,10 @@
package stdcopy
import (
- "bytes"
"encoding/binary"
"errors"
"fmt"
"io"
- "sync"
)
// StdType is the type of standard stream
@@ -14,16 +12,13 @@ import (
type StdType byte
const (
- // Stdin represents standard input stream type.
- Stdin StdType = iota
- // Stdout represents standard output stream type.
- Stdout
- // Stderr represents standard error steam type.
- Stderr
- // Systemerr represents errors originating from the system that make it
- // into the multiplexed stream.
- Systemerr
+ Stdin StdType = 0 // Stdin represents standard input stream. It is present for completeness and should NOT be used. When reading the stream with [StdCopy] it is output on [Stdout].
+ Stdout StdType = 1 // Stdout represents standard output stream.
+ Stderr StdType = 2 // Stderr represents standard error steam.
+ Systemerr StdType = 3 // Systemerr represents errors originating from the system. When reading the stream with [StdCopy] it is returned as an error.
+)
+const (
stdWriterPrefixLen = 8
stdWriterFdIndex = 0
stdWriterSizeIndex = 4
@@ -31,67 +26,28 @@ const (
startingBufLen = 32*1024 + stdWriterPrefixLen + 1
)
-var bufPool = &sync.Pool{New: func() interface{} { return bytes.NewBuffer(nil) }}
-
-// stdWriter is wrapper of io.Writer with extra customized info.
-type stdWriter struct {
- io.Writer
- prefix byte
-}
-
-// Write sends the buffer to the underneath writer.
-// It inserts the prefix header before the buffer,
-// so stdcopy.StdCopy knows where to multiplex the output.
-// It makes stdWriter to implement io.Writer.
-func (w *stdWriter) Write(p []byte) (int, error) {
- if w == nil || w.Writer == nil {
- return 0, errors.New("writer not instantiated")
- }
- if p == nil {
- return 0, nil
- }
-
- header := [stdWriterPrefixLen]byte{stdWriterFdIndex: w.prefix}
- binary.BigEndian.PutUint32(header[stdWriterSizeIndex:], uint32(len(p)))
- buf := bufPool.Get().(*bytes.Buffer)
- buf.Write(header[:])
- buf.Write(p)
-
- n, err := w.Writer.Write(buf.Bytes())
- n -= stdWriterPrefixLen
- if n < 0 {
- n = 0
- }
-
- buf.Reset()
- bufPool.Put(buf)
- return n, err
-}
-
-// NewStdWriter instantiates a new Writer.
-// Everything written to it will be encapsulated using a custom format,
-// and written to the underlying `w` stream.
-// This allows multiple write streams (e.g. stdout and stderr) to be muxed into a single connection.
-// `t` indicates the id of the stream to encapsulate.
-// It can be stdcopy.Stdin, stdcopy.Stdout, stdcopy.Stderr.
-func NewStdWriter(w io.Writer, t StdType) io.Writer {
- return &stdWriter{
- Writer: w,
- prefix: byte(t),
- }
-}
-
-// StdCopy is a modified version of io.Copy.
+// StdCopy is a modified version of [io.Copy] to de-multiplex messages
+// from "multiplexedSource" and copy them to destination streams
+// "destOut" and "destErr".
+//
+// StdCopy demultiplexes "multiplexedSource", assuming that it contains
+// two streams, previously multiplexed using a writer created with
+// [NewStdWriter].
//
-// StdCopy will demultiplex `src`, assuming that it contains two streams,
-// previously multiplexed together using a StdWriter instance.
-// As it reads from `src`, StdCopy will write to `dstout` and `dsterr`.
+// As it reads from "multiplexedSource", StdCopy writes [Stdout] messages
+// to "destOut", and [Stderr] message to "destErr]. For backward-compatibility,
+// [Stdin] messages are output to "destOut". The [Systemerr] stream provides
+// errors produced by the daemon. It is returned as an error, and terminates
+// processing the stream.
//
-// StdCopy will read until it hits EOF on `src`. It will then return a nil error.
-// In other words: if `err` is non nil, it indicates a real underlying error.
+// StdCopy it reads until it hits [io.EOF] on "multiplexedSource", after
+// which it returns a nil error. In other words: any error returned indicates
+// a real underlying error, which may be when an unknown [StdType] stream
+// is received.
//
-// `written` will hold the total number of bytes written to `dstout` and `dsterr`.
-func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, _ error) {
+// The "written" return holds the total number of bytes written to "destOut"
+// and "destErr" combined.
+func StdCopy(destOut, destErr io.Writer, multiplexedSource io.Reader) (written int64, _ error) {
var (
buf = make([]byte, startingBufLen)
bufLen = len(buf)
@@ -105,7 +61,7 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, _ error) {
// Make sure we have at least a full header
for nr < stdWriterPrefixLen {
var nr2 int
- nr2, err = src.Read(buf[nr:])
+ nr2, err = multiplexedSource.Read(buf[nr:])
nr += nr2
if errors.Is(err, io.EOF) {
if nr < stdWriterPrefixLen {
@@ -118,24 +74,24 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, _ error) {
}
}
- stream := StdType(buf[stdWriterFdIndex])
// Check the first byte to know where to write
+ stream := StdType(buf[stdWriterFdIndex])
switch stream {
case Stdin:
fallthrough
case Stdout:
// Write on stdout
- out = dstout
+ out = destOut
case Stderr:
// Write on stderr
- out = dsterr
+ out = destErr
case Systemerr:
// If we're on Systemerr, we won't write anywhere.
// NB: if this code changes later, make sure you don't try to write
// to outstream if Systemerr is the stream
out = nil
default:
- return 0, fmt.Errorf("Unrecognized input header: %d", buf[stdWriterFdIndex])
+ return 0, fmt.Errorf("unrecognized stream: %d", stream)
}
// Retrieve the size of the frame
@@ -151,7 +107,7 @@ func StdCopy(dstout, dsterr io.Writer, src io.Reader) (written int64, _ error) {
// While the amount of bytes read is less than the size of the frame + header, we keep reading
for nr < frameSize+stdWriterPrefixLen {
var nr2 int
- nr2, err = src.Read(buf[nr:])
+ nr2, err = multiplexedSource.Read(buf[nr:])
nr += nr2
if errors.Is(err, io.EOF) {
if nr < frameSize+stdWriterPrefixLen {
diff --git a/vendor/github.com/moby/moby/client/pkg/jsonmessage/jsonmessage.go b/vendor/github.com/moby/moby/client/pkg/jsonmessage/jsonmessage.go
new file mode 100644
index 00000000..e3ac43af
--- /dev/null
+++ b/vendor/github.com/moby/moby/client/pkg/jsonmessage/jsonmessage.go
@@ -0,0 +1,294 @@
+package jsonmessage
+
+import (
+ "encoding/json"
+ "errors"
+ "fmt"
+ "io"
+ "iter"
+ "strings"
+ "time"
+
+ "github.com/docker/go-units"
+ "github.com/moby/moby/api/types/jsonstream"
+ "github.com/moby/term"
+)
+
+var timeNow = time.Now // For overriding in tests.
+
+// RFC3339NanoFixed is time.RFC3339Nano with nanoseconds padded using zeros to
+// ensure the formatted time is always the same number of characters.
+const RFC3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"
+
+// DisplayOpt configures behavior for [DisplayStream] and [DisplayMessages].
+// Options are applied in order; if an option returns an error, processing
+// stops and the error is returned to the caller.
+type DisplayOpt func(*displayOpts) error
+
+type displayOpts struct {
+ auxCallback func(jsonstream.Message)
+}
+
+// WithAuxCallback registers a callback that is invoked for auxiliary
+// jsonstream messages as they are processed. The callback is optional;
+// if not provided, auxiliary messages are ignored.
+func WithAuxCallback(fn func(jsonstream.Message)) DisplayOpt {
+ return func(opts *displayOpts) error {
+ opts.auxCallback = fn
+ return nil
+ }
+}
+
+func RenderTUIProgress(p jsonstream.Progress, width uint16) string {
+ var (
+ pbBox string
+ numbersBox string
+ )
+ if p.Current <= 0 && p.Total <= 0 {
+ return ""
+ }
+ if p.Total <= 0 {
+ switch p.Units {
+ case "":
+ return fmt.Sprintf("%8v", units.HumanSize(float64(p.Current)))
+ default:
+ return fmt.Sprintf("%d %s", p.Current, p.Units)
+ }
+ }
+
+ percentage := min(int(float64(p.Current)/float64(p.Total)*100)/2, 50)
+ if width > 110 {
+ // this number can't be negative gh#7136
+ numSpaces := max(50-percentage, 0)
+ pbBox = fmt.Sprintf("[%s>%s] ", strings.Repeat("=", percentage), strings.Repeat(" ", numSpaces))
+ }
+
+ switch {
+ case p.HideCounts:
+ case p.Units == "": // no units, use bytes
+ current := units.HumanSize(float64(p.Current))
+ total := units.HumanSize(float64(p.Total))
+
+ numbersBox = fmt.Sprintf("%8v/%v", current, total)
+
+ if p.Current > p.Total {
+ // remove total display if the reported current is wonky.
+ numbersBox = fmt.Sprintf("%8v", current)
+ }
+ default:
+ numbersBox = fmt.Sprintf("%d/%d %s", p.Current, p.Total, p.Units)
+
+ if p.Current > p.Total {
+ // remove total display if the reported current is wonky.
+ numbersBox = fmt.Sprintf("%d %s", p.Current, p.Units)
+ }
+ }
+
+ // Show approximation of remaining time if there's enough width.
+ var timeLeftBox string
+ if width > 50 {
+ if p.Current > 0 && p.Start > 0 && percentage < 50 {
+ fromStart := timeNow().UTC().Sub(time.Unix(p.Start, 0))
+ perEntry := fromStart / time.Duration(p.Current)
+ left := time.Duration(p.Total-p.Current) * perEntry
+ timeLeftBox = " " + left.Round(time.Second).String()
+ }
+ }
+ return pbBox + numbersBox + timeLeftBox
+}
+
+// We can probably use [aec.EmptyBuilder] for managing the output, but
+// currently we're doing it all manually, so defining some consts for
+// the basics we use.
+//
+// [aec.EmptyBuilder]: https://pkg.go.dev/github.com/morikuni/aec#EmptyBuilder
+const (
+ ansiEraseLine = "\x1b[2K" // Erase entire line
+ ansiCursorUpFmt = "\x1b[%dA" // Move cursor up N lines
+ ansiCursorDownFmt = "\x1b[%dB" // Move cursor down N lines
+)
+
+func clearLine(out io.Writer) {
+ _, _ = out.Write([]byte(ansiEraseLine))
+}
+
+func cursorUp(out io.Writer, l uint) {
+ if l == 0 {
+ return
+ }
+ _, _ = fmt.Fprintf(out, ansiCursorUpFmt, l)
+}
+
+func cursorDown(out io.Writer, l uint) {
+ if l == 0 {
+ return
+ }
+ _, _ = fmt.Fprintf(out, ansiCursorDownFmt, l)
+}
+
+// Display prints the JSONMessage to out. If isTerminal is true, it erases
+// the entire current line when displaying the progressbar. It returns an
+// error if the [JSONMessage.Error] field is non-nil.
+func Display(jm jsonstream.Message, out io.Writer, isTerminal bool, width uint16) error {
+ if jm.Error != nil {
+ return jm.Error
+ }
+ var endl string
+ if isTerminal && jm.Stream == "" && jm.Progress != nil {
+ clearLine(out)
+ endl = "\r"
+ _, _ = fmt.Fprint(out, endl)
+ } else if jm.Progress != nil && (jm.Progress.Current > 0 || jm.Progress.Total > 0) { // disable progressbar in non-terminal
+ return nil
+ }
+ if jm.ID != "" {
+ _, _ = fmt.Fprintf(out, "%s: ", jm.ID)
+ }
+ if jm.Progress != nil && isTerminal {
+ if width == 0 {
+ width = 200
+ }
+ _, _ = fmt.Fprintf(out, "%s %s%s", jm.Status, RenderTUIProgress(*jm.Progress, width), endl)
+ } else if jm.Stream != "" {
+ _, _ = fmt.Fprintf(out, "%s%s", jm.Stream, endl)
+ } else {
+ _, _ = fmt.Fprintf(out, "%s%s\n", jm.Status, endl)
+ }
+ return nil
+}
+
+type JSONMessagesStream = iter.Seq2[jsonstream.Message, error]
+
+// DisplayJSONMessagesStream is like [DisplayStream], but allows the caller to
+// explicitly provide the terminal file descriptor and whether out is a terminal.
+func DisplayJSONMessagesStream(in io.Reader, out io.Writer, terminalFd uintptr, isTerminal bool, auxCallback func(jsonstream.Message)) error {
+ var opts []DisplayOpt
+ if auxCallback != nil {
+ opts = append(opts, WithAuxCallback(auxCallback))
+ }
+ return displayJSONMessagesStream(in, out, terminalFd, isTerminal, opts...)
+}
+
+// DisplayStream reads a JSON message stream from in, and writes each
+// [jsonstream.Message] to out. See [DisplayMessages] for details.
+func DisplayStream(in io.Reader, out io.Writer, opts ...DisplayOpt) error {
+ terminalFd, isTerminal := term.GetFdInfo(out)
+ return displayJSONMessagesStream(in, out, terminalFd, isTerminal, opts...)
+}
+
+func displayJSONMessagesStream(in io.Reader, out io.Writer, terminalFd uintptr, isTerminal bool, opts ...DisplayOpt) error {
+ dec := json.NewDecoder(in)
+ f := func(yield func(jsonstream.Message, error) bool) {
+ for {
+ var jm jsonstream.Message
+ err := dec.Decode(&jm)
+ if errors.Is(err, io.EOF) {
+ break
+ }
+ if !yield(jm, err) {
+ return
+ }
+ }
+ }
+
+ return displayJSONMessages(f, out, terminalFd, isTerminal, opts...)
+}
+
+// DisplayJSONMessages is like [DisplayMessages], but allows the caller to
+// explicitly provide the terminal file descriptor and whether out is a terminal.
+func DisplayJSONMessages(messages iter.Seq2[jsonstream.Message, error], out io.Writer, terminalFd uintptr, isTerminal bool, auxCallback func(jsonstream.Message)) error {
+ var opts []DisplayOpt
+ if auxCallback != nil {
+ opts = append(opts, WithAuxCallback(auxCallback))
+ }
+ return displayJSONMessages(messages, out, terminalFd, isTerminal, opts...)
+}
+
+// DisplayMessages writes each [jsonstream.Message] from stream to out.
+// It returns an error if an invalid [jsonstream.Message] is received, or if
+// a message contains a non-zero [jsonstream.Message.Error].
+//
+// Presentation of the message depends on whether out is a terminal, and on the
+// terminal width. Progress bars ([jsonstream.Progress]) are suppressed on
+// narrower terminals (< 110 characters). If out is a terminal, it prints a
+// newline ("\n") at the end of each line and moves the cursor while displaying.
+//
+// auxCallback allows handling the [jsonstream.Message.Aux] field. It is called
+// if a message contains an Aux field, in which case DisplayMessages does not
+// present the message.
+func DisplayMessages(messages iter.Seq2[jsonstream.Message, error], out io.Writer, opts ...DisplayOpt) error {
+ terminalFd, isTerminal := term.GetFdInfo(out)
+ return displayJSONMessages(messages, out, terminalFd, isTerminal, opts...)
+}
+
+func displayJSONMessages(messages iter.Seq2[jsonstream.Message, error], out io.Writer, terminalFd uintptr, isTerminal bool, opts ...DisplayOpt) error {
+ var cfg displayOpts
+ for _, opt := range opts {
+ if opt == nil {
+ continue
+ }
+ if err := opt(&cfg); err != nil {
+ return err
+ }
+ }
+ auxCallback := cfg.auxCallback
+
+ ids := make(map[string]uint)
+ var width uint16 = 200
+ if isTerminal {
+ ws, err := term.GetWinsize(terminalFd)
+ if err == nil {
+ width = ws.Width
+ }
+ }
+
+ for jm, err := range messages {
+ var diff uint
+ if err != nil {
+ return err
+ }
+
+ if jm.Aux != nil {
+ if auxCallback != nil {
+ auxCallback(jm)
+ }
+ continue
+ }
+
+ if jm.ID != "" && jm.Progress != nil {
+ line, ok := ids[jm.ID]
+ if !ok {
+ // NOTE: This approach of using len(id) to
+ // figure out the number of lines of history
+ // only works as long as we clear the history
+ // when we output something that's not
+ // accounted for in the map, such as a line
+ // with no ID.
+ line = uint(len(ids))
+ ids[jm.ID] = line
+ if isTerminal {
+ _, _ = fmt.Fprintf(out, "\n")
+ }
+ }
+ diff = uint(len(ids)) - line
+ if isTerminal {
+ cursorUp(out, diff)
+ }
+ } else {
+ // When outputting something that isn't progress
+ // output, clear the history of previous lines. We
+ // don't want progress entries from some previous
+ // operation to be updated (for example, pull -a
+ // with multiple tags).
+ ids = make(map[string]uint)
+ }
+ err := Display(jm, out, isTerminal, width)
+ if jm.ID != "" && isTerminal {
+ cursorDown(out, diff)
+ }
+ if err != nil {
+ return err
+ }
+ }
+ return nil
+}
diff --git a/vendor/github.com/shirou/gopsutil/v4/cpu/cpu_aix_cgo.go b/vendor/github.com/shirou/gopsutil/v4/cpu/cpu_aix_cgo.go
index 559dc5fe..8bd84de6 100644
--- a/vendor/github.com/shirou/gopsutil/v4/cpu/cpu_aix_cgo.go
+++ b/vendor/github.com/shirou/gopsutil/v4/cpu/cpu_aix_cgo.go
@@ -27,16 +27,16 @@ func TimesWithContext(ctx context.Context, percpu bool) ([]TimesStat, error) {
ret = append(ret, *ct)
}
} else {
- c, err := perfstat.CpuUtilTotalStat()
+ c, err := perfstat.CpuTotalStat()
if err != nil {
return nil, err
}
ct := &TimesStat{
CPU: "cpu-total",
- Idle: float64(c.IdlePct),
- User: float64(c.UserPct),
- System: float64(c.KernPct),
- Iowait: float64(c.WaitPct),
+ Idle: float64(c.Idle),
+ User: float64(c.User),
+ System: float64(c.Sys),
+ Iowait: float64(c.Wait),
}
ret = append(ret, *ct)
}
@@ -48,19 +48,32 @@ func InfoWithContext(ctx context.Context) ([]InfoStat, error) {
if err != nil {
return nil, err
}
+ p, err := perfstat.LparInfo()
+ if err != nil {
+ return nil, err
+ }
info := InfoStat{
- CPU: 0,
- Mhz: float64(c.ProcessorHz / 1000000),
- Cores: int32(c.NCpusCfg),
+ CPU: 0,
+ ModelName: c.Description,
+ Mhz: float64(c.ProcessorHz / 1000000),
+ Cores: int32(p.OnlineVCpus),
}
result := []InfoStat{info}
return result, nil
}
func CountsWithContext(ctx context.Context, logical bool) (int, error) {
- c, err := perfstat.CpuTotalStat()
+ if logical {
+ c, err := perfstat.CpuTotalStat()
+ if err != nil {
+ return 0, err
+ }
+ return c.NCpusCfg, nil
+ }
+ // For physical count, use the number of online virtual CPUs (before SMT multiplications).
+ p, err := perfstat.LparInfo()
if err != nil {
return 0, err
}
- return c.NCpusCfg, nil
+ return int(p.OnlineVCpus), nil
}
diff --git a/vendor/github.com/shirou/gopsutil/v4/cpu/cpu_darwin_arm64.go b/vendor/github.com/shirou/gopsutil/v4/cpu/cpu_darwin_arm64.go
index 2effcadf..c9628a6d 100644
--- a/vendor/github.com/shirou/gopsutil/v4/cpu/cpu_darwin_arm64.go
+++ b/vendor/github.com/shirou/gopsutil/v4/cpu/cpu_darwin_arm64.go
@@ -6,24 +6,38 @@ package cpu
import (
"encoding/binary"
"fmt"
+ "sync"
"unsafe"
"github.com/shirou/gopsutil/v4/internal/common"
)
+// Keep IOKit and CoreFoundation libraries open for the process lifetime.
+// See: https://github.com/shirou/gopsutil/issues/1832
+var (
+ cpuLibOnce sync.Once
+ cpuIOKit *common.IOKitLib
+ cpuCF *common.CoreFoundationLib
+ cpuLibErr error
+)
+
+func initCPULibraries() {
+ cpuIOKit, cpuLibErr = common.NewIOKitLib()
+ if cpuLibErr != nil {
+ return
+ }
+ cpuCF, cpuLibErr = common.NewCoreFoundationLib()
+}
+
// https://github.com/shoenig/go-m1cpu/blob/v0.1.6/cpu.go
func getFrequency() (float64, error) {
- iokit, err := common.NewIOKitLib()
- if err != nil {
- return 0, err
+ cpuLibOnce.Do(initCPULibraries)
+ if cpuLibErr != nil {
+ return 0, cpuLibErr
}
- defer iokit.Close()
- corefoundation, err := common.NewCoreFoundationLib()
- if err != nil {
- return 0, err
- }
- defer corefoundation.Close()
+ iokit := cpuIOKit
+ corefoundation := cpuCF
matching := iokit.IOServiceMatching("AppleARMIODevice")
diff --git a/vendor/github.com/shirou/gopsutil/v4/internal/common/common.go b/vendor/github.com/shirou/gopsutil/v4/internal/common/common.go
index f0d3c454..dce15b3b 100644
--- a/vendor/github.com/shirou/gopsutil/v4/internal/common/common.go
+++ b/vendor/github.com/shirou/gopsutil/v4/internal/common/common.go
@@ -334,7 +334,7 @@ func PathExists(filename string) bool {
// PathExistsWithContents returns the filename exists and it is not empty
func PathExistsWithContents(filename string) bool {
- info, err := os.Stat(filename) //nolint:gosec // filename is constructed from system paths, not user input
+ info, err := os.Stat(filename)
if err != nil {
return false
}
diff --git a/vendor/github.com/shirou/gopsutil/v4/internal/common/common_darwin.go b/vendor/github.com/shirou/gopsutil/v4/internal/common/common_darwin.go
index 384b4c5a..caa1b8d9 100644
--- a/vendor/github.com/shirou/gopsutil/v4/internal/common/common_darwin.go
+++ b/vendor/github.com/shirou/gopsutil/v4/internal/common/common_darwin.go
@@ -7,6 +7,7 @@ import (
"errors"
"fmt"
"math"
+ "sync"
"unsafe"
"github.com/ebitengine/purego"
@@ -16,6 +17,7 @@ import (
type library struct {
handle uintptr
fnMap map[string]any
+ mu sync.RWMutex
}
// library paths
@@ -41,15 +43,29 @@ func (lib *library) Dlsym(symbol string) (uintptr, error) {
return purego.Dlsym(lib.handle, symbol)
}
+// getFunc resolves a function pointer from the library, caching it in fnMap.
+// Thread-safe via double-checked locking to support shared library handles.
func getFunc[T any](lib *library, symbol string) T {
- var dlfun *dlFunc[T]
+ // Fast path: read lock only
+ lib.mu.RLock()
if f, ok := lib.fnMap[symbol].(*dlFunc[T]); ok {
- dlfun = f
- } else {
- dlfun = newDlfunc[T](symbol)
- dlfun.init(lib.handle)
- lib.fnMap[symbol] = dlfun
+ lib.mu.RUnlock()
+ return f.fn
}
+ lib.mu.RUnlock()
+
+ // Slow path: write lock for first-time resolution
+ lib.mu.Lock()
+ defer lib.mu.Unlock()
+
+ // Double-check after acquiring write lock
+ if f, ok := lib.fnMap[symbol].(*dlFunc[T]); ok {
+ return f.fn
+ }
+
+ dlfun := newDlfunc[T](symbol)
+ dlfun.init(lib.handle)
+ lib.fnMap[symbol] = dlfun
return dlfun.fn
}
diff --git a/vendor/github.com/shirou/gopsutil/v4/mem/mem_linux.go b/vendor/github.com/shirou/gopsutil/v4/mem/mem_linux.go
index 9d969ba8..a888c5ba 100644
--- a/vendor/github.com/shirou/gopsutil/v4/mem/mem_linux.go
+++ b/vendor/github.com/shirou/gopsutil/v4/mem/mem_linux.go
@@ -18,13 +18,6 @@ import (
"github.com/shirou/gopsutil/v4/internal/common"
)
-// WillBeDeletedOptOutMemAvailableCalc is a context key to opt out of calculating Mem.Used.
-// This is not documented, and will be removed in Mar. 2026. This constant will be removed
-// in the future, but it is currently public. The reason is that making it public allows
-// developers to notice its removal when their build fails.
-// See https://github.com/shirou/gopsutil/issues/1873
-const WillBeDeletedOptOutMemAvailableCalc = "optOutMemAvailableCalc"
-
func VirtualMemory() (*VirtualMemoryStat, error) {
return VirtualMemoryWithContext(context.Background())
}
@@ -325,16 +318,7 @@ func fillFromMeminfoWithContext(ctx context.Context) (*VirtualMemoryStat, *ExVir
ret.Available = ret.Cached + ret.Free
}
}
- // Opt-Out of calculating Mem.Used if the context has the context key set to true.
- // This is used for backward compatibility with applications that expect the old calculation method.
- // However, we plan to standardize on using MemAvailable in the future.
- // Therefore, please avoid using this opt-out unless it is absolutely necessary.
- // see https://github.com/shirou/gopsutil/issues/1873
- if val, ok := ctx.Value(WillBeDeletedOptOutMemAvailableCalc).(bool); ok && val {
- ret.Used = ret.Total - ret.Free - ret.Buffers - ret.Cached
- } else {
- ret.Used = ret.Total - ret.Available
- }
+ ret.Used = ret.Total - ret.Available
ret.UsedPercent = float64(ret.Used) / float64(ret.Total) * 100.0
diff --git a/vendor/github.com/shirou/gopsutil/v4/mem/mem_openbsd.go b/vendor/github.com/shirou/gopsutil/v4/mem/mem_openbsd.go
index 1cb785f0..69d8a811 100644
--- a/vendor/github.com/shirou/gopsutil/v4/mem/mem_openbsd.go
+++ b/vendor/github.com/shirou/gopsutil/v4/mem/mem_openbsd.go
@@ -38,19 +38,6 @@ func VirtualMemoryWithContext(_ context.Context) (*VirtualMemoryStat, error) {
}
p := uint64(uvmexp.Pagesize)
- ret := &VirtualMemoryStat{
- Total: uint64(uvmexp.Npages) * p,
- Free: uint64(uvmexp.Free) * p,
- Active: uint64(uvmexp.Active) * p,
- Inactive: uint64(uvmexp.Inactive) * p,
- Cached: 0, // not available
- Wired: uint64(uvmexp.Wired) * p,
- }
-
- ret.Available = ret.Inactive + ret.Cached + ret.Free
- ret.Used = ret.Total - ret.Available
- ret.UsedPercent = float64(ret.Used) / float64(ret.Total) * 100.0
-
mib := []int32{CTLVfs, VfsGeneric, VfsBcacheStat}
buf, length, err := common.CallSyscall(mib)
if err != nil {
@@ -64,7 +51,23 @@ func VirtualMemoryWithContext(_ context.Context) (*VirtualMemoryStat, error) {
if err := binary.Read(br, binary.LittleEndian, &bcs); err != nil {
return nil, err
}
- ret.Buffers = uint64(bcs.Numbufpages) * p
+ // On OpenBSD, the buffer cache is the closest equivalent to both
+ // Linux's Buffers and Cached memory.
+ bcache := uint64(bcs.Numbufpages) * p
+
+ ret := &VirtualMemoryStat{
+ Total: uint64(uvmexp.Npages) * p,
+ Free: uint64(uvmexp.Free) * p,
+ Active: uint64(uvmexp.Active) * p,
+ Inactive: uint64(uvmexp.Inactive) * p,
+ Cached: bcache,
+ Buffers: bcache,
+ Wired: uint64(uvmexp.Wired) * p,
+ }
+
+ ret.Available = ret.Inactive + ret.Cached + ret.Free
+ ret.Used = ret.Total - ret.Available
+ ret.UsedPercent = float64(ret.Used) / float64(ret.Total) * 100.0
return ret, nil
}
diff --git a/vendor/github.com/shirou/gopsutil/v4/net/net_aix_cgo.go b/vendor/github.com/shirou/gopsutil/v4/net/net_aix_cgo.go
index f7da4ce1..71786369 100644
--- a/vendor/github.com/shirou/gopsutil/v4/net/net_aix_cgo.go
+++ b/vendor/github.com/shirou/gopsutil/v4/net/net_aix_cgo.go
@@ -23,8 +23,9 @@ func IOCountersWithContext(ctx context.Context, pernic bool) ([]IOCountersStat,
BytesRecv: uint64(netif.IBytes),
PacketsSent: uint64(netif.OPackets),
PacketsRecv: uint64(netif.IPackets),
- Errin: uint64(netif.OErrors),
- Errout: uint64(netif.IErrors),
+ Errin: uint64(netif.IErrors),
+ Errout: uint64(netif.OErrors),
+ Dropin: uint64(netif.IfIqDrops),
Dropout: uint64(netif.XmitDrops),
}
iocounters = append(iocounters, n)
diff --git a/vendor/github.com/shirou/gopsutil/v4/net/net_darwin.go b/vendor/github.com/shirou/gopsutil/v4/net/net_darwin.go
index c47e0c37..9531ad5b 100644
--- a/vendor/github.com/shirou/gopsutil/v4/net/net_darwin.go
+++ b/vendor/github.com/shirou/gopsutil/v4/net/net_darwin.go
@@ -54,15 +54,13 @@ func parseNetstatLine(line string) (stat *IOCountersStat, linkID *uint, err erro
parsed := make([]uint64, 0, 7)
vv := []string{
- columns[base+3], // Ipkts == PacketsRecv
- columns[base+4], // Ierrs == Errin
- columns[base+5], // Ibytes == BytesRecv
- columns[base+6], // Opkts == PacketsSent
- columns[base+7], // Oerrs == Errout
- columns[base+8], // Obytes == BytesSent
- }
- if len(columns) == 12 {
- vv = append(vv, columns[base+10])
+ columns[base+3], // Ipkts == PacketsRecv
+ columns[base+4], // Ierrs == Errin
+ columns[base+5], // Ibytes == BytesRecv
+ columns[base+6], // Opkts == PacketsSent
+ columns[base+7], // Oerrs == Errout
+ columns[base+8], // Obytes == BytesSent
+ columns[base+10], // Drop == Dropout
}
for _, target := range vv {
@@ -85,9 +83,7 @@ func parseNetstatLine(line string) (stat *IOCountersStat, linkID *uint, err erro
PacketsSent: parsed[3],
Errout: parsed[4],
BytesSent: parsed[5],
- }
- if len(parsed) == 7 {
- stat.Dropout = parsed[6]
+ Dropout: parsed[6],
}
return stat, linkID, nil
}
diff --git a/vendor/github.com/shirou/gopsutil/v4/net/net_linux.go b/vendor/github.com/shirou/gopsutil/v4/net/net_linux.go
index d1e7f0ce..a3dd17aa 100644
--- a/vendor/github.com/shirou/gopsutil/v4/net/net_linux.go
+++ b/vendor/github.com/shirou/gopsutil/v4/net/net_linux.go
@@ -348,6 +348,7 @@ type connTmp struct {
pid int32
boundPid int32
path string
+ inode string
}
func ConnectionsWithContext(ctx context.Context, kind string) ([]ConnectionStat, error) {
@@ -405,6 +406,19 @@ func connectionsPidMaxWithoutUidsWithContext(ctx context.Context, kind string, p
return statsFromInodesWithContext(ctx, root, pid, tmap, inodes, skipUids)
}
+// connectionDedupKey builds a key to deduplicate connections.
+// For inet sockets, the tuple (type, src, dst, status) is sufficient.
+// For unix sockets, unnamed sockets share the same empty address,
+// so pid, fd, and inode must be included to avoid incorrect deduplication.
+// The inode is especially important when pid/fd are unavailable (e.g.,
+// unprivileged queries where inode-to-pid mapping fails).
+func connectionDedupKey(family uint32, c connTmp) string {
+ if family == syscall.AF_UNIX {
+ return fmt.Sprintf("%d-%d-%s-%d-%s:%d-%s:%d-%s", c.pid, c.fd, c.inode, c.sockType, c.laddr.IP, c.laddr.Port, c.raddr.IP, c.raddr.Port, c.status)
+ }
+ return fmt.Sprintf("%d-%s:%d-%s:%d-%s", c.sockType, c.laddr.IP, c.laddr.Port, c.raddr.IP, c.raddr.Port, c.status)
+}
+
func statsFromInodesWithContext(ctx context.Context, root string, pid int32, tmap []netConnectionKindType, inodes map[string][]inodeMap, skipUids bool) ([]ConnectionStat, error) {
dupCheckMap := make(map[string]struct{})
var ret []ConnectionStat
@@ -412,7 +426,6 @@ func statsFromInodesWithContext(ctx context.Context, root string, pid int32, tma
var err error
for _, t := range tmap {
var path string
- var connKey string
var ls []connTmp
if pid == 0 {
path = fmt.Sprintf("%s/net/%s", root, t.filename)
@@ -429,10 +442,7 @@ func statsFromInodesWithContext(ctx context.Context, root string, pid int32, tma
return nil, err
}
for _, c := range ls {
- // Build TCP key to id the connection uniquely
- // socket type, src ip, src port, dst ip, dst port and state should be enough
- // to prevent duplications.
- connKey = fmt.Sprintf("%d-%s:%d-%s:%d-%s", c.sockType, c.laddr.IP, c.laddr.Port, c.raddr.IP, c.raddr.Port, c.status)
+ connKey := connectionDedupKey(t.family, c)
if _, ok := dupCheckMap[connKey]; ok {
continue
}
@@ -728,6 +738,7 @@ func processInet(file string, kind netConnectionKindType, inodes map[string][]in
raddr: ra,
status: status,
pid: pid,
+ inode: inode,
})
}
@@ -785,6 +796,7 @@ func processUnix(file string, kind netConnectionKindType, inodes map[string][]in
pid: pair.pid,
status: "NONE",
path: path,
+ inode: inode,
})
}
}
diff --git a/vendor/github.com/shirou/gopsutil/v4/process/process_darwin.go b/vendor/github.com/shirou/gopsutil/v4/process/process_darwin.go
index d7fb921c..35c34adb 100644
--- a/vendor/github.com/shirou/gopsutil/v4/process/process_darwin.go
+++ b/vendor/github.com/shirou/gopsutil/v4/process/process_darwin.go
@@ -133,7 +133,7 @@ func (p *Process) GidsWithContext(_ context.Context) ([]uint32, error) {
}
gids := make([]uint32, 0, 3)
- gids = append(gids, uint32(k.Eproc.Pcred.P_rgid), uint32(k.Eproc.Pcred.P_rgid), uint32(k.Eproc.Pcred.P_svgid))
+ gids = append(gids, uint32(k.Eproc.Pcred.P_rgid), uint32(k.Eproc.Ucred.Groups[0]), uint32(k.Eproc.Pcred.P_svgid))
return gids, nil
}
@@ -465,9 +465,8 @@ func (p *Process) MemoryInfoWithContext(_ context.Context) (*MemoryInfoStat, err
funcs.lib.ProcPidInfo(p.Pid, common.PROC_PIDTASKINFO, 0, uintptr(unsafe.Pointer(&ti)), int32(unsafe.Sizeof(ti)))
ret := &MemoryInfoStat{
- RSS: uint64(ti.Resident_size),
- VMS: uint64(ti.Virtual_size),
- Swap: uint64(ti.Pageins),
+ RSS: uint64(ti.Resident_size),
+ VMS: uint64(ti.Virtual_size),
}
return ret, nil
}
diff --git a/vendor/github.com/shirou/gopsutil/v4/process/process_posix.go b/vendor/github.com/shirou/gopsutil/v4/process/process_posix.go
index 06642238..9f0e93f3 100644
--- a/vendor/github.com/shirou/gopsutil/v4/process/process_posix.go
+++ b/vendor/github.com/shirou/gopsutil/v4/process/process_posix.go
@@ -111,7 +111,7 @@ func PidExistsWithContext(ctx context.Context, pid int32) (bool, error) {
defer proc.Release()
if isMount(common.HostProcWithContext(ctx)) { // if //proc exists and is mounted, check if //proc/ folder exists
- _, err := os.Stat(common.HostProcWithContext(ctx, strconv.Itoa(int(pid)))) //nolint:gosec // pid is int32, path traversal is not possible
+ _, err := os.Stat(common.HostProcWithContext(ctx, strconv.Itoa(int(pid))))
if os.IsNotExist(err) {
return false, nil
}
diff --git a/vendor/github.com/stretchr/objx/README.md b/vendor/github.com/stretchr/objx/README.md
index 78dc1f8b..e9ba8307 100644
--- a/vendor/github.com/stretchr/objx/README.md
+++ b/vendor/github.com/stretchr/objx/README.md
@@ -1,8 +1,6 @@
# Objx
[](https://travis-ci.org/stretchr/objx)
[](https://goreportcard.com/report/github.com/stretchr/objx)
-[](https://codeclimate.com/github/stretchr/objx/maintainability)
-[](https://codeclimate.com/github/stretchr/objx/test_coverage)
[](https://sourcegraph.com/github.com/stretchr/objx)
[](https://pkg.go.dev/github.com/stretchr/objx)
@@ -19,49 +17,62 @@ Objx provides the `objx.Map` type, which is a `map[string]interface{}` that expo
### Pattern
Objx uses a predictable pattern to make access data from within `map[string]interface{}` easy. Call one of the `objx.` functions to create your `objx.Map` to get going:
- m, err := objx.FromJSON(json)
+```go
+m, err := objx.FromJSON(json)
+```
NOTE: Any methods or functions with the `Must` prefix will panic if something goes wrong, the rest will be optimistic and try to figure things out without panicking.
Use `Get` to access the value you're interested in. You can use dot and array
notation too:
- m.Get("places[0].latlng")
+```go
+m.Get("places[0].latlng")
+```
Once you have sought the `Value` you're interested in, you can use the `Is*` methods to determine its type.
- if m.Get("code").IsStr() { // Your code... }
+```go
+if m.Get("code").IsStr() { // Your code... }
+```
Or you can just assume the type, and use one of the strong type methods to extract the real value:
- m.Get("code").Int()
+```go
+m.Get("code").Int()
+```
If there's no value there (or if it's the wrong type) then a default value will be returned, or you can be explicit about the default value.
- Get("code").Int(-1)
-
+```go
+Get("code").Int(-1)
+```
If you're dealing with a slice of data as a value, Objx provides many useful methods for iterating, manipulating and selecting that data. You can find out more by exploring the index below.
### Reading data
A simple example of how to use Objx:
- // Use MustFromJSON to make an objx.Map from some JSON
- m := objx.MustFromJSON(`{"name": "Mat", "age": 30}`)
+```go
+// Use MustFromJSON to make an objx.Map from some JSON
+m := objx.MustFromJSON(`{"name": "Mat", "age": 30}`)
- // Get the details
- name := m.Get("name").Str()
- age := m.Get("age").Int()
+// Get the details
+name := m.Get("name").Str()
+age := m.Get("age").Int()
- // Get their nickname (or use their name if they don't have one)
- nickname := m.Get("nickname").Str(name)
+// Get their nickname (or use their name if they don't have one)
+nickname := m.Get("nickname").Str(name)
+```
### Ranging
Since `objx.Map` is a `map[string]interface{}` you can treat it as such. For example, to `range` the data, do what you would expect:
- m := objx.MustFromJSON(json)
- for key, value := range m {
- // Your code...
- }
+```go
+m := objx.MustFromJSON(json)
+for key, value := range m {
+ // Your code...
+}
+```
## Installation
To install Objx, use go get:
diff --git a/vendor/github.com/testcontainers/testcontainers-go/.gitignore b/vendor/github.com/testcontainers/testcontainers-go/.gitignore
index 1693b100..c13cb1fb 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/.gitignore
+++ b/vendor/github.com/testcontainers/testcontainers-go/.gitignore
@@ -26,3 +26,8 @@ coverage.out
# Usage metrics script binary
usage-metrics/scripts/collect-metrics
+
+# Gas Town / Claude Code agent artifacts
+.beads/
+.claude/
+.runtime/
diff --git a/vendor/github.com/testcontainers/testcontainers-go/.golangci.yml b/vendor/github.com/testcontainers/testcontainers-go/.golangci.yml
index 6f68a937..bd3e9de7 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/.golangci.yml
+++ b/vendor/github.com/testcontainers/testcontainers-go/.golangci.yml
@@ -8,6 +8,7 @@ formatters:
- standard
- default
- prefix(github.com/testcontainers)
+
linters:
enable:
- errorlint
@@ -115,4 +116,5 @@ output:
path: stdout
run:
relative-path-mode: gitroot
+
version: "2"
diff --git a/vendor/github.com/testcontainers/testcontainers-go/AI.md b/vendor/github.com/testcontainers/testcontainers-go/AI.md
index c66a8c69..f90971bb 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/AI.md
+++ b/vendor/github.com/testcontainers/testcontainers-go/AI.md
@@ -14,15 +14,15 @@ This is a **Go monorepo** containing:
## Environment Setup
### Go Version
-- **Required**: Go 1.25.7
+- **Required**: Go 1.25.9
- **Tool**: Use [gvm](https://github.com/andrewkroh/gvm) for version management
- **CRITICAL**: Always run this before ANY Go command:
```bash
# For Apple Silicon (M1/M2/M3)
- eval "$(gvm 1.25.7 --arch=arm64)"
+ eval "$(gvm 1.25.9 --arch=arm64)"
# For Intel/AMD (x86_64)
- eval "$(gvm 1.25.7 --arch=amd64)"
+ eval "$(gvm 1.25.9 --arch=amd64)"
```
### Project Structure
@@ -171,14 +171,14 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom
### When Tests Fail
1. **Read the error message carefully** - it usually tells you exactly what's wrong
2. **Check if it's a lint issue** - run `make pre-commit` first
-3. **Verify Go version** - ensure using Go 1.25.7
+3. **Verify Go version** - ensure using Go 1.25.9
4. **Check Docker** - some tests require Docker daemon running
## Common Pitfalls to Avoid
### Code Issues
- ❌ Using interface types as return values
-- ❌ Forgetting to run `eval "$(gvm 1.25.7 --arch=arm64)"`
+- ❌ Forgetting to run `eval "$(gvm 1.25.9 --arch=arm64)"`
- ❌ Not handling errors from built-in options
- ❌ Using module-specific container names (`PostgresContainer`)
- ❌ Calling `.Customize()` method instead of direct function call
diff --git a/vendor/github.com/testcontainers/testcontainers-go/Pipfile b/vendor/github.com/testcontainers/testcontainers-go/Pipfile
index 28f9305d..f7a1fb06 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/Pipfile
+++ b/vendor/github.com/testcontainers/testcontainers-go/Pipfile
@@ -8,7 +8,7 @@ verify_ssl = true
[packages]
mkdocs = "==1.5.3"
mkdocs-codeinclude-plugin = "==0.3.1"
-mkdocs-include-markdown-plugin = "==7.2.1"
+mkdocs-include-markdown-plugin = "==7.2.2"
mkdocs-material = "==9.5.18"
mkdocs-markdownextradata-plugin = "==0.2.6"
diff --git a/vendor/github.com/testcontainers/testcontainers-go/Pipfile.lock b/vendor/github.com/testcontainers/testcontainers-go/Pipfile.lock
index ff0b12f9..111787b0 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/Pipfile.lock
+++ b/vendor/github.com/testcontainers/testcontainers-go/Pipfile.lock
@@ -1,7 +1,7 @@
{
"_meta": {
"hash": {
- "sha256": "c30436cdeb31baa333fdc82d0679532754a1ea51be468b4fd83da0de242b70cf"
+ "sha256": "d2dc50d3b1c6818dd8a8fb4fa7a60013292b7f173db53d3e996bf43b4191ad70"
},
"pipfile-spec": 6,
"requires": {
@@ -34,109 +34,146 @@
},
"certifi": {
"hashes": [
- "sha256:6b31f564a415d79ee77df69d757bb49a5bb53bd9f756cbbe24394ffd6fc1f4b2",
- "sha256:8ea99dbdfaaf2ba2f9bac77b9249ef62ec5218e7c2b2e903378ed5fccf765995"
+ "sha256:027692e4402ad994f1c42e52a4997a9763c646b73e4096e4d5d6db8af1d6f0fa",
+ "sha256:e887ab5cee78ea814d3472169153c2d12cd43b14bd03329a39a9c6e2e80bfba7"
],
"markers": "python_version >= '3.7'",
- "version": "==2025.7.14"
+ "version": "==2026.2.25"
},
"charset-normalizer": {
"hashes": [
- "sha256:005fa3432484527f9732ebd315da8da8001593e2cf46a3d817669f062c3d9ed4",
- "sha256:046595208aae0120559a67693ecc65dd75d46f7bf687f159127046628178dc45",
- "sha256:0c29de6a1a95f24b9a1aa7aefd27d2487263f00dfd55a77719b530788f75cff7",
- "sha256:0c8c57f84ccfc871a48a47321cfa49ae1df56cd1d965a09abe84066f6853b9c0",
- "sha256:0f5d9ed7f254402c9e7d35d2f5972c9bbea9040e99cd2861bd77dc68263277c7",
- "sha256:18dd2e350387c87dabe711b86f83c9c78af772c748904d372ade190b5c7c9d4d",
- "sha256:1b1bde144d98e446b056ef98e59c256e9294f6b74d7af6846bf5ffdafd687a7d",
- "sha256:1c95a1e2902a8b722868587c0e1184ad5c55631de5afc0eb96bc4b0d738092c0",
- "sha256:1cad5f45b3146325bb38d6855642f6fd609c3f7cad4dbaf75549bf3b904d3184",
- "sha256:21b2899062867b0e1fde9b724f8aecb1af14f2778d69aacd1a5a1853a597a5db",
- "sha256:24498ba8ed6c2e0b56d4acbf83f2d989720a93b41d712ebd4f4979660db4417b",
- "sha256:25a23ea5c7edc53e0f29bae2c44fcb5a1aa10591aae107f2a2b2583a9c5cbc64",
- "sha256:289200a18fa698949d2b39c671c2cc7a24d44096784e76614899a7ccf2574b7b",
- "sha256:28a1005facc94196e1fb3e82a3d442a9d9110b8434fc1ded7a24a2983c9888d8",
- "sha256:32fc0341d72e0f73f80acb0a2c94216bd704f4f0bce10aedea38f30502b271ff",
- "sha256:36b31da18b8890a76ec181c3cf44326bf2c48e36d393ca1b72b3f484113ea344",
- "sha256:3c21d4fca343c805a52c0c78edc01e3477f6dd1ad7c47653241cf2a206d4fc58",
- "sha256:3fddb7e2c84ac87ac3a947cb4e66d143ca5863ef48e4a5ecb83bd48619e4634e",
- "sha256:43e0933a0eff183ee85833f341ec567c0980dae57c464d8a508e1b2ceb336471",
- "sha256:4a476b06fbcf359ad25d34a057b7219281286ae2477cc5ff5e3f70a246971148",
- "sha256:4e594135de17ab3866138f496755f302b72157d115086d100c3f19370839dd3a",
- "sha256:50bf98d5e563b83cc29471fa114366e6806bc06bc7a25fd59641e41445327836",
- "sha256:5a9979887252a82fefd3d3ed2a8e3b937a7a809f65dcb1e068b090e165bbe99e",
- "sha256:5baececa9ecba31eff645232d59845c07aa030f0c81ee70184a90d35099a0e63",
- "sha256:5bf4545e3b962767e5c06fe1738f951f77d27967cb2caa64c28be7c4563e162c",
- "sha256:6333b3aa5a12c26b2a4d4e7335a28f1475e0e5e17d69d55141ee3cab736f66d1",
- "sha256:65c981bdbd3f57670af8b59777cbfae75364b483fa8a9f420f08094531d54a01",
- "sha256:68a328e5f55ec37c57f19ebb1fdc56a248db2e3e9ad769919a58672958e8f366",
- "sha256:6a0289e4589e8bdfef02a80478f1dfcb14f0ab696b5a00e1f4b8a14a307a3c58",
- "sha256:6b66f92b17849b85cad91259efc341dce9c1af48e2173bf38a85c6329f1033e5",
- "sha256:6c9379d65defcab82d07b2a9dfbfc2e95bc8fe0ebb1b176a3190230a3ef0e07c",
- "sha256:6fc1f5b51fa4cecaa18f2bd7a003f3dd039dd615cd69a2afd6d3b19aed6775f2",
- "sha256:70f7172939fdf8790425ba31915bfbe8335030f05b9913d7ae00a87d4395620a",
- "sha256:721c76e84fe669be19c5791da68232ca2e05ba5185575086e384352e2c309597",
- "sha256:7222ffd5e4de8e57e03ce2cef95a4c43c98fcb72ad86909abdfc2c17d227fc1b",
- "sha256:75d10d37a47afee94919c4fab4c22b9bc2a8bf7d4f46f87363bcf0573f3ff4f5",
- "sha256:76af085e67e56c8816c3ccf256ebd136def2ed9654525348cfa744b6802b69eb",
- "sha256:770cab594ecf99ae64c236bc9ee3439c3f46be49796e265ce0cc8bc17b10294f",
- "sha256:7a6ab32f7210554a96cd9e33abe3ddd86732beeafc7a28e9955cdf22ffadbab0",
- "sha256:7c48ed483eb946e6c04ccbe02c6b4d1d48e51944b6db70f697e089c193404941",
- "sha256:7f56930ab0abd1c45cd15be65cc741c28b1c9a34876ce8c17a2fa107810c0af0",
- "sha256:8075c35cd58273fee266c58c0c9b670947c19df5fb98e7b66710e04ad4e9ff86",
- "sha256:8272b73e1c5603666618805fe821edba66892e2870058c94c53147602eab29c7",
- "sha256:82d8fd25b7f4675d0c47cf95b594d4e7b158aca33b76aa63d07186e13c0e0ab7",
- "sha256:844da2b5728b5ce0e32d863af26f32b5ce61bc4273a9c720a9f3aa9df73b1455",
- "sha256:8755483f3c00d6c9a77f490c17e6ab0c8729e39e6390328e42521ef175380ae6",
- "sha256:915f3849a011c1f593ab99092f3cecfcb4d65d8feb4a64cf1bf2d22074dc0ec4",
- "sha256:926ca93accd5d36ccdabd803392ddc3e03e6d4cd1cf17deff3b989ab8e9dbcf0",
- "sha256:982bb1e8b4ffda883b3d0a521e23abcd6fd17418f6d2c4118d257a10199c0ce3",
- "sha256:98f862da73774290f251b9df8d11161b6cf25b599a66baf087c1ffe340e9bfd1",
- "sha256:9cbfacf36cb0ec2897ce0ebc5d08ca44213af24265bd56eca54bee7923c48fd6",
- "sha256:a370b3e078e418187da8c3674eddb9d983ec09445c99a3a263c2011993522981",
- "sha256:a955b438e62efdf7e0b7b52a64dc5c3396e2634baa62471768a64bc2adb73d5c",
- "sha256:aa6af9e7d59f9c12b33ae4e9450619cf2488e2bbe9b44030905877f0b2324980",
- "sha256:aa88ca0b1932e93f2d961bf3addbb2db902198dca337d88c89e1559e066e7645",
- "sha256:aaeeb6a479c7667fbe1099af9617c83aaca22182d6cf8c53966491a0f1b7ffb7",
- "sha256:aaf27faa992bfee0264dc1f03f4c75e9fcdda66a519db6b957a3f826e285cf12",
- "sha256:b2680962a4848b3c4f155dc2ee64505a9c57186d0d56b43123b17ca3de18f0fa",
- "sha256:b2d318c11350e10662026ad0eb71bb51c7812fc8590825304ae0bdd4ac283acd",
- "sha256:b33de11b92e9f75a2b545d6e9b6f37e398d86c3e9e9653c4864eb7e89c5773ef",
- "sha256:b3daeac64d5b371dea99714f08ffc2c208522ec6b06fbc7866a450dd446f5c0f",
- "sha256:be1e352acbe3c78727a16a455126d9ff83ea2dfdcbc83148d2982305a04714c2",
- "sha256:bee093bf902e1d8fc0ac143c88902c3dfc8941f7ea1d6a8dd2bcb786d33db03d",
- "sha256:c72fbbe68c6f32f251bdc08b8611c7b3060612236e960ef848e0a517ddbe76c5",
- "sha256:c9e36a97bee9b86ef9a1cf7bb96747eb7a15c2f22bdb5b516434b00f2a599f02",
- "sha256:cddf7bd982eaa998934a91f69d182aec997c6c468898efe6679af88283b498d3",
- "sha256:cf713fe9a71ef6fd5adf7a79670135081cd4431c2943864757f0fa3a65b1fafd",
- "sha256:d11b54acf878eef558599658b0ffca78138c8c3655cf4f3a4a673c437e67732e",
- "sha256:d41c4d287cfc69060fa91cae9683eacffad989f1a10811995fa309df656ec214",
- "sha256:d524ba3f1581b35c03cb42beebab4a13e6cdad7b36246bd22541fa585a56cccd",
- "sha256:daac4765328a919a805fa5e2720f3e94767abd632ae410a9062dff5412bae65a",
- "sha256:db4c7bf0e07fc3b7d89ac2a5880a6a8062056801b83ff56d8464b70f65482b6c",
- "sha256:dc7039885fa1baf9be153a0626e337aa7ec8bf96b0128605fb0d77788ddc1681",
- "sha256:dccab8d5fa1ef9bfba0590ecf4d46df048d18ffe3eec01eeb73a42e0d9e7a8ba",
- "sha256:dedb8adb91d11846ee08bec4c8236c8549ac721c245678282dcb06b221aab59f",
- "sha256:e45ba65510e2647721e35323d6ef54c7974959f6081b58d4ef5d87c60c84919a",
- "sha256:e53efc7c7cee4c1e70661e2e112ca46a575f90ed9ae3fef200f2a25e954f4b28",
- "sha256:e635b87f01ebc977342e2697d05b56632f5f879a4f15955dfe8cef2448b51691",
- "sha256:e70e990b2137b29dc5564715de1e12701815dacc1d056308e2b17e9095372a82",
- "sha256:e8082b26888e2f8b36a042a58307d5b917ef2b1cacab921ad3323ef91901c71a",
- "sha256:e8323a9b031aa0393768b87f04b4164a40037fb2a3c11ac06a03ffecd3618027",
- "sha256:e92fca20c46e9f5e1bb485887d074918b13543b1c2a1185e69bb8d17ab6236a7",
- "sha256:eb30abc20df9ab0814b5a2524f23d75dcf83cde762c161917a2b4b7b55b1e518",
- "sha256:eba9904b0f38a143592d9fc0e19e2df0fa2e41c3c3745554761c5f6447eedabf",
- "sha256:ef8de666d6179b009dce7bcb2ad4c4a779f113f12caf8dc77f0162c29d20490b",
- "sha256:efd387a49825780ff861998cd959767800d54f8308936b21025326de4b5a42b9",
- "sha256:f0aa37f3c979cf2546b73e8222bbfa3dc07a641585340179d768068e3455e544",
- "sha256:f4074c5a429281bf056ddd4c5d3b740ebca4d43ffffe2ef4bf4d2d05114299da",
- "sha256:f69a27e45c43520f5487f27627059b64aaf160415589230992cec34c5e18a509",
- "sha256:fb707f3e15060adf5b7ada797624a6c6e0138e2a26baa089df64c68ee98e040f",
- "sha256:fcbe676a55d7445b22c10967bceaaf0ee69407fbe0ece4d032b6eb8d4565982a",
- "sha256:fdb20a30fe1175ecabed17cbf7812f7b804b8a315a25f24678bcdf120a90077f"
+ "sha256:06a7e86163334edfc5d20fe104db92fcd666e5a5df0977cb5680a506fe26cc8e",
+ "sha256:0c173ce3a681f309f31b87125fecec7a5d1347261ea11ebbb856fa6006b23c8c",
+ "sha256:0e28d62a8fc7a1fa411c43bd65e346f3bce9716dc51b897fbe930c5987b402d5",
+ "sha256:0e901eb1049fdb80f5bd11ed5ea1e498ec423102f7a9b9e4645d5b8204ff2815",
+ "sha256:11afb56037cbc4b1555a34dd69151e8e069bee82e613a73bef6e714ce733585f",
+ "sha256:150b8ce8e830eb7ccb029ec9ca36022f756986aaaa7956aad6d9ec90089338c0",
+ "sha256:172985e4ff804a7ad08eebec0a1640ece87ba5041d565fff23c8f99c1f389484",
+ "sha256:197c1a244a274bb016dd8b79204850144ef77fe81c5b797dc389327adb552407",
+ "sha256:1ae6b62897110aa7c79ea2f5dd38d1abca6db663687c0b1ad9aed6f6bae3d9d6",
+ "sha256:1cf0a70018692f85172348fe06d3a4b63f94ecb055e13a00c644d368eb82e5b8",
+ "sha256:1ed80ff870ca6de33f4d953fda4d55654b9a2b340ff39ab32fa3adbcd718f264",
+ "sha256:22c6f0c2fbc31e76c3b8a86fba1a56eda6166e238c29cdd3d14befdb4a4e4815",
+ "sha256:231d4da14bcd9301310faf492051bee27df11f2bc7549bc0bb41fef11b82daa2",
+ "sha256:259695e2ccc253feb2a016303543d691825e920917e31f894ca1a687982b1de4",
+ "sha256:2a24157fa36980478dd1770b585c0f30d19e18f4fb0c47c13aa568f871718579",
+ "sha256:2b1a63e8224e401cafe7739f77efd3f9e7f5f2026bda4aead8e59afab537784f",
+ "sha256:2bd9d128ef93637a5d7a6af25363cf5dec3fa21cf80e68055aad627f280e8afa",
+ "sha256:2e1d8ca8611099001949d1cdfaefc510cf0f212484fe7c565f735b68c78c3c95",
+ "sha256:2ef7fedc7a6ecbe99969cd09632516738a97eeb8bd7258bf8a0f23114c057dab",
+ "sha256:2f7fdd9b6e6c529d6a2501a2d36b240109e78a8ceaef5687cfcfa2bbe671d297",
+ "sha256:30f445ae60aad5e1f8bdbb3108e39f6fbc09f4ea16c815c66578878325f8f15a",
+ "sha256:31215157227939b4fb3d740cd23fe27be0439afef67b785a1eb78a3ae69cba9e",
+ "sha256:34315ff4fc374b285ad7f4a0bf7dcbfe769e1b104230d40f49f700d4ab6bbd84",
+ "sha256:3516bbb8d42169de9e61b8520cbeeeb716f12f4ecfe3fd30a9919aa16c806ca8",
+ "sha256:3778fd7d7cd04ae8f54651f4a7a0bd6e39a0cf20f801720a4c21d80e9b7ad6b0",
+ "sha256:39f5068d35621da2881271e5c3205125cc456f54e9030d3f723288c873a71bf9",
+ "sha256:404a1e552cf5b675a87f0651f8b79f5f1e6fd100ee88dc612f89aa16abd4486f",
+ "sha256:419a9d91bd238052642a51938af8ac05da5b3343becde08d5cdeab9046df9ee1",
+ "sha256:423fb7e748a08f854a08a222b983f4df1912b1daedce51a72bd24fe8f26a1843",
+ "sha256:4482481cb0572180b6fd976a4d5c72a30263e98564da68b86ec91f0fe35e8565",
+ "sha256:461598cd852bfa5a61b09cae2b1c02e2efcd166ee5516e243d540ac24bfa68a7",
+ "sha256:47955475ac79cc504ef2704b192364e51d0d473ad452caedd0002605f780101c",
+ "sha256:48696db7f18afb80a068821504296eb0787d9ce239b91ca15059d1d3eaacf13b",
+ "sha256:4be9f4830ba8741527693848403e2c457c16e499100963ec711b1c6f2049b7c7",
+ "sha256:4d1d02209e06550bdaef34af58e041ad71b88e624f5d825519da3a3308e22687",
+ "sha256:4f41da960b196ea355357285ad1316a00099f22d0929fe168343b99b254729c9",
+ "sha256:517ad0e93394ac532745129ceabdf2696b609ec9f87863d337140317ebce1c14",
+ "sha256:51fb3c322c81d20567019778cb5a4a6f2dc1c200b886bc0d636238e364848c89",
+ "sha256:5273b9f0b5835ff0350c0828faea623c68bfa65b792720c453e22b25cc72930f",
+ "sha256:530d548084c4a9f7a16ed4a294d459b4f229db50df689bfe92027452452943a0",
+ "sha256:530e8cebeea0d76bdcf93357aa5e41336f48c3dc709ac52da2bb167c5b8271d9",
+ "sha256:54fae94be3d75f3e573c9a1b5402dc593de19377013c9a0e4285e3d402dd3a2a",
+ "sha256:572d7c822caf521f0525ba1bce1a622a0b85cf47ffbdae6c9c19e3b5ac3c4389",
+ "sha256:58c948d0d086229efc484fe2f30c2d382c86720f55cd9bc33591774348ad44e0",
+ "sha256:5d11595abf8dd942a77883a39d81433739b287b6aa71620f15164f8096221b30",
+ "sha256:5f8ddd609f9e1af8c7bd6e2aca279c931aefecd148a14402d4e368f3171769fd",
+ "sha256:5feb91325bbceade6afab43eb3b508c63ee53579fe896c77137ded51c6b6958e",
+ "sha256:60c74963d8350241a79cb8feea80e54d518f72c26db618862a8f53e5023deaf9",
+ "sha256:613f19aa6e082cf96e17e3ffd89383343d0d589abda756b7764cf78361fd41dc",
+ "sha256:659a1e1b500fac8f2779dd9e1570464e012f43e580371470b45277a27baa7532",
+ "sha256:695f5c2823691a25f17bc5d5ffe79fa90972cc34b002ac6c843bb8a1720e950d",
+ "sha256:69dd852c2f0ad631b8b60cfbe25a28c0058a894de5abb566619c205ce0550eae",
+ "sha256:6cceb5473417d28edd20c6c984ab6fee6c6267d38d906823ebfe20b03d607dc2",
+ "sha256:71be7e0e01753a89cf024abf7ecb6bca2c81738ead80d43004d9b5e3f1244e64",
+ "sha256:74119174722c4349af9708993118581686f343adc1c8c9c007d59be90d077f3f",
+ "sha256:74a2e659c7ecbc73562e2a15e05039f1e22c75b7c7618b4b574a3ea9118d1557",
+ "sha256:7504e9b7dc05f99a9bbb4525c67a2c155073b44d720470a148b34166a69c054e",
+ "sha256:79090741d842f564b1b2827c0b82d846405b744d31e84f18d7a7b41c20e473ff",
+ "sha256:7a6967aaf043bceabab5412ed6bd6bd26603dae84d5cb75bf8d9a74a4959d398",
+ "sha256:7bda6eebafd42133efdca535b04ccb338ab29467b3f7bf79569883676fc628db",
+ "sha256:7edbed096e4a4798710ed6bc75dcaa2a21b68b6c356553ac4823c3658d53743a",
+ "sha256:7f9019c9cb613f084481bd6a100b12e1547cf2efe362d873c2e31e4035a6fa43",
+ "sha256:802168e03fba8bbc5ce0d866d589e4b1ca751d06edee69f7f3a19c5a9fe6b597",
+ "sha256:80d0a5615143c0b3225e5e3ef22c8d5d51f3f72ce0ea6fb84c943546c7b25b6c",
+ "sha256:82060f995ab5003a2d6e0f4ad29065b7672b6593c8c63559beefe5b443242c3e",
+ "sha256:836ab36280f21fc1a03c99cd05c6b7af70d2697e374c7af0b61ed271401a72a2",
+ "sha256:8761ac29b6c81574724322a554605608a9960769ea83d2c73e396f3df896ad54",
+ "sha256:87725cfb1a4f1f8c2fc9890ae2f42094120f4b44db9360be5d99a4c6b0e03a9e",
+ "sha256:899d28f422116b08be5118ef350c292b36fc15ec2daeb9ea987c89281c7bb5c4",
+ "sha256:8bc5f0687d796c05b1e28ab0d38a50e6309906ee09375dd3aff6a9c09dd6e8f4",
+ "sha256:8bea55c4eef25b0b19a0337dc4e3f9a15b00d569c77211fa8cde38684f234fb7",
+ "sha256:8e5a94886bedca0f9b78fecd6afb6629142fd2605aa70a125d49f4edc6037ee6",
+ "sha256:90ca27cd8da8118b18a52d5f547859cc1f8354a00cd1e8e5120df3e30d6279e5",
+ "sha256:92734d4d8d187a354a556626c221cd1a892a4e0802ccb2af432a1d85ec012194",
+ "sha256:947cf925bc916d90adba35a64c82aace04fa39b46b52d4630ece166655905a69",
+ "sha256:95b52c68d64c1878818687a473a10547b3292e82b6f6fe483808fb1468e2f52f",
+ "sha256:97d0235baafca5f2b09cf332cc275f021e694e8362c6bb9c96fc9a0eb74fc316",
+ "sha256:9ca4c0b502ab399ef89248a2c84c54954f77a070f28e546a85e91da627d1301e",
+ "sha256:9cc4fc6c196d6a8b76629a70ddfcd4635a6898756e2d9cac5565cf0654605d73",
+ "sha256:9cc6e6d9e571d2f863fa77700701dae73ed5f78881efc8b3f9a4398772ff53e8",
+ "sha256:a056d1ad2633548ca18ffa2f85c202cfb48b68615129143915b8dc72a806a923",
+ "sha256:a26611d9987b230566f24a0a125f17fe0de6a6aff9f25c9f564aaa2721a5fb88",
+ "sha256:a4474d924a47185a06411e0064b803c68be044be2d60e50e8bddcc2649957c1f",
+ "sha256:a4ea868bc28109052790eb2b52a9ab33f3aa7adc02f96673526ff47419490e21",
+ "sha256:a9e68c9d88823b274cf1e72f28cb5dc89c990edf430b0bfd3e2fb0785bfeabf4",
+ "sha256:aa9cccf4a44b9b62d8ba8b4dd06c649ba683e4bf04eea606d2e94cfc2d6ff4d6",
+ "sha256:ab30e5e3e706e3063bc6de96b118688cb10396b70bb9864a430f67df98c61ecc",
+ "sha256:ac2393c73378fea4e52aa56285a3d64be50f1a12395afef9cce47772f60334c2",
+ "sha256:ad8faf8df23f0378c6d527d8b0b15ea4a2e23c89376877c598c4870d1b2c7866",
+ "sha256:b35b200d6a71b9839a46b9b7fff66b6638bb52fc9658aa58796b0326595d3021",
+ "sha256:b3694e3f87f8ac7ce279d4355645b3c878d24d1424581b46282f24b92f5a4ae2",
+ "sha256:b4ff1d35e8c5bd078be89349b6f3a845128e685e751b6ea1169cf2160b344c4d",
+ "sha256:bbc8c8650c6e51041ad1be191742b8b421d05bbd3410f43fa2a00c8db87678e8",
+ "sha256:bc72863f4d9aba2e8fd9085e63548a324ba706d2ea2c83b260da08a59b9482de",
+ "sha256:bf625105bb9eef28a56a943fec8c8a98aeb80e7d7db99bd3c388137e6eb2d237",
+ "sha256:c2274ca724536f173122f36c98ce188fd24ce3dad886ec2b7af859518ce008a4",
+ "sha256:c45a03a4c69820a399f1dda9e1d8fbf3562eda46e7720458180302021b08f778",
+ "sha256:c8ae56368f8cc97c7e40a7ee18e1cedaf8e780cd8bc5ed5ac8b81f238614facb",
+ "sha256:c907cdc8109f6c619e6254212e794d6548373cc40e1ec75e6e3823d9135d29cc",
+ "sha256:ca0276464d148c72defa8bb4390cce01b4a0e425f3b50d1435aa6d7a18107602",
+ "sha256:cd5e2801c89992ed8c0a3f0293ae83c159a60d9a5d685005383ef4caca77f2c4",
+ "sha256:d08ec48f0a1c48d75d0356cea971921848fb620fdeba805b28f937e90691209f",
+ "sha256:d1a2ee9c1499fc8f86f4521f27a973c914b211ffa87322f4ee33bb35392da2c5",
+ "sha256:d5f5d1e9def3405f60e3ca8232d56f35c98fb7bf581efcc60051ebf53cb8b611",
+ "sha256:d60377dce4511655582e300dc1e5a5f24ba0cb229005a1d5c8d0cb72bb758ab8",
+ "sha256:d73beaac5e90173ac3deb9928a74763a6d230f494e4bfb422c217a0ad8e629bf",
+ "sha256:d7de2637729c67d67cf87614b566626057e95c303bc0a55ffe391f5205e7003d",
+ "sha256:dad6e0f2e481fffdcf776d10ebee25e0ef89f16d691f1e5dee4b586375fdc64b",
+ "sha256:dda86aba335c902b6149a02a55b38e96287157e609200811837678214ba2b1db",
+ "sha256:df01808ee470038c3f8dc4f48620df7225c49c2d6639e38f96e6d6ac6e6f7b0e",
+ "sha256:e1f6e2f00a6b8edb562826e4632e26d063ac10307e80f7461f7de3ad8ef3f077",
+ "sha256:e25369dc110d58ddf29b949377a93e0716d72a24f62bad72b2b39f155949c1fd",
+ "sha256:e3c701e954abf6fc03a49f7c579cc80c2c6cc52525340ca3186c41d3f33482ef",
+ "sha256:e5bcc1a1ae744e0bb59641171ae53743760130600da8db48cbb6e4918e186e4e",
+ "sha256:e68c14b04827dd76dcbd1aeea9e604e3e4b78322d8faf2f8132c7138efa340a8",
+ "sha256:e8aeb10fcbe92767f0fa69ad5a72deca50d0dca07fbde97848997d778a50c9fe",
+ "sha256:e985a16ff513596f217cee86c21371b8cd011c0f6f056d0920aa2d926c544058",
+ "sha256:ecbbd45615a6885fe3240eb9db73b9e62518b611850fdf8ab08bd56de7ad2b17",
+ "sha256:ee4ec14bc1680d6b0afab9aea2ef27e26d2024f18b24a2d7155a52b60da7e833",
+ "sha256:ef5960d965e67165d75b7c7ffc60a83ec5abfc5c11b764ec13ea54fbef8b4421",
+ "sha256:f0cdaecd4c953bfae0b6bb64910aaaca5a424ad9c72d85cb88417bb9814f7550",
+ "sha256:f1ce721c8a7dfec21fcbdfe04e8f68174183cf4e8188e0645e92aa23985c57ff",
+ "sha256:f50498891691e0864dc3da965f340fada0771f6142a378083dc4608f4ea513e2",
+ "sha256:f5ea69428fa1b49573eef0cc44a1d43bebd45ad0c611eb7d7eac760c7ae771bc",
+ "sha256:f61aa92e4aad0be58eb6eb4e0c21acf32cf8065f4b2cae5665da756c4ceef982",
+ "sha256:f6e4333fb15c83f7d1482a76d45a0818897b3d33f00efd215528ff7c51b8e35d",
+ "sha256:f820f24b09e3e779fe84c3c456cb4108a7aa639b0d1f02c28046e11bfcd088ed",
+ "sha256:f98059e4fcd3e3e4e2d632b7cf81c2faae96c43c60b569e9c621468082f1d104",
+ "sha256:fcce033e4021347d80ed9c66dcf1e7b1546319834b74445f561d2e2221de5659"
],
"markers": "python_version >= '3.7'",
- "version": "==3.4.2"
+ "version": "==3.4.6"
},
"click": {
"hashes": [
@@ -163,11 +200,11 @@
},
"idna": {
"hashes": [
- "sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9",
- "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3"
+ "sha256:771a87f49d9defaf64091e6e6fe9c18d4833f140bd19464795bc32d966ca37ea",
+ "sha256:795dafcc9c04ed0c1fb032c2aa73654d8e8c5023a7df64a53f39190ada629902"
],
- "markers": "python_version >= '3.6'",
- "version": "==3.10"
+ "markers": "python_version >= '3.8'",
+ "version": "==3.11"
},
"importlib-metadata": {
"hashes": [
@@ -316,12 +353,12 @@
},
"mkdocs-include-markdown-plugin": {
"hashes": [
- "sha256:30da634c568ea5d5f9e5881d51f80ac30d8c5f891cec160344ad7a0fdaea6286",
- "sha256:5d94db87b06cd303619dbaebba5f7f43a3ded7fd7709451d26f08c176376ffec"
+ "sha256:f052ccb741eccf498116b826c1d78a2d761c56747372594709441cee0963fbc9",
+ "sha256:f2ec4487cf32d3e33ca528f9366f20fb9280ded9c8d1630eb2bbda244962dcd1"
],
"index": "pypi",
"markers": "python_version >= '3.9'",
- "version": "==7.2.1"
+ "version": "==7.2.2"
},
"mkdocs-markdownextradata-plugin": {
"hashes": [
@@ -373,19 +410,20 @@
},
"platformdirs": {
"hashes": [
- "sha256:9170634f126f8efdae22fb58ae8a0eaa86f38365bc57897a6c4f781d1f5875bd",
- "sha256:9a33809944b9db043ad67ca0db94b14bf452cc6aeaac46a88ea55b26e2e9d291"
+ "sha256:1ec356301b7dc906d83f371c8f487070e99d3ccf9e501686456394622a01a934",
+ "sha256:68a9a4619a666ea6439f2ff250c12a853cd1cbd5158d258bd824a7df6be2f868"
],
"markers": "python_version >= '3.10'",
- "version": "==4.9.2"
+ "version": "==4.9.4"
},
"pygments": {
"hashes": [
- "sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887",
- "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b"
+ "sha256:6757cd03768053ff99f3039c1a36d6c0aa0b263438fcab17520b30a303a82b5f",
+ "sha256:81a9e26dd42fd28a23a2d169d86d7ac03b46e2f8b59ed4698fb4785f946d0176"
],
- "markers": "python_version >= '3.8'",
- "version": "==2.19.2"
+ "index": "pypi",
+ "markers": "python_version >= '3.9'",
+ "version": "==2.20.0"
},
"pymdown-extensions": {
"hashes": [
@@ -586,12 +624,12 @@
},
"requests": {
"hashes": [
- "sha256:27babd3cda2a6d50b30443204ee89830707d396671944c998b5975b031ac2b2c",
- "sha256:27d0316682c8a29834d3264820024b62a36942083d52caf2f14c0591336d3422"
+ "sha256:3324635456fa185245e24865e810cecec7b4caf933d7eb133dcde67d48cee69b",
+ "sha256:c7ebc5e8b0f21837386ad0e1c8fe8b829fa5f544d8df3b2253bff14ef29d7652"
],
"index": "pypi",
- "markers": "python_version >= '3.8'",
- "version": "==2.32.4"
+ "markers": "python_version >= '3.10'",
+ "version": "==2.33.0"
},
"six": {
"hashes": [
@@ -606,7 +644,6 @@
"sha256:1b62b6884944a57dbe321509ab94fd4d3b307075e0c2eae991ac71ee15ad38ed",
"sha256:bf272323e553dfb2e87d9bfd225ca7b0f467b919d7bbd355436d3fd37cb0acd4"
],
- "index": "pypi",
"markers": "python_version >= '3.9'",
"version": "==2.6.3"
},
diff --git a/vendor/github.com/testcontainers/testcontainers-go/cleanup.go b/vendor/github.com/testcontainers/testcontainers-go/cleanup.go
index bd937135..2f844863 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/cleanup.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/cleanup.go
@@ -6,6 +6,8 @@ import (
"fmt"
"reflect"
"time"
+
+ "github.com/moby/moby/client"
)
// TerminateOptions is a type that holds the options for terminating a container.
@@ -48,15 +50,15 @@ func (o *TerminateOptions) Cleanup() error {
if len(o.volumes) == 0 {
return nil
}
- client, err := NewDockerClientWithOpts(o.ctx)
+ apiClient, err := NewDockerClientWithOpts(o.ctx)
if err != nil {
return fmt.Errorf("docker client: %w", err)
}
- defer client.Close()
+ defer apiClient.Close()
// Best effort to remove all volumes.
var errs []error
for _, volume := range o.volumes {
- if errRemove := client.VolumeRemove(o.ctx, volume, true); errRemove != nil {
+ if _, errRemove := apiClient.VolumeRemove(o.ctx, volume, client.VolumeRemoveOptions{Force: true}); errRemove != nil {
errs = append(errs, fmt.Errorf("volume remove %q: %w", volume, errRemove))
}
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/commons-test.mk b/vendor/github.com/testcontainers/testcontainers-go/commons-test.mk
index bb86a9fa..50f8a2e9 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/commons-test.mk
+++ b/vendor/github.com/testcontainers/testcontainers-go/commons-test.mk
@@ -14,6 +14,9 @@ $(GOBIN)/gotestsum:
$(GOBIN)/mockery:
$(call go_install,github.com/vektra/mockery/v2@v2.53.4)
+$(GOBIN)/gci:
+ $(call go_install,github.com/daixiang0/gci@v0.13.5)
+
.PHONY: install
install: $(GOBIN)/golangci-lint $(GOBIN)/gotestsum $(GOBIN)/mockery
@@ -30,9 +33,10 @@ dependencies-scan:
.PHONY: lint
lint: $(GOBIN)/golangci-lint
- golangci-lint run --verbose -c $(ROOT_DIR)/.golangci.yml --fix
+ golangci-lint run -c $(ROOT_DIR)/.golangci.yml --fix
.PHONY: generate
+generate: $(GOBIN)/gci
generate: $(GOBIN)/mockery
go generate ./...
diff --git a/vendor/github.com/testcontainers/testcontainers-go/container.go b/vendor/github.com/testcontainers/testcontainers-go/container.go
index 49c421a7..b7f0b653 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/container.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/container.go
@@ -13,13 +13,12 @@ import (
"time"
"github.com/cpuguy83/dockercfg"
- "github.com/docker/docker/api/types/build"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/network"
- "github.com/docker/docker/api/types/registry"
- "github.com/docker/go-connections/nat"
"github.com/google/uuid"
"github.com/moby/go-archive"
+ "github.com/moby/moby/api/types/container"
+ "github.com/moby/moby/api/types/network"
+ "github.com/moby/moby/api/types/registry"
+ "github.com/moby/moby/client"
"github.com/moby/patternmatcher/ignorefile"
tcexec "github.com/testcontainers/testcontainers-go/exec"
@@ -34,23 +33,23 @@ import (
type DeprecatedContainer interface {
GetHostEndpoint(ctx context.Context, port string) (string, string, error)
GetIPAddress(ctx context.Context) (string, error)
- LivenessCheckPorts(ctx context.Context) (nat.PortSet, error)
+ LivenessCheckPorts(ctx context.Context) (network.PortSet, error)
Terminate(ctx context.Context) error
}
// Container allows getting info about and controlling a single container instance
type Container interface {
- GetContainerID() string // get the container id from the provider
- Endpoint(context.Context, string) (string, error) // get proto://ip:port string for the lowest exposed port
- PortEndpoint(ctx context.Context, port nat.Port, proto string) (string, error) // get proto://ip:port string for the given exposed port
- Host(context.Context) (string, error) // get host where the container port is exposed
- Inspect(context.Context) (*container.InspectResponse, error) // get container info
- MappedPort(context.Context, nat.Port) (nat.Port, error) // get externally mapped port for a container port
- Ports(context.Context) (nat.PortMap, error) // Deprecated: Use c.Inspect(ctx).NetworkSettings.Ports instead
- SessionID() string // get session id
- IsRunning() bool // IsRunning returns true if the container is running, false otherwise.
- Start(context.Context) error // start the container
- Stop(context.Context, *time.Duration) error // stop the container
+ GetContainerID() string // get the container id from the provider
+ Endpoint(context.Context, string) (string, error) // get proto://ip:port string for the lowest exposed port
+ PortEndpoint(ctx context.Context, port string, proto string) (string, error) // get proto://ip:port string for the given exposed port
+ Host(context.Context) (string, error) // get host where the container port is exposed
+ Inspect(context.Context) (*container.InspectResponse, error) // get container info
+ MappedPort(context.Context, string) (network.Port, error) // get externally mapped port for a container port
+ Ports(context.Context) (network.PortMap, error) // Deprecated: Use c.Inspect(ctx).NetworkSettings.Ports instead
+ SessionID() string // get session id
+ IsRunning() bool // IsRunning returns true if the container is running, false otherwise.
+ Start(context.Context) error // start the container
+ Stop(context.Context, *time.Duration) error // stop the container
// Terminate stops and removes the container and its image if it was built and not flagged as kept.
Terminate(ctx context.Context, opts ...TerminateOption) error
@@ -75,15 +74,15 @@ type Container interface {
// ImageBuildInfo defines what is needed to build an image
type ImageBuildInfo interface {
- BuildOptions() (build.ImageBuildOptions, error) // converts the ImageBuildInfo to a build.ImageBuildOptions
- GetContext() (io.Reader, error) // the path to the build context
- GetDockerfile() string // the relative path to the Dockerfile, including the file itself
- GetRepo() string // get repo label for image
- GetTag() string // get tag label for image
- BuildLogWriter() io.Writer // for output of build log, use io.Discard to disable the output
- ShouldBuildImage() bool // return true if the image needs to be built
- GetBuildArgs() map[string]*string // return the environment args used to build the Dockerfile
- GetAuthConfigs() map[string]registry.AuthConfig // Deprecated. Testcontainers will detect registry credentials automatically. Return the auth configs to be able to pull from an authenticated docker registry
+ BuildOptions() (client.ImageBuildOptions, error) // converts the ImageBuildInfo to a build.ImageBuildOptions
+ GetContext() (io.Reader, error) // the path to the build context
+ GetDockerfile() string // the relative path to the Dockerfile, including the file itself
+ GetRepo() string // get repo label for image
+ GetTag() string // get tag label for image
+ BuildLogWriter() io.Writer // for output of build log, use io.Discard to disable the output
+ ShouldBuildImage() bool // return true if the image needs to be built
+ GetBuildArgs() map[string]*string // return the environment args used to build the Dockerfile
+ GetAuthConfigs() map[string]registry.AuthConfig // Deprecated. Testcontainers will detect registry credentials automatically. Return the auth configs to be able to pull from an authenticated docker registry
}
// FromDockerfile represents the parameters needed to build an image from a Dockerfile
@@ -105,7 +104,7 @@ type FromDockerfile struct {
// BuildOptionsModifier Modifier for the build options before image build. Use it for
// advanced configurations while building the image. Please consider that the modifier
// is called after the default build options are set.
- BuildOptionsModifier func(*build.ImageBuildOptions)
+ BuildOptionsModifier func(*client.ImageBuildOptions)
}
type ContainerFile struct {
@@ -435,8 +434,8 @@ func (c *ContainerRequest) BuildLogWriter() io.Writer {
// BuildOptions returns the image build options when building a Docker image from a Dockerfile.
// It will apply some defaults and finally call the BuildOptionsModifier from the FromDockerfile struct,
// if set.
-func (c *ContainerRequest) BuildOptions() (build.ImageBuildOptions, error) {
- buildOptions := build.ImageBuildOptions{
+func (c *ContainerRequest) BuildOptions() (client.ImageBuildOptions, error) {
+ buildOptions := client.ImageBuildOptions{
Remove: true,
ForceRemove: true,
}
@@ -452,7 +451,7 @@ func (c *ContainerRequest) BuildOptions() (build.ImageBuildOptions, error) {
// Make sure the auth configs from the Dockerfile are set right after the user-defined build options.
authsFromDockerfile, err := getAuthConfigsFromDockerfile(c)
if err != nil {
- return build.ImageBuildOptions{}, fmt.Errorf("auth configs from Dockerfile: %w", err)
+ return client.ImageBuildOptions{}, fmt.Errorf("auth configs from Dockerfile: %w", err)
}
if buildOptions.AuthConfigs == nil {
@@ -468,7 +467,7 @@ func (c *ContainerRequest) BuildOptions() (build.ImageBuildOptions, error) {
for _, is := range c.ImageSubstitutors {
modifiedTag, err := is.Substitute(tag)
if err != nil {
- return build.ImageBuildOptions{}, fmt.Errorf("failed to substitute image %s with %s: %w", tag, is.Description(), err)
+ return client.ImageBuildOptions{}, fmt.Errorf("failed to substitute image %s with %s: %w", tag, is.Description(), err)
}
if modifiedTag != tag {
@@ -487,10 +486,10 @@ func (c *ContainerRequest) BuildOptions() (build.ImageBuildOptions, error) {
if !c.ShouldKeepBuiltImage() {
dst := GenericLabels()
if err = core.MergeCustomLabels(dst, c.Labels); err != nil {
- return build.ImageBuildOptions{}, err
+ return client.ImageBuildOptions{}, err
}
if err = core.MergeCustomLabels(dst, buildOptions.Labels); err != nil {
- return build.ImageBuildOptions{}, err
+ return client.ImageBuildOptions{}, err
}
buildOptions.Labels = dst
}
@@ -498,7 +497,7 @@ func (c *ContainerRequest) BuildOptions() (build.ImageBuildOptions, error) {
// Do this as late as possible to ensure we don't leak the context on error/panic.
buildContext, err := c.GetContext()
if err != nil {
- return build.ImageBuildOptions{}, err
+ return client.ImageBuildOptions{}, err
}
buildOptions.Context = buildContext
diff --git a/vendor/github.com/testcontainers/testcontainers-go/docker.go b/vendor/github.com/testcontainers/testcontainers-go/docker.go
index 9cfe50fc..03633f49 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/docker.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/docker.go
@@ -4,9 +4,7 @@ import (
"archive/tar"
"bufio"
"context"
- "encoding/base64"
"encoding/binary"
- "encoding/json"
"errors"
"fmt"
"io"
@@ -17,22 +15,20 @@ import (
"path/filepath"
"regexp"
"slices"
+ "strconv"
"sync"
+ "sync/atomic"
"time"
"github.com/cenkalti/backoff/v4"
"github.com/containerd/errdefs"
"github.com/containerd/platforms"
- "github.com/docker/docker/api/types/build"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/image"
- "github.com/docker/docker/api/types/network"
- "github.com/docker/docker/client"
- "github.com/docker/docker/pkg/jsonmessage"
- "github.com/docker/docker/pkg/stdcopy"
- "github.com/docker/go-connections/nat"
- "github.com/moby/term"
+ "github.com/moby/moby/api/pkg/authconfig"
+ "github.com/moby/moby/api/pkg/stdcopy"
+ "github.com/moby/moby/api/types/container"
+ "github.com/moby/moby/api/types/network"
+ "github.com/moby/moby/client"
+ "github.com/moby/moby/client/pkg/jsonmessage"
specs "github.com/opencontainers/image-spec/specs-go/v1"
tcexec "github.com/testcontainers/testcontainers-go/exec"
@@ -74,7 +70,7 @@ type DockerContainer struct {
Image string
exposedPorts []string // a reference to the container's requested exposed ports. It allows checking they are ready before any wait strategy
- isRunning bool
+ isRunning atomic.Bool
imageWasBuilt bool
// keepBuiltImage makes Terminate not remove the image if imageWasBuilt.
keepBuiltImage bool
@@ -96,7 +92,7 @@ type DockerContainer struct {
logger log.Logger
lifecycleHooks []ContainerLifecycleHooks
- healthStatus string // container health status, will default to healthStatusNone if no healthcheck is present
+ healthStatus container.HealthStatus // container health status, will default to healthStatusNone if no healthcheck is present
}
// SetLogger sets the logger for the container
@@ -119,7 +115,7 @@ func (c *DockerContainer) GetContainerID() string {
}
func (c *DockerContainer) IsRunning() bool {
- return c.isRunning
+ return c.isRunning.Load()
}
// Endpoint gets proto://host:port string for the lowest numbered exposed port
@@ -131,20 +127,20 @@ func (c *DockerContainer) Endpoint(ctx context.Context, proto string) (string, e
}
// Get lowest numbered bound port.
- var lowestPort nat.Port
+ var lowestPort network.Port
for port := range inspect.NetworkSettings.Ports {
- if lowestPort == "" || port.Int() < lowestPort.Int() {
+ if lowestPort.IsZero() || port.Num() < lowestPort.Num() {
lowestPort = port
}
}
- return c.PortEndpoint(ctx, lowestPort, proto)
+ return c.PortEndpoint(ctx, lowestPort.String(), proto)
}
// PortEndpoint gets proto://host:port string for the given exposed port
// It returns proto://host:port or proto://[IPv6host]:port string for the given exposed port.
// It returns just host:port or [IPv6host]:port if proto is blank.
-func (c *DockerContainer) PortEndpoint(ctx context.Context, port nat.Port, proto string) (string, error) {
+func (c *DockerContainer) PortEndpoint(ctx context.Context, port string, proto string) (string, error) {
host, err := c.Host(ctx)
if err != nil {
return "", err
@@ -181,40 +177,56 @@ func (c *DockerContainer) Inspect(ctx context.Context) (*container.InspectRespon
return nil, err
}
- return jsonRaw, nil
+ return &jsonRaw.Container, nil
}
// MappedPort gets externally mapped port for a container port
-func (c *DockerContainer) MappedPort(ctx context.Context, port nat.Port) (nat.Port, error) {
+func (c *DockerContainer) MappedPort(ctx context.Context, port string) (network.Port, error) {
inspect, err := c.Inspect(ctx)
if err != nil {
- return "", fmt.Errorf("inspect: %w", err)
+ return network.Port{}, fmt.Errorf("inspect: %w", err)
+ }
+ // The old nat.Port type (a plain string) accepted empty strings:
+ // nat.SplitProtoPort("") returns ("", ""), so Port() == "" and
+ // no container port matches, yielding "not found".
+ // See https://github.com/docker/go-connections/blob/v0.6.0/nat/nat.go#L101-L110
+ // Skip parsing here to preserve that behavior and avoid a
+ // ParsePort error on empty input.
+ var nwPort network.Port
+ if port != "" {
+ nwPort, err = network.ParsePort(port)
+ if err != nil {
+ return network.Port{}, err
+ }
}
+
if inspect.HostConfig.NetworkMode == "host" {
- return port, nil
+ return nwPort, nil
}
ports := inspect.NetworkSettings.Ports
for k, p := range ports {
- if k.Port() != port.Port() {
+ if k.Num() != nwPort.Num() {
continue
}
- if port.Proto() != "" && k.Proto() != port.Proto() {
+ if nwPort.Proto() != "" && k.Proto() != nwPort.Proto() {
continue
}
if len(p) == 0 {
continue
}
- return nat.NewPort(k.Proto(), p[0].HostPort)
+ pNum, _ := strconv.ParseUint(p[0].HostPort, 10, 16)
+ hPort, _ := network.PortFrom(uint16(pNum), k.Proto())
+ return hPort, nil
}
- return "", errdefs.ErrNotFound.WithMessage(fmt.Sprintf("port %q not found", port))
+ return network.Port{}, errdefs.ErrNotFound.WithMessage(fmt.Sprintf("port %q not found", nwPort))
}
// Deprecated: use c.Inspect(ctx).NetworkSettings.Ports instead.
// Ports gets the exposed ports for the container.
-func (c *DockerContainer) Ports(ctx context.Context) (nat.PortMap, error) {
+func (c *DockerContainer) Ports(ctx context.Context) (network.PortMap, error) {
inspect, err := c.Inspect(ctx)
if err != nil {
return nil, err
@@ -234,7 +246,7 @@ func (c *DockerContainer) Start(ctx context.Context) error {
return fmt.Errorf("starting hook: %w", err)
}
- if err := c.provider.client.ContainerStart(ctx, c.ID, container.StartOptions{}); err != nil {
+ if _, err := c.provider.client.ContainerStart(ctx, c.ID, client.ContainerStartOptions{}); err != nil {
return fmt.Errorf("container start: %w", err)
}
defer c.provider.Close()
@@ -244,7 +256,7 @@ func (c *DockerContainer) Start(ctx context.Context) error {
return fmt.Errorf("started hook: %w", err)
}
- c.isRunning = true
+ c.isRunning.Store(true)
err = c.readiedHook(ctx)
if err != nil {
@@ -278,20 +290,20 @@ func (c *DockerContainer) Stop(ctx context.Context, timeout *time.Duration) erro
return fmt.Errorf("stopping hook: %w", err)
}
- var options container.StopOptions
+ var options client.ContainerStopOptions
if timeout != nil {
timeoutSeconds := int(timeout.Seconds())
options.Timeout = &timeoutSeconds
}
- if err := c.provider.client.ContainerStop(ctx, c.ID, options); err != nil {
+ if _, err := c.provider.client.ContainerStop(ctx, c.ID, options); err != nil {
return fmt.Errorf("container stop: %w", err)
}
defer c.provider.Close()
- c.isRunning = false
+ c.isRunning.Store(false)
err = c.stoppedHook(ctx)
if err != nil {
@@ -331,17 +343,17 @@ func (c *DockerContainer) Terminate(ctx context.Context, opts ...TerminateOption
// TODO: Handle errors from ContainerRemove more correctly, e.g. should we
// run the terminated hook?
- errs := []error{
- c.terminatingHook(ctx),
- c.provider.client.ContainerRemove(ctx, c.GetContainerID(), container.RemoveOptions{
- RemoveVolumes: true,
- Force: true,
- }),
- c.terminatedHook(ctx),
- }
+ var errs []error
+ errs = append(errs, c.terminatingHook(ctx))
+ _, err = c.provider.client.ContainerRemove(ctx, c.GetContainerID(), client.ContainerRemoveOptions{
+ RemoveVolumes: true,
+ Force: true,
+ })
+ errs = append(errs, err)
+ errs = append(errs, c.terminatedHook(ctx))
if c.imageWasBuilt && !c.keepBuiltImage {
- _, err := c.provider.client.ImageRemove(ctx, c.Image, image.RemoveOptions{
+ _, err := c.provider.client.ImageRemove(ctx, c.Image, client.ImageRemoveOptions{
Force: true,
PruneChildren: true,
})
@@ -349,7 +361,7 @@ func (c *DockerContainer) Terminate(ctx context.Context, opts ...TerminateOption
}
c.sessionID = ""
- c.isRunning = false
+ c.isRunning.Store(false)
if err = options.Cleanup(); err != nil {
errs = append(errs, err)
@@ -359,9 +371,9 @@ func (c *DockerContainer) Terminate(ctx context.Context, opts ...TerminateOption
}
// update container raw info
-func (c *DockerContainer) inspectRawContainer(ctx context.Context) (*container.InspectResponse, error) {
+func (c *DockerContainer) inspectRawContainer(ctx context.Context) (*client.ContainerInspectResult, error) {
defer c.provider.Close()
- inspect, err := c.provider.client.ContainerInspect(ctx, c.ID)
+ inspect, err := c.provider.client.ContainerInspect(ctx, c.ID, client.ContainerInspectOptions{})
if err != nil {
return nil, err
}
@@ -372,12 +384,10 @@ func (c *DockerContainer) inspectRawContainer(ctx context.Context) (*container.I
// Logs will fetch both STDOUT and STDERR from the current container. Returns a
// ReadCloser and leaves it up to the caller to extract what it wants.
func (c *DockerContainer) Logs(ctx context.Context) (io.ReadCloser, error) {
- options := container.LogsOptions{
+ rc, err := c.provider.client.ContainerLogs(ctx, c.ID, client.ContainerLogsOptions{
ShowStdout: true,
ShowStderr: true,
- }
-
- rc, err := c.provider.client.ContainerLogs(ctx, c.ID, options)
+ })
if err != nil {
return nil, err
}
@@ -469,7 +479,7 @@ func (c *DockerContainer) State(ctx context.Context) (*container.State, error) {
if err != nil {
return nil, err
}
- return inspect.State, nil
+ return inspect.Container.State, nil
}
// Networks gets the names of the networks the container is attached to.
@@ -497,14 +507,13 @@ func (c *DockerContainer) ContainerIP(ctx context.Context) (string, error) {
return "", err
}
- //nolint:staticcheck // SA1019: IPAddress is deprecated, but we need it for compatibility until v29
- ip := inspect.NetworkSettings.IPAddress
- if ip == "" {
- // use IP from "Networks" if only single network defined
- networks := inspect.NetworkSettings.Networks
- if len(networks) == 1 {
- for _, v := range networks {
- ip = v.IPAddress
+ var ip string
+ // IPAddress is deprecated; use IP from "Networks" if only single network defined
+ networks := inspect.NetworkSettings.Networks
+ if len(networks) == 1 {
+ for _, v := range networks {
+ if v.IPAddress.IsValid() {
+ ip = v.IPAddress.String()
}
}
}
@@ -522,7 +531,9 @@ func (c *DockerContainer) ContainerIPs(ctx context.Context) ([]string, error) {
networks := inspect.NetworkSettings.Networks
ips := make([]string, 0, len(networks))
for _, nw := range networks {
- ips = append(ips, nw.IPAddress)
+ if nw.IPAddress.IsValid() {
+ ips = append(ips, nw.IPAddress.String())
+ }
}
return ips, nil
@@ -564,12 +575,12 @@ func (c *DockerContainer) Exec(ctx context.Context, cmd []string, options ...tce
o.Apply(processOptions)
}
- response, err := cli.ContainerExecCreate(ctx, c.ID, processOptions.ExecConfig)
+ response, err := cli.ExecCreate(ctx, c.ID, processOptions.ExecConfig)
if err != nil {
return 0, nil, fmt.Errorf("container exec create: %w", err)
}
- hijack, err := cli.ContainerExecAttach(ctx, response.ID, container.ExecAttachOptions{})
+ hijack, err := cli.ExecAttach(ctx, response.ID, client.ExecAttachOptions{})
if err != nil {
return 0, nil, fmt.Errorf("container exec attach: %w", err)
}
@@ -584,7 +595,7 @@ func (c *DockerContainer) Exec(ctx context.Context, cmd []string, options ...tce
var exitCode int
for {
- execResp, err := cli.ContainerExecInspect(ctx, response.ID)
+ execResp, err := cli.ExecInspect(ctx, response.ID, client.ExecInspectOptions{})
if err != nil {
return 0, nil, fmt.Errorf("container exec inspect: %w", err)
}
@@ -614,13 +625,15 @@ func (fc *FileFromContainer) Close() error {
}
func (c *DockerContainer) CopyFileFromContainer(ctx context.Context, filePath string) (io.ReadCloser, error) {
- r, _, err := c.provider.client.CopyFromContainer(ctx, c.ID, filePath)
+ r, err := c.provider.client.CopyFromContainer(ctx, c.ID, client.CopyFromContainerOptions{
+ SourcePath: filePath,
+ })
if err != nil {
return nil, err
}
defer c.provider.Close()
- tarReader := tar.NewReader(r)
+ tarReader := tar.NewReader(r.Content)
// if we got here we have exactly one file in the TAR-stream
// so we advance the index by one so the next call to Read will start reading it
@@ -630,7 +643,7 @@ func (c *DockerContainer) CopyFileFromContainer(ctx context.Context, filePath st
}
ret := &FileFromContainer{
- underlying: &r,
+ underlying: &r.Content,
tarreader: tarReader,
}
@@ -658,7 +671,10 @@ func (c *DockerContainer) CopyDirToContainer(ctx context.Context, hostDirPath st
// create the directory under its parent
parent := filepath.Dir(containerParentPath)
- err = c.provider.client.CopyToContainer(ctx, c.ID, parent, buff, container.CopyToContainerOptions{})
+ _, err = c.provider.client.CopyToContainer(ctx, c.ID, client.CopyToContainerOptions{
+ DestinationPath: parent,
+ Content: buff,
+ })
if err != nil {
return err
}
@@ -716,7 +732,10 @@ func (c *DockerContainer) copyToContainer(ctx context.Context, fileContent func(
return err
}
- err = c.provider.client.CopyToContainer(ctx, c.ID, "/", buffer, container.CopyToContainerOptions{})
+ _, err = c.provider.client.CopyToContainer(ctx, c.ID, client.CopyToContainerOptions{
+ DestinationPath: "/",
+ Content: buffer,
+ })
if err != nil {
return err
}
@@ -817,7 +836,7 @@ func (c *DockerContainer) logProducer(stdout, stderr io.Writer) {
defer c.provider.Close()
// Setup the log options, start from the beginning.
- options := &container.LogsOptions{
+ options := &client.ContainerLogsOptions{
ShowStdout: true,
ShowStderr: true,
Follow: true,
@@ -831,7 +850,7 @@ func (c *DockerContainer) logProducer(stdout, stderr io.Writer) {
// copyLogsTimeout copies logs from the container to stdout and stderr with a timeout.
// It returns true if the log production should be retried, false otherwise.
-func (c *DockerContainer) copyLogsTimeout(stdout, stderr io.Writer, options *container.LogsOptions) bool {
+func (c *DockerContainer) copyLogsTimeout(stdout, stderr io.Writer, options *client.ContainerLogsOptions) bool {
timeoutCtx, cancel := context.WithTimeout(c.logProductionCtx, *c.logProductionTimeout)
defer cancel()
@@ -858,7 +877,7 @@ func (c *DockerContainer) copyLogsTimeout(stdout, stderr io.Writer, options *con
}
// copyLogs copies logs from the container to stdout and stderr.
-func (c *DockerContainer) copyLogs(ctx context.Context, stdout, stderr io.Writer, options container.LogsOptions) error {
+func (c *DockerContainer) copyLogs(ctx context.Context, stdout, stderr io.Writer, options client.ContainerLogsOptions) error {
rc, err := c.provider.client.ContainerLogs(ctx, c.GetContainerID(), options)
if err != nil {
return fmt.Errorf("container logs: %w", err)
@@ -966,7 +985,8 @@ func (n *DockerNetwork) Remove(ctx context.Context) error {
defer n.provider.Close()
- return n.provider.client.NetworkRemove(ctx, n.ID)
+ _, err := n.provider.client.NetworkRemove(ctx, n.ID, client.NetworkRemoveOptions{})
+ return err
}
func (n *DockerNetwork) SetTerminationSignal(signal chan bool) {
@@ -1006,22 +1026,22 @@ var _ ContainerProvider = (*DockerProvider)(nil)
// BuildImage will build and image from context and Dockerfile, then return the tag
func (p *DockerProvider) BuildImage(ctx context.Context, img ImageBuildInfo) (string, error) {
- var buildOptions build.ImageBuildOptions
+ var buildOptions client.ImageBuildOptions
resp, err := backoff.RetryNotifyWithData(
- func() (build.ImageBuildResponse, error) {
+ func() (client.ImageBuildResult, error) {
var err error
buildOptions, err = img.BuildOptions()
if err != nil {
- return build.ImageBuildResponse{}, backoff.Permanent(fmt.Errorf("build options: %w", err))
+ return client.ImageBuildResult{}, backoff.Permanent(fmt.Errorf("build options: %w", err))
}
defer tryClose(buildOptions.Context) // release resources in any case
resp, err := p.client.ImageBuild(ctx, buildOptions.Context, buildOptions)
if err != nil {
if isPermanentClientError(err) {
- return build.ImageBuildResponse{}, backoff.Permanent(fmt.Errorf("build image: %w", err))
+ return client.ImageBuildResult{}, backoff.Permanent(fmt.Errorf("build image: %w", err))
}
- return build.ImageBuildResponse{}, err
+ return client.ImageBuildResult{}, err
}
defer p.Close()
@@ -1037,13 +1057,10 @@ func (p *DockerProvider) BuildImage(ctx context.Context, img ImageBuildInfo) (st
}
defer resp.Body.Close()
- output := img.BuildLogWriter()
-
// Always process the output, even if it is not printed
// to ensure that errors during the build process are
// correctly handled.
- termFd, isTerm := term.GetFdInfo(output)
- if err = jsonmessage.DisplayJSONMessagesStream(resp.Body, output, termFd, isTerm, nil); err != nil {
+ if err = jsonmessage.DisplayStream(resp.Body, img.BuildLogWriter()); err != nil {
return "", fmt.Errorf("build image: %w", err)
}
@@ -1155,8 +1172,11 @@ func (p *DockerProvider) CreateContainer(ctx context.Context, req ContainerReque
}
if shouldPullImage {
- pullOpt := image.PullOptions{
- Platform: req.ImagePlatform, // may be empty
+ pullOpt := client.ImagePullOptions{}
+ if req.ImagePlatform != "" {
+ if pf, err := platforms.Parse(req.ImagePlatform); err == nil {
+ pullOpt.Platforms = append(pullOpt.Platforms, pf)
+ }
}
if err := p.attemptToPullImage(ctx, imageName, pullOpt); err != nil {
return nil, err
@@ -1228,7 +1248,13 @@ func (p *DockerProvider) CreateContainer(ctx context.Context, req ContainerReque
return nil, err
}
- resp, err := p.client.ContainerCreate(ctx, dockerInput, hostConfig, networkingConfig, platform, req.Name)
+ resp, err := p.client.ContainerCreate(ctx, client.ContainerCreateOptions{
+ Config: dockerInput,
+ HostConfig: hostConfig,
+ NetworkingConfig: networkingConfig,
+ Platform: platform,
+ Name: req.Name,
+ })
if err != nil {
return nil, fmt.Errorf("container create: %w", err)
}
@@ -1243,7 +1269,10 @@ func (p *DockerProvider) CreateContainer(ctx context.Context, req ContainerReque
endpointSetting := network.EndpointSettings{
Aliases: req.NetworkAliases[n],
}
- err = p.client.NetworkConnect(ctx, nw.ID, resp.ID, &endpointSetting)
+ _, err = p.client.NetworkConnect(ctx, nw.ID, client.NetworkConnectOptions{
+ Container: resp.ID,
+ EndpointConfig: &endpointSetting,
+ })
if err != nil {
return nil, fmt.Errorf("network connect: %w", err)
}
@@ -1288,15 +1317,17 @@ func (p *DockerProvider) findContainerByName(ctx context.Context, name string) (
}
// Note that, 'name' filter will use regex to find the containers
- filter := filters.NewArgs(filters.Arg("name", fmt.Sprintf("^%s$", name)))
- containers, err := p.client.ContainerList(ctx, container.ListOptions{All: true, Filters: filter})
+ containers, err := p.client.ContainerList(ctx, client.ContainerListOptions{
+ All: true,
+ Filters: make(client.Filters).Add("name", fmt.Sprintf("^%s$", name)),
+ })
if err != nil {
return nil, fmt.Errorf("container list: %w", err)
}
defer p.Close()
- if len(containers) > 0 {
- return &containers[0], nil
+ if len(containers.Items) > 0 {
+ return &containers.Items[0], nil
}
return nil, nil
}
@@ -1400,10 +1431,10 @@ func (p *DockerProvider) ReuseOrCreateContainer(ctx context.Context, req Contain
// a paused container. The Docker Engine returns the "cannot start a paused container,
// try unpause instead" error.
switch dcState.Status {
- case "running":
+ case container.StateRunning:
// cannot re-start a running container, but we still need
// to call the startup hooks.
- case "paused":
+ case container.StatePaused:
// TODO: we should unpause the container here.
return nil, fmt.Errorf("cannot start a paused container: %w", errors.ErrUnsupported)
default:
@@ -1417,7 +1448,7 @@ func (p *DockerProvider) ReuseOrCreateContainer(ctx context.Context, req Contain
return nil, err
}
- dc.isRunning = true
+ dc.isRunning.Store(true)
err = dc.readiedHook(ctx)
if err != nil {
@@ -1429,17 +1460,16 @@ func (p *DockerProvider) ReuseOrCreateContainer(ctx context.Context, req Contain
// attemptToPullImage tries to pull the image while respecting the ctx cancellations.
// Besides, if the image cannot be pulled due to ErrorNotFound then no need to retry but terminate immediately.
-func (p *DockerProvider) attemptToPullImage(ctx context.Context, tag string, pullOpt image.PullOptions) error {
+func (p *DockerProvider) attemptToPullImage(ctx context.Context, tag string, pullOpt client.ImagePullOptions) error {
registry, imageAuth, err := DockerImageAuth(ctx, tag)
if err != nil {
p.Logger.Printf("No image auth found for %s. Setting empty credentials for the image: %s. This is expected for public images. Details: %s", registry, tag, err)
} else {
// see https://github.com/docker/docs/blob/e8e1204f914767128814dca0ea008644709c117f/engine/api/sdk/examples.md?plain=1#L649-L657
- encodedJSON, err := json.Marshal(imageAuth)
- if err != nil {
+ if encodedAuth, err := authconfig.Encode(imageAuth); err != nil {
p.Logger.Printf("Failed to marshal image auth. Setting empty credentials for the image: %s. Error is: %s", tag, err)
} else {
- pullOpt.RegistryAuth = base64.URLEncoding.EncodeToString(encodedJSON)
+ pullOpt.RegistryAuth = encodedAuth
}
}
@@ -1475,7 +1505,7 @@ func (p *DockerProvider) attemptToPullImage(ctx context.Context, tag string, pul
// Health measure the healthiness of the provider. Right now we leverage the
// docker-client Info endpoint to see if the daemon is reachable.
func (p *DockerProvider) Health(ctx context.Context) error {
- _, err := p.client.Info(ctx)
+ _, err := p.client.Info(ctx, client.InfoOptions{})
defer p.Close()
return err
@@ -1577,7 +1607,7 @@ func (p *DockerProvider) CreateNetwork(ctx context.Context, req NetworkRequest)
req.Labels = make(map[string]string)
}
- nc := network.CreateOptions{
+ nc := client.NetworkCreateOptions{
Driver: req.Driver,
Internal: req.Internal,
EnableIPv6: req.EnableIPv6,
@@ -1629,14 +1659,14 @@ func (p *DockerProvider) CreateNetwork(ctx context.Context, req NetworkRequest)
// GetNetwork returns the object representing the network identified by its name
func (p *DockerProvider) GetNetwork(ctx context.Context, req NetworkRequest) (network.Inspect, error) {
- networkResource, err := p.client.NetworkInspect(ctx, req.Name, network.InspectOptions{
+ networkResource, err := p.client.NetworkInspect(ctx, req.Name, client.NetworkInspectOptions{
Verbose: true,
})
if err != nil {
return network.Inspect{}, err
}
- return networkResource, err
+ return networkResource.Network, err
}
func (p *DockerProvider) GetGatewayIP(ctx context.Context) (string, error) {
@@ -1656,8 +1686,8 @@ func (p *DockerProvider) getGatewayIP(ctx context.Context, defaultNetwork string
var ip string
for _, cfg := range nw.IPAM.Config {
- if cfg.Gateway != "" {
- ip = cfg.Gateway
+ if cfg.Gateway.IsValid() {
+ ip = cfg.Gateway.String()
break
}
}
@@ -1683,7 +1713,7 @@ func (p *DockerProvider) ensureDefaultNetworkLocked(ctx context.Context) (string
return p.defaultNetwork, nil
}
- networkResources, err := p.client.NetworkList(ctx, network.ListOptions{})
+ networkResources, err := p.client.NetworkList(ctx, client.NetworkListOptions{})
if err != nil {
return "", fmt.Errorf("network list: %w", err)
}
@@ -1691,8 +1721,8 @@ func (p *DockerProvider) ensureDefaultNetworkLocked(ctx context.Context) (string
// TODO: remove once we have docker context support via #2810
// Prefer the default bridge network if it exists.
// This makes the results stable as network list order is not guaranteed.
- for _, net := range networkResources {
- switch net.Name {
+ for _, nw := range networkResources.Items {
+ switch nw.Name {
case p.defaultBridgeNetworkName:
p.defaultNetwork = p.defaultBridgeNetworkName
return p.defaultNetwork, nil
@@ -1706,7 +1736,7 @@ func (p *DockerProvider) ensureDefaultNetworkLocked(ctx context.Context) (string
}
// Create a bridge network for the container communications.
- _, err = p.client.NetworkCreate(ctx, ReaperDefault, network.CreateOptions{
+ _, err = p.client.NetworkCreate(ctx, ReaperDefault, client.NetworkCreateOptions{
Driver: Bridge,
Attachable: true,
Labels: GenericLabels(),
@@ -1736,7 +1766,6 @@ func (p *DockerProvider) ContainerFromType(ctx context.Context, response contain
Image: response.Image,
imageWasBuilt: false,
sessionID: response.Labels[core.LabelSessionID],
- isRunning: response.State == "running",
exposedPorts: exposedPorts,
provider: p,
logger: p.Logger,
@@ -1744,6 +1773,7 @@ func (p *DockerProvider) ContainerFromType(ctx context.Context, response contain
DefaultLoggingHook(p.Logger),
},
}
+ ctr.isRunning.Store(response.State == "running")
if err = ctr.connectReaper(ctx); err != nil {
return nil, err
@@ -1755,14 +1785,14 @@ func (p *DockerProvider) ContainerFromType(ctx context.Context, response contain
}(ctr)
// populate the raw representation of the container
- jsonRaw, err := ctr.inspectRawContainer(ctx)
+ resp, err := ctr.inspectRawContainer(ctx)
if err != nil {
// Return the container to allow caller to clean up.
return ctr, fmt.Errorf("inspect raw container: %w", err)
}
// the health status of the container, if any
- if health := jsonRaw.State.Health; health != nil {
+ if health := resp.Container.State.Health; health != nil {
ctr.healthStatus = health.Status
}
@@ -1774,12 +1804,12 @@ func (p *DockerProvider) ContainerFromType(ctx context.Context, response contain
func (p *DockerProvider) ListImages(ctx context.Context) ([]ImageInfo, error) {
images := []ImageInfo{}
- imageList, err := p.client.ImageList(ctx, image.ListOptions{})
+ imageList, err := p.client.ImageList(ctx, client.ImageListOptions{})
if err != nil {
return images, fmt.Errorf("listing images %w", err)
}
- for _, img := range imageList {
+ for _, img := range imageList.Items {
for _, tag := range img.RepoTags {
images = append(images, ImageInfo{ID: img.ID, Name: tag})
}
@@ -1838,7 +1868,7 @@ func SaveDockerImageWithPlatforms(platforms ...specs.Platform) SaveImageOption {
// PullImage pulls image from registry
func (p *DockerProvider) PullImage(ctx context.Context, img string) error {
- return p.attemptToPullImage(ctx, img, image.PullOptions{})
+ return p.attemptToPullImage(ctx, img, client.ImagePullOptions{})
}
var permanentClientErrors = []func(error) bool{
diff --git a/vendor/github.com/testcontainers/testcontainers-go/docker_auth.go b/vendor/github.com/testcontainers/testcontainers-go/docker_auth.go
index 6472a973..eaa313f9 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/docker_auth.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/docker_auth.go
@@ -14,7 +14,8 @@ import (
"sync"
"github.com/cpuguy83/dockercfg"
- "github.com/docker/docker/api/types/registry"
+ "github.com/moby/moby/api/types/registry"
+ "github.com/moby/moby/client"
"github.com/testcontainers/testcontainers-go/internal/core"
)
@@ -87,18 +88,18 @@ func getRegistryAuth(reg string, cfgs map[string]registry.AuthConfig) (registry.
// It will use the docker daemon to get the default registry, returning "https://index.docker.io/v1/" if
// it fails to get the information from the daemon
func defaultRegistry(ctx context.Context) string {
- client, err := NewDockerClientWithOpts(ctx)
+ apiClient, err := NewDockerClientWithOpts(ctx)
if err != nil {
return core.IndexDockerIO
}
- defer client.Close()
+ defer apiClient.Close()
- info, err := client.Info(ctx)
+ info, err := apiClient.Info(ctx, client.InfoOptions{})
if err != nil {
return core.IndexDockerIO
}
- return info.IndexServerAddress
+ return info.Info.IndexServerAddress
}
// authConfigResult is a result looking up auth details for key.
@@ -205,7 +206,6 @@ func getDockerAuthConfigs() (map[string]registry.AuthConfig, error) {
ac := registry.AuthConfig{
Auth: v.Auth,
- Email: v.Email,
IdentityToken: v.IdentityToken,
Password: v.Password,
RegistryToken: v.RegistryToken,
diff --git a/vendor/github.com/testcontainers/testcontainers-go/docker_client.go b/vendor/github.com/testcontainers/testcontainers-go/docker_client.go
index ea652240..ae4ff511 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/docker_client.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/docker_client.go
@@ -6,11 +6,7 @@ import (
"strings"
"sync"
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/events"
- "github.com/docker/docker/api/types/registry"
- "github.com/docker/docker/api/types/system"
- "github.com/docker/docker/client"
+ "github.com/moby/moby/client"
"github.com/testcontainers/testcontainers-go/internal"
"github.com/testcontainers/testcontainers-go/internal/core"
@@ -25,7 +21,7 @@ type DockerClient struct {
var (
// dockerInfo stores the docker info to be reused in the Info method
- dockerInfo system.Info
+ dockerInfo client.SystemInfoResult
dockerInfoSet bool
dockerInfoLock sync.Mutex
)
@@ -34,25 +30,25 @@ var (
var _ client.SystemAPIClient = &DockerClient{}
// Events returns a channel to listen to events that happen to the docker daemon.
-func (c *DockerClient) Events(ctx context.Context, options events.ListOptions) (<-chan events.Message, <-chan error) {
+func (c *DockerClient) Events(ctx context.Context, options client.EventsListOptions) client.EventsResult {
return c.Client.Events(ctx, options)
}
// Info returns information about the docker server. The result of Info is cached
// and reused every time Info is called.
// It will also print out the docker server info, and the resolved Docker paths, to the default logger.
-func (c *DockerClient) Info(ctx context.Context) (system.Info, error) {
+func (c *DockerClient) Info(ctx context.Context, options client.InfoOptions) (client.SystemInfoResult, error) {
dockerInfoLock.Lock()
defer dockerInfoLock.Unlock()
if dockerInfoSet {
return dockerInfo, nil
}
- info, err := c.Client.Info(ctx)
+ res, err := c.Client.Info(ctx, options)
if err != nil {
- return info, fmt.Errorf("failed to retrieve docker info: %w", err)
+ return res, fmt.Errorf("failed to retrieve docker info: %w", err)
}
- dockerInfo = info
+ dockerInfo = res
dockerInfoSet = true
infoMessage := `%v - Connected to docker:
@@ -67,23 +63,27 @@ func (c *DockerClient) Info(ctx context.Context) (system.Info, error) {
Test ProcessID: %s
`
infoLabels := ""
- if len(dockerInfo.Labels) > 0 {
+ if len(dockerInfo.Info.Labels) > 0 {
infoLabels = `
Labels:`
var infoLabelsSb72 strings.Builder
- for _, lb := range dockerInfo.Labels {
+ for _, lb := range dockerInfo.Info.Labels {
infoLabelsSb72.WriteString("\n " + lb)
}
infoLabels += infoLabelsSb72.String()
}
+ host, err := core.ExtractDockerHost(ctx)
+ if err != nil {
+ return dockerInfo, err
+ }
log.Printf(infoMessage, packagePath,
- dockerInfo.ServerVersion,
+ dockerInfo.Info.ServerVersion,
c.ClientVersion(),
- dockerInfo.OperatingSystem, dockerInfo.MemTotal/1024/1024,
+ dockerInfo.Info.OperatingSystem, dockerInfo.Info.MemTotal/1024/1024,
infoLabels,
internal.Version,
- core.MustExtractDockerHost(ctx),
+ host,
core.MustExtractDockerSocket(ctx),
core.SessionID(),
core.ProcessID(),
@@ -93,18 +93,18 @@ func (c *DockerClient) Info(ctx context.Context) (system.Info, error) {
}
// RegistryLogin logs into a Docker registry.
-func (c *DockerClient) RegistryLogin(ctx context.Context, auth registry.AuthConfig) (registry.AuthenticateOKBody, error) {
- return c.Client.RegistryLogin(ctx, auth)
+func (c *DockerClient) RegistryLogin(ctx context.Context, options client.RegistryLoginOptions) (client.RegistryLoginResult, error) {
+ return c.Client.RegistryLogin(ctx, options)
}
// DiskUsage returns the disk usage of all images.
-func (c *DockerClient) DiskUsage(ctx context.Context, options types.DiskUsageOptions) (types.DiskUsage, error) {
+func (c *DockerClient) DiskUsage(ctx context.Context, options client.DiskUsageOptions) (client.DiskUsageResult, error) {
return c.Client.DiskUsage(ctx, options)
}
// Ping pings the docker server.
-func (c *DockerClient) Ping(ctx context.Context) (types.Ping, error) {
- return c.Client.Ping(ctx)
+func (c *DockerClient) Ping(ctx context.Context, options client.PingOptions) (client.PingResult, error) {
+ return c.Client.Ping(ctx, options)
}
// Deprecated: Use NewDockerClientWithOpts instead.
@@ -127,18 +127,18 @@ func NewDockerClientWithOpts(ctx context.Context, opt ...client.Opt) (*DockerCli
Client: dockerClient,
}
- if _, err = tcClient.Info(ctx); err != nil {
+ if _, err = tcClient.Info(ctx, client.InfoOptions{}); err != nil {
// Fallback to environment, including the original options
if len(opt) == 0 {
- opt = []client.Opt{client.FromEnv, client.WithAPIVersionNegotiation()}
+ opt = []client.Opt{client.FromEnv}
}
- dockerClient, err := client.NewClientWithOpts(opt...)
+ apiClient, err := client.New(opt...)
if err != nil {
return nil, err
}
- tcClient.Client = dockerClient
+ tcClient.Client = apiClient
}
defer tcClient.Close()
diff --git a/vendor/github.com/testcontainers/testcontainers-go/docker_mounts.go b/vendor/github.com/testcontainers/testcontainers-go/docker_mounts.go
index 9609d92c..5d654b9a 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/docker_mounts.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/docker_mounts.go
@@ -4,7 +4,7 @@ import (
"errors"
"path/filepath"
- "github.com/docker/docker/api/types/mount"
+ "github.com/moby/moby/api/types/mount"
"github.com/testcontainers/testcontainers-go/log"
)
diff --git a/vendor/github.com/testcontainers/testcontainers-go/exec/processor.go b/vendor/github.com/testcontainers/testcontainers-go/exec/processor.go
index 36f1db1c..072c7512 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/exec/processor.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/exec/processor.go
@@ -6,13 +6,13 @@ import (
"io"
"sync"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/pkg/stdcopy"
+ "github.com/moby/moby/api/pkg/stdcopy"
+ "github.com/moby/moby/client"
)
// ProcessOptions defines options applicable to the reader processor
type ProcessOptions struct {
- ExecConfig container.ExecOptions
+ ExecConfig client.ExecCreateOptions
Reader io.Reader
}
@@ -23,7 +23,7 @@ type ProcessOptions struct {
// - attach stderr: true
func NewProcessOptions(cmd []string) *ProcessOptions {
return &ProcessOptions{
- ExecConfig: container.ExecOptions{
+ ExecConfig: client.ExecCreateOptions{
Cmd: cmd,
AttachStdout: true,
AttachStderr: true,
diff --git a/vendor/github.com/testcontainers/testcontainers-go/generate.go b/vendor/github.com/testcontainers/testcontainers-go/generate.go
index 19ae4969..c1c5c5fd 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/generate.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/generate.go
@@ -1,3 +1,4 @@
package testcontainers
//go:generate mockery
+//go:generate gci write -s standard -s default -s prefix(github.com/testcontainers) .
diff --git a/vendor/github.com/testcontainers/testcontainers-go/image.go b/vendor/github.com/testcontainers/testcontainers-go/image.go
index 11154d86..38557e77 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/image.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/image.go
@@ -3,7 +3,7 @@ package testcontainers
import (
"context"
- "github.com/docker/docker/client"
+ "github.com/moby/moby/client"
)
// ImageInfo represents summary information of an image
diff --git a/vendor/github.com/testcontainers/testcontainers-go/internal/core/client.go b/vendor/github.com/testcontainers/testcontainers-go/internal/core/client.go
index 04a54bcb..795e6640 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/internal/core/client.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/internal/core/client.go
@@ -4,7 +4,7 @@ import (
"context"
"path/filepath"
- "github.com/docker/docker/client"
+ "github.com/moby/moby/client"
"github.com/testcontainers/testcontainers-go/internal"
"github.com/testcontainers/testcontainers-go/internal/config"
@@ -12,11 +12,14 @@ import (
// NewClient returns a new docker client extracting the docker host from the different alternatives
func NewClient(ctx context.Context, ops ...client.Opt) (*client.Client, error) {
- tcConfig := config.Read()
+ dockerHost, err := ExtractDockerHost(ctx)
+ if err != nil {
+ return nil, err
+ }
- dockerHost := MustExtractDockerHost(ctx)
+ tcConfig := config.Read()
- opts := []client.Opt{client.FromEnv, client.WithAPIVersionNegotiation()}
+ opts := []client.Opt{client.FromEnv}
if dockerHost != "" {
opts = append(opts, client.WithHost(dockerHost))
@@ -41,7 +44,7 @@ func NewClient(ctx context.Context, ops ...client.Opt) (*client.Client, error) {
// passed options have priority over the default ones
opts = append(opts, ops...)
- cli, err := client.NewClientWithOpts(opts...)
+ cli, err := client.New(opts...)
if err != nil {
return nil, err
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/internal/core/docker_host.go b/vendor/github.com/testcontainers/testcontainers-go/internal/core/docker_host.go
index 73ff0a97..fbb2e2b0 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/internal/core/docker_host.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/internal/core/docker_host.go
@@ -9,7 +9,7 @@ import (
"strings"
"sync"
- "github.com/docker/docker/client"
+ "github.com/moby/moby/client"
"github.com/testcontainers/testcontainers-go/internal/config"
)
@@ -31,8 +31,9 @@ var (
)
var (
- dockerHostCache string
- dockerHostOnce sync.Once
+ dockerHostCache string
+ dockerHostErrCache error
+ dockerHostOnce sync.Once
)
var (
@@ -59,13 +60,13 @@ func DefaultGatewayIP() (string, error) {
// dockerHostCheck Use a vanilla Docker client to check if the Docker host is reachable.
// It will avoid recursive calls to this function.
var dockerHostCheck = func(ctx context.Context, host string) error {
- cli, err := client.NewClientWithOpts(client.FromEnv, client.WithHost(host), client.WithAPIVersionNegotiation())
+ cli, err := client.New(client.FromEnv, client.WithHost(host))
if err != nil {
return fmt.Errorf("new client: %w", err)
}
defer cli.Close()
- _, err = cli.Info(ctx)
+ _, err = cli.Info(ctx, client.InfoOptions{})
if err != nil {
return fmt.Errorf("docker info: %w", err)
}
@@ -85,16 +86,18 @@ var dockerHostCheck = func(ctx context.Context, host string) error {
// 6. Rootless docker socket path.
// 7. Else, because the Docker host is not set, it panics.
func MustExtractDockerHost(ctx context.Context) string {
- dockerHostOnce.Do(func() {
- cache, err := extractDockerHost(ctx)
- if err != nil {
- panic(err)
- }
+ host, err := ExtractDockerHost(ctx)
+ if err != nil {
+ panic(err)
+ }
+ return host
+}
- dockerHostCache = cache
+func ExtractDockerHost(ctx context.Context) (string, error) {
+ dockerHostOnce.Do(func() {
+ dockerHostCache, dockerHostErrCache = extractDockerHost(ctx)
})
-
- return dockerHostCache
+ return dockerHostCache, dockerHostErrCache
}
// MustExtractDockerSocket Extracts the docker socket from the different alternatives, removing the socket schema and
@@ -198,13 +201,13 @@ func extractDockerSocketFromClient(ctx context.Context, cli client.APIClient) st
return checkDockerSocketFn(testcontainersDockerSocket)
}
- info, err := cli.Info(ctx)
+ info, err := cli.Info(ctx, client.InfoOptions{})
if err != nil {
panic(err) // Docker Info is required to get the Operating System
}
// Because Docker Desktop runs in a VM, we need to use the default docker path for rootless docker
- if info.OperatingSystem == "Docker Desktop" {
+ if info.Info.OperatingSystem == "Docker Desktop" {
if IsWindows() {
return WindowsDockerSocketPath
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/internal/core/docker_socket.go b/vendor/github.com/testcontainers/testcontainers-go/internal/core/docker_socket.go
index b0c0c848..d3492901 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/internal/core/docker_socket.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/internal/core/docker_socket.go
@@ -4,7 +4,7 @@ import (
"net/url"
"strings"
- "github.com/docker/docker/client"
+ "github.com/moby/moby/client"
)
// DockerSocketSchema is the unix schema.
diff --git a/vendor/github.com/testcontainers/testcontainers-go/internal/core/labels.go b/vendor/github.com/testcontainers/testcontainers-go/internal/core/labels.go
index 198fdae7..fdfee742 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/internal/core/labels.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/internal/core/labels.go
@@ -62,11 +62,11 @@ func MergeCustomLabels(dst, src map[string]string) error {
if dst == nil {
return errors.New("destination map is nil")
}
- for key, value := range src {
+ for key := range src {
if strings.HasPrefix(key, LabelBase) {
return fmt.Errorf("key %q has %q prefix", key, LabelBase)
}
- dst[key] = value
}
+ maps.Copy(dst, src)
return nil
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/internal/core/network/network.go b/vendor/github.com/testcontainers/testcontainers-go/internal/core/network/network.go
index 787065ae..55081b3f 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/internal/core/network/network.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/internal/core/network/network.go
@@ -4,8 +4,8 @@ import (
"context"
"fmt"
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/network"
+ "github.com/moby/moby/api/types/network"
+ "github.com/moby/moby/client"
"github.com/testcontainers/testcontainers-go/internal/core"
)
@@ -19,17 +19,17 @@ const (
)
// Get returns a network by its ID.
-func Get(ctx context.Context, id string) (network.Inspect, error) {
+func Get(ctx context.Context, id string) (network.Summary, error) {
return get(ctx, FilterByID, id)
}
// GetByName returns a network by its name.
-func GetByName(ctx context.Context, name string) (network.Inspect, error) {
+func GetByName(ctx context.Context, name string) (network.Summary, error) {
return get(ctx, FilterByName, name)
}
-func get(ctx context.Context, filter string, value string) (network.Inspect, error) {
- var nw network.Inspect // initialize to the zero value
+func get(ctx context.Context, filter string, value string) (network.Summary, error) {
+ var nw network.Summary // initialize to the zero value
cli, err := core.NewClient(ctx)
if err != nil {
@@ -37,16 +37,16 @@ func get(ctx context.Context, filter string, value string) (network.Inspect, err
}
defer cli.Close()
- list, err := cli.NetworkList(ctx, network.ListOptions{
- Filters: filters.NewArgs(filters.Arg(filter, value)),
+ list, err := cli.NetworkList(ctx, client.NetworkListOptions{
+ Filters: make(client.Filters).Add(filter, value),
})
if err != nil {
return nw, fmt.Errorf("failed to list networks: %w", err)
}
- if len(list) == 0 {
+ if len(list.Items) == 0 {
return nw, fmt.Errorf("network %s not found (filtering by %s)", value, filter)
}
- return list[0], nil
+ return list.Items[0], nil
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/internal/version.go b/vendor/github.com/testcontainers/testcontainers-go/internal/version.go
index 295c1a6a..ebe1f043 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/internal/version.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/internal/version.go
@@ -1,4 +1,4 @@
package internal
// Version is the next development version of the application
-const Version = "0.41.0"
+const Version = "0.42.0"
diff --git a/vendor/github.com/testcontainers/testcontainers-go/lifecycle.go b/vendor/github.com/testcontainers/testcontainers-go/lifecycle.go
index 7aedd54f..90516df7 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/lifecycle.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/lifecycle.go
@@ -9,9 +9,8 @@ import (
"strings"
"time"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/network"
- "github.com/docker/go-connections/nat"
+ "github.com/moby/moby/api/types/container"
+ "github.com/moby/moby/api/types/network"
"github.com/testcontainers/testcontainers-go/log"
)
@@ -233,7 +232,7 @@ var defaultReadinessHook = func() ContainerLifecycleHooks {
}
}
- dockerContainer.isRunning = true
+ dockerContainer.isRunning.Store(true)
return nil
},
@@ -522,32 +521,29 @@ func (p *DockerProvider) preCreateContainerHook(ctx context.Context, req Contain
networkingConfig.EndpointsConfig = endpointSettings
+ // Expose ports automatically if the container request exposes zero ports and the container
+ // does not run in a container network. The NetworkMode check must be done after the pre-creation
+ // Modifiers are called, so the network mode is already set.
exposedPorts := req.ExposedPorts
- // this check must be done after the pre-creation Modifiers are called, so the network mode is already set
if len(exposedPorts) == 0 && !hostConfig.NetworkMode.IsContainer() {
image, err := p.client.ImageInspect(ctx, dockerInput.Image)
if err != nil {
return err
}
- for p := range image.Config.ExposedPorts {
- exposedPorts = append(exposedPorts, string(p))
+
+ exposedPorts = exposedPorts[:0]
+ for port := range image.Config.ExposedPorts {
+ exposedPorts = append(exposedPorts, port)
}
}
- exposedPortSet, exposedPortMap, err := nat.ParsePortSpecs(exposedPorts)
+ exposedPortSet, err := parseExposedPorts(exposedPorts)
if err != nil {
return err
}
dockerInput.ExposedPorts = exposedPortSet
-
- // only exposing those ports automatically if the container request exposes zero ports and the container does not run in a container network
- if len(exposedPorts) == 0 && !hostConfig.NetworkMode.IsContainer() {
- hostConfig.PortBindings = exposedPortMap
- } else {
- hostConfig.PortBindings = mergePortBindings(hostConfig.PortBindings, exposedPortMap, req.ExposedPorts)
- }
-
+ hostConfig.PortBindings = mergePortBindings(hostConfig.PortBindings, exposedPortSet)
return nil
}
@@ -597,32 +593,57 @@ func combineContainerHooks(defaultHooks, userDefinedHooks []ContainerLifecycleHo
return hooks
}
-func mergePortBindings(configPortMap, exposedPortMap nat.PortMap, exposedPorts []string) nat.PortMap {
- if exposedPortMap == nil {
- exposedPortMap = make(map[nat.Port][]nat.PortBinding)
+func parseExposedPorts(specs []string) (network.PortSet, error) {
+ exposed := make(network.PortSet, len(specs))
+ for _, s := range specs {
+ pr, err := network.ParsePortRange(s)
+ if err != nil {
+ return nil, fmt.Errorf("invalid exposed port %q: %w", s, err)
+ }
+
+ for p := range pr.All() {
+ exposed[p] = struct{}{}
+ }
}
+ return exposed, nil
+}
- mappedPorts := make(map[string]struct{}, len(exposedPorts))
- for _, p := range exposedPorts {
- p = strings.Split(p, "/")[0]
- mappedPorts[p] = struct{}{}
+// mergePortBindings returns a PortMap for the given exposedPortSet.
+//
+// For each port in exposedPortSet, a binding is ensured:
+// - If configPortMap contains bindings for that port, those bindings are used.
+// - Otherwise, a default binding with HostPort "0" (ephemeral allocation)
+// is assigned.
+//
+// Bindings for ports not present in exposedPortSet are not preserved.
+// Any binding with an empty HostPort is normalized to "0".
+//
+// TODO(thaJeztah): this logic seems the reverse of the docker CLI, which
+// exposes ports if the user requests a port-mapping (i.e., if a port-mapping
+// is requested, but not exposed, we map the port *and* add an entry to
+// ExposedPorts). The logic here is the reverse; any port "mapped" in
+// HostConfig.PortBindings is dropped if is not exposed.
+func mergePortBindings(configPortMap network.PortMap, exposedPortSet network.PortSet) network.PortMap {
+ if len(exposedPortSet) == 0 {
+ return network.PortMap{}
}
- for k, v := range configPortMap {
- if _, ok := mappedPorts[k.Port()]; ok {
- exposedPortMap[k] = v
+ exposedPortMap := make(network.PortMap, len(exposedPortSet))
+ for p := range exposedPortSet {
+ bindings := configPortMap[p]
+ if len(bindings) == 0 {
+ exposedPortMap[p] = []network.PortBinding{{HostPort: "0"}}
+ continue
}
- }
- // Fix: Ensure that ports with empty HostPort get "0" for automatic allocation
- // This fixes the UDP port binding issue where ports were getting HostPort:0 instead of being allocated
- for k, v := range exposedPortMap {
- for i := range v {
- if v[i].HostPort == "" {
- v[i].HostPort = "0" // Tell Docker to allocate a random port
+ // Fix: Ensure that ports with empty HostPort get "0" for automatic allocation
+ // This fixes the UDP port binding issue where ports were getting HostPort:0 instead of being allocated
+ for i := range bindings {
+ if bindings[i].HostPort == "" {
+ bindings[i].HostPort = "0" // Tell Docker to allocate a random port
}
}
- exposedPortMap[k] = v
+ exposedPortMap[p] = bindings
}
return exposedPortMap
diff --git a/vendor/github.com/testcontainers/testcontainers-go/mkdocs.yml b/vendor/github.com/testcontainers/testcontainers-go/mkdocs.yml
index e4e13b80..b77c004f 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/mkdocs.yml
+++ b/vendor/github.com/testcontainers/testcontainers-go/mkdocs.yml
@@ -162,4 +162,4 @@ nav:
- Getting help: getting_help.md
edit_uri: edit/main/docs/
extra:
- latest_version: v0.41.0
+ latest_version: v0.42.0
diff --git a/vendor/github.com/testcontainers/testcontainers-go/network.go b/vendor/github.com/testcontainers/testcontainers-go/network.go
index e0cc83f5..c5fa4eb5 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/network.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/network.go
@@ -3,7 +3,7 @@ package testcontainers
import (
"context"
- "github.com/docker/docker/api/types/network"
+ "github.com/moby/moby/api/types/network"
"github.com/testcontainers/testcontainers-go/internal/core"
)
diff --git a/vendor/github.com/testcontainers/testcontainers-go/options.go b/vendor/github.com/testcontainers/testcontainers-go/options.go
index 6e5f455d..4a629cbe 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/options.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/options.go
@@ -9,8 +9,8 @@ import (
"time"
"dario.cat/mergo"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/network"
+ "github.com/moby/moby/api/types/container"
+ "github.com/moby/moby/api/types/network"
tcexec "github.com/testcontainers/testcontainers-go/exec"
"github.com/testcontainers/testcontainers-go/internal/core"
diff --git a/vendor/github.com/testcontainers/testcontainers-go/port_forwarding.go b/vendor/github.com/testcontainers/testcontainers-go/port_forwarding.go
index 6a3c6238..493a4071 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/port_forwarding.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/port_forwarding.go
@@ -10,8 +10,8 @@ import (
"sync"
"time"
- "github.com/docker/docker/api/types/container"
"github.com/google/uuid"
+ "github.com/moby/moby/api/types/container"
"golang.org/x/crypto/ssh"
"github.com/testcontainers/testcontainers-go/internal/core/network"
@@ -107,14 +107,12 @@ func exposeHostPorts(ctx context.Context, req *ContainerRequest, ports ...int) (
return sshdConnectHook, fmt.Errorf("inspect sshd container: %w", err)
}
- // TODO: remove once we have docker context support via #2810
- //nolint:staticcheck // SA1019: IPAddress is deprecated, but we need it for compatibility until v29
- sshdIP := inspect.NetworkSettings.IPAddress
- if sshdIP == "" {
- single := len(inspect.NetworkSettings.Networks) == 1
- for name, network := range inspect.NetworkSettings.Networks {
- if name == sshdFirstNetwork || single {
- sshdIP = network.IPAddress
+ var sshdIP string
+ single := len(inspect.NetworkSettings.Networks) == 1
+ for name, nw := range inspect.NetworkSettings.Networks {
+ if name == sshdFirstNetwork || single {
+ if nw.IPAddress.IsValid() {
+ sshdIP = nw.IPAddress.String()
break
}
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/provider.go b/vendor/github.com/testcontainers/testcontainers-go/provider.go
index d2347b7f..210f451f 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/provider.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/provider.go
@@ -141,15 +141,18 @@ func NewDockerProvider(provOpts ...DockerProviderOption) (*DockerProvider, error
}
ctx := context.Background()
+ host, err := core.ExtractDockerHost(ctx)
+ if err != nil {
+ return nil, err
+ }
c, err := NewDockerClientWithOpts(ctx)
if err != nil {
return nil, err
}
-
return &DockerProvider{
DockerProviderOptions: o,
- host: core.MustExtractDockerHost(ctx),
client: c,
+ host: host,
config: config.Read(),
}, nil
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/reaper.go b/vendor/github.com/testcontainers/testcontainers-go/reaper.go
index 4f5c555e..f42c5bf4 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/reaper.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/reaper.go
@@ -15,10 +15,9 @@ import (
"github.com/cenkalti/backoff/v4"
"github.com/containerd/errdefs"
- "github.com/docker/docker/api/types"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/go-connections/nat"
+ "github.com/moby/moby/api/types/container"
+ "github.com/moby/moby/api/types/network"
+ "github.com/moby/moby/client"
"github.com/testcontainers/testcontainers-go/internal/config"
"github.com/testcontainers/testcontainers-go/internal/core"
@@ -41,7 +40,7 @@ var (
// defaultReaperPort is the default port that the reaper listens on if not
// overridden by the RYUK_PORT environment variable.
- defaultReaperPort = nat.Port("8080/tcp")
+ defaultReaperPort = network.MustParsePort("8080/tcp")
// errReaperNotFound is returned when no reaper container is found.
errReaperNotFound = errors.New("reaper not found")
@@ -95,9 +94,9 @@ type reaperSpawner struct {
}
// port returns the port that a new reaper should listen on.
-func (r *reaperSpawner) port() nat.Port {
+func (r *reaperSpawner) port() network.Port {
if port := os.Getenv("RYUK_PORT"); port != "" {
- natPort, err := nat.NewPort("tcp", port)
+ natPort, err := network.ParsePort(port + "/tcp")
if err != nil {
panic(fmt.Sprintf("invalid RYUK_PORT value %q: %s", port, err))
}
@@ -170,14 +169,13 @@ func (r *reaperSpawner) lookupContainer(ctx context.Context, sessionID string) (
provider.SetClient(dockerClient)
- opts := container.ListOptions{
+ opts := client.ContainerListOptions{
All: true,
- Filters: filters.NewArgs(
- filters.Arg("label", fmt.Sprintf("%s=%s", core.LabelSessionID, sessionID)),
- filters.Arg("label", fmt.Sprintf("%s=%t", core.LabelReaper, true)),
- filters.Arg("label", fmt.Sprintf("%s=%t", core.LabelRyuk, true)),
- filters.Arg("name", reaperContainerNameFromSessionID(sessionID)),
- ),
+ Filters: make(client.Filters).
+ Add("label", fmt.Sprintf("%s=%s", core.LabelSessionID, sessionID)).
+ Add("label", fmt.Sprintf("%s=%t", core.LabelReaper, true)).
+ Add("label", fmt.Sprintf("%s=%t", core.LabelRyuk, true)).
+ Add("name", reaperContainerNameFromSessionID(sessionID)),
}
return backoff.RetryWithData(
@@ -187,29 +185,26 @@ func (r *reaperSpawner) lookupContainer(ctx context.Context, sessionID string) (
return nil, fmt.Errorf("container list: %w", err)
}
- if len(resp) == 0 {
+ if len(resp.Items) == 0 {
// No reaper container not found.
return nil, backoff.Permanent(errReaperNotFound)
}
- if len(resp) > 1 {
- return nil, fmt.Errorf("found %d reaper containers for session ID %q", len(resp), sessionID)
+ if len(resp.Items) > 1 {
+ return nil, fmt.Errorf("found %d reaper containers for session ID %q", len(resp.Items), sessionID)
}
- r, err := provider.ContainerFromType(ctx, resp[0])
+ r, err := provider.ContainerFromType(ctx, resp.Items[0])
if err != nil {
return nil, fmt.Errorf("from docker: %w", err)
}
- switch {
- case r.healthStatus == types.Healthy,
- r.healthStatus == types.NoHealthcheck:
+ switch r.healthStatus {
+ case "", container.Healthy, container.NoHealthcheck:
return r, nil
- case r.healthStatus != "":
+ default:
return nil, fmt.Errorf("container not healthy: %s", r.healthStatus)
}
-
- return r, nil
},
backoff.WithContext(r.backoff(), ctx),
)
@@ -225,7 +220,7 @@ func (r *reaperSpawner) isRunning(ctx context.Context, ctr Container) error {
if !state.Running {
// Use NotFound error to indicate the container is not running
// and should be recreated.
- return errdefs.ErrNotFound.WithMessage("container state: " + state.Status)
+ return errdefs.ErrNotFound.WithMessage("container state: " + string(state.Status))
}
return nil
@@ -381,9 +376,9 @@ func (r *reaperSpawner) newReaper(ctx context.Context, sessionID string, provide
tcConfig := provider.Config().Config
req := ContainerRequest{
Image: config.ReaperDefaultImage,
- ExposedPorts: []string{string(port)},
+ ExposedPorts: []string{port.String()},
Labels: core.DefaultLabels(sessionID),
- WaitingFor: wait.ForListeningPort(port),
+ WaitingFor: wait.ForListeningPort(port.String()),
Name: reaperContainerNameFromSessionID(sessionID),
HostConfigModifier: func(hc *container.HostConfig) {
hc.AutoRemove = true
@@ -428,7 +423,7 @@ func (r *reaperSpawner) newReaper(ctx context.Context, sessionID string, provide
return nil, fmt.Errorf("run container: %w", err)
}
- endpoint, err := c.PortEndpoint(ctx, port, "")
+ endpoint, err := c.PortEndpoint(ctx, port.String(), "")
if err != nil {
return nil, fmt.Errorf("port endpoint: %w", err)
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/testing.go b/vendor/github.com/testcontainers/testcontainers-go/testing.go
index 704af99c..47b36092 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/testing.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/testing.go
@@ -4,10 +4,13 @@ import (
"context"
"fmt"
"io"
+ "os"
"regexp"
+ "strings"
"testing"
"github.com/containerd/errdefs"
+ "github.com/moby/moby/client"
"github.com/stretchr/testify/require"
)
@@ -39,16 +42,25 @@ func SkipIfProviderIsNotHealthy(t *testing.T) {
}
// SkipIfDockerDesktop is a utility function capable of skipping tests
-// if tests are run using Docker Desktop.
+// if tests are run using Docker Desktop or another VM-based Docker
+// environment (e.g. colima) where host network access is not available.
func SkipIfDockerDesktop(t *testing.T, ctx context.Context) {
t.Helper()
+
+ // Colima runs Docker inside a Linux VM, so host networking doesn't work
+ // the same way as native Docker on Linux. Detect it via DOCKER_HOST which
+ // typically contains the colima socket path.
+ if strings.Contains(os.Getenv("DOCKER_HOST"), "colima") {
+ t.Skip("Skipping test that requires host network access when running in colima")
+ }
+
cli, err := NewDockerClientWithOpts(ctx)
require.NoErrorf(t, err, "failed to create docker client: %s", err)
- info, err := cli.Info(ctx)
+ res, err := cli.Info(ctx, client.InfoOptions{})
require.NoErrorf(t, err, "failed to get docker info: %s", err)
- if info.OperatingSystem == "Docker Desktop" {
+ if res.Info.OperatingSystem == "Docker Desktop" {
t.Skip("Skipping test that requires host network access when running in Docker Desktop")
}
}
@@ -60,10 +72,10 @@ func SkipIfNotDockerDesktop(t *testing.T, ctx context.Context) {
cli, err := NewDockerClientWithOpts(ctx)
require.NoErrorf(t, err, "failed to create docker client: %s", err)
- info, err := cli.Info(ctx)
+ res, err := cli.Info(ctx, client.InfoOptions{})
require.NoErrorf(t, err, "failed to get docker info: %s", err)
- if info.OperatingSystem != "Docker Desktop" {
+ if res.Info.OperatingSystem != "Docker Desktop" {
t.Skip("Skipping test that needs Docker Desktop")
}
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/wait/health.go b/vendor/github.com/testcontainers/testcontainers-go/wait/health.go
index c2a27383..6df6f0de 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/wait/health.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/wait/health.go
@@ -4,7 +4,7 @@ import (
"context"
"time"
- "github.com/docker/docker/api/types"
+ "github.com/moby/moby/api/types/container"
)
// Implement interface
@@ -87,7 +87,7 @@ func (ws *HealthStrategy) WaitUntilReady(ctx context.Context, target StrategyTar
if err := checkState(state); err != nil {
return err
}
- if state.Health == nil || state.Health.Status != types.Healthy {
+ if state.Health == nil || state.Health.Status != container.Healthy {
time.Sleep(ws.PollInterval)
continue
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/wait/host_port.go b/vendor/github.com/testcontainers/testcontainers-go/wait/host_port.go
index 706e3489..60cf5e4e 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/wait/host_port.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/wait/host_port.go
@@ -8,7 +8,7 @@ import (
"os"
"time"
- "github.com/docker/go-connections/nat"
+ "github.com/moby/moby/api/types/network"
"github.com/testcontainers/testcontainers-go/log"
)
@@ -32,7 +32,7 @@ var (
type HostPortStrategy struct {
// Port is a string containing port number and protocol in the format "80/tcp"
// which
- Port nat.Port
+ Port string
// all WaitStrategies should have a startupTimeout to avoid waiting infinitely
timeout *time.Duration
PollInterval time.Duration
@@ -50,7 +50,7 @@ type HostPortStrategy struct {
// NewHostPortStrategy constructs a default host port strategy that waits for the given
// port to be exposed. The default startup timeout is 60 seconds.
-func NewHostPortStrategy(port nat.Port) *HostPortStrategy {
+func NewHostPortStrategy(port string) *HostPortStrategy {
return &HostPortStrategy{
Port: port,
PollInterval: defaultPollInterval(),
@@ -64,7 +64,7 @@ func NewHostPortStrategy(port nat.Port) *HostPortStrategy {
// ForListeningPort returns a host port strategy that waits for the given port
// to be exposed and bound internally the container.
// Alias for `NewHostPortStrategy(port)`.
-func ForListeningPort(port nat.Port) *HostPortStrategy {
+func ForListeningPort(port string) *HostPortStrategy {
return NewHostPortStrategy(port)
}
@@ -76,7 +76,7 @@ func ForExposedPort() *HostPortStrategy {
// ForMappedPort returns a host port strategy that waits for the given port
// to be mapped without accessing the port itself.
-func ForMappedPort(port nat.Port) *HostPortStrategy {
+func ForMappedPort(port string) *HostPortStrategy {
return NewHostPortStrategy(port).SkipInternalCheck().SkipExternalCheck()
}
@@ -118,7 +118,7 @@ func (hp *HostPortStrategy) Timeout() *time.Duration {
func (hp *HostPortStrategy) String() string {
port := "first exposed port"
if hp.Port != "" {
- port = fmt.Sprintf("port %s", hp.Port)
+ port = "port " + hp.Port
}
var checks string
@@ -139,15 +139,15 @@ func (hp *HostPortStrategy) String() string {
// detectInternalPort returns the lowest internal port that is currently bound.
// If no internal port is found, it returns the zero nat.Port value which
// can be checked against an empty string.
-func (hp *HostPortStrategy) detectInternalPort(ctx context.Context, target StrategyTarget) (nat.Port, error) {
- var internalPort nat.Port
+func (hp *HostPortStrategy) detectInternalPort(ctx context.Context, target StrategyTarget) (network.Port, error) {
+ var internalPort network.Port
inspect, err := target.Inspect(ctx)
if err != nil {
return internalPort, fmt.Errorf("inspect: %w", err)
}
for port := range inspect.NetworkSettings.Ports {
- if internalPort == "" || port.Int() < internalPort.Int() {
+ if internalPort.IsZero() || port.Num() < internalPort.Num() {
internalPort = port
}
}
@@ -167,9 +167,17 @@ func (hp *HostPortStrategy) WaitUntilReady(ctx context.Context, target StrategyT
waitInterval := hp.PollInterval
- internalPort := hp.Port
+ var internalPort network.Port
+ if hp.Port != "" {
+ p, err := network.ParsePort(hp.Port)
+ if err != nil {
+ return err
+ }
+ internalPort = p
+ }
+
i := 0
- if internalPort == "" {
+ if internalPort.IsZero() {
var err error
// Port is not specified, so we need to detect it.
internalPort, err = hp.detectInternalPort(ctx, target)
@@ -177,7 +185,7 @@ func (hp *HostPortStrategy) WaitUntilReady(ctx context.Context, target StrategyT
return fmt.Errorf("detect internal port: %w", err)
}
- for internalPort == "" {
+ for internalPort.IsZero() {
select {
case <-ctx.Done():
return fmt.Errorf("detect internal port: retries: %d, last err: %w, ctx err: %w", i, err, ctx.Err())
@@ -194,10 +202,10 @@ func (hp *HostPortStrategy) WaitUntilReady(ctx context.Context, target StrategyT
}
}
- port, err := target.MappedPort(ctx, internalPort)
+ port, err := target.MappedPort(ctx, internalPort.String())
i = 0
- for port == "" {
+ for port.IsZero() {
i++
select {
@@ -207,7 +215,7 @@ func (hp *HostPortStrategy) WaitUntilReady(ctx context.Context, target StrategyT
if err := checkTarget(ctx, target); err != nil {
return fmt.Errorf("mapped port: check target: retries: %d, port: %q, last err: %w", i, port, err)
}
- port, err = target.MappedPort(ctx, internalPort)
+ port, err = target.MappedPort(ctx, internalPort.String())
if err != nil {
log.Printf("mapped port: retries: %d, port: %q, err: %s\n", i, port, err)
}
@@ -245,7 +253,7 @@ func (hp *HostPortStrategy) WaitUntilReady(ctx context.Context, target StrategyT
return nil
}
-func externalCheck(ctx context.Context, ipAddress string, port nat.Port, target StrategyTarget, waitInterval time.Duration) error {
+func externalCheck(ctx context.Context, ipAddress string, port network.Port, target StrategyTarget, waitInterval time.Duration) error {
proto := port.Proto()
dialer := net.Dialer{}
@@ -254,7 +262,7 @@ func externalCheck(ctx context.Context, ipAddress string, port nat.Port, target
if err := checkTarget(ctx, target); err != nil {
return fmt.Errorf("check target: retries: %d address: %s: %w", i, address, err)
}
- conn, err := dialer.DialContext(ctx, proto, address)
+ conn, err := dialer.DialContext(ctx, string(proto), address)
if err != nil {
var v *net.OpError
if errors.As(err, &v) {
@@ -269,13 +277,13 @@ func externalCheck(ctx context.Context, ipAddress string, port nat.Port, target
return fmt.Errorf("dial: %w", err)
}
- conn.Close()
+ _ = conn.Close()
return nil
}
}
-func internalCheck(ctx context.Context, internalPort nat.Port, target StrategyTarget) error {
- command := buildInternalCheckCommand(internalPort.Int())
+func internalCheck(ctx context.Context, internalPort network.Port, target StrategyTarget) error {
+ command := buildInternalCheckCommand(internalPort.Num())
for {
if ctx.Err() != nil {
return ctx.Err()
@@ -302,7 +310,7 @@ func internalCheck(ctx context.Context, internalPort nat.Port, target StrategyTa
}
}
-func buildInternalCheckCommand(internalPort int) string {
+func buildInternalCheckCommand(internalPort uint16) string {
command := `(
cat /proc/net/tcp* | awk '{print $2}' | grep -i :%04x ||
nc -vz -w 1 localhost %d ||
diff --git a/vendor/github.com/testcontainers/testcontainers-go/wait/http.go b/vendor/github.com/testcontainers/testcontainers-go/wait/http.go
index 81f4c34b..95208290 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/wait/http.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/wait/http.go
@@ -14,7 +14,7 @@ import (
"strings"
"time"
- "github.com/docker/go-connections/nat"
+ "github.com/moby/moby/api/types/network"
)
// Implement interface
@@ -28,7 +28,7 @@ type HTTPStrategy struct {
timeout *time.Duration
// additional properties
- Port nat.Port
+ Port network.Port
Path string
StatusCodeMatcher func(status int) bool
ResponseMatcher func(body io.Reader) bool
@@ -44,10 +44,10 @@ type HTTPStrategy struct {
ForceIPv4LocalHost bool
}
-// NewHTTPStrategy constructs a HTTP strategy waiting on port 80 and status code 200
+// NewHTTPStrategy constructs an HTTP strategy waiting on port 80 and status code 200
func NewHTTPStrategy(path string) *HTTPStrategy {
return &HTTPStrategy{
- Port: "",
+ Port: network.Port{},
Path: path,
StatusCodeMatcher: defaultStatusCodeMatcher,
ResponseMatcher: func(_ io.Reader) bool { return true },
@@ -78,8 +78,10 @@ func (ws *HTTPStrategy) WithStartupTimeout(timeout time.Duration) *HTTPStrategy
// WithPort set the port to wait for.
// Default is the lowest numbered port.
-func (ws *HTTPStrategy) WithPort(port nat.Port) *HTTPStrategy {
- ws.Port = port
+func (ws *HTTPStrategy) WithPort(port string) *HTTPStrategy {
+ if p, err := network.ParsePort(port); err == nil {
+ ws.Port = p
+ }
return ws
}
@@ -162,7 +164,7 @@ func (ws *HTTPStrategy) String() string {
}
port := "default"
- if ws.Port != "" {
+ if !ws.Port.IsZero() {
port = ws.Port.Port()
}
@@ -188,8 +190,9 @@ func (ws *HTTPStrategy) WaitUntilReady(ctx context.Context, target StrategyTarge
ipAddress = strings.Replace(ipAddress, "localhost", "127.0.0.1", 1)
}
- var mappedPort nat.Port
- if ws.Port == "" {
+ var mappedPort network.Port
+ if ws.Port.IsZero() {
+ // No specific port requested; inspect container to find lowest exposed TCP port.
// We wait one polling interval before we grab the ports
// otherwise they might not be bound yet on startup.
select {
@@ -209,28 +212,29 @@ func (ws *HTTPStrategy) WaitUntilReady(ctx context.Context, target StrategyTarge
}
// Find the lowest numbered exposed tcp port.
- var lowestPort nat.Port
+ var lowestPort network.Port
var hostPort string
for port, bindings := range inspect.NetworkSettings.Ports {
if len(bindings) == 0 || port.Proto() != "tcp" {
continue
}
- if lowestPort == "" || port.Int() < lowestPort.Int() {
+ if lowestPort.IsZero() || port.Num() < lowestPort.Num() {
lowestPort = port
hostPort = bindings[0].HostPort
}
}
- if lowestPort == "" {
+ if lowestPort.IsZero() {
return errors.New("no exposed tcp ports or mapped ports - cannot wait for status")
}
- mappedPort, _ = nat.NewPort(lowestPort.Proto(), hostPort)
+ hPort, _ := strconv.ParseUint(hostPort, 10, 16)
+ mappedPort, _ = network.PortFrom(uint16(hPort), lowestPort.Proto())
} else {
- mappedPort, err = target.MappedPort(ctx, ws.Port)
-
- for mappedPort == "" {
+ // Specific port requested; use MappedPort to resolve it.
+ mappedPort, err = target.MappedPort(ctx, ws.Port.String())
+ for mappedPort.IsZero() {
select {
case <-ctx.Done():
return fmt.Errorf("%w: %w", ctx.Err(), err)
@@ -239,7 +243,7 @@ func (ws *HTTPStrategy) WaitUntilReady(ctx context.Context, target StrategyTarge
return err
}
- mappedPort, err = target.MappedPort(ctx, ws.Port)
+ mappedPort, err = target.MappedPort(ctx, ws.Port.String())
}
}
@@ -289,7 +293,7 @@ func (ws *HTTPStrategy) WaitUntilReady(ctx context.Context, target StrategyTarge
}
client := http.Client{Transport: tripper, Timeout: time.Second}
- address := net.JoinHostPort(ipAddress, strconv.Itoa(mappedPort.Int()))
+ address := net.JoinHostPort(ipAddress, mappedPort.Port())
endpoint, err := url.Parse(ws.Path)
if err != nil {
diff --git a/vendor/github.com/testcontainers/testcontainers-go/wait/nop.go b/vendor/github.com/testcontainers/testcontainers-go/wait/nop.go
index 633a97cc..8a23e7ea 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/wait/nop.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/wait/nop.go
@@ -5,8 +5,8 @@ import (
"io"
"time"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/go-connections/nat"
+ "github.com/moby/moby/api/types/container"
+ "github.com/moby/moby/api/types/network"
"github.com/testcontainers/testcontainers-go/exec"
)
@@ -61,12 +61,15 @@ func (st NopStrategyTarget) Inspect(_ context.Context) (*container.InspectRespon
}
// Deprecated: use Inspect instead
-func (st NopStrategyTarget) Ports(_ context.Context) (nat.PortMap, error) {
+func (st NopStrategyTarget) Ports(_ context.Context) (network.PortMap, error) {
return nil, nil
}
-func (st NopStrategyTarget) MappedPort(_ context.Context, n nat.Port) (nat.Port, error) {
- return n, nil
+func (st NopStrategyTarget) MappedPort(_ context.Context, n string) (network.Port, error) {
+ if n == "" {
+ return network.Port{}, nil
+ }
+ return network.ParsePort(n)
}
func (st NopStrategyTarget) Logs(_ context.Context) (io.ReadCloser, error) {
diff --git a/vendor/github.com/testcontainers/testcontainers-go/wait/sql.go b/vendor/github.com/testcontainers/testcontainers-go/wait/sql.go
index c9a9dbad..5d0228a0 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/wait/sql.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/wait/sql.go
@@ -6,7 +6,7 @@ import (
"fmt"
"time"
- "github.com/docker/go-connections/nat"
+ "github.com/moby/moby/api/types/network"
)
var (
@@ -17,7 +17,7 @@ var (
const defaultForSQLQuery = "SELECT 1"
// ForSQL constructs a new waitForSql strategy for the given driver
-func ForSQL(port nat.Port, driver string, url func(host string, port nat.Port) string) *waitForSQL {
+func ForSQL(port string, driver string, url func(host string, port string) string) *waitForSQL {
return &waitForSQL{
Port: port,
URL: url,
@@ -31,9 +31,9 @@ func ForSQL(port nat.Port, driver string, url func(host string, port nat.Port) s
type waitForSQL struct {
timeout *time.Duration
- URL func(host string, port nat.Port) string
+ URL func(host string, port string) string
Driver string
- Port nat.Port
+ Port string
startupTimeout time.Duration
PollInterval time.Duration
query string
@@ -65,7 +65,10 @@ func (w *waitForSQL) Timeout() *time.Duration {
func (w *waitForSQL) String() string {
port := "default"
if w.Port != "" {
- port = w.Port.Port()
+ p, err := network.ParsePort(w.Port)
+ if err == nil {
+ port = p.Port()
+ }
}
query := ""
@@ -96,10 +99,10 @@ func (w *waitForSQL) WaitUntilReady(ctx context.Context, target StrategyTarget)
ticker := time.NewTicker(w.PollInterval)
defer ticker.Stop()
- var port nat.Port
+ var port network.Port
port, err = target.MappedPort(ctx, w.Port)
- for port == "" {
+ for port.IsZero() {
select {
case <-ctx.Done():
return fmt.Errorf("%w: %w", ctx.Err(), err)
@@ -111,7 +114,7 @@ func (w *waitForSQL) WaitUntilReady(ctx context.Context, target StrategyTarget)
}
}
- db, err := sql.Open(w.Driver, w.URL(host, port))
+ db, err := sql.Open(w.Driver, w.URL(host, port.String()))
if err != nil {
return fmt.Errorf("sql.Open: %w", err)
}
diff --git a/vendor/github.com/testcontainers/testcontainers-go/wait/wait.go b/vendor/github.com/testcontainers/testcontainers-go/wait/wait.go
index ca5a7dbf..43485001 100644
--- a/vendor/github.com/testcontainers/testcontainers-go/wait/wait.go
+++ b/vendor/github.com/testcontainers/testcontainers-go/wait/wait.go
@@ -7,8 +7,8 @@ import (
"io"
"time"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/go-connections/nat"
+ "github.com/moby/moby/api/types/container"
+ "github.com/moby/moby/api/types/network"
"github.com/testcontainers/testcontainers-go/exec"
)
@@ -26,8 +26,8 @@ type StrategyTimeout interface {
type StrategyTarget interface {
Host(context.Context) (string, error)
Inspect(context.Context) (*container.InspectResponse, error)
- Ports(ctx context.Context) (nat.PortMap, error) // Deprecated: use Inspect instead
- MappedPort(context.Context, nat.Port) (nat.Port, error)
+ Ports(ctx context.Context) (network.PortMap, error) // Deprecated: use Inspect instead
+ MappedPort(context.Context, string) (network.Port, error)
Logs(context.Context) (io.ReadCloser, error)
Exec(context.Context, []string, ...exec.ProcessOption) (int, io.Reader, error)
State(context.Context) (*container.State, error)
@@ -49,7 +49,7 @@ func checkState(state *container.State) error {
return nil
case state.OOMKilled:
return errors.New("container crashed with out-of-memory (OOMKilled)")
- case state.Status == "exited":
+ case state.Status == container.StateExited:
return fmt.Errorf("container exited with code %d", state.ExitCode)
default:
return fmt.Errorf("unexpected container status %q", state.Status)
diff --git a/vendor/modules.txt b/vendor/modules.txt
index b81741dd..9395fefe 100644
--- a/vendor/modules.txt
+++ b/vendor/modules.txt
@@ -499,33 +499,13 @@ github.com/docker/distribution/registry/storage/cache
github.com/docker/distribution/registry/storage/cache/memory
# github.com/docker/docker v28.5.2+incompatible
## explicit
-github.com/docker/docker/api
-github.com/docker/docker/api/types
-github.com/docker/docker/api/types/blkiodev
-github.com/docker/docker/api/types/build
-github.com/docker/docker/api/types/checkpoint
-github.com/docker/docker/api/types/common
-github.com/docker/docker/api/types/container
-github.com/docker/docker/api/types/events
github.com/docker/docker/api/types/filters
-github.com/docker/docker/api/types/image
-github.com/docker/docker/api/types/mount
-github.com/docker/docker/api/types/network
github.com/docker/docker/api/types/registry
-github.com/docker/docker/api/types/storage
-github.com/docker/docker/api/types/strslice
-github.com/docker/docker/api/types/swarm
-github.com/docker/docker/api/types/swarm/runtime
-github.com/docker/docker/api/types/system
-github.com/docker/docker/api/types/time
github.com/docker/docker/api/types/versions
-github.com/docker/docker/api/types/volume
-github.com/docker/docker/client
github.com/docker/docker/internal/lazyregexp
github.com/docker/docker/pkg/homedir
github.com/docker/docker/pkg/ioutils
github.com/docker/docker/pkg/jsonmessage
-github.com/docker/docker/pkg/stdcopy
github.com/docker/docker/registry
# github.com/docker/docker-credential-helpers v0.9.5
## explicit; go 1.21
@@ -533,7 +513,6 @@ github.com/docker/docker-credential-helpers/client
github.com/docker/docker-credential-helpers/credentials
# github.com/docker/go-connections v0.7.0
## explicit; go 1.23
-github.com/docker/go-connections/nat
github.com/docker/go-connections/sockets
github.com/docker/go-connections/tlsconfig
# github.com/docker/go-metrics v0.0.1
@@ -1102,6 +1081,8 @@ github.com/moby/go-archive/compression
github.com/moby/go-archive/tarheader
# github.com/moby/moby/api v1.54.2
## explicit; go 1.24
+github.com/moby/moby/api/pkg/authconfig
+github.com/moby/moby/api/pkg/stdcopy
github.com/moby/moby/api/types
github.com/moby/moby/api/types/blkiodev
github.com/moby/moby/api/types/build
@@ -1125,6 +1106,7 @@ github.com/moby/moby/client
github.com/moby/moby/client/internal
github.com/moby/moby/client/internal/mod
github.com/moby/moby/client/internal/timestamp
+github.com/moby/moby/client/pkg/jsonmessage
github.com/moby/moby/client/pkg/versions
# github.com/moby/patternmatcher v0.6.1
## explicit; go 1.19
@@ -1357,7 +1339,7 @@ github.com/securego/gosec/v2/analyzers
github.com/securego/gosec/v2/cwe
github.com/securego/gosec/v2/issue
github.com/securego/gosec/v2/rules
-# github.com/shirou/gopsutil/v4 v4.26.2
+# github.com/shirou/gopsutil/v4 v4.26.3
## explicit; go 1.24.0
github.com/shirou/gopsutil/v4/common
github.com/shirou/gopsutil/v4/cpu
@@ -1415,7 +1397,7 @@ github.com/ssgreg/nlreturn/v2/pkg/nlreturn
# github.com/stbenjam/no-sprintf-host-port v0.3.1
## explicit; go 1.24.0
github.com/stbenjam/no-sprintf-host-port/pkg/analyzer
-# github.com/stretchr/objx v0.5.2
+# github.com/stretchr/objx v0.5.3
## explicit; go 1.20
github.com/stretchr/objx
# github.com/stretchr/testify v1.11.1
@@ -1427,7 +1409,7 @@ github.com/stretchr/testify/require
# github.com/subosito/gotenv v1.6.0
## explicit; go 1.18
github.com/subosito/gotenv
-# github.com/testcontainers/testcontainers-go v0.41.0
+# github.com/testcontainers/testcontainers-go v0.42.0
## explicit; go 1.25.0
github.com/testcontainers/testcontainers-go
github.com/testcontainers/testcontainers-go/exec
@@ -1666,8 +1648,6 @@ golang.org/x/text/runes
golang.org/x/text/transform
golang.org/x/text/unicode/norm
golang.org/x/text/width
-# golang.org/x/time v0.15.0
-## explicit; go 1.25.0
# golang.org/x/tools v0.44.0
## explicit; go 1.25.0
golang.org/x/tools/cover
@@ -1761,12 +1741,6 @@ golang.org/x/tools/internal/typesinternal
golang.org/x/tools/internal/typesinternal/typeindex
golang.org/x/tools/internal/versions
golang.org/x/tools/refactor/satisfy
-# google.golang.org/genproto/googleapis/api v0.0.0-20260401001100-f93e5f3e9f0f
-## explicit; go 1.25.0
-# google.golang.org/genproto/googleapis/rpc v0.0.0-20260401024825-9d38bb4040a9
-## explicit; go 1.25.0
-# google.golang.org/grpc v1.80.0
-## explicit; go 1.24.0
# google.golang.org/protobuf v1.36.11
## explicit; go 1.23
google.golang.org/protobuf/encoding/protodelim