Adding install doc and updating example #25
Merged
Conversation
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
dlakhaws
temporarily deployed
to
PR Unit Tests
GitHub Actions
Inactive
dlakhaws
temporarily deployed
to
PR Integration Tests
GitHub Actions
Inactive
dlakhaws
commented
Oct 30, 2023
| #### Helm | ||
| - Add the `aws-mountpoint-s3-csi-driver` Helm repository. | ||
| ```sh | ||
| helm repo add aws-mountpoint-s3-csi-driver ??? |
There was a problem hiding this comment.
note: this will stay ??? until we finalize where we install the helm repo from
vladem
reviewed
Oct 31, 2023
vladem
previously approved these changes
Oct 31, 2023
docs/install.md
Outdated
| kubectl delete -k "github.com/awslabs/aws-mountpoint-s3-csi-driver/deploy/kubernetes/overlays/stable/?ref=release-<YOUR-CSI-DRIVER-VERION-NUMBER>" | ||
| ``` | ||
|
|
||
| > Warning: Warning: executing this command will delete a service account s3-csi-driver-sa from your cluster , which may cause problems when installing the driver again on a EKS cluster (re-created account won't include eks.amazonaws.com/role-arn annotation). Please refer to [eksctl documentation](https://eksctl.io/usage/iamserviceaccounts/) for details of how to re-create SA in this case. |
vladem
approved these changes
Oct 31, 2023
jjkr
approved these changes
Oct 31, 2023
| ### Set up driver permissions | ||
| The driver requires IAM permissions to talk to Amazon S3 to manage the volume on user's behalf. AWS maintains a managed policy, available at ARN `arn:aws:iam::aws:policy/AmazonS3FullAccess`. | ||
|
|
||
| For more information, review ["Creating the Amazon Mountpoint for S3 CSI driver IAM role for service accounts" from the EKS User Guide.](TODO: add AWS docs link) |
There was a problem hiding this comment.
We'll have to update this to cover self managed clusters. Fine with that being a followup though.
|
|
||
| ## Prerequisites | ||
|
|
||
| * Kubernetes Version >= 1.20 |
There was a problem hiding this comment.
Where does this version come from? Just curious
There was a problem hiding this comment.
I believe this is due to the CSI Driver Spec requirement but will double check, will have another doc PR up soon and will make an edi tin there if it's not the case
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes: