Add support for on-premise Kubernetes environment

[davidshtian]

Is this a bug fix or adding new feature?
Yes, this is add feature for supporting on-premise Kubernetes environment to deploy Amazon EFS CSI Driver, and this is related to issue 468.

What is this PR about? / Why do we need it?
As on-premise Kubernetes users also would like to leverage Amazon EFS service for shared file system, while currently there are several issues when deploying to on-premise environment, like EC2 metadata service dependency.

What testing is done?
I've tested using actual on-premise Kubernetes environment.

[k8s-ci-robot]

Welcome @davidshtian!

It looks like this is your first PR to kubernetes-sigs/aws-efs-csi-driver 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/aws-efs-csi-driver has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @davidshtian. 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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: davidshtian
To complete the pull request process, please assign justinsb after the PR has been reviewed.
You can assign the PR to them by writing /assign @justinsb in a comment when ready.

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

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[wongma7]

/ok-to-test

Over at https://github.com/kubernetes-sigs/aws-ebs-csi-driver we have been working on decoupling driver from instance metadata as well. And I was planning to port the solution here. The solution over there is to check, in order:

1. EC2 instance metadata
2. Kubernetes API (fall back to this because the node object has instance id, region, zone in spec.providerID)

Do your Nodes have spec.providerID set? If so, the solution could work here too.

Still, there is value in adding environment variable overrides in case spec.providerID is not set or kubernetes API access is blocked from CSI node pods.

The order could be something like:

1. Environment variable override (this PR).
2. ECS/fargate instance metadata
3. EC2 instance metadata
4. Kubernetes API (the node object has instance id, region, zone in spec.providerID)

Let me know what you think.

[k8s-ci-robot]

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

---

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
• If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
• If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
• Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

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. I understand the commands that are listed here.

[davidshtian]

/ok-to-test

Over at https://github.com/kubernetes-sigs/aws-ebs-csi-driver we have been working on decoupling driver from instance metadata as well. And I was planning to port the solution here. The solution over there is to check, in order:

1. EC2 instance metadata
2. Kubernetes API (fall back to this because the node object has instance id, region, zone in spec.providerID)

Do your Nodes have spec.providerID set? If so, the solution could work here too.

Still, there is value in adding environment variable overrides in case spec.providerID is not set or kubernetes API access is blocked from CSI node pods.

The order could be something like:

1. Environment variable override (this PR).
2. ECS/fargate instance metadata
3. EC2 instance metadata
4. Kubernetes API (the node object has instance id, region, zone in spec.providerID)

Let me know what you think.

Hi~ The check order looks great! I've checked that there is no "spec.providerID" in on premise environment, it seems to be set by Cloud Controller Manager. Thanks~

[davidshtian]

/assign @justinsb

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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.

[CNLHC]

/ok-to-test

Over at https://github.com/kubernetes-sigs/aws-ebs-csi-driver we have been working on decoupling driver from instance metadata as well. And I was planning to port the solution here. The solution over there is to check, in order:

1. EC2 instance metadata
2. Kubernetes API (fall back to this because the node object has instance id, region, zone in spec.providerID)

Do your Nodes have spec.providerID set? If so, the solution could work here too.

Still, there is value in adding environment variable overrides in case spec.providerID is not set or kubernetes API access is blocked from CSI node pods.

The order could be something like:

1. Environment variable override (this PR).
2. ECS/fargate instance metadata
3. EC2 instance metadata
4. Kubernetes API (the node object has instance id, region, zone in spec.providerID)

Let me know what you think.

Hello @wongma7
It seems that this feature does not gain some progress yet. Are you still working on this feature? If you are too busy to work on this I am glad to sign the CLA and develop this.

[jonathanrainer]

/ok-to-test

Over at https://github.com/kubernetes-sigs/aws-ebs-csi-driver we have been working on decoupling driver from instance metadata as well. And I was planning to port the solution here. The solution over there is to check, in order:

1. EC2 instance metadata

2. Kubernetes API (fall back to this because the node object has instance id, region, zone in spec.providerID)

Do your Nodes have spec.providerID set? If so, the solution could work here too.

Still, there is value in adding environment variable overrides in case spec.providerID is not set or kubernetes API access is blocked from CSI node pods.

The order could be something like:

1. Environment variable override (this PR).

2. ECS/fargate instance metadata

3. EC2 instance metadata

4. Kubernetes API (the node object has instance id, region, zone in spec.providerID)

Let me know what you think.

Hello @wongma7

It seems that this feature does not gain some progress yet. Are you still working on this feature? If you are too busy to work on this I am glad to sign the CLA and develop this.

Hi, I have a PR open for this in #681. Would very much appreciate a review :)