DOCS-892: GW 4.53.0 and CLI 1.146.0#312
Conversation
|
Warning Review limit reached
More reviews will be available in 53 minutes and 8 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 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 configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughThis PR adds a new HashiCorp Vault rotated secret documentation page, introduces USC folder-sync CLI commands ( ChangesDocumentation Updates
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
harrison-akeyless
changed the title
| #### Usage | ||
|
|
||
| ```shell | ||
| akeyless folder-sync \ |
|
|
||
| `-u, --gateway-url[=http://localhost:8000]`: API Gateway URL (Configuration Management port) | ||
|
|
||
| ### `folder-sync-all` |
| <br /> | ||
| ## Access Request Flow | ||
|
|
||
| From Gateway `4.53.0` and later, the portal supports Secure Remote Access request flows, and approvers can process those requests through the Event Center. |
There was a problem hiding this comment.
@harrison-akeyless The users can approve the requests from the Access Requests page.
There was a problem hiding this comment.
Rechecked this against the current code before changing it. The approval flow still routes through Event Center in the current frontend implementation, and I could not find a current Access Requests page implementation in the checked-in frontend sources, so I left the docs wording unchanged for now.
|
|
||
| ## Sync Entire Folder Contents | ||
|
|
||
| For HashiCorp Vault USC integrations in Multi-Vault Governance (MVG), you can sync all supported secrets under a folder in one operation. |
There was a problem hiding this comment.
@harrison-akeyless Not only Hashi, it's supported for all of the USC's.
|
|
||
| > ℹ️ **Note:** | ||
| > | ||
| > To emit structured logs to container standard output, set the log format to `JSON`. |
There was a problem hiding this comment.
@harrison-akeyless This should be set as an env var when deploying the gw - https://akeyless.atlassian.net/browse/ASM-18177
There was a problem hiding this comment.
Rechecked this against the current implementation before editing. Gateway supports deploy-time initialization through the LOG_FORWARDING env var, but the current runtime config path also persists stdout/JSON selection through the log-forwarding configuration itself, so I left the note unchanged to avoid implying that env-var setup is the only supported way to enable JSON stdout output.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
docs/Advanced Functionality/akeyless-agent.md (1)
126-131: ⚡ Quick winMissing code block label on Dynamic Secret template example.
All other template examples in the "Template Examples" section include a filename label (e.g.,
static.tmpl,rotated.tmpl,ssh_cert.tmpl), but the new Dynamic Secret example lacks one. For consistency and clarity, add thedynamic.tmpllabel to the code block, matching thesource = "path_to/dynamic.tmpl"reference in the agent.toml configuration (line 63).✏️ Proposed fix
### Dynamic Secret -```shell +```shell dynamic.tmpl {{- with dynamicSecret "/my_dynamic_secret" -}} username={{ .Data.user }} password={{ .Data.password }} {{- end -}}</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/AdvancedFunctionality/akeyless-agent.md around lines 126 - 131, Add
the filename labeldynamic.tmplto the code block containing the dynamicSecret
template example. Change the opening code fence fromshell` toshell
dynamic.tmplto match the consistent labeling pattern used by other template examples in the Template Examples section (such asstatic.tmpl,rotated.tmpl, andssh_cert.tmpl), and to align with thesource =
"path_to/dynamic.tmpl"` reference shown in the agent.toml configuration.</details> <!-- cr-comment:v1:3019a3b6e669b6b0fea5e72f --> _Source: Coding guidelines_ </blockquote></details> <details> <summary>docs/Universal Secret Connector/universal-secrets-connector/hc-vault-universal-secrets-connector.md (1)</summary><blockquote> `166-170`: _⚡ Quick win_ **Move general account-level versioning information outside HC Vault–specific section.** Line 168 describes "Account-level secret versioning [that] applies across Akeyless item types such as Static Secrets, Rotated Secrets, and Targets" — this is a general Akeyless capability, not specific to HashiCorp Vault. It may be more appropriate in the parent [Universal Secrets Connector overview](https://docs.akeyless.io/docs/universal-secrets-connector#hashicorp-vault-universal-secrets-details) or a shared capabilities section rather than in the HC Vault–specific page. <details> <summary>🤖 Prompt for AI Agents</summary> ``` Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/Universal` Secret Connector/universal-secrets-connector/hc-vault-universal-secrets-connector.md around lines 166 - 170, The bullet point describing account-level secret versioning that applies across Akeyless item types (Static Secrets, Rotated Secrets, and Targets) is currently in the HashiCorp Vault-specific section but represents a general Akeyless capability, not HC Vault-specific functionality. Remove this bullet point from the HC Vault-specific section in hc-vault-universal-secrets-connector.md and relocate it to the Universal Secrets Connector overview page or a shared capabilities section where it more appropriately documents this cross-platform feature. Keep only the truly HC Vault-specific information (folder sync commands and provider-specific version details variation) in the current location. ``` </details> <!-- cr-comment:v1:cc96f47437e0f658025031f9 --> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.Inline comments:
In@docs/Integrations&
Plugins/cli-reference/cli-reference-universal-secrets-connector.md:
- Around line 133-198: Update the HashiCorp Vault documentation page to clarify
that folder-sync commands are universal features, not Vault-exclusive. The
current language misleadingly suggests these commands are specific to Vault
targets. Reference the evidence from the CLI reference that demonstrates
universal capability: the folder-sync command description explicitly states it
syncs "through Universal Secrets Connector" with no target-type restriction, and
the --usc-name flag documentation confirms it can be omitted to "process all
attached USCs for the folder." Revise the language to indicate that folder-sync
is being documented in a Vault-specific context as an example use case, not as a
Vault-only feature.In
@docs/Secrets
Management/rotated-secrets/create-a-hashicorp-vault-rotated-secret.md:
- Around line 1-12: The frontmatter in this documentation file has empty values
for metadata.title and metadata.description (lines 7-8). Populate these fields
with descriptive content that accurately represents the page topic (HashiCorp
Vault Rotated Secret) to meet the complete frontmatter requirement for
ReadMe.com pages. The metadata.title should be a clear page title and
metadata.description should provide a brief summary suitable for SEO and
documentation discoverability.
Nitpick comments:
In@docs/AdvancedFunctionality/akeyless-agent.md:
- Around line 126-131: Add the filename label
dynamic.tmplto the code block
containing the dynamicSecret template example. Change the opening code fence
fromshell` toshell dynamic.tmplto match the consistent labeling pattern used by other template examples in the Template Examples section (such asstatic.tmpl,rotated.tmpl, andssh_cert.tmpl), and to align with thesource = "path_to/dynamic.tmpl"` reference shown in the agent.toml
configuration.In
@docs/UniversalSecret
Connector/universal-secrets-connector/hc-vault-universal-secrets-connector.md:
- Around line 166-170: The bullet point describing account-level secret
versioning that applies across Akeyless item types (Static Secrets, Rotated
Secrets, and Targets) is currently in the HashiCorp Vault-specific section but
represents a general Akeyless capability, not HC Vault-specific functionality.
Remove this bullet point from the HC Vault-specific section in
hc-vault-universal-secrets-connector.md and relocate it to the Universal Secrets
Connector overview page or a shared capabilities section where it more
appropriately documents this cross-platform feature. Keep only the truly HC
Vault-specific information (folder sync commands and provider-specific version
details variation) in the current location.</details> <details> <summary>🪄 Autofix (Beta)</summary> Fix all unresolved CodeRabbit comments on this PR: - [ ] <!-- {"checkboxId": "4b0d0e0a-96d7-4f10-b296-3a18ea78f0b9"} --> Push a commit to this branch (recommended) - [ ] <!-- {"checkboxId": "ff5b1114-7d8c-49e6-8ac1-43f82af23a33"} --> Create a new PR with the fixes </details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **Run ID**: `d1dc2350-6d18-4533-8776-b80126834a73` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between d906941f799444da6d64324f6f70bcd23899931a and ecbc909746129d7cfdf17d5ea6e3b7f23ca8f300. </details> <details> <summary>📒 Files selected for processing (31)</summary> * `docs/AI Security/akeyless-ai-insight.md` * `docs/AI Security/identity-and-secrets-intelligence.md` * `docs/Accessing Akeyless/access-and-authentication-methods/auth-with-kubernetes/dedicated-k8s-auth-service-accounts.md` * `docs/Accessing Akeyless/access-and-authentication-methods/index.md` * `docs/Accessing Akeyless/rbac/index.md` * `docs/Accessing Akeyless/rbac/sub-claims.md` * `docs/Advanced Functionality/account-settings/index.md` * `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/index.md` * `docs/Akeyless Gateway/configure-gateway/gateway-caching/proactive-caching.md` * `docs/Akeyless Gateway/configure-gateway/gateway-log-forwarding.md` * `docs/Akeyless Gateway/gateway-best-practices.md` * `docs/Encryption & KMS/kmip-server/index.md` * `docs/Integrations & Plugins/cli-reference/cli-ref-auth/cli-reference-k8s-auth-method.md` * `docs/Integrations & Plugins/cli-reference/cli-reference-access-roles.md` * `docs/Integrations & Plugins/cli-reference/cli-reference-gateway/cli-reference-connect.md` * `docs/Integrations & Plugins/cli-reference/cli-reference-gateway/cli-reference-sra.md` * `docs/Integrations & Plugins/cli-reference/cli-reference-rotated-secrets.md` * `docs/Integrations & Plugins/cli-reference/cli-reference-universal-secrets-connector.md` * `docs/Secrets Management/rotated-secrets/_order.yaml` * `docs/Secrets Management/rotated-secrets/create-a-database-rotated-secret.md` * `docs/Secrets Management/rotated-secrets/create-a-hashicorp-vault-rotated-secret.md` * `docs/Secrets Management/rotated-secrets/index.md` * `docs/Secure Remote Access/sra-admin-guides/sra-akeyless-connect.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` * `docs/Universal Secret Connector/universal-secrets-connector/index.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| --- | ||
| title: HashiCorp Vault Rotated Secret | ||
| excerpt: '' | ||
| deprecated: false | ||
| hidden: false | ||
| metadata: | ||
| title: '' | ||
| description: '' | ||
| robots: index | ||
| next: | ||
| description: '' | ||
| --- |
There was a problem hiding this comment.
Populate empty metadata fields in frontmatter.
The frontmatter has the required keys present but metadata.title and metadata.description (lines 7-8) are empty strings. Per the coding guidelines, ReadMe.com pages require "complete front matter" with populated metadata values for proper documentation discoverability and SEO. These should be filled with descriptive content.
📝 Suggested metadata content
metadata:
- title: ''
- description: ''
+ title: 'Create a HashiCorp Vault Rotated Secret'
+ description: 'Set up automatic password rotation for HashiCorp Vault secrets using Akeyless'
robots: index📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --- | |
| title: HashiCorp Vault Rotated Secret | |
| excerpt: '' | |
| deprecated: false | |
| hidden: false | |
| metadata: | |
| title: '' | |
| description: '' | |
| robots: index | |
| next: | |
| description: '' | |
| --- | |
| --- | |
| title: HashiCorp Vault Rotated Secret | |
| excerpt: '' | |
| deprecated: false | |
| hidden: false | |
| metadata: | |
| title: 'Create a HashiCorp Vault Rotated Secret' | |
| description: 'Set up automatic password rotation for HashiCorp Vault secrets using Akeyless' | |
| robots: index | |
| next: | |
| description: '' | |
| --- |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/Secrets`
Management/rotated-secrets/create-a-hashicorp-vault-rotated-secret.md around
lines 1 - 12, The frontmatter in this documentation file has empty values for
metadata.title and metadata.description (lines 7-8). Populate these fields with
descriptive content that accurately represents the page topic (HashiCorp Vault
Rotated Secret) to meet the complete frontmatter requirement for ReadMe.com
pages. The metadata.title should be a clear page title and metadata.description
should provide a brief summary suitable for SEO and documentation
discoverability.
Source: Coding guidelines
3 participants
Summary
This PR reapplies the DOCS-892 documentation updates from #309.
be7437bb(the PR Revert PR #309 (DOCS-892) #311 revert commit)Traceability
Validation
Summary by CodeRabbit