driver

const (
	// DevicePathKey represents key for device path in PublishContext
	// devicePath is the device path where the volume is attached to.
	DevicePathKey = "devicePath"
	// VolumeIDKey represents key for volume ID in PublishContext
	// Used for node-local volumes to pass the real volume ID.
	VolumeIDKey = "volumeID"
)

const (
	// VolumeTypeKey represents key for volume type.
	VolumeTypeKey = "type"

	// IopsPerGBKey represents key for IOPS per GB.
	IopsPerGBKey = "iopspergb"

	// AllowAutoIOPSPerGBIncreaseKey represents key for allowing automatic increase of IOPS.
	AllowAutoIOPSPerGBIncreaseKey = "allowautoiopspergbincrease"

	// AllowAutoIOPSIncreaseOnModifyKey represents key for allowing IOPS increase on resizing if IopsPerGB is set to ensure desired ratio is maintained.
	AllowAutoIOPSIncreaseOnModifyKey = "allowautoiopsincreaseonmodify"

	// VolumeInitializationRateKey represents key for volume initialization rate when creating volumes from snapshots.
	VolumeInitializationRateKey = "volumeinitializationrate"

	// IopsKey represents key for IOPS for volume.
	IopsKey = "iops"

	// ThroughputKey represents key for throughput.
	ThroughputKey = "throughput"

	// EncryptedKey represents key for whether filesystem is encrypted.
	EncryptedKey = "encrypted"

	// KmsKeyIDKey represents key for KMS encryption key.
	KmsKeyIDKey = "kmskeyid"

	// PVCNameKey contains name of the PVC for which is a volume provisioned.
	PVCNameKey = "csi.storage.k8s.io/pvc/name"

	// PVCNamespaceKey contains namespace of the PVC for which is a volume provisioned.
	PVCNamespaceKey = "csi.storage.k8s.io/pvc/namespace"

	// PVNameKey contains name of the final PV that will be used for the dynamically
	// provisioned volume.
	PVNameKey = "csi.storage.k8s.io/pv/name"

	// VolumeSnapshotNameKey contains name of the snapshot.
	VolumeSnapshotNameKey = "csi.storage.k8s.io/volumesnapshot/name"

	// VolumeSnapshotNamespaceKey contains namespace of the snapshot.
	VolumeSnapshotNamespaceKey = "csi.storage.k8s.io/volumesnapshot/namespace"

	// VolumeSnapshotContentNameKey contains name of the VolumeSnapshotContent that is the source
	// for the snapshot.
	VolumeSnapshotContentNameKey = "csi.storage.k8s.io/volumesnapshotcontent/name"

	// DeprecatedBlockExpressKey was previously `BlockExpressKey` now deprecated as all io2 volumes now support up to 256,000 IOPS.
	// See https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html.
	DeprecatedBlockExpressKey = "blockexpress"

	// FSTypeKey configures the file system type that will be formatted during volume creation.
	FSTypeKey = "csi.storage.k8s.io/fstype"

	// BlockSizeKey configures the block size when formatting a volume.
	BlockSizeKey = "blocksize"

	// InodeSizeKey configures the inode size when formatting a volume.
	InodeSizeKey = "inodesize"

	// BytesPerInodeKey configures the `bytes-per-inode` when formatting a volume.
	BytesPerInodeKey = "bytesperinode"

	// NumberOfInodesKey configures the `number-of-inodes` when formatting a volume.
	NumberOfInodesKey = "numberofinodes"

	// Ext4BigAllocKey enables the bigalloc option when formatting an ext4 volume.
	Ext4BigAllocKey = "ext4bigalloc"

	// Ext4ClusterSizeKey configures the cluster size when formatting an ext4 volume with the bigalloc option enabled.
	Ext4ClusterSizeKey = "ext4clustersize"

	// Ext4EncryptionSupportKey enables the encrypt option when formatting an ext4 volume.
	Ext4EncryptionSupportKey = "ext4encryptionsupport"

	// TagKeyPrefix contains the prefix of a volume parameter that designates it as
	// a tag to be attached to the resource.
	TagKeyPrefix = "tagSpecification"

	// OutpostArnKey represents key for outpost's arn.
	OutpostArnKey = "outpostarn"

	// BlockAttachUntilInitializedKey will prevent restored volume from being attached until it is fully initialized.
	BlockAttachUntilInitializedKey = "blockattachuntilinitialized"
)

