mirror of
https://github.com/truecharts/charts.git
synced 2026-07-06 18:51:23 -03:00
c0ff8684ce
**Description**
This PR builds up on #40000 by adding an additional key -
`credentials.$name.customCASecretRef`. This allows referencing secrets
via the already familiar `configMapRef`/`secretRef` pattern, using the
`name` and `expandObjectName` keys to reference secrets defined under
`.Values.secret`. Additionally, it also adds a
`credentials.$name.customCASecretRef.key` forcing users to specify the
key in the secret which contains the CA, for maximum flexibility.
⚒️ Fixes # <!--(issue)-->
**⚙️ Type of change**
- [X] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [X] 📜 Documentation Changes
**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->
I tested rendering the same CA secret using both the current `customCA`
implementation and the new `.secret.$name` + `customCASecretRef` way.
Also added unit tests for CI.
**📃 Notes:**
Regarding CNPG support - the changes in this PR and from #40000 should
also work for CNPG. As far as i can tell it requires the CA secret to be
referenced under a key called `endpointCA` in the following way
([docs](https://cloudnative-pg.io/documentation/1.16/api_reference/#backupstatus),
[CRD
def](6ae2fb61be/config/crd/bases/postgresql.cnpg.io_backups.yaml (L256))):
```yaml
...
barmanObjectStore:
endpointURL: ...
...
endpointCA:
name: secret-name
key: secret-key
```
Note that while the current [in-tree barman cloud support is being
deprecated in favour of a barman cloud
plugin](https://cloudnative-pg.io/releases/cloudnative-pg-1-26.0-released/#barman-cloud-deprecation-begins),
the [migration
guide](https://cloudnative-pg.io/plugin-barman-cloud/docs/migration/)
says the new `ObjectStore` CRD has a **direct mapping** between it and
the legacy `barmanObjectStore`. Therefore, the example above can be
translated to:
```yaml
apiVersion: barmancloud.cnpg.io/v1
kind: ObjectStore
...
spec:
configuration:
endpointURL: ...
...
endpointCA:
name: secret-name
key: secret-key
```
**✔️ Checklist:**
- [X] ⚖️ My code follows the style guidelines of this project
- [X] 👀 I have performed a self-review of my own code
- [X] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [X] 📄 I have made changes to the documentation
- [X] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [X] ⬆️ I increased versions for any altered app according to semantic
versioning
- [X] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`
**➕ App addition**
If this PR is an app addition please make sure you have done the
following.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`
---
_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
---------
Signed-off-by: Kjeld Schouten <info@kjeldschouten.nl>
Co-authored-by: Kjeld Schouten <info@kjeldschouten.nl>
Chart Docs
News
- To add new authors, add their username in the
authors.tsfile insrc/content/docs/news/authors.ts. - News Posts must have these fields in the
frontmatter:titleslug(must start withnews/)dateauthors(The key in theauthorsobject insrc/content/docs/news/authors.ts)
Supported Code Block Languages
Check upstream docs
🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run dev-windows |
Starts local dev server on windows machines |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.
Images can be added to src/assets/ and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the public/ directory.
👀 Want to learn more?
Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.