Skip to content

Enable optional TLS on nodecache metrics endpoint #694

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nuhakala
Copy link

@nuhakala nuhakala commented May 26, 2025

Fixes #692. Chose to do the configuration with flags instead of extra config file because thought that it will be simpler and more in line with the project overall.

Adapted the implementation for CoreDNS metrics TLS support to nodecache. The original PR here coredns/coredns#7255

  • TLS support optional (backward compatible)
  • TLS can be configured through command line flags, including the key files and client certificate.
  • Added tests

New command line flags

  • tls-cert-file default value /etc/ssl/tls.crt
  • tls-private-key-file default value /etc/ssl/tls.key
  • client-auth-type default value NoClientCert
  • client-ca-file default value empty
  • tls-min-version default value TLS version 13
  • tls-enabled default value false

In order to use the feature, one needs to give as flag -tls-enabled=1. The defaults are used and the existence of TLS key-files is checked and error is thrown if no files are found. The defaults can be changed by using the corresponding flags.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 26, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @nuhakala!

It looks like this is your first PR to kubernetes/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/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
Copy link
Contributor

Hi @nuhakala. Thanks for your PR.

I'm waiting for a kubernetes 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 26, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: nuhakala
Once this PR has been reviewed and has the lgtm label, please assign damiansawicki for approval. For more information see the 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:

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 requested review from bowei and MrHohn May 26, 2025 09:32
@k8s-triage-robot
Copy link

Unknown CLA label state. Rechecking for CLA labels.

Send feedback to sig-contributor-experience at kubernetes/community.

/check-cla
/easycla

Copy link

linux-foundation-easycla bot commented May 26, 2025

CLA Signed


The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. 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 May 26, 2025
@nuhakala
Copy link
Author

@bowei @MrHohn Do you have time to review?

@nuhakala
Copy link
Author

nuhakala commented Jun 6, 2025

@bowei @MrHohn Can I get a review on this so that the PR can move forward?

@kashifest
Copy link

it would be great to have some reviews on this one and move it forward. /cc @DamianSawicki

@lentzi90
Copy link

lentzi90 commented Jun 9, 2025

/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 Jun 9, 2025
@DamianSawicki
Copy link
Collaborator

it would be great to have some reviews on this one and move it forward. /cc @DamianSawicki

Personally, I won't be able to have a look at it at the moment.

I see 3 open PRs touching the cmd/node-cache directory (this one, #690, and #689). It could be really beneficial if authors of these PRs, with apparent expertise in node-cache, could cross-review each other's PRs. CC: @Michcioperz @johnbelamaric @zooneon

@peppi-lotta
Copy link

This PR is self-contained and primarily focuses on updates to metrics.go and metrics_test.go. The changes to main.go and cache_app.go are minimal and only introduce optional flags to support TLS encryption for the /metrics endpoint.

The implementation is designed to be non-intrusive and does not alter existing functionality. As such, reviewing this PR does not require familiarity with other open pull requests.

@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feature: TLS-support for node-local-dns metrics endpoint
7 participants