dsdk / v1.47 / ClusterVolumeSpec
Type Alias: ClusterVolumeSpec ​
ClusterVolumeSpec:
object
Cluster-specific options used to create the volume.
Type declaration ​
| Name | Type | Description |
|---|---|---|
AccessMode? | object | Defines how the volume is used by tasks. |
AccessMode.AccessibilityRequirements? | object | 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. |
AccessMode.AccessibilityRequirements.Preferred? | Topology[] | A list of topologies that the volume should attempt to be provisioned in. |
AccessMode.AccessibilityRequirements.Requisite? | Topology[] | A list of required topologies, at least one of which the volume must be accessible from. |
AccessMode.Availability? | "active" | "pause" | "drain" | 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. |
AccessMode.CapacityRange? | object | The desired capacity that the volume should be created with. If empty, the plugin will decide the capacity. |
AccessMode.CapacityRange.LimitBytes? | number | The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. |
AccessMode.CapacityRange.RequiredBytes? | number | The volume must be at least this big. The value of 0 indicates an unspecified minimum |
AccessMode.MountVolume? | unknown | 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: |
AccessMode.Scope? | "single" | "multi" | 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. |
AccessMode.Secrets? | object[] | Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. |
AccessMode.Sharing? | "none" | "readonly" | "onewriter" | "all" | 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. |
Group? | string | 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. |