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

Updated the README with information on mountOptions that can be provided while mounting. #1006

Merged
merged 1 commit into from
May 23, 2023

Conversation

mskanth972
Copy link
Contributor

@mskanth972 mskanth972 commented May 18, 2023

Is this a bug fix or adding new feature?

What is this PR about? / Why do we need it?
Updated the README with information on mountOptions that can be provided while mounting.

What testing is done?

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 18, 2023
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 18, 2023
@mskanth972 mskanth972 force-pushed the optionupdate branch 2 times, most recently from 9fa5bbe to 1aaad15 Compare May 18, 2023 18:47
@mskanth972 mskanth972 changed the title Updated the README with information on mountOptions that can be provi… Updated the README with information on mountOptions that can be provided while mounting. May 18, 2023
docs/README.md Outdated
@@ -47,6 +47,15 @@ The following CSI interfaces are implemented:
* The uid/gid configured on the access point is either the uid/gid specified in the storage class, a value in the gidRangeStart-gidRangeEnd (used as both uid/gid) specified in the storage class, or is a value selected by the driver is no uid/gid or gidRange is specified.
* We suggest using [static provisioning](https://github.com/kubernetes-sigs/aws-efs-csi-driver/blob/master/examples/kubernetes/static_provisioning/README.md) if you do not wish to use user identity enforcement.

**Note**

If you want to pass any other mountOptions to EFS CSI driver while mounting, they can be passed in pv and storage class for static and dynamic provisioning respectively.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would capitalize the Kubernetes resources ->

...they can be passed in through the Persistent Volume or the Storage Class objects, depending on whether static or dynamic provisioning is used.

docs/README.md Outdated

**lookupcache**: Specifies how the kernel manages its cache of directory entries for a given mount point. Mode can be one of all, none, pos, or positive. Each mode has different functions and for more information you can refer to this [link](https://linux.die.net/man/5/nfs).

**iam**: The IAM option allows you to control the AWS Identity and Access Management Permissions for the EFS CSI driver and the associated EFS file system.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would reword the iam option. Maybe something like

"Use the CSI Node Pod's IAM identity to authenticate with EFS".

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mskanth972, RyanStan

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Ashley-wenyizha
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 23, 2023
@mskanth972
Copy link
Contributor Author

/test pull-aws-efs-csi-driver-unit

1 similar comment
@mskanth972
Copy link
Contributor Author

/test pull-aws-efs-csi-driver-unit

@k8s-ci-robot k8s-ci-robot merged commit 9f36e75 into kubernetes-sigs:master May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants