# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
The FIXED_LENGTH value indicates that data ranges are returned in fixed size blocks.
No description provided by the author
The VARIABLE_LENGTH value indicates that data ranges are returned in potentially variable sized extents.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Plugins supporting volume cloning at the storage level MAY report this capability.
Currently the only way to consume a snapshot is to create a volume from it.
No description provided by the author
See VolumeExpansion for details.
No description provided by the author
Indicates the SP supports the ControllerGetVolume RPC.
No description provided by the author
No description provided by the author
Indicates the SP supports the ListVolumesResponse.entry.published_node_ids field and the ControllerGetVolumeResponse.published_node_ids field.
Indicates the SP supports modifying volume with mutable parameters.
Indicates the SP supports ControllerPublishVolume.readonly field.
No description provided by the author
Indicates the SP supports the SINGLE_NODE_SINGLE_WRITER and/or SINGLE_NODE_MULTI_WRITER access modes.
No description provided by the author
Indicates that the Controller service can report volume conditions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Indicates that the group controller plugin supports creating, deleting, and getting details of a volume group snapshot.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
See VolumeExpansion for details.
If Plugin implements GET_VOLUME_STATS capability then it MUST implement NodeGetVolumeStats RPC call for fetching volume statistics.
Indicates the SP supports the SINGLE_NODE_SINGLE_WRITER and/or SINGLE_NODE_MULTI_WRITER access modes.
No description provided by the author
No description provided by the author
Indicates that the Node service can report volume conditions.
Indicates that Node service supports mounting volumes with provided volume group identifier during node stage or node publish RPC calls.
CONTROLLER_SERVICE indicates that the Plugin provides RPCs for the ControllerService.
GROUP_CONTROLLER_SERVICE indicates that the Plugin provides RPCs for operating on groups of volumes.
SNAPSHOT_METADATA_SERVICE indicates that the Plugin provides RPCs to retrieve metadata on the allocated blocks of a single snapshot, or the changed blocks between a pair of snapshots of the same block volume.
No description provided by the author
VOLUME_ACCESSIBILITY_CONSTRAINTS indicates that the volumes for this plugin MAY NOT be equally accessible by all nodes in the cluster.
OFFLINE indicates that volumes currently published and available on a node SHALL NOT be expanded via ControllerExpandVolume.
ONLINE indicates that volumes may be expanded when published to a node.
No description provided by the author
No description provided by the author
No description provided by the author
Can be published as read/write at multiple nodes simultaneously.
Can be published as readonly at multiple nodes simultaneously.
Can be published at multiple nodes simultaneously.
Can be published as read/write at multiple workloads on a single node simultaneously.
Can only be published once as readonly on a single node, at any given time.
Can only be published once as read/write at a single workload on a single node, at any given time.
Can only be published once as read/write on a single node, at any given time.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
Enum value maps for BlockMetadataType.
Enum value maps for BlockMetadataType.
Controller_ServiceDesc is the grpc.ServiceDesc for Controller service.
Enum value maps for ControllerServiceCapability_RPC_Type.
Enum value maps for ControllerServiceCapability_RPC_Type.
Indicates that this enum is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this enum value is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this field is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this message is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this method is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that this service is OPTIONAL and part of an experimental API that may be deprecated and eventually removed between minor releases.
Indicates that a field MAY contain information that is sensitive and MUST be treated as such (e.g.
No description provided by the author
GroupController_ServiceDesc is the grpc.ServiceDesc for GroupController service.
Enum value maps for GroupControllerServiceCapability_RPC_Type.
Enum value maps for GroupControllerServiceCapability_RPC_Type.
Identity_ServiceDesc is the grpc.ServiceDesc for Identity service.
Node_ServiceDesc is the grpc.ServiceDesc for Node service.
Enum value maps for NodeServiceCapability_RPC_Type.
Enum value maps for NodeServiceCapability_RPC_Type.
Enum value maps for PluginCapability_Service_Type.
Enum value maps for PluginCapability_Service_Type.
Enum value maps for PluginCapability_VolumeExpansion_Type.
Enum value maps for PluginCapability_VolumeExpansion_Type.
SnapshotMetadata_ServiceDesc is the grpc.ServiceDesc for SnapshotMetadata service.
Enum value maps for VolumeCapability_AccessMode_Mode.
Enum value maps for VolumeCapability_AccessMode_Mode.
Enum value maps for VolumeUsage_Unit.
Enum value maps for VolumeUsage_Unit.
# Structs
BlockMetadata specifies a data range.
The capacity of the storage space in bytes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies a capability of the controller service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The GetMetadataAllocatedRequest message is used to solicit metadata on the allocated blocks of a snapshot: i.e.
GetMetadataAllocatedResponse messages are returned in a gRPC stream.
The GetMetadataDeltaRequest message is used to solicit metadata on the data ranges that have changed between two snapshots.
GetMetadataDeltaResponse messages are returned in a gRPC stream.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies a capability of the group controller service.
No description provided by the author
No description provided by the author
List all snapshots on the storage system regardless of how they were created.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies a capability of the node service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies a capability of the plugin.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Information about a specific snapshot.
Topology is a map of topological domains to topological segments.
No description provided by the author
UnimplementedControllerServer must be embedded to have forward compatible implementations.
UnimplementedGroupControllerServer must be embedded to have forward compatible implementations.
UnimplementedIdentityServer must be embedded to have forward compatible implementations.
UnimplementedNodeServer must be embedded to have forward compatible implementations.
UnimplementedSnapshotMetadataServer must be embedded to have forward compatible implementations.
No description provided by the author
No description provided by the author
No description provided by the author
Information about a specific volume.
Specify a capability of a volume.
Specify how a volume can be accessed.
No description provided by the author
Indicate that the volume will be accessed via the block device API.
No description provided by the author
Indicate that the volume will be accessed via the filesystem API.
VolumeCondition represents the current condition of a volume.
Specifies what source the volume will be created from.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
ControllerClient is the client API for Controller service.
ControllerServer is the server API for Controller service.
GroupControllerClient is the client API for GroupController service.
GroupControllerServer is the server API for GroupController service.
IdentityClient is the client API for Identity service.
IdentityServer is the server API for Identity service.
NodeClient is the client API for Node service.
NodeServer is the server API for Node service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SnapshotMetadataClient is the client API for SnapshotMetadata service.
SnapshotMetadataServer is the server API for SnapshotMetadata service.
UnsafeControllerServer may be embedded to opt out of forward compatibility for this service.
UnsafeGroupControllerServer may be embedded to opt out of forward compatibility for this service.
UnsafeIdentityServer may be embedded to opt out of forward compatibility for this service.
UnsafeNodeServer may be embedded to opt out of forward compatibility for this service.
UnsafeSnapshotMetadataServer may be embedded to opt out of forward compatibility for this service.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author