Discover EFS FileSystemId instead of specifying it in storage class

avanish23 commented 3 weeks ago

What is this PR about? / Why do we need it? This PR introduces the feature of discovering EFS FileSystemId instead of having to specify it in the SC parameters. The way to use this feature is to create a storage class where the parameters have a new field fileSystemDiscovery. Currently, it takes 2 fields creationToken andtags both being optional. creationToken is a string that takes the creation token of the EFS to be discovered as input tags is a map of strings Sample Storage Class

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: efs-sc
provisioner: efs.csi.aws.com
parameters:
  provisioningMode: efs-ap
  directoryPerms: "700"
  gidRangeStart: "1000" # optional
  gidRangeEnd: "2000" # optional
  basePath: "/dynamic_provisioning" # optional
  subPathPattern: "${.PVC.namespace}/${.PVC.name}" # optional
  ensureUniqueDirectory: "true" # optional
  reuseAccessPoint: "false" # optional
  fileSystemDiscovery: |
    creationToken: aws-efs-for-discovery
    tags:
      env: prod
      owner: avanishpatil23@gmail.com

Note:

use EFS Discovery with | as it is a multi-line string input
fileSystemId will continue to be supported as a parameter
if more than one EFS is discovered, the driver will throw an error; likewise, if no EFS is discovered
the EFS discovery results are not cached

What testing is done? Unit tests added and current unit tests pass

Closes #1052

k8s-ci-robot commented 3 weeks ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: avanish23 Once this PR has been reviewed and has the lgtm label, please assign d-nishi for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/kubernetes-sigs/aws-efs-csi-driver/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

k8s-ci-robot commented 3 weeks ago

Hi @avanish23. 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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

kubernetes-sigs / aws-efs-csi-driver

Discover EFS FileSystemId instead of specifying it in storage class #1492