Skip to content

docs: Update FluxCD example#5862

Merged
Skarlso merged 4 commits intoexternal-secrets:mainfrom
umizoom:bitwarden-docs
Jan 25, 2026
Merged

docs: Update FluxCD example#5862
Skarlso merged 4 commits intoexternal-secrets:mainfrom
umizoom:bitwarden-docs

Conversation

@umizoom
Copy link
Copy Markdown
Contributor

@umizoom umizoom commented Jan 25, 2026

Problem Statement

The example docs have a older/incorrect path reference for the external-secrets crds paths.

The Helm release example is out of date for the current helm chart

Related Issue

Fixes #... N/A

Proposed Changes

Updated the external-secrets crds paths in the FluxCD example docs

Updated the Helm release example for the current release of external-secrets

Example of this running in my cluster

Checklist

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage
  • All tests pass with make test
  • I ensured my PR is ready for review with make reviewable

Summary

Updates FluxCD example documentation to align with the current external-secrets chart and CRD locations.

Changes

  • Kustomization CRD path: updated from ./deploy/crds to ./config/crds/bases (docs/snippets/gitops/deployment-crds.yaml).
  • HelmRelease (docs/snippets/gitops/deployment.yaml):
    • Chart version bumped from 0.10.3 to 1.3.1.
    • Removed targetNamespace: external-secrets.
    • Replaced installCRDs: false with values.crds.create: false.
    • Minor reordering/formatting of releaseName and values block.
  • GitRepository reference (docs/snippets/gitops/repositories.yaml): ref tag updated from v0.10.3 to v1.3.1.

All changes are documentation/example updates to match the current external-secrets Helm chart and CRD layout.

When following the GitOps using FluxCD (v2) example docs I noticed a incorrect path for the external-secrets crds paths.
I also fixed the HelmRelease support the latest external-secrets chart version.

Signed-off-by: Umaid Abbasi <umaidabbasi@gmail.com>
Signed-off-by: Umaid Abbasi <umaidabbasi@gmail.com>
Signed-off-by: Umaid Abbasi <umaidabbasi@gmail.com>
@github-actions github-actions bot added kind/documentation Categorizes issue or PR as related to documentation. size/s labels Jan 25, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 25, 2026

Walkthrough

Updated Flux CD snippets for external-secrets: chart version bumped to v1.3.1, Kustomize CRD path changed, CRD installation config moved from installCRDs to values.crds.create, and targetNamespace: external-secrets was removed.

Changes

Cohort / File(s) Change Summary
Flux CD external-secrets Configuration
docs/snippets/gitops/deployment-crds.yaml, docs/snippets/gitops/deployment.yaml, docs/snippets/gitops/repositories.yaml
docs/snippets/gitops/deployment-crds.yaml: Kustomize path changed from ./deploy/crds./config/crds/bases.; docs/snippets/gitops/deployment.yaml: chart version 0.10.31.3.1; removed targetNamespace: external-secrets; moved releaseName position; removed installCRDs: false and added values.crds.create: false.; docs/snippets/gitops/repositories.yaml: GitRepository ref v0.10.3v1.3.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 and usage tips.

