ClusterVolumeSpecAccessMode

@Serializable
data class ClusterVolumeSpecAccessMode(val scope: ClusterVolumeSpecAccessMode.Scope? = Scope.SINGLE, val sharing: ClusterVolumeSpecAccessMode.Sharing? = Sharing.NONE, val mountVolume: JsonObject? = null, val secrets: List<ClusterVolumeSpecAccessModeSecretsInner>? = null, val accessibilityRequirements: ClusterVolumeSpecAccessModeAccessibilityRequirements? = null, val capacityRange: ClusterVolumeSpecAccessModeCapacityRange? = null, val availability: ClusterVolumeSpecAccessMode.Availability? = Availability.ACTIVE)

Defines how the volume is used by tasks.

Parameters

scope

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.

sharing

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.

mountVolume

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

Swarm Secrets that are passed to the CSI storage plugin when operating on this volume.

accessibilityRequirements
capacityRange
availability

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.

Constructors

Link copied to clipboard
constructor(scope: ClusterVolumeSpecAccessMode.Scope? = Scope.SINGLE, sharing: ClusterVolumeSpecAccessMode.Sharing? = Sharing.NONE, mountVolume: JsonObject? = null, secrets: List<ClusterVolumeSpecAccessModeSecretsInner>? = null, accessibilityRequirements: ClusterVolumeSpecAccessModeAccessibilityRequirements? = null, capacityRange: ClusterVolumeSpecAccessModeCapacityRange? = null, availability: ClusterVolumeSpecAccessMode.Availability? = Availability.ACTIVE)

Types

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Properties

Link copied to clipboard
@SerialName(value = "AccessibilityRequirements")
val accessibilityRequirements: ClusterVolumeSpecAccessModeAccessibilityRequirements?
Link copied to clipboard
@SerialName(value = "Availability")
val availability: ClusterVolumeSpecAccessMode.Availability?
Link copied to clipboard
@SerialName(value = "CapacityRange")
val capacityRange: ClusterVolumeSpecAccessModeCapacityRange?
Link copied to clipboard
@SerialName(value = "MountVolume")
val mountVolume: JsonObject?
Link copied to clipboard
@SerialName(value = "Scope")
val scope: ClusterVolumeSpecAccessMode.Scope?
Link copied to clipboard
@SerialName(value = "Secrets")
val secrets: List<ClusterVolumeSpecAccessModeSecretsInner>?
Link copied to clipboard
@SerialName(value = "Sharing")
val sharing: ClusterVolumeSpecAccessMode.Sharing?