Skip to content

DOCS-892: integrate 4.53.0/1.146 updates into existing docs pages - #309

Merged
harrison-akeyless merged 23 commits into
v1.0from
v1.0_DOCS-892-release-453-cli-sra
Jun 15, 2026
Merged

DOCS-892: integrate 4.53.0/1.146 updates into existing docs pages#309
harrison-akeyless merged 23 commits into
v1.0from
v1.0_DOCS-892-release-453-cli-sra

Conversation

@harrison-akeyless

@harrison-akeyless harrison-akeyless commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR implements DOCS-892 by integrating release-impact updates into existing documentation pages (no release-note-style docs).

Summary by CodeRabbit

  • Documentation
    • Added HashiCorp Vault rotated secret creation guide.
    • Documented Dynamic Secrets support for Akeyless Agent.
    • Added Universal Secrets Connector folder sync commands for Multi-Vault Governance.
    • Enhanced SRA portal with access request flows (v4.53.0+).
    • Added MySQL interactive flags support in Akeyless Connect (CLI v1.146+).
    • Clarified permissions requirements and rate-limiting configuration.
    • Expanded caching strategy guidance for proactive deployments.

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@harrison-akeyless, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 52 minutes and 31 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9209f3ec-dadd-401b-800e-f51c86b445ff

📥 Commits

Reviewing files that changed from the base of the PR and between 1e91206 and aa40a32.

📒 Files selected for processing (11)
  • docs/Advanced Functionality/akeyless-agent.md
  • docs/Advanced Functionality/audit-logs/index.md
  • docs/Akeyless Gateway/configure-gateway/gateway-access-permissions-reference.md
  • docs/Akeyless Gateway/configure-gateway/gateway-caching/proactive-caching.md
  • docs/Integrations & Plugins/cli-reference/cli-reference-gateway/cli-reference-sra.md
  • docs/Integrations & Plugins/cli-reference/cli-reference-universal-secrets-connector.md
  • docs/Secrets Management/rotated-secrets/create-a-hashicorp-vault-rotated-secret.md
  • docs/Secure Remote Access/sra-user-guides/sra-akeyless-scp.md
  • docs/Secure Remote Access/sra-user-guides/sra-portal.md
  • docs/Universal Secret Connector/sync-secret/index.md
  • docs/Universal Secret Connector/universal-secrets-connector/hc-vault-universal-secrets-connector.md
📝 Walkthrough

Walkthrough

This PR adds documentation for new features across multiple product areas: a HashiCorp Vault rotated secret type, USC folder-sync commands for Multi-Vault Governance, SRA access request flow and MySQL pre-connect flags, Gateway 4.53.0 K8s TokenReview rate limiting and proactive caching improvements, SRA file transfer migration from SCP to SFTP, and miscellaneous updates to audit logs, sub-claims, the Akeyless Agent, and KMIP.

Changes

HashiCorp Vault Rotated Secret

Layer / File(s) Summary
New HC Vault rotated secret page and index entries
docs/Secrets Management/rotated-secrets/create-a-hashicorp-vault-rotated-secret.md, docs/Secrets Management/rotated-secrets/_order.yaml, docs/Secrets Management/rotated-secrets/index.md
New documentation page covering prerequisites, console creation steps, CLI command syntax, and version history; added to the rotated secrets index and nav order manifest.
Rotated secret permission behavior notes
docs/Secrets Management/rotated-secrets/create-a-database-rotated-secret.md, docs/Integrations & Plugins/cli-reference/cli-reference-rotated-secrets.md, docs/Advanced Functionality/account-settings/index.md
Adds list-only target permission notes for credentials-based rotators to the database guide and CLI reference; updates account settings to mention version history review from the item details view.

Universal Secret Connector Folder Sync

Layer / File(s) Summary
Folder sync CLI reference
docs/Integrations & Plugins/cli-reference/cli-reference-universal-secrets-connector.md
Adds a Folder Sync Commands section documenting folder-sync, folder-sync-all, and folder-delete-sync with full flag descriptions including Vault namespace/engine mapping and deletion options.
USC folder sync guide pages and index
docs/Universal Secret Connector/sync-secret/index.md, docs/Universal Secret Connector/universal-secrets-connector/hc-vault-universal-secrets-connector.md, docs/Universal Secret Connector/universal-secrets-connector/index.md
Adds Sync Entire Folder Contents subsection, HC Vault USC Additional Capabilities section with MVG folder sync CLI examples, and an updated USC index overview paragraph and reformatted provider list.

SRA and RBAC Updates

Layer / File(s) Summary
RBAC: SRA access requests and Reverse RBAC SRA/ARA types
docs/Accessing Akeyless/rbac/index.md, docs/Integrations & Plugins/cli-reference/cli-reference-access-roles.md
Adds Gateway 4.53.0+ SRA portal access request note, a Reverse RBAC Review Coverage section with --type sra/--type ara guidance, and corrects --reverse-rbac-access values from own/all to scoped/all in create-role and update-role.
SRA portal access request flow
docs/Secure Remote Access/sra-user-guides/sra-portal.md
Inserts a new Access Request Flow section describing Gateway 4.53.0+ request processing via the Event Center; reformats authentication methods list and Key Features bullets.
SRA file transfer: SCP replaced by SFTP over tunnel
docs/Secure Remote Access/sra-user-guides/sra-akeyless-scp.md, docs/Integrations & Plugins/cli-reference/cli-reference-gateway/cli-reference-sra.md
Rewrites transfer-flow description to SFTP over SRA tunnel, updates prerequisites to ssh with SFTP support, bumps minimum CLI version to 1.146.
MySQL pre-connect flags for akeyless connect
docs/Integrations & Plugins/cli-reference/cli-reference-gateway/cli-reference-connect.md, docs/Secure Remote Access/sra-admin-guides/sra-akeyless-connect.md
Documents pre: prefix semantics for -C MySQL flags in the CLI connect reference and SRA admin guide, with interactive and combined pre/post examples.

