Amazon FSx for OpenZFS CSI Driver
Overview
The Amazon FSx for OpenZFS Container Storage Interface (CSI) Driver provides a CSI interface used by container orchestrators to manage the lifecycle of Amazon FSx for OpenZFS file systems and volumes.
Features
- Static Provisioning - Associate an externally-created FSx for OpenZFS file system or volume with a PersistentVolume (PV) for consumption within Kubernetes.
- Dynamic Provisioning - Automatically create FSx for OpenZFS file systems or volumes and associated PersistentVolumes (PV) from PersistentVolumeClaims (PVC). Parameters can be passed via a StorageClass for fine-grained control over volume creation.
- Mount Options - NFS Mount options can be specified in the PersistentVolume (PV) resource to define how the volume should be mounted.
- Volume Snapshots - Create and restore snapshots taken from a volume in Kubernetes. These snapshots can then be used to create new FSx for OpenZFS volumes.
- Volume Resizing - Expand an FSx for OpenZFS file system by specifying a new size in the PersistentVolumeClaim (PVC).
CSI Interfaces
- Controller Service: ControllerGetCapabilities, CreateVolume, DeleteVolume, CreateSnapshot, DeleteSnapshot, ControllerExpandVolume
- Node Service: NodePublishVolume, NodeUnpublishVolume, NodeGetCapabilities, NodeGetInfo, NodeGetId
- Identity Service: GetPluginInfo, GetPluginCapabilities, Probe
Container Images
| Driver Version | ECR Public Image |
|---|---|
| v1.1.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-openzfs-csi-driver:v1.1.0 |
Previous Images
| Driver Version | ECR Public Image |
|---|---|
| v1.0.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-openzfs-csi-driver:v1.0.0 |
| v0.1.0 (Beta) | public.ecr.aws/fsx-csi-driver/aws-fsx-openzfs-csi-driver:v0.1.0 |
Releases
The FSx for OpenZFS 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.
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 FSx for OpenZFS CSI Driver is compatible with Kubernetes versions v1.17+ and implements the CSI Specification v1.1.0.
Documentation
Please read the documentation below before using the FSx for OpenZFS CSI Driver.
- FAQ
- Driver Installation
- Driver Launch Options
- StorageClass Parameters
- Volume Tagging
- Guides and Examples
- Development and Contributing
License
This library is licensed under the Apache 2.0 License.