Documentation
¶
Overview ¶
Package types catalogs github.com/moby/moby/api/types/volume for wrapping by containerkit.
Code generated by go run ./tools/gencatalog; DO NOT EDIT.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume
Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/engine/volume/types), not in renamed aliases.
Index ¶
- type AccessMode
- type Availability
- type CapacityRange
- type ClusterVolume
- type ClusterVolumeSpec
- type CreateRequest
- type DiskUsage
- type Info
- type ListResponse
- type PruneReport
- type PublishState
- type PublishStatus
- type Scope
- type Secret
- type SharingMode
- type Topology
- type TopologyRequirement
- type TypeBlock
- type TypeMount
- type UsageData
- type Volume
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessMode ¶
type AccessMode = volume.AccessMode
AccessMode wraps volume.AccessMode.
AccessMode defines the access mode of a volume.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#AccessMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type AccessMode from volume.
type Availability ¶
type Availability = volume.Availability
Availability wraps volume.Availability.
Availability specifies the availability of the volume.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#Availability GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: named:string Underlying: string Usecase: wrap the Engine API type Availability from volume.
type CapacityRange ¶
type CapacityRange = volume.CapacityRange
CapacityRange wraps volume.CapacityRange.
CapacityRange describes the minimum and maximum capacity a volume should be created with
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#CapacityRange GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type CapacityRange from volume.
type ClusterVolume ¶
type ClusterVolume = volume.ClusterVolume
ClusterVolume wraps volume.ClusterVolume.
ClusterVolume contains options and information specific to, and only present on, Swarm CSI cluster volumes.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#ClusterVolume GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct References: github.com/moby/moby/api/types/swarm.Meta Usecase: wrap the Engine API type ClusterVolume from volume.
type ClusterVolumeSpec ¶
type ClusterVolumeSpec = volume.ClusterVolumeSpec
ClusterVolumeSpec wraps volume.ClusterVolumeSpec.
ClusterVolumeSpec contains the spec used to create this volume.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#ClusterVolumeSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type ClusterVolumeSpec from volume.
type CreateRequest ¶
type CreateRequest = volume.CreateRequest
CreateRequest wraps volume.CreateRequest.
CreateRequest VolumeConfig ¶
Volume configuration ¶
swagger:model CreateRequest
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#CreateRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/create_request.go Kind: struct Usecase: wrap the Engine API type CreateRequest from volume.
type DiskUsage ¶
DiskUsage wraps volume.DiskUsage.
DiskUsage represents system data usage for volume resources.
swagger:model DiskUsage
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#DiskUsage GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/disk_usage.go Kind: struct Usecase: wrap the Engine API type DiskUsage from volume.
type Info ¶
Info wraps volume.Info.
Info contains information about the Volume as a whole as provided by the CSI storage plugin.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#Info GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type Info from volume.
type ListResponse ¶
type ListResponse = volume.ListResponse
ListResponse wraps volume.ListResponse.
ListResponse VolumeListResponse ¶
Volume list response ¶
swagger:model ListResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#ListResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/list_response.go Kind: struct Usecase: wrap the Engine API type ListResponse from volume.
type PruneReport ¶
type PruneReport = volume.PruneReport
PruneReport wraps volume.PruneReport.
PruneReport contains the response for Engine API: POST "/volumes/prune"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#PruneReport GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/prune_report.go Kind: struct Usecase: wrap the Engine API type PruneReport from volume.
type PublishState ¶
type PublishState = volume.PublishState
PublishState wraps volume.PublishState.
PublishState represents the state of a Volume as it pertains to its use on a particular Node.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#PublishState GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: named:string Underlying: string Usecase: wrap the Engine API type PublishState from volume.
type PublishStatus ¶
type PublishStatus = volume.PublishStatus
PublishStatus wraps volume.PublishStatus.
PublishStatus represents the status of the volume as published to an individual node
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#PublishStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type PublishStatus from volume.
type Scope ¶
Scope wraps volume.Scope.
Scope defines the Scope of a Cluster Volume. This is how many nodes a Volume can be accessed simultaneously on.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#Scope GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: named:string Underlying: string Usecase: wrap the Engine API type Scope from volume.
type Secret ¶
Secret wraps volume.Secret.
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.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#Secret GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type Secret from volume.
type SharingMode ¶
type SharingMode = volume.SharingMode
SharingMode wraps volume.SharingMode.
SharingMode defines the Sharing of a Cluster Volume. This is how Tasks using a Volume at the same time can use it.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#SharingMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: named:string Underlying: string Usecase: wrap the Engine API type SharingMode from volume.
type Topology ¶
Topology wraps volume.Topology.
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.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#Topology GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type Topology from volume.
type TopologyRequirement ¶
type TopologyRequirement = volume.TopologyRequirement
TopologyRequirement wraps volume.TopologyRequirement.
TopologyRequirement expresses the user's requirements for a volume's accessible topology.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#TopologyRequirement GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type TopologyRequirement from volume.
type TypeBlock ¶
TypeBlock wraps volume.TypeBlock.
TypeBlock defines options for using a volume as a block-type volume.
Intentionally empty.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#TypeBlock GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type TypeBlock from volume.
type TypeMount ¶
TypeMount wraps volume.TypeMount.
TypeMount contains options for using a volume as a Mount-type volume.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#TypeMount GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/cluster_volume.go Kind: struct Usecase: wrap the Engine API type TypeMount from volume.
type UsageData ¶
UsageData wraps volume.UsageData.
UsageData Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints.
swagger:model UsageData
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#UsageData GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/volume.go Kind: struct Usecase: wrap the Engine API type UsageData from volume.
type Volume ¶
Volume wraps volume.Volume.
Volume volume ¶
swagger:model Volume
Source: https://pkg.go.dev/github.com/moby/moby/api/types/volume#Volume GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/volume/volume.go Kind: struct Usecase: wrap the Engine API type Volume from volume.