{"id":13720856,"url":"https://github.com/kubernetes-sigs/aws-fsx-csi-driver","last_synced_at":"2025-10-19T20:12:39.921Z","repository":{"id":33837381,"uuid":"161854186","full_name":"kubernetes-sigs/aws-fsx-csi-driver","owner":"kubernetes-sigs","description":"CSI Driver of Amazon FSx for Lustre https://aws.amazon.com/fsx/lustre/","archived":false,"fork":false,"pushed_at":"2024-09-24T12:04:00.000Z","size":13517,"stargazers_count":125,"open_issues_count":17,"forks_count":79,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-09-29T20:29:56.738Z","etag":null,"topics":["aws","csi","fsx","k8s-sig-aws","kubernetes"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kubernetes-sigs.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG-0.x.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY_CONTACTS","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-15T00:16:28.000Z","updated_at":"2024-09-24T12:04:05.000Z","dependencies_parsed_at":"2024-05-01T17:48:16.005Z","dependency_job_id":"b349ce05-52eb-4daf-9fa3-5752aabf5ffc","html_url":"https://github.com/kubernetes-sigs/aws-fsx-csi-driver","commit_stats":{"total_commits":328,"total_committers":45,"mean_commits":7.288888888888889,"dds":0.7012195121951219,"last_synced_commit":"bea5a265aeb0fb5f8594da1a47d22b0bc2cde4d4"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubernetes-sigs%2Faws-fsx-csi-driver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubernetes-sigs%2Faws-fsx-csi-driver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubernetes-sigs%2Faws-fsx-csi-driver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubernetes-sigs%2Faws-fsx-csi-driver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kubernetes-sigs","download_url":"https://codeload.github.com/kubernetes-sigs/aws-fsx-csi-driver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224604591,"owners_count":17339166,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","csi","fsx","k8s-sig-aws","kubernetes"],"created_at":"2024-08-03T01:01:08.869Z","updated_at":"2025-10-19T20:12:39.914Z","avatar_url":"https://github.com/kubernetes-sigs.png","language":"Go","funding_links":[],"categories":["Roadmap","Storage","Tools and Libraries","Featured On"],"sub_categories":["[Tutorials](#tutorials)","Storage"],"readme":"[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kubernetes-sigs/aws-fsx-csi-driver)](https://github.com/kubernetes-sigs/aws-fsx-csi-driver/releases)\n[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes-sigs/aws-fsx-csi-driver)](https://goreportcard.com/report/github.com/kubernetes-sigs/aws-fsx-csi-driver)\n\n## Amazon FSx for Lustre CSI Driver\n### Overview\n\nThe [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.\n\n### Troubleshooting\nFor help with troubleshooting, please refer to our [troubleshooting doc](https://github.com/kubernetes-sigs/aws-fsx-csi-driver/blob/master/docs/troubleshooting.md).\n\n### Installation\nFor installation and deployment instructions, please refer to our [installation doc](https://github.com/kubernetes-sigs/aws-fsx-csi-driver/blob/master/docs/install.md)\n\n### CSI Specification Compatibility Matrix\n| AWS FSx for Lustre CSI Driver \\ CSI Version | v0.3.0 | v1.x.x |\n|---------------------------------------------|--------|--------|\n| v1.6.0 | no | yes |\n| v1.5.0 | no | yes |\n| v1.4.0 | no | yes |\n| v1.3.0 | no | yes |\n| v1.2.0 | no | yes |\n| v1.1.0 | no | yes |\n| v1.0.0 | no | yes |\n| v0.10.1 | no | yes |\n| v0.10.0 | no | yes |\n| v0.9.0 | no | yes |\n| v0.8.3 | no | yes |\n| v0.8.2 | no | yes |\n| v0.8.1 | no | yes |\n| v0.8.0 | no | yes |\n| v0.7.1 | no | yes |\n| v0.7.0 | no | yes |\n| v0.6.0 | no | yes |\n| v0.5.0 | no | yes |\n| v0.4.0 | no | yes |\n| v0.3.0 | no | yes |\n| v0.2.0 | no | yes |\n| v0.1.0 | yes | no |\n\n### Features\nThe following CSI interfaces are implemented:\n* Controller Service: CreateVolume, DeleteVolume, ControllerExpandVolume, ControllerGetCapabilities, ValidateVolumeCapabilities\n* Node Service: NodePublishVolume, NodeUnpublishVolume, NodeGetCapabilities, NodeGetInfo, NodeGetId\n* Identity Service: GetPluginInfo, GetPluginCapabilities, Probe\n\n## FSx for Lustre CSI Driver on Kubernetes\nThe following sections are Kubernetes-specific. If you are a Kubernetes user, use the following for driver features, installation steps and examples.\n\n### Kubernetes Version Compatibility Matrix\n| AWS FSx for Lustre CSI Driver \\ Kubernetes Version | v1.11 | v1.12 | v1.13 | v1.14-16 | v1.17+ |\n|----------------------------------------------------|-------|-------|-------|----------|--------|\n| v1.6.0 | no | no | no | no | yes |\n| v1.5.0 | no | no | no | no | yes |\n| v1.4.0 | no | no | no | no | yes |\n| v1.3.0 | no | no | no | no | yes |\n| v1.2.0 | no | no | no | no | yes |\n| v1.1.0 | no | no | no | no | yes |\n| v1.0.0 | no | no | no | no | yes |\n| v0.10.1 | no | no | no | no | yes |\n| v0.10.0 | no | no | no | no | yes |\n| v0.9.0 | no | no | no | no | yes |\n| v0.8.3 | no | no | no | no | yes |\n| v0.8.2 | no | no | no | no | yes |\n| v0.8.1 | no | no | no | no | yes |\n| v0.8.0 | no | no | no | no | yes |\n| v0.7.1 | no | no | no | no | yes |\n| v0.7.0 | no | no | no | no | yes |\n| v0.6.0 | no | no | no | no | yes |\n| v0.5.0 | no | no | no | no | yes |\n| v0.4.0 | no | no | no | yes | yes |\n| v0.3.0 | no | no | no | yes | yes |\n| v0.2.0 | no | no | no | yes | yes |\n| v0.1.0 | yes | yes | yes | no | no |\n\n### Container Images\n| FSx CSI Driver Version | Image |\n|------------------------|----------------------------------------------------------|\n| v1.6.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.6.0 |\n| v1.5.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.5.0 |\n| v1.4.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.4.0 |\n| v1.3.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.3.0 |\n| v1.2.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.2.0 |\n| v1.1.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.1.0 |\n| v1.0.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v1.0.0 |\n| v0.10.1 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.10.1 |\n| v0.10.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.10.0 |\n| v0.9.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.9.0 |\n| v0.8.3 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.8.3 |\n| v0.8.2 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.8.2 |\n| v0.8.1 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.8.1 |\n| v0.8.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.8.0 |\n| v0.7.1 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.7.1 |\n| v0.7.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.7.0 |\n| v0.6.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.6.0 |\n| v0.5.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.5.0 |\n| v0.4.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.4.0 |\n| v0.3.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.3.0 |\n| v0.2.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.2.0 |\n| v0.1.0 | public.ecr.aws/fsx-csi-driver/aws-fsx-csi-driver:v0.1.0 |\n\n### Features\n* 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.\n* 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.\n* Mount options - mount options can be specified in storageclass to define how the volume should be mounted.\n\n**Notes**:\n* 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.\n\n### Examples\nBefore the example, you need to:\n* 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.\n* 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.\n * For FSx for Lustre VPC, you can either create FSx for lustre filesystem inside the same VPC as Kubernetes cluster or using VPC peering.\n * For security group, make sure port 988 is allowed for the security groups that are attached the lustre filesystem ENI.\n* Install FSx for Lustre CSI driver following the [Installation](README.md#Installation) steps.\n\n#### Example links\n* [Static provisioning](../examples/kubernetes/static_provisioning/README.md)\n* [Dynamic provisioning](../examples/kubernetes/dynamic_provisioning/README.md)\n* [Dynamic provisioning with S3 integration](../examples/kubernetes/dynamic_provisioning_s3/README.md)\n* [Accessing the filesystem from multiple pods](../examples/kubernetes/multiple_pods/README.md)\n\n## Development\nPlease 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.\n\n### Requirements\n* Golang 1.23.0+\n\n### Dependency\nDependencies are managed through go module. To build the project, first turn on go mod using `export GO111MODULE=on`, to build the project run: `make`\n\n### Testing\n* To execute all unit tests, run: `make test`\n* To execute sanity tests, run: `make test-sanity`\n* To execute e2e tests, run: `make test-e2e`\n\n## License\nThis library is licensed under the Apache 2.0 License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubernetes-sigs%2Faws-fsx-csi-driver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubernetes-sigs%2Faws-fsx-csi-driver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubernetes-sigs%2Faws-fsx-csi-driver/lists"}