Skip to content

Update external-secrets-operator.md - #322

Closed
baraka-akeyless wants to merge 1 commit into
v1.0from
baraka-akeyless-patch-1
Closed

Update external-secrets-operator.md#322
baraka-akeyless wants to merge 1 commit into
v1.0from
baraka-akeyless-patch-1

Conversation

@baraka-akeyless

@baraka-akeyless baraka-akeyless commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

adding ignoreCache option

Summary

Validation

  • markdownlint run for edited Markdown files
  • cspell run for edited Markdown files
  • link check run for edited Markdown files

Safety Checklist

  • No real credentials, tokens, account identifiers, tenant IDs, project numbers, or email addresses were added.
  • All cloud identities in examples use placeholders (for example, <service-account-name>@<project-id>.iam.gserviceaccount.com, arn:aws:iam::<aws-account-id>:root, <azure-tenant-id>, and <resource-ocid>).
  • Added examples were reviewed for sanitized values and non-production identifiers.

Jira

  • DOCS-

Summary by CodeRabbit

  • Documentation
    • Updated the External Secrets Operator integration guide with the ignoreCache option.
    • Added configuration guidance for bypassing Gateway cache and retrieving secrets directly from SaaS.

adding ignoreCache option
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The External Secrets Operator integration guide now documents the ignoreCache option in SecretStore and ExternalSecret examples, including Gateway cache bypass and direct SaaS retrieval.

Changes

ESO cache bypass documentation

Layer / File(s) Summary
Document ignoreCache usage
docs/Integrations & Plugins/plugins-overview/kubernetes-plugins/external-secrets-operator.md
Adds a commented ignoreCache: true SecretStore example field and documents the ExternalSecret option for retrieving secrets directly from SaaS without cache involvement.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: harrison-akeyless

🚥 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 is related to the changed documentation file, but it is broad and does not mention the new ignoreCache option.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch baraka-akeyless-patch-1

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with 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.

Inline comments:
In `@docs/Integrations` &
Plugins/plugins-overview/kubernetes-plugins/external-secrets-operator.md:
- Line 356: Remove the ignoreCache bullet from the ExternalSecret fields
documentation and retain its description under the SecretStore Akeyless provider
settings alongside the existing example. Ensure the documentation identifies it
as spec.provider.akeyless.ignoreCache rather than an ExternalSecret.spec field.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: dcfa751f-a532-4b1a-a36d-eb8b81d8c08e

📥 Commits

Reviewing files that changed from the base of the PR and between 65a325f and e275064.

📒 Files selected for processing (1)
  • docs/Integrations & Plugins/plugins-overview/kubernetes-plugins/external-secrets-operator.md

* `target.name`: Name of the Kubernetes Secret created.
* `data[*].secretKey`: Key name inside the Kubernetes Secret.
* `data[*].remoteRef.key`: Full path of the item in Akeyless.
* `ignoreCache`: Fetch the secret directly from SaaS without cache involved.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Locate all references to ignoreCache in the relevant docs
rg -n "ignoreCache|AkeylessProvider|SecretStore|ExternalSecret" "docs/Integrations & Plugins/plugins-overview/kubernetes-plugins/external-secrets-operator.md"

# Show the relevant surrounding lines around the reported location and the earlier example
sed -n '210,235p' "docs/Integrations & Plugins/plugins-overview/kubernetes-plugins/external-secrets-operator.md"
echo "-----"
sed -n '345,365p' "docs/Integrations & Plugins/plugins-overview/kubernetes-plugins/external-secrets-operator.md"

Repository: akeylesslabs/technical-documentation

Length of output: 5371


Move ignoreCache to the SecretStore provider docs.

ignoreCache is an Akeyless provider setting under spec.provider.akeyless, not an ExternalSecret.spec field. The bullet at line 356 points to the wrong resource boundary; the example at line 221 is the correct placement.

🤖 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/Integrations` &
Plugins/plugins-overview/kubernetes-plugins/external-secrets-operator.md at line
356, Remove the ignoreCache bullet from the ExternalSecret fields documentation
and retain its description under the SecretStore Akeyless provider settings
alongside the existing example. Ensure the documentation identifies it as
spec.provider.akeyless.ignoreCache rather than an ExternalSecret.spec field.

@EldadH89

Copy link
Copy Markdown
Collaborator

closed from readme

@EldadH89 EldadH89 closed this Jul 22, 2026
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