Gateway 4.53.0 Feature Documentation

Layer / File(s) Summary
K8s TokenReview rate limiting
docs/Accessing Akeyless/access-and-authentication-methods/auth-with-kubernetes/dedicated-k8s-auth-service-accounts.md, docs/Integrations & Plugins/cli-reference/cli-ref-auth/cli-reference-k8s-auth-method.md
Documents K8S_TOKEN_REVIEW_QPS and K8S_TOKEN_REVIEW_BURST environment variables, their client-go defaults, and scope limited to native_k8s flows.
Proactive caching 429 handling, leadership-loss, and startup note
docs/Akeyless Gateway/configure-gateway/gateway-caching/proactive-caching.md, docs/Akeyless Gateway/configure-gateway/gateway-caching/index.md, docs/Akeyless Gateway/gateway-best-practices.md
Expands Rate-Limit Behavior with header-aware shared backoff and bounded retry details, adds Leadership-Loss Handling subsection, appends a startup continuity note, and propagates NEW_PROACTIVE_CACHE_ENABLE=true recommendation to the caching index and best practices page.
Gateway log forwarding JSON note and permissions visibility
docs/Akeyless Gateway/configure-gateway/gateway-log-forwarding.md, docs/Akeyless Gateway/configure-gateway/gateway-access-permissions-reference.md
Adds a note requiring JSON format for structured stdout logs and a permission-scoped Gateway Console visibility clarification.

Miscellaneous Documentation Updates

Layer / File(s) Summary
Audit logs raw field table and sub-claim docs
docs/Advanced Functionality/audit-logs/index.md, docs/Accessing Akeyless/access-and-authentication-methods/index.md, docs/Accessing Akeyless/rbac/sub-claims.md
Rewrites the audit log raw field table with new fields (seq_num, component, scope_params, auth sub-claims); updates Audit Log Sub-Claims feature bullet with uid_comment example; documents uid_comment as a UID token sub-claim key.
Akeyless Agent dynamic secrets support
docs/Advanced Functionality/akeyless-agent.md
Adds Dynamic Secrets to the supported items list, a [[template]] example for dynamic.tmpl, and a dynamicSecret template rendering user and password fields.
AI Insight chat management and identity scanner coverage
docs/AI Security/akeyless-ai-insight.md, docs/AI Security/identity-and-secrets-intelligence.md
Extends AI Insight console walkthrough with chat list/search steps and per-gateway session storage note; expands identity scanner coverage with GCP Cloud Audit Log enrichment and AWS Gateway Cloud Identity bullets.
KMIP certificate-ttl flag constraints
docs/Encryption & KMS/kmip-server/index.md
Documents the optional --certificate-ttl flag for kmip-server-setup with a 90+ day minimum and Gateway version note; tightens the same constraint for kmip-create-client.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested reviewers

  • Avi-Akeyless

Poem

🐇 Hop hop, the docs have grown today,
New secrets rotate the HashiCorp way!
Folders sync, the SFTP flows,
Rate limits tamed, the Gateway knows.
Sub-claims tagged, the audit sings,
A rabbit cheers for all these things! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically references the main objective: integrating documentation updates from versions 4.53.0 and 1.146 into existing documentation pages, which accurately reflects the changeset's focus.
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.

✏️ 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 v1.0_DOCS-892-release-453-cli-sra

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@harrison-akeyless
harrison-akeyless marked this pull request as ready for review June 15, 2026 14:54
coderabbitai[bot]

This comment was marked as outdated.

- Audit logs: add missing 5xx server error range documentation
- Gateway access permissions: change 'scope' to 'scoped' for API term
- Proactive caching: clarify temporary startup behavior of NEW_PROACTIVE_CACHE_ENABLE flag
- SRA file transfer: replace stale binary requirement with SFTP client capability description
- USC: remove non-existent --engine-name flag from two locations
- Vault rotated secrets: fix broken anchor link to correct synchronization section
- Folder sync: update old (MVG) anchor references to current heading names
- Akeyless agent: add missing frontmatter fields (excerpt, metadata.title, metadata.description)
@harrison-akeyless
harrison-akeyless merged commit 0afe6dd into v1.0 Jun 15, 2026
1 check was pending
@harrison-akeyless
harrison-akeyless deleted the v1.0_DOCS-892-release-453-cli-sra branch June 15, 2026 18:13
harrison-akeyless added a commit that referenced this pull request Jun 15, 2026
harrison-akeyless added a commit that referenced this pull request Jun 16, 2026
* Reapply "DOCS-892: integrate 4.53.0/1.146 updates into existing docs pages (#309)" (#311)

This reverts commit be7437b.

* DOCS-892: address USC folder sync review feedback
@coderabbitai coderabbitai Bot mentioned this pull request Jul 23, 2026
6 tasks
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.

1 participant