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.

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

cloudflare: support reading API token from file #3552

Merged
merged 2 commits into from
Apr 24, 2023
Merged

cloudflare: support reading API token from file #3552

merged 2 commits into from
Apr 24, 2023

Conversation

cxuu
Copy link
Contributor

@cxuu cxuu commented Apr 18, 2023 •
edited
Loading

Description

Currently, the Cloudflare provider in external-dns can only read the Cloudflare API token from an environment variable named $CF_API_TOKEN. Users could populate $CF_API_TOKEN with a Kubernetes Secret. But a more flexible way is to read the Cloudflare API token from file. For example, if the user stores the secret (Cloudflare API token) in HashiCorp Vault, and uses vault agent sidecar to provide the secret to external-dns container through a shared volume backed by memory, allowing the Cloudflare provider in external-dns to read this secret file would be superb.

Checklist

  • Unit tests updated
  • End user documentation updated

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 18, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Apr 18, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: cxuu / name: Charles Xu (91cd518)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 18, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @cxuu!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. 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/external-dns 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 size/S Denotes a PR that changes 10-29 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 Apr 18, 2023
@cxuu cxuu force-pushed the cloudflare-token branch from 91cd518 to c5a684d Compare April 18, 2023 22:37
@cxuu cxuu force-pushed the cloudflare-token branch from c5a684d to 4447b2a Compare April 18, 2023 22:44
@cxuu cxuu marked this pull request as ready for review April 18, 2023 22:44
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 18, 2023
@cxuu
Copy link
Contributor Author

cxuu commented Apr 23, 2023

@seanmalloy @szuecs
Appreciate it if you could take a look. Thanks! 🙏

szuecs
szuecs reviewed Apr 24, 2023
View reviewed changes
provider/cloudflare/cloudflare.go Outdated
if strings.HasPrefix(token, "file:") {
tokenBytes, err := ioutil.ReadFile(strings.TrimPrefix(token, "file:"))
if err != nil {
return nil, fmt.Errorf("failed to read CF_API_TOKEN from file: %v", err)
Copy link
Contributor

Choose a reason for hiding this comment

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

%v -> %w

@szuecs
Copy link
Contributor

szuecs commented Apr 24, 2023

/ok-to-test

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Apr 24, 2023
@szuecs
Copy link
Contributor

szuecs commented Apr 24, 2023

@cxuu please fix the small nit, after that we can merge it.

@cxuu
Copy link
Contributor Author

cxuu commented Apr 24, 2023

@szuecs I fixed the linter issue. The PR should be ready to merge.

@szuecs
Copy link
Contributor

szuecs commented Apr 24, 2023

/approve
/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cxuu, szuecs

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 Apr 24, 2023
@k8s-ci-robot k8s-ci-robot merged commit 21da27f into kubernetes-sigs:master Apr 24, 2023
@cxuu cxuu deleted the cloudflare-token branch April 24, 2023 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szuecs szuecs szuecs left review comments

@seanmalloy seanmalloy Awaiting requested review from seanmalloy

Assignees

@szuecs szuecs

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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cxuu @k8s-ci-robot @szuecs