Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding example for S3 Express use case #92

Merged
merged 4 commits into from
Dec 5, 2023
Merged

Adding example for S3 Express use case #92

merged 4 commits into from
Dec 5, 2023

Conversation

dlakhaws
Copy link
Contributor

@dlakhaws dlakhaws commented Dec 4, 2023

Description of changes:

  • Adding documentation and example for S3 Express one zone allowing customers to choose pod AZs

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dlakhaws dlakhaws changed the title Adding docs for S3 Express use case Adding example for S3 Express use case Dec 4, 2023
jjkr
jjkr previously approved these changes Dec 4, 2023
docs/install.md Outdated
@@ -115,6 +115,9 @@ Review the [configuration values](https://github.com/awslabs/mountpoint-s3-csi-d
kubectl get pods -n kube-system -l app.kubernetes.io/name=aws-mountpoint-s3-csi-driver
```

### Driver example
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like "Volume Configuration Example" makes more sense to me here.

examples/kubernetes/static_provisioning/README.md Outdated Show resolved Hide resolved

## Configure
### Edit [Persistent Volume](https://github.com/awslabs/mountpoint-s3-csi-driver/blob/main/examples/kubernetes/static_provisioning/static_provisioning.yaml)
> Note: This example assumes your S3 bucket has already been created. If you need to create a bucket, follow the [S3 documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html).
> Note: This example assumes your S3 bucket has already been created. If you need to create a bucket, follow the [S3 documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html) for a regular bucket and [S3 One Zone documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-create.html) for an S3 Express bucket (aka a Directory bucket).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This says S3 One Zone, in line with the above comment it should probably be S3 Express One Zone

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in latest commit

examples/kubernetes/static_provisioning/README.md Outdated Show resolved Hide resolved
examples/kubernetes/static_provisioning/README.md Outdated Show resolved Hide resolved
examples/kubernetes/static_provisioning/README.md Outdated Show resolved Hide resolved
- key: topology.kubernetes.io/zone
operator: In
values:
- us-west-2a # specify az where bucket lives
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you know if there's a selector that supports AZ IDs like usw2-az2? otherwise folks will need to look up the mapping between the AZ ID of their directory bucket and the AZ name in their account (https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html), which is maybe worth a comment

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nope, that's not supported here so I added a reference to this link since it indicates all the codes that can be used here -- we'll make sure to include support for AZ ID when we work on this issue

@dlakhaws dlakhaws merged commit ab48c45 into main Dec 5, 2023
1 check passed
@dlakhaws dlakhaws deleted the dl-s3express-docs branch December 5, 2023 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants