Skip to content

Commit

Permalink
v1.0.0 docs (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
dlakhaws committed Nov 16, 2023
1 parent 97cac13 commit 1cda403
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
10 changes: 6 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# v0.1.0alpha
[Documentation](https://github.com/awslabs/aws-s3-csi-driver/blob/v0.0.1alpha/README.md)
# v1.0.0
[Documentation](https://github.com/awslabs/mountpoint-s3-csi-driver/blob/v1.0.0/README.md)

### Notable changes
* Add suppport for Static Provisioning with all-in-one pod implementation ([#2](https://github.com/awslabs/aws-s3-csi-driver/pull/2), [#4](https://github.com/awslabs/aws-s3-csi-driver/pull/4))
* Add helm install ([#8](https://github.com/awslabs/aws-s3-csi-driver/pull/8))
* Initial release to support using [Mountpoint for Amazon S3](https://github.com/awslabs/mountpoint-s3) to mount S3 buckets as a persistent volume in your kubernetes cluster
* Mountpoint Version: 1.1.1
* Add support for Static Provisioning ([#2](https://github.com/awslabs/aws-s3-csi-driver/pull/2), [#4](https://github.com/awslabs/aws-s3-csi-driver/pull/4))
* Add helm install ([#8](https://github.com/awslabs/aws-s3-csi-driver/pull/8))
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
#limitations under the License.
SHELL = /bin/bash

VERSION=0.1.0
VERSION=1.0.0

PKG=github.com/awslabs/aws-s3-csi-driver
GIT_COMMIT?=$(shell git rev-parse HEAD)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Mountpoint for Amazon S3 CSI Driver [WIP]
# Mountpoint for Amazon S3 CSI Driver

## 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.
Expand All @@ -7,10 +7,10 @@ The [Mountpoint for Amazon S3](https://github.com/awslabs/mountpoint-s3) Contain
* **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]
## Container Images
| 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 |
| v1.0.0 | public.ecr.aws/mountpoint-s3-csi-driver/aws-mountpoint-s3-csi-driver:v1.0.0 |


## Releases
Expand Down

0 comments on commit 1cda403

Please sign in to comment.