@umizoom umizoom changed the title docs(FluxCD example): Fix incorrect CRD paths docs: Update FluxCD example Jan 25, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/snippets/gitops/deployment.yaml`:
- Around line 22-25: The inline comment line under the Helm spec is mis-indented
(3 spaces) and should be aligned with top-level keys like values and install;
update the indentation of the comment (the line beginning with "# Ref:
https://fluxcd.io/...") to use 2 spaces so it is a sibling of values and
install, ensuring keys such as values, crds.create remain at the same
indentation level.

Signed-off-by: Umaid Abbasi <umaidabbasi@gmail.com>
@sonarqubecloud
Copy link
Copy Markdown

@Skarlso Skarlso merged commit bacb8f2 into external-secrets:main Jan 25, 2026
33 checks passed
nutmos pushed a commit to nutmos/external-secrets that referenced this pull request Feb 11, 2026
Signed-off-by: Nattapong Ekudomsuk <nuttapong_mos@hotmail.com>
nutmos pushed a commit to nutmos/external-secrets that referenced this pull request Feb 18, 2026
Signed-off-by: Nattapong Ekudomsuk <nuttapong_mos@hotmail.com>
radermacher-iits pushed a commit to kubara-io/kubara that referenced this pull request Feb 19, 2026
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [external-secrets](https://github.com/external-secrets/external-secrets) | minor | `1.2.1` → `1.3.2` |

---

### Release Notes

<details>
<summary>external-secrets/external-secrets (external-secrets)</summary>

### [`v1.3.2`](https://github.com/external-secrets/external-secrets/releases/tag/v1.3.2)

[Compare Source](external-secrets/external-secrets@v1.3.1...v1.3.2)

Image: `ghcr.io/external-secrets/external-secrets:v1.3.2`
Image: `ghcr.io/external-secrets/external-secrets:v1.3.2-ubi`
Image: `ghcr.io/external-secrets/external-secrets:v1.3.2-ubi-boringssl`

<!-- Release notes generated using configuration in .github/release.yml at main -->

#### What's Changed

##### General

- chore: release helm chart for v1.3.1 by [@&#8203;Skarlso](https://github.com/Skarlso) in [#&#8203;5860](external-secrets/external-secrets#5860)
- chore(chart): Add missing tests for readinessProbe by [@&#8203;jcpunk](https://github.com/jcpunk) in [#&#8203;5769](external-secrets/external-secrets#5769)
- docs: Update FluxCD example by [@&#8203;umizoom](https://github.com/umizoom) in [#&#8203;5862](external-secrets/external-secrets#5862)
- fix(ci): Removed the unused check for Windows in Makefile by [@&#8203;HauptJ](https://github.com/HauptJ) in [#&#8203;5870](external-secrets/external-secrets#5870)
- docs(release): Add actual dates for EOL of 1.x releases in stability and support page by [@&#8203;n4zukker](https://github.com/n4zukker) in [#&#8203;5889](external-secrets/external-secrets#5889)
- docs: Passbolt provider maintenance ownership by [@&#8203;stripthis](https://github.com/stripthis) in [#&#8203;5886](external-secrets/external-secrets#5886)
- chore: Update Passbolt MaintenanceStatus to MaintenanceStatusMaintained by [@&#8203;stripthis](https://github.com/stripthis) in [#&#8203;5887](external-secrets/external-secrets#5887)
- fix(security): sanitize json.Unmarshal errors to prevent secret data … by [@&#8203;moolen](https://github.com/moolen) in [#&#8203;5884](external-secrets/external-secrets#5884)
- fix: webhook initialization order by [@&#8203;gusfcarvalho](https://github.com/gusfcarvalho) in [#&#8203;5901](external-secrets/external-secrets#5901)
- chore: Cleanup flags by [@&#8203;evrardj-roche](https://github.com/evrardj-roche) in [#&#8203;5845](external-secrets/external-secrets#5845)
- fix: onepasswordsdk shared tenant by altering the provider in the client cache by [@&#8203;Skarlso](https://github.com/Skarlso) in [#&#8203;5921](external-secrets/external-secrets#5921)

##### Dependencies

- chore(deps): bump github/codeql-action from 4.31.10 to 4.31.11 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5873](external-secrets/external-secrets#5873)
- chore(deps): bump pymdown-extensions from 10.20 to 10.20.1 in /hack/api-docs by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5877](external-secrets/external-secrets#5877)
- chore(deps): bump markdown from 3.10 to 3.10.1 in /hack/api-docs by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5880](external-secrets/external-secrets#5880)
- chore(deps): bump ubi9/ubi from `22e9573` to `1f84f5c` by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5871](external-secrets/external-secrets#5871)
- chore(deps): bump actions/setup-python from 6.1.0 to 6.2.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5872](external-secrets/external-secrets#5872)
- chore(deps): bump hashicorp/setup-terraform from [`93d5a27`](external-secrets/external-secrets@93d5a27) to [`dcc3150`](external-secrets/external-secrets@dcc3150) by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5875](external-secrets/external-secrets#5875)
- chore(deps): bump actions/checkout from 6.0.1 to 6.0.2 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5876](external-secrets/external-secrets#5876)
- chore(deps): bump step-security/harden-runner from 2.14.0 to 2.14.1 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5878](external-secrets/external-secrets#5878)
- chore(deps): bump anchore/sbom-action from 0.21.1 to 0.22.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5874](external-secrets/external-secrets#5874)
- chore(deps): bump packaging from 25.0 to 26.0 in /hack/api-docs by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5879](external-secrets/external-secrets#5879)
- chore(deps): bump golang from `d9b2e14` to `98e6cff` by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5907](external-secrets/external-secrets#5907)
- chore(deps): bump alpine from `865b95f` to `2510918` in /hack/api-docs by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5914](external-secrets/external-secrets#5914)
- chore(deps): bump docker/login-action from 3.6.0 to 3.7.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5909](external-secrets/external-secrets#5909)
- chore(deps): bump actions/cache from 5.0.2 to 5.0.3 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5912](external-secrets/external-secrets#5912)
- chore(deps): bump actions/attest-build-provenance from 3.1.0 to 3.2.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5910](external-secrets/external-secrets#5910)
- chore(deps): bump hashicorp/setup-terraform from [`dcc3150`](external-secrets/external-secrets@dcc3150) to [`ce70bcf`](external-secrets/external-secrets@ce70bcf) by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5911](external-secrets/external-secrets#5911)
- chore(deps): bump ubi9/ubi from `1f84f5c` to `c8df11b` by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5908](external-secrets/external-secrets#5908)
- chore(deps): bump alpine from 3.23.2 to 3.23.3 in /e2e by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5915](external-secrets/external-secrets#5915)
- chore(deps): bump alpine from `865b95f` to `2510918` by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5906](external-secrets/external-secrets#5906)
- chore(deps): bump pathspec from 1.0.3 to 1.0.4 in /hack/api-docs by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5916](external-secrets/external-secrets#5916)
- chore(deps): bump babel from 2.17.0 to 2.18.0 in /hack/api-docs by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5917](external-secrets/external-secrets#5917)
- chore(deps): bump github/codeql-action from 4.31.11 to 4.32.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;5913](external-secrets/external-secrets#5913)

#### New Contributors

- [@&#8203;umizoom](https://github.com/umizoom) made their first contribution in [#&#8203;5862](external-secrets/external-secrets#5862)
- [@&#8203;HauptJ](https://github.com/HauptJ) made their first contribution in [#&#8203;5870](external-secrets/external-secrets#5870)
- [@&#8203;n4zukker](https://github.com/n4zukker) made their first contribution in [#&#8203;5889](external-secrets/external-secrets#5889)
- [@&#8203;stripthis](https://github.com/stripthis) made their first contribution in [#&#8203;5886](external-secrets/external-secrets#5886)

**Full Changelog**: <external-secrets/external-secrets@v1.3.1...v1.3.2>

### [`v1.3.1`](https://github.com/external-secrets/external-secrets/releases/tag/v1.3.1)

[Compare Source](external-secrets/external-secrets@v1.2.1...v1.3.1)

Image: `ghcr.io/external-secrets/external-secrets:v1.3.1`
Image: `ghcr.io/external-secrets/external-secrets:v1.3.1-ubi`
Image: `ghcr.io/external-secrets/external-secrets:v1.3.1-ubi-boringssl`

<!-- Release notes generated using configuration in .github/release.yml at main -->

For a Full release please referre to <https://github.com/external-secrets/external-secrets/releases/tag/v1.3.0>. This is a fix build for the docker publish flow.

#### What's Changed

##### General

- fix: ignore the in-toto manifest when promoting the docker build by [@&#8203;Skarlso](https://github.com/Skarlso) in [#&#8203;5859](external-secrets/external-secrets#5859)

**Full Changelog**: <external-secrets/external-secrets@v1.3.0...v1.3.1>

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi45Mi4yIiwidXBkYXRlZEluVmVyIjoiNDIuOTUuNSIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6W119-->

Reviewed-on: https://kubara.git.onstackit.cloud/STACKIT/kubara/pulls/250
dsp0x4 pushed a commit to dsp0x4/external-secrets that referenced this pull request Mar 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/s

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants