Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kubernetes-sigs/aws-fsx-csi-driver
CSI Driver of Amazon FSx for Lustre https://aws.amazon.com/fsx/lustre/
https://github.com/kubernetes-sigs/aws-fsx-csi-driver
aws csi fsx k8s-sig-aws kubernetes
Last synced: 29 days ago
JSON representation
CSI Driver of Amazon FSx for Lustre https://aws.amazon.com/fsx/lustre/
- Host: GitHub
- URL: https://github.com/kubernetes-sigs/aws-fsx-csi-driver
- Owner: kubernetes-sigs
- License: apache-2.0
- Created: 2018-12-15T00:16:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T12:04:00.000Z (3 months ago)
- Last Synced: 2024-09-29T20:29:56.738Z (2 months ago)
- Topics: aws, csi, fsx, k8s-sig-aws, kubernetes
- Language: Go
- Homepage:
- Size: 12.9 MB
- Stars: 125
- Watchers: 13
- Forks: 79
- Open Issues: 17
-
Metadata Files:
- Readme: docs/README.md
- Changelog: CHANGELOG-0.x.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
- Security: SECURITY_CONTACTS
Awesome Lists containing this project
- awesome-eks - Amazon FSx for Lustre CSI driver
README
[](https://github.com/kubernetes-sigs/aws-fsx-csi-driver/releases)
[](https://goreportcard.com/report/github.com/kubernetes-sigs/aws-fsx-csi-driver)
## Amazon FSx for Lustre CSI Driver
### Overview
The [Amazon FSx for Lustre](https://aws.amazon.com/fsx/lustre/) Container Storage Interface (CSI) Driver implements [CSI](https://github.com/container-storage-interface/spec/blob/master/spec.md) specification for container orchestrators (CO) to manage lifecycle of Amazon FSx for Lustre filesystems.
### Troubleshooting
For help with troubleshooting, please refer to our [troubleshooting doc](https://github.com/kubernetes-sigs/aws-fsx-csi-driver/blob/master/docs/troubleshooting.md).
### Installation
For installation and deployment instructions, please refer to our [installation doc](https://github.com/kubernetes-sigs/aws-fsx-csi-driver/blob/master/docs/install.md)
### CSI Specification Compatibility Matrix
| AWS FSx for Lustre CSI Driver \ CSI Version | v0.3.0 | v1.x.x |
|---------------------------------------------|--------|--------|
| v1.2.0 | no | yes |
| v1.1.0 | no | yes |
| v1.0.0 | no | yes |
| v0.10.1 | no | yes |
| v0.10.0 | no | yes |
| v0.9.0 | no | yes |
| v0.8.3 | no | yes |
| v0.8.2 | no | yes |
| v0.8.1 | no | yes |
| v0.8.0 | no | yes |
| v0.7.1 | no | yes |
| v0.7.0 | no | yes |
| v0.6.0 | no | yes |
| v0.5.0 | no | yes |
| v0.4.0 | no | yes |
| v0.3.0 | no | yes |
| v0.2.0 | no | yes |
| v0.1.0 | yes | no |
### Features
The following CSI interfaces are implemented:
* Controller Service: CreateVolume, DeleteVolume, ControllerExpandVolume, ControllerGetCapabilities, ValidateVolumeCapabilities
* Node Service: NodePublishVolume, NodeUnpublishVolume, NodeGetCapabilities, NodeGetInfo, NodeGetId
* Identity Service: GetPluginInfo, GetPluginCapabilities, Probe
## FSx for Lustre CSI Driver on Kubernetes
The following sections are Kubernetes-specific. If you are a Kubernetes user, use the following for driver features, installation steps and examples.
### Kubernetes Version Compatibility Matrix
| AWS FSx for Lustre CSI Driver \ Kubernetes Version | v1.11 | v1.12 | v1.13 | v1.14-16 | v1.17+ |
|----------------------------------------------------|-------|-------|-------|----------|--------|
| v1.2.0 | no | no | no | no | yes |
| v1.1.0 | no | no | no | no | yes |
| v1.0.0 | no | no | no | no | yes |
| v0.10.1 | no | no | no | no | yes |
| v0.10.0 | no | no | no | no | yes |
| v0.9.0 | no | no | no | no | yes |
| v0.8.3 | no | no | no | no | yes |
| v0.8.2 | no | no | no | no | yes |
| v0.8.1 | no | no | no | no | yes |
| v0.8.0 | no | no | no | no | yes |
| v0.7.1 | no | no | no | no | yes |
| v0.7.0 | no | no | no | no | yes |
| v0.6.0 | no | no | no | no | yes |
| v0.5.0 | no | no | no | no | yes |
| v0.4.0 | no | no | no | yes | yes |
| v0.3.0 | no | no | no | yes | yes |
| v0.2.0 | no | no | no | yes | yes |
| v0.1.0 | yes | yes | yes | no | no |
### Container Images
| FSx CSI Driver Version | Image |
|------------------------|----------------------------------------------------------|
| v1.2.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.2.0 |
| v1.1.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.1.0 |
| v1.0.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.0.0 |
| v0.10.1 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.10.1 |
| v0.10.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.10.0 |
| v0.9.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.9.0 |
| v0.8.3 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.8.3 |
| v0.8.2 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.8.2 |
| v0.8.1 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.8.1 |
| v0.8.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.8.0 |
| v0.7.1 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.7.1 |
| v0.7.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.7.0 |
| v0.6.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.6.0 |
| v0.5.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.5.0 |
| v0.4.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.4.0 |
| v0.3.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.3.0 |
| v0.2.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.2.0 |
| v0.1.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.1.0 |
### Features
* Static provisioning - FSx for Lustre file system needs to be created manually first, then it could be mounted inside container as a volume using the Driver.
* Dynamic provisioning - uses persistent volume claim (PVC) to let Kubernetes create the FSx for Lustre filesystem for you and consumes the volume from inside container.
* Mount options - mount options can be specified in storageclass to define how the volume should be mounted.
**Notes**:
* For dynamically provisioned volumes, only one subnet is allowed inside a storageclass's `parameters.subnetId`. This is a [limitation](https://docs.aws.amazon.com/fsx/latest/APIReference/API_CreateFileSystem.html#FSx-CreateFileSystem-request-SubnetIds) that is enforced by FSx for Lustre.
### Examples
Before the example, you need to:
* Get yourself familiar with how to setup Kubernetes on AWS and [create FSx for Lustre filesystem](https://docs.aws.amazon.com/fsx/latest/LustreGuide/getting-started.html#getting-started-step1) if you are using static provisioning.
* When creating FSx for Lustre file system, make sure its VPC is accessible from Kuberenetes cluster's VPC and network traffic is allowed by security group.
* For FSx for Lustre VPC, you can either create FSx for lustre filesystem inside the same VPC as Kubernetes cluster or using VPC peering.
* For security group, make sure port 988 is allowed for the security groups that are attached the lustre filesystem ENI.
* Install FSx for Lustre CSI driver following the [Installation](README.md#Installation) steps.
#### Example links
* [Static provisioning](../examples/kubernetes/static_provisioning/README.md)
* [Dynamic provisioning](../examples/kubernetes/dynamic_provisioning/README.md)
* [Dynamic provisioning with S3 integration](../examples/kubernetes/dynamic_provisioning_s3/README.md)
* [Accessing the filesystem from multiple pods](../examples/kubernetes/multiple_pods/README.md)
## Development
Please go through [CSI Spec](https://github.com/container-storage-interface/spec/blob/master/spec.md) and [General CSI driver development guideline](https://kubernetes-csi.github.io/docs/Development.html) to get some basic understanding of CSI driver before you start.
### Requirements
* Golang 1.21.0+
### Dependency
Dependencies are managed through go module. To build the project, first turn on go mod using `export GO111MODULE=on`, to build the project run: `make`
### Testing
* To execute all unit tests, run: `make test`
* To execute sanity tests, run: `make test-sanity`
* To execute e2e tests, run: `make test-e2e`
## License
This library is licensed under the Apache 2.0 License.