const (
	// FastSnapshotRestoreAvailabilityZones represents key for fast snapshot restore availability zones.
	FastSnapshotRestoreAvailabilityZones = "fastsnapshotrestoreavailabilityzones"

	// LockMode represents a key for indicating whether snapshots are locked in Governance or Compliance mode.
	LockMode = "lockmode"

	// LockDuration is a key for the duration for which to lock the snapshots, specified in days.
	LockDuration = "lockduration"

	// LockExpirationDate is a key for specifying the expiration date for the snapshot lock, specified in the format "YYYY-MM-DDThh:mm:ss.sssZ".
	LockExpirationDate = "lockexpirationdate"

	// LockCoolOffPeriod is a key specifying the cooling-off period for compliance mode, specified in hours.
	LockCoolOffPeriod = "lockcooloffperiod"
)

const (
	// ResourceLifecycleTagPrefix is prefix of tag for provisioned EBS volume that
	// marks them as owned by the cluster. Used only when --cluster-id is set.
	ResourceLifecycleTagPrefix = "kubernetes.io/cluster/"

	// ResourceLifecycleOwned is the value we use when tagging resources to indicate
	// that the resource is considered owned and managed by the cluster,
	// and in particular that the lifecycle is tied to the lifecycle of the cluster.
	// From k8s.io/legacy-cloud-providers/aws/tags.go.
	ResourceLifecycleOwned = "owned"

	// NameTag is tag applied to provisioned EBS volume for backward compatibility with
	// in-tree volume plugin. Used only when --cluster-id is set.
	NameTag = "Name"

	// KubernetesClusterTag is tag applied to provisioned EBS volume for backward compatibility with
	// in-tree volume plugin. Used only when --cluster-id is set.
	// See https://github.com/kubernetes/cloud-provider-aws/blob/release-1.20/pkg/providers/v1/tags.go#L38-L41.
	KubernetesClusterTag = "KubernetesCluster"

	// PVCNameTag is tag applied to provisioned EBS volume for backward compatibility
	// with in-tree volume plugin. Value of the tag is PVC name. It is applied only when
	// the external provisioner sidecar is started with --extra-create-metadata=true and
	// thus provides such metadata to the CSI driver.
	PVCNameTag = "kubernetes.io/created-for/pvc/name"

	// PVCNamespaceTag is tag applied to provisioned EBS volume for backward compatibility
	// with in-tree volume plugin. Value of the tag is PVC namespace. It is applied only when
	// the external provisioner sidecar is started with --extra-create-metadata=true and
	// thus provides such metadata to the CSI driver.
	PVCNamespaceTag = "kubernetes.io/created-for/pvc/namespace"

	// PVNameTag is tag applied to provisioned EBS volume for backward compatibility
	// with in-tree volume plugin. Value of the tag is PV name. It is applied only when
	// the external provisioner sidecar is started with --extra-create-metadata=true and
	// thus provides such metadata to the CSI driver.
	PVNameTag = "kubernetes.io/created-for/pv/name"
)

const (
	DefaultCSIEndpoint                       = "unix://tmp/csi.sock"
	DefaultModifyVolumeRequestHandlerTimeout = 2 * time.Second
)

const (
	// FSTypeExt3 represents the ext3 filesystem type.
	FSTypeExt3 = "ext3"
	// FSTypeExt4 represents the ext4 filesystem type.
	FSTypeExt4 = "ext4"
	// FSTypeXfs represents the xfs filesystem type.
	FSTypeXfs = "xfs"
	// FSTypeNtfs represents the ntfs filesystem type.
	FSTypeNtfs = "ntfs"
)

const (
	SingleNodeWriter     = csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER
	MultiNodeMultiWriter = csi.VolumeCapability_AccessMode_MULTI_NODE_MULTI_WRITER
)

const (
	ModificationKeyVolumeType = "type"
	// DeprecatedModificationKeyVolumeType is retained for backwards compatibility, but not recommended.
	DeprecatedModificationKeyVolumeType = "volumeType"

	ModificationKeyIOPS = "iops"

	ModificationKeyThroughput = "throughput"

	ModificationAddTag = "tagSpecification"

	ModificationDeleteTag = "tagDeletion"
)

const (
	WellKnownZoneTopologyKey = "topology.kubernetes.io/zone"
	// ZoneIDTopologyKey name is purposefully consistent with the CCM's ZoneID topology key.
	// This key is only used for provisioning by az-id and will not be used for node topology
	// to prevent any backwards compatibility issues.
	ZoneIDTopologyKey = "topology.k8s.aws/zone-id"
	OSTopologyKey     = "kubernetes.io/os"
)

const (
	// NodeLocalVolumeHandlePrefix is the prefix for node-local volume handles.
	NodeLocalVolumeHandlePrefix = "local-ebs://"
)

const (
	// VolumeAttributePartition represents key for partition config in VolumeContext
	// this represents the partition number on a device used to mount.
	VolumeAttributePartition = "partition"
)

const (

	// VolumeOperationAlreadyExists is message fmt returned to CO when there is another in-flight call on the given volumeID.
	VolumeOperationAlreadyExists = "An operation with the given volume=%q is already in progress"
)