README
¶
Amazon Elastic Block Store (EBS) CSI driver
[!CAUTION]
[ACTION REQUIRED] Update to the EBS CSI Driver IAM Policy
Due to an upcoming change in handling of IAM polices for the CreateVolume API when creating a volume from an EBS snapshot, a change to your EBS CSI Driver policy may be needed. For more information and remediation steps, see GitHub issue #2190.
Overview
The Amazon Elastic Block Store Container Storage Interface (CSI) Driver provides a CSI interface used by Container Orchestrators to manage the lifecycle of Amazon EBS volumes.
Features
- Static Provisioning - Associate an externally-created EBS volume with a PersistentVolume (PV) for consumption within Kubernetes.
- Dynamic Provisioning - Automatically create EBS volumes and associated PersistentVolumes (PV) from PersistentVolumeClaims) (PVC). Parameters can be passed via a StorageClass for fine-grained control over volume creation.
- Mount Options - Mount options could be specified in the PersistentVolume (PV) resource to define how the volume should be mounted.
- NVMe Volumes - Consume NVMe volumes from EC2 Nitro instances.
- Block Volumes - Consume an EBS volume as a raw block device.
- Volume Snapshots - Create and restore snapshots taken from a volume in Kubernetes.
- Volume Resizing - Expand the volume by specifying a new size in the PersistentVolumeClaim (PVC).
- Volume Modification - Change the properties (type, iops, or throughput) via a
VolumeAttributesClass.
Container Images
| Driver Version | registry.k8s.io Image | ECR Public Image |
|---|---|---|
| v1.36.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.36.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.36.0 |
| v1.35.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.35.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.35.0 |
Releases
The EBS CSI Driver publishes monthly releases. Unscheduled releases may be published for patches to security vulnerabilities and other fixes deemed urgent.
The EBS CSI Driver follows semantic versioning. The version will be bumped following the rules below:
- Significant breaking changes will be released as a
MAJORupdate. - New features will be released as a
MINORupdate. - Bug or vulnerability fixes will be released as a
PATCHupdate.
Monthly releases will contain at minimum a MINOR version bump, even if the content would normally be treated as a PATCH version.
Support
Support will be provided for the latest version and one prior version. Bugs or vulnerabilities found in the latest version will be backported to the previous release in a new minor version.
This policy is non-binding and subject to change.
Compatibility
The EBS CSI Driver is compatible with all Kubernetes versions supported by the Kubernetes project and/or Amazon EKS (including extended support versions).
The EBS CSI Driver implements the Container Storage Interface specification version v1.9.0.
Documentation
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
batcher
Package batcher facilitates task aggregation and execution.
|
Package batcher facilitates task aggregation and execution. |
|
cloud
Package cloud is a generated GoMock package.
|
Package cloud is a generated GoMock package. |
|
cloud/metadata
Package metadata is a generated GoMock package.
|
Package metadata is a generated GoMock package. |
|
coalescer
Package coalescer combines multiple requests made over a period of time into a single request
|
Package coalescer combines multiple requests made over a period of time into a single request |
|
driver
Package driver is a generated GoMock package.
|
Package driver is a generated GoMock package. |
|
mounter
Package mounter is a generated GoMock package.
|
Package mounter is a generated GoMock package. |
|
tests
|
|