Skip to content

Add compute-endpoint flag to pdcsi driver #1077

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Nov 16, 2022
Merged

Add compute-endpoint flag to pdcsi driver #1077

merged 6 commits into from
Nov 16, 2022

Conversation

judemars
Copy link
Contributor

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind failing-test

/kind feature

/kind flake

What this PR does / why we need it:
Adds ability to pick up compute endpoint from compute-endpoint flag rather than using hard-coded value. This is needed to achieve service regionalization

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:
This is my first change so still working out which tests to run.

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note-none Denotes a PR that doesn't merit a release note. kind/feature Categorizes issue or PR as related to a new feature. labels Nov 12, 2022
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 12, 2022 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: judemars / name: Julianne DeMars (0d9edc4)

@k8s-ci-robot
Copy link
Contributor

Welcome @judemars!

It looks like this is your first PR to kubernetes-sigs/gcp-compute-persistent-disk-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/gcp-compute-persistent-disk-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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 12, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @judemars. 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 k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 12, 2022
@judemars judemars marked this pull request as draft November 12, 2022 03:48
@saikat-royc
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 14, 2022
@judemars
Copy link
Contributor Author

/retest

@judemars judemars changed the title [WIP] Add compute-endpoint flag to pdcsi driver Add compute-endpoint flag to pdcsi driver Nov 15, 2022
@judemars judemars marked this pull request as ready for review November 15, 2022 03:56
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 15, 2022
sunnylovestiramisu
sunnylovestiramisu reviewed Nov 15, 2022
View reviewed changes
cmd/gce-pd-csi-driver/main.go
@@ -36,6 +36,7 @@ import (
var (
cloudConfigFilePath = flag.String("cloud-config", "", "Path to GCE cloud provider config")
endpoint = flag.String("endpoint", "unix:/tmp/csi.sock", "CSI endpoint")
computeEndpoint = flag.String("compute-endpoint", "", "If set, used as the endpoint for the GCE API.")
Copy link
Contributor

Choose a reason for hiding this comment

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

For safety, should we always fall back/default to the public GCE endpoint?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If no endpoint is passed into the computebeta.NewService constructor, the default "https://compute.googleapis.com/compute/beta/" is used. This value is being used in the current implementation and the new.

[1]: see "basePath" in https://raw.githubusercontent.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver/7592dc19d3bd000f34cf950454c3355ae35f1475/vendor/google.golang.org/api/compute/v0.beta/compute-gen.go

@mattcary
Copy link
Contributor

Does it make sense to add an e2e test to confirm that passing an endpoint in actually works? IIUC currently no test (e2e or integration) will actually exercise this flag, so we run the risk of accidentally breaking it.

@judemars
Copy link
Contributor Author

/retest

@judemars
Copy link
Contributor Author

Alrighty @mattcary I added an e2e test. I couldn't find a way to pass in a valid endpoint and then verify the exact endpoint was passed through apart from just checking for success, but if you know of a way to check that met me know and I'll add it. I opted to go with:

  1. Pass in nothing (i.e. use the default) see it succeed in a call to gcs
  2. Use an invalid one and see it fail w/ "no such host"
  3. Pass in the default one and see it succeed w/ a call to gcs

@mattcary
Copy link
Contributor

Awesome, that's solid.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 16, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: judemars, mattcary

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 16, 2022
@k8s-ci-robot k8s-ci-robot merged commit cd8a6d2 into kubernetes-sigs:master Nov 16, 2022
This was referenced Nov 16, 2022
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leiyiz leiyiz leiyiz left review comments

@sunnylovestiramisu sunnylovestiramisu sunnylovestiramisu left review comments

@saad-ali saad-ali Awaiting requested review from saad-ali

@saikat-royc saikat-royc Awaiting requested review from saikat-royc

@davidz627 davidz627 Awaiting requested review from davidz627

Assignees

@mattcary mattcary

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. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@judemars @k8s-ci-robot @saikat-royc @mattcary @leiyiz @sunnylovestiramisu