/ 
API-Docker-0.004
/ API::Docker::Type::ClusterVolumeSpec::AccessMode

NAME

API::Docker::Type::ClusterVolumeSpec::AccessMode - Defines how the volume is used by tasks

VERSION

version 0.004

DESCRIPTION

Generated from the inline AccessMode schema of the ClusterVolumeSpec definition in spec/v1.51.yaml.

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.

The daemon defaults it to single.

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.

The daemon defaults it to none.

mount_volume

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. See API::Docker::Type::ClusterVolumeSpec::AccessMode::Secret.

accessibility_requirements

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. See API::Docker::Type::ClusterVolumeSpec::AccessMode::AccessibilityRequirements.

capacity_range

The desired capacity that the volume should be created with. If empty, the plugin will decide the capacity. See API::Docker::Type::ClusterVolumeSpec::AccessMode::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.

The daemon defaults it to active.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.