Skip to content

fix(platform): DSPX-2933 align KAS root key env var with Viper config path #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jp-ayyappan wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(platform): DSPX-2933 align KAS root key env var with Viper config path #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2c4557
fix(platform): DSPX-2933 align KAS root key env var with Viper config…
jp-ayyappan May 6, 2026
b7bce13
test(platform): DSPX-2933 update unit test for renamed KAS root key e…
jp-ayyappan May 6, 2026
b67ea38
docs(platform): document SERVICES_KAS_ROOT_KEY env var for root_key_s…
jp-ayyappan May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/platform/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ Download the [keycloak_data.yaml](https://raw.githubusercontent.com/opentdf/plat
| services.kas.config.registered_kas_uri | string | `nil` | Used by key management, if present. |
| services.kas.privateKeysSecret | string | `"kas-private-keys"` | KAS secret containing keys @deprecated Use `private_keys_secret` instead. This value will be removed in a future release. |
| services.kas.private_keys_secret | string | `""` | KAS secret containing keys kas-private.pem , kas-cert.pem , kas-ec-private.pem , kas-ec-cert.pem |
| services.kas.root_key_secret | object | `{"key":"root_key","name":"kas-root-key"}` | Key needed when key_management feature is enabled (openssl rand 32 -hex) openssl rand 32 -hex | kubectl create secret generic kas-root-key --from-file=root_key=/dev/stdin |
| services.kas.root_key_secret | object | `{"key":"root_key","name":"kas-root-key"}` | Key needed when key_management feature is enabled. Injected as `{PREFIX}_SERVICES_KAS_ROOT_KEY` env var (openssl rand 32 -hex) openssl rand 32 -hex | kubectl create secret generic kas-root-key --from-file=root_key=/dev/stdin |
| tolerations | list | `[]` | Tolerations to apply to the pod (https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
| trace.enabled | bool | `false` | Enable distributed tracing |
| trace.provider.file.compress | string | `nil` | Enable compression of trace files |
Expand Down
2 changes: 1 addition & 1 deletion charts/platform/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ spec:
key: {{ .Values.sdk_config.existingSecret.key }}
{{- end }}
{{- if and (or (contains "all" .Values.mode) (contains "kas" .Values.mode)) .Values.services.kas.config.preview.key_management }}
- name: {{include "platform.envVarPrefix" .}}_KAS_ROOT_KEY
- name: {{include "platform.envVarPrefix" .}}_SERVICES_KAS_ROOT_KEY
valueFrom:
secretKeyRef:
name: {{ .Values.services.kas.root_key_secret.name }}
Expand Down
2 changes: 1 addition & 1 deletion charts/platform/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ services:
alg: ec:secp256r1
- kid: r1
alg: rsa:2048
# -- Key needed when key_management feature is enabled (openssl rand 32 -hex)
# -- Key needed when key_management feature is enabled. Injected as `{PREFIX}_SERVICES_KAS_ROOT_KEY` env var (openssl rand 32 -hex)
# openssl rand 32 -hex | kubectl create secret generic kas-root-key --from-file=root_key=/dev/stdin
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 7, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Unescaped | in the helm-docs continuation line breaks the generated README table.

helm-docs appends plain # lines to the preceding # -- description, so the shell pipe in openssl rand 32 -hex | kubectl ... lands verbatim inside the Markdown table cell and creates a spurious extra column (confirmed by markdownlint MD056 at README line 217 — the data after the | is silently truncated).

Escape the pipe so it renders as a literal character:

🐛 Proposed fix 
-# openssl rand 32 -hex | kubectl create secret generic kas-root-key --from-file=root_key=/dev/stdin
+# openssl rand 32 -hex \| kubectl create secret generic kas-root-key --from-file=root_key=/dev/stdin
📝 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.

Suggested change
# openssl rand 32 -hex | kubectl create secret generic kas-root-key --from-file=root_key=/dev/stdin
# openssl rand 32 -hex \| kubectl create secret generic kas-root-key --from-file=root_key=/dev/stdin
🤖 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 `@charts/platform/values.yaml` at line 482, The README table breaks because the
comment line containing "openssl rand 32 -hex | kubectl create secret generic
kas-root-key --from-file=root_key=/dev/stdin" includes an unescaped pipe; edit
the comment in charts/platform/values.yaml and escape the pipe by replacing "|"
with "\|" so helm-docs emits a literal pipe in the generated Markdown
(preserving the rest of the line exactly) to prevent the table column split.

root_key_secret:
name: kas-root-key
Expand Down
2 changes: 1 addition & 1 deletion tests/chart_platform_template_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -944,7 +944,7 @@ func (s *PlatformChartTemplateSuite) Test_KeyManagement_Enabled_With_RootKeySecr
envVarFound := false
for _, container := range deployment.Spec.Template.Spec.Containers {
for _, envVar := range container.Env {
if envVar.Name == "OPENTDF_KAS_ROOT_KEY" {
if envVar.Name == "OPENTDF_SERVICES_KAS_ROOT_KEY" {
s.Require().Equal("my-root-key-secret", envVar.ValueFrom.SecretKeyRef.Name)
s.Require().Equal("my-root-key", envVar.ValueFrom.SecretKeyRef.Key)
envVarFound = true
Expand Down
Loading