docker.update

Update Docker service configuration.

This method is a job.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: docker_update

docker_update

Type: object

DockerUpdateArgs parameters.

No Additional Properties

enable_image_updates

Enable Image Updates

Type: boolean

Whether automatic Docker image updates are enabled.

pool

Pool

Storage pool used for Docker or null if not configured.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

nvidia

Nvidia

Type: boolean

Whether NVIDIA GPU support is enabled for containers.

address_pools

Address Pools

Type: array of object

Array of network address pools for container networking.

No Additional Items

Each item of this array must be:

AddressPool

Type: object
No Additional Properties

base Required

Base

Type: stringFormat: ipvanyinterface

Base network address with prefix for the pool.

size Required

Size

Type: integer

Subnet size for networks allocated from this pool.

Value must be greater or equal to 1

cidr_v6

Cidr V6

Type: stringFormat: ipvanyinterface

IPv6 CIDR block for Docker container networking.

registry_mirrors

Registry Mirrors

Type: array of object

Array of registry mirrors.

No Additional Items

Each item of this array must be:

RegistryMirror

Type: object
No Additional Properties

url Required

Url

Type: stringFormat: uri

URL of the registry mirror.

Must be at least 1 characters long

Must be at most 2083 characters long

insecure Required

Insecure

Type: boolean

Whether the registry mirror uses an insecure (HTTP) connection.

migrate_applications

Migrate Applications

Type: boolean

Whether to migrate existing applications when changing pools.

Return value

DockerEntry

Type: object

The updated Docker configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the Docker configuration.

enable_image_updates Required

Enable Image Updates

Type: boolean

Whether automatic Docker image updates are enabled.

dataset Required

Dataset

ZFS dataset used for Docker data storage or null.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

pool Required

Pool

Storage pool used for Docker or null if not configured.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

nvidia Required

Nvidia

Type: boolean

Whether NVIDIA GPU support is enabled for containers.

address_pools Required

Address Pools

Type: array of object

Array of network address pools for container networking.

No Additional Items

Each item of this array must be:

Type: object

cidr_v6 Required

Cidr V6

Type: string

IPv6 CIDR block for Docker container networking.

registry_mirrors Required

Registry Mirrors

Type: array of object

Array of registry mirrors.

No Additional Items

Each item of this array must be:

RegistryMirror

Type: object
No Additional Properties

url Required

Url

Type: stringFormat: uri

URL of the registry mirror.

Must be at least 1 characters long

Must be at most 2083 characters long

insecure Required

Insecure

Type: boolean

Whether the registry mirror uses an insecure (HTTP) connection.

Required roles: DOCKER_WRITE