Skip to content

docs: document service account token daily rate limit#600

Open
micheleRP wants to merge 2 commits into
mainfrom
docs-service-account-token-rate-limits
Open

docs: document service account token daily rate limit#600
micheleRP wants to merge 2 commits into
mainfrom
docs-service-account-token-rate-limits

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 27, 2026

Summary

  • Adds a Service account token rate limits subsection under Authenticate to the Cloud API in modules/security/pages/cloud-authentication.adoc, covering the HTTP 429 response, token caching guidance, and the path to contact Redpanda Support for higher daily limits.
  • Adds a matching May 2026 entry to modules/get-started/pages/whats-new-cloud.adoc linking back to the new subsection.

Reference (internal): cupboard engineering/auth/2026-05-22-service-account-token-rate-limit.md and the matching runbook.

Preview pages

Test plan

  • Local Antora build completes without new warnings or broken xrefs for the changed files
  • Security > Authentication > Service account token rate limits renders below Authenticate to the Cloud API and above Enable mTLS authentication
  • Get Started > What's New > May 2026 > Service account token rate limits renders and the See link resolves to the new anchor on the authentication page
  • No em dashes; sentence-case headings; second-person voice; passes docs-team-standards review on the touched files

🤖 Generated with Claude Code

Add a Service account token rate limits subsection under
Authenticate to the Cloud API in the security/authentication page,
covering the HTTP 429 response, token caching guidance, and the
Support contact path for higher daily limits. Add a matching
What's New entry under May 2026.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP requested a review from a team as a code owner May 27, 2026 18:40
@netlify
Copy link
Copy Markdown

netlify Bot commented May 27, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 661a9a4
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a17619281aeff0008588d0f
😎 Deploy Preview https://deploy-preview-600--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 27, 2026

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 448a51fe-12be-4ab6-a631-a74af940ee88

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR documents a new service account token rate-limiting feature in Redpanda Cloud. It adds two complementary documentation sections: one entry in the May 2026 "what's new" changelog, and one detailed section in the cloud authentication guide. Together, they explain the organization-level daily quota for service account access token requests, describe the HTTP 429 response when the limit is exceeded, recommend token caching strategies, and provide an escalation path for organizations requiring higher limits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • redpanda-data/cloud-docs#555: Both PRs touch the same "service account" documentation around authorization/authentication behavior—this PR adds token rate-limit/HTTP 429 quota guidance for service account access tokens, while the retrieved PR updates RBAC UI docs for assigning scoped roles to service accounts.

Suggested reviewers

  • Mateoc
  • kbatuigas
  • Feediver1
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: documenting service account token daily rate limits across two documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description is well-structured with clear summary, preview pages, and test plan, but diverges from the template by missing the issue reference and checkbox verification.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-service-account-token-rate-limits

Comment @coderabbitai help to get the list of available commands and usage tips.

@micheleRP micheleRP requested review from Mateoc and deniscoady May 27, 2026 18:46
Copy link
Copy Markdown

@Mateoc Mateoc left a comment

Choose a reason for hiding this comment

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

LGTM
I think we should include how Auth0-Organization-Quota-Limit header works, is the way to track the quota. Here is some info on how it works https://github.com/redpanda-data/cupboard/blob/main/engineering/auth/2026-05-22-service-account-token-rate-limit.md ping me for clarification

Expand the Service account token rate limits subsection with the
quota header format, field meanings, and the on-429 retry guidance
(find the bucket whose r is 0, back off for t seconds). This is
the only quota-tracking surface customers have today.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants