-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
32 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,40 @@ | ||
## Amazon S3 CSI Driver [WIP] | ||
# Mountpoint for Amazon S3 CSI Driver [WIP] | ||
|
||
## NOTE: THIS PRODUCT IS UNDER DEVELOPMENT | ||
## Overview | ||
The [Mountpoint for Amazon S3](https://github.com/awslabs/mountpoint-s3) 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 S3 filesystems. [S3](https://aws.amazon.com/s3/) iteslf is a cloud storage service and this CSI driver specifically uses Mountpoint to mount S3 as a filesystem. | ||
|
||
### Overview | ||
The [S3](https://aws.amazon.com/s3/) 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 S3 filesystems. S3 iteslf is a cloud storage service and this CSI driver specifically uses [Mountpoint](https://github.com/awslabs/mountpoint-s3) to mount S3 as a filesystem. | ||
## Features | ||
* **Static Provisioning** - Associate an externally-created S3 bucket with a [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (PV) for consumption within Kubernetes. | ||
* **Mount Options** - Mount options can be specified in the PersistentVolume (PV) resource to define how the volume should be mounted. For Mountpoint for S3 specific options, take a look at the Mountpoint docs for [configuration](https://github.com/awslabs/mountpoint-s3/blob/main/doc/CONFIGURATION.md) and [semantics](https://github.com/awslabs/mountpoint-s3/blob/main/doc/SEMANTICS.md). | ||
|
||
## Container Images [WIP] | ||
| Driver Version | [ECR Public](https://gallery.ecr.aws/mountpoint-s3-csi-driver/aws-mountpoint-s3-csi-driver) Image | | ||
|----------------|---------------------------------------------------------------------------------------------------| | ||
| v0.1.0 | public.ecr.aws/mountpoint-s3-csi-driver/aws-mountpoint-s3-csi-driver:v0.1.0 | | ||
|
||
## Security | ||
|
||
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. | ||
## Releases | ||
The Mountpoint for S3 CSI Driver follows [semantic versioning](https://semver.org/). The version will be bumped following the rules below: | ||
|
||
## License | ||
* 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. | ||
|
||
This project is licensed under the Apache-2.0 License. | ||
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 Mountpoint for S3 CSI Driver is compatible with Kubernetes versions v1.20+ and implements the CSI Specification v1.8.0. | ||
|
||
## Documentation | ||
|
||
* [Driver Installation](docs/install.md) | ||
* [Kubernetes Static Provisionin Example](/examples/kubernetes/static_provisioning) | ||
* [Driver Uninstallation](docs/install.md#uninstalling-the-driver) | ||
* [Development and Contributing](CONTRIBUTING.md) |