Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/kubernetes-sigs/aws-ebs-csi-driver

CSI driver for Amazon EBS https://aws.amazon.com/ebs/
https://github.com/kubernetes-sigs/aws-ebs-csi-driver

aws csi ebs k8s-sig-aws kubernetes

Last synced: about 2 months ago
JSON representation

CSI driver for Amazon EBS https://aws.amazon.com/ebs/

Lists

README

        

# Amazon Elastic Block Store (EBS) CSI driver
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kubernetes-sigs/aws-ebs-csi-driver)](https://github.com/kubernetes-sigs/aws-ebs-csi-driver/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes-sigs/aws-ebs-csi-driver)](https://goreportcard.com/report/github.com/kubernetes-sigs/aws-ebs-csi-driver)

## Overview

The [Amazon Elastic Block Store](https://aws.amazon.com/ebs/) Container Storage Interface (CSI) Driver provides a [CSI](https://github.com/container-storage-interface/spec/blob/master/spec.md) 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](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (PV) for consumption within Kubernetes.
* **Dynamic Provisioning** - Automatically create EBS volumes and associated [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (PV) from [PersistentVolumeClaims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#dynamic)) (PVC). Parameters can be passed via a [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/#the-storageclass-resource) for fine-grained control over volume creation.
* **Mount Options** - Mount options could be specified in the [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (PV) resource to define how the volume should be mounted.
* **NVMe Volumes** - Consume [NVMe](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nvme-ebs-volumes.html) volumes from EC2 [Nitro instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances).
* **Block Volumes** - Consume an EBS volume as a [raw block device](https://kubernetes-csi.github.io/docs/raw-block.html).
* **Volume Snapshots** - Create and restore [snapshots](https://kubernetes.io/docs/concepts/storage/volume-snapshots/) taken from a volume in Kubernetes.
* **Volume Resizing** - Expand the volume by specifying a new size in the [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#expanding-persistent-volumes-claims) (PVC).

## Container Images

| Driver Version | [registry.k8s.io](https://kubernetes.io/blog/2022/11/28/registry-k8s-io-faster-cheaper-ga/) Image | [ECR Public](https://gallery.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver) Image |
|----------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| v1.27.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.27.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.27.0 |

Previous Images

| Driver Version | [registry.k8s.io](https://kubernetes.io/blog/2022/11/28/registry-k8s-io-faster-cheaper-ga/) Image | [ECR Public](https://gallery.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver) Image |
|----------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| v1.26.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.26.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.26.1 |
| v1.26.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.26.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.26.0 |
| v1.25.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.25.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.25.0 |
| v1.24.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.24.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.24.1 |
| v1.24.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.24.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.24.0 |
| v1.23.2 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.23.2 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.23.2 |
| v1.23.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.23.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.23.1 |
| v1.23.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.23.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.23.0 |
| v1.22.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.22.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.22.1 |
| v1.22.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.22.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.22.0 |
| v1.21.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.21.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.21.0 |
| v1.20.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.20.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.20.0 |
| v1.19.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.19.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.19.0 |
| v1.18.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.18.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.18.0 |
| v1.17.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.17.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.17.0 |
| v1.16.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.16.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.16.1 |
| v1.16.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.16.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.16.0 |
| v1.15.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.15.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.15.1 |
| v1.15.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.15.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.15.0 |
| v1.14.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.14.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.14.1 |
| v1.14.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.14.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.14.0 |
| v1.13.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.13.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.13.0 |
| v1.12.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.12.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.12.1 |
| v1.12.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.12.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.12.0 |
| v1.11.5 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.11.5 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.11.5 |
| v1.11.4 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.11.4 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.11.4 |
| v1.11.3 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.11.3 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.11.3 |
| v1.11.2 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.11.2 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.11.2 |
| v1.10.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.10.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.10.0 |
| v1.9.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.9.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.9.0 |
| v1.8.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.8.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.8.0 |
| v1.7.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.7.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.7.0 |
| v1.6.2 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.6.2 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.6.2 |
| v1.6.1 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.6.1 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.6.1 |
| v1.6.0 | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.6.0 | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.6.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](https://semver.org/). The version will be bumped following the rules below:

* Significant breaking changes will be released as a `MAJOR` update.
* New features will be released as a `MINOR` update.
* Bug or vulnerability fixes will be released as a `PATCH` update.

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 Kubernetes versions v1.17+ and implements the CSI Specification v1.1.0.

## Documentation

* [Driver Installation](docs/install.md)
* [Driver Launch Options](docs/options.md)
* [StorageClass Parameters](docs/parameters.md)
* [Frequently Asked Questions](docs/faq.md)
* [Volume Tagging](docs/tagging.md)
* [Volume Modification](docs/modify-volume.md)
* [Kubernetes Examples](/examples/kubernetes)
* [Driver Uninstallation](docs/install.md#uninstalling-the-ebs-csi-driver)
* [Development and Contributing](CONTRIBUTING.md)