Skip to content

docs: clarify security implications of space quotas#1118

Open
pigeio wants to merge 1 commit intoetcd-io:mainfrom
pigeio:docs-clarify-quota-security
Open

docs: clarify security implications of space quotas#1118
pigeio wants to merge 1 commit intoetcd-io:mainfrom
pigeio:docs-clarify-quota-security

Conversation

@pigeio
Copy link

@pigeio pigeio commented Feb 4, 2026

What is this change?

This PR adds a specific "Security Note" to the Space Quota documentation in the Maintenance Guide. It clarifies that quotas are not just for resource management, but serve as a defense mechanism against Availability-based Denial of Service (DoS).

Why is this change necessary?

While investigating the write path in server/etcdserver/api/v3rpc/quota.go, I observed that the check() function runs prior to the main Put logic.

Many operators view quotas purely as a storage administrative task. Highlighting that this protects the cluster from entering a "read-only" panic state (due to disk exhaustion) emphasizes the security value of this configuration.

How was this tested?

  • Verified code logic in etcd/server/etcdserver/api/v3rpc/quota.go.
  • Local Hugo build to ensure the alert renders correctly in the documentation.

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 jberkus 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