-
Notifications
You must be signed in to change notification settings - Fork 548
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
Merged information from EKS User Guide #1051
Conversation
Welcome @pgasca! |
Hi @pgasca. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
/ok-to-test |
docs/README.md
Outdated
|
||
**To install the driver using images stored in the private Amazon ECR registry** | ||
|
||
1. Download the manifest. Replace `release-1.X` with a tag for your desired released version. We recommend using the latest released version. For more information and the changelog on released versions and tags, see [Releases](../releases). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change "1" to a bullet point or other format than numbered here? since there is another "1" below
Content looks good to me, left comment. Could we also rebase the commits and leave a cleaner commit messages/history? |
@Ashley-wenyizha , the numbering got fixed when I corrected the spacing for the Note inbetween the two steps. I've also added detail about how using the master branch isn't recommended for the driver and gave a link to allow users to see the active branches. Yes, you can rebase the commits. I tried to figure that out but not sure how to do it from the website itself since I'm just using the GitHub forms to edit the readme files. Could you handle the rebase when merging the PR? |
@Ashley-wenyizha, I added another commit removing mention that master isn't recommended (but keeping the link to active branches). Originally I added these statements based on my understanding from a different storage driver (https://github.com/kubernetes-sigs/aws-fsx-csi-driver/blob/master/docs/install.md), but this same recommendation may not apply to EFS CSI based on mentions of master throughout rest of readme. Please let me know if anything else is needed for this to be merged. |
Moved considerations, prereqs, and IAM steps from EKS User Guide. Globally replaced "EFS" and "AWS EFS" with "Amazon EFS". "Amazon EKS" branding Globally replaced "EKS" with "Amazon EKS". Replacement correction. Global replacement fix. Updated links to work with move Merged deploy/install info from EKS User Guide. Moved IAM policy steps to separate file. Removed steps that were moved to separate file. Added new link. Moved over "Create an Amazon EFS file system" from user guide Update and rename efs-create-filesystem to efs-create-filesystem.md Update iam-policy-create.md Give extra context. Adding references to other sections, other tweaks small edits Update iam-policy-create.md Update README.md Merged extra details from EKS User Guide. Update README.md Formatting fixes Update README.md Cleaned up descriptions of settings. Update README.md Update README.md Merged extra details from EKS User Guide. Update README.md Addressed Ashley's comment regarding numbering starting over. Also updated replacing release-X.X with more clear instructions on how to look up latest active branch. Corrected Branches links. Removed mention that master isn't recommended. I originally added these statements based on my understanding from a different storage driver (https://github.com/kubernetes-sigs/aws-fsx-csi-driver/blob/master/docs/install.md), but this same recommendation may not apply to EFS CSI.
/lgtm |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Ashley-wenyizha, pgasca The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Is this a bug fix or adding new feature?
Documentation update
What is this PR about? / Why do we need it?
Merged missing details from https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html into the existing sections that were noted as Kubernetes specific.
One reason for this is so that Kubernetes users will have full information needed on GitHub even if they aren't aware of the information in the EKS User Guide. Users will be able to more easily contribute to the content when the EKS User Guide no longer has an equivalent GitHub repo.
There was overlap between both sources, with some extra information in one place or another. After this PR, the EKS User Guide will be updated to point to the GitHub readmes where it makes sense to do so rather than have potentially contradictory information that could go out of sync. This is also more consistent with how more recent storage drivers are handled in the EKS User Guide, such as the Amazon File Cache CSI driver.
What testing is done?
Extra details come from what is currently live for EKS User Guide.