Skip to content

docs: clarify that /metrics endpoint requires separate authentication#1120

Open
pigeio wants to merge 2 commits intoetcd-io:mainfrom
pigeio:docs/metrics-auth-note
Open

docs: clarify that /metrics endpoint requires separate authentication#1120
pigeio wants to merge 2 commits intoetcd-io:mainfrom
pigeio:docs/metrics-auth-note

Conversation

@pigeio
Copy link

@pigeio pigeio commented Feb 6, 2026

What is this change?

This PR adds a security clarification note to the RBAC documentation explaining that the /metrics and /health HTTP endpoints are not protected by V3 RBAC authentication (auth enable).

Why is this needed?

Operators may assume that enabling authentication with etcdctl auth enable protects all endpoints. However, the /metrics endpoint uses a separate HTTP handler and requires mTLS or network isolation for protection.

Code references:

  • V3 auth layer: server/etcdserver/api/v3rpc/interceptor.go - guards gRPC API
  • Metrics handler: server/embed/etcd.go - separate HTTP handler

Changes

Added a new section "Security Scope of Authentication" after the "Enabling authentication" section in rbac.md that:

  • Clarifies what V3 auth protects (gRPC API operations)
  • Adds a warning note about /metrics and /health endpoints
  • Provides mitigation options (mTLS, --listen-metrics-urls, network policies)

Related

Signed-off-by: Anand raj <rajanand3307@gmail.com>
Signed-off-by: Anand raj <rajanand3307@gmail.com>
@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: pigeio
Once this PR has been reviewed and has the lgtm label, please assign nate-double-u for approval. For more information see the Code Review Process.

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

Details 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
Copy link

Hi @pigeio. Thanks for your PR.

I'm waiting for a etcd-io 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.

Details

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants