Repository navigation
Commit 06ca603
authored
feat(platform): expose Keycloak truststores through platform values (#5144)
## What this PR does
Fixes #5140.
#5039 added `truststores` to the Keycloak chart, but that capability was
not reachable through the administrator-owned platform Package: the
system bundle rendered `Package cozystack.keycloak` without a components
override. This PR adds the optional
`authentication.oidc.keycloakTruststores` platform value and forwards it
unchanged to `spec.components.keycloak.values.truststores` on that child
Package.
Administrators can configure it under `spec.components.platform.values`
on `Package cozystack.cozystack-platform`:
```yaml
authentication:
oidc:
keycloakTruststores:
- configMapName: organization-ca
key: ca.crt
- secretName: partner-ca
key: certificates.pem
```
When OIDC is enabled and the list is non-empty, the complete list is
forwarded, including entry order, explicitly selected keys, and entries
that omit `key` so the chart's `ca.crt` default remains effective. When
the value is unset or explicitly empty, the platform continues to use
the default Package helper without introducing `spec.components`. When
OIDC is disabled, the value is ignored because no Keycloak Package is
emitted.
The platform layer only forwards references; it does not create Secrets
or ConfigMaps. Referenced objects and keys must already exist in
`cozy-keycloak`, and the Keycloak chart remains responsible for
validation and mounting. Its existing semantics are unchanged: trust
applies server-wide across all realms, only public certificate material
should be supplied, and changing an object's contents requires a
Keycloak restart or a versioned object reference to reload the
truststore.
### Validation
- `make test` in `packages/core/platform`: all 295 tests pass. The new
suite covers unset, empty and null defaults, complete list forwarding,
false-y malformed values, both `isp-full` and `isp-slim`, and disabled
OIDC; removing the forwarding path or restoring truthiness-based empty
checks makes the regression suite fail.
- `make test` in `packages/system/keycloak`: all 121 tests pass.
- With the system bundle and OIDC enabled, the unset render is
byte-identical to `upstream/main`. The explicitly empty case is
separately verified to omit `spec.components`; malformed false-y values
reach the Keycloak chart and are rejected by its existing `truststores
must be a list` validation.
- `make generate` has no target in `packages/core/platform`; there are
no generated platform schema artifacts to update.
- `make show` could not run because `cozyhr` is unavailable. A direct
`helm template` render of the system bundle was checked in a temporary
chart copy with `templates/repository.yaml` removed because its `lookup`
requires a live source. This verifies rendering and forwarding, not a
live-cluster deployment or an end-to-end Keycloak TLS connection.
### Screenshots
Not applicable; no UI changes.
### Downstream repositories
Changing `packages/core/platform/values.yaml` directly triggers the
website's hand-written platform-package reference. The existing
cozystack/website#765 follow-up covers both the chart-level value and
this platform configuration path, including
`content/en/docs/next/operations/configuration/platform-package.md`; no
other downstream trigger applies to this diff.
- [ ] No downstream repository is affected by this change
- [x] [cozystack/website](https://github.com/cozystack/website) -
follow-up: cozystack/website#765 (covers the
platform value and platform-package reference as well as the chart-level
guide)
- [ ]
[cozystack/terraform-provider-cozystack](https://github.com/cozystack/terraform-provider-cozystack)
- follow-up:
- [ ]
[cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack)
- follow-up:
- [ ] [cozystack/ccp](https://github.com/cozystack/ccp) - follow-up:
- [ ] [cozystack/talm](https://github.com/cozystack/talm) - follow-up:
- [ ] [cozystack/cozyhr](https://github.com/cozystack/cozyhr) -
follow-up:
- [ ] [cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy) -
follow-up:
- [ ]
[cozystack/cozystack-telemetry-server](https://github.com/cozystack/cozystack-telemetry-server)
- follow-up:
- [ ]
[cozystack/external-apps-example](https://github.com/cozystack/external-apps-example)
- follow-up:
- [ ] [cozystack/examples](https://github.com/cozystack/examples) -
follow-up:
- [ ] [cozystack/community](https://github.com/cozystack/community) -
follow-up:
### Release note
```release-note
feat(platform): add `authentication.oidc.keycloakTruststores` so administrators can forward existing Secret or ConfigMap CA references from the platform Package to the bundled Keycloak server for private-CA LDAPS, external identity-provider, and SMTP TLS connections.
```
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
<!-- coderabbit-ai-generated:v1 -->
## Summary by CodeRabbit
* **New Features**
* Added the `authentication.oidc.keycloakTruststores` setting for
configuring additional CA certificates from Secrets or ConfigMaps in
`cozy-keycloak`. Certificate entries default to `ca.crt`, and configured
certificates apply across all Keycloak realms.
* The setting defaults to an empty list. Configured truststores are
passed to Keycloak when OIDC is enabled; when OIDC is disabled, the
setting is ignored and existing Keycloak package settings remain
unchanged.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->3 files changed
Lines changed: 226 additions & 0 deletions
File tree
- packages/core/platform
- templates/bundles
- tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
178 | 178 | | |
179 | 179 | | |
180 | 180 | | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
181 | 187 | | |
182 | 188 | | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
183 | 192 | | |
| 193 | + | |
184 | 194 | | |
185 | 195 | | |
186 | 196 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
549 | 549 | | |
550 | 550 | | |
551 | 551 | | |
| 552 | + | |
| 553 | + | |
| 554 | + | |
| 555 | + | |
| 556 | + | |
| 557 | + | |
| 558 | + | |
| 559 | + | |
| 560 | + | |
| 561 | + | |
| 562 | + | |
| 563 | + | |
| 564 | + | |
552 | 565 | | |
553 | 566 | | |
554 | 567 | | |
| |||
0 commit comments