Skip to content

Commit 8aae9cd

Browse files
[docs] Address review feedback on tenant-module-overrides proposal
- Fix schema path in Design §2 to match the valuesOverride field name. - Invoke dict() explicitly as (dict) in the Helm template schematics for clarity. - Add a fence language to the @embed syntax block. Signed-off-by: Myasnikov Daniil <[email protected]>
1 parent 0319581 commit 8aae9cd

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

  • design-proposals/tenant-module-overrides

‎design-proposals/tenant-module-overrides/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Key points:
9393

9494
New annotation in [cozyvalues-gen](https://github.com/cozystack/cozyvalues-gen):
9595

96-
```
96+
```text
9797
@embed <package-path> as <TypedefName>
9898
```
9999

@@ -112,7 +112,7 @@ Semantics:
112112

113113
Generator output side effects:
114114

115-
- Tenant chart's `values.schema.json` gains the full etcd sub-schema under `properties.etcd.properties.values`.
115+
- Tenant chart's `values.schema.json` gains the full etcd sub-schema under `properties.etcd.properties.valuesOverride`.
116116
- Tenant chart's generated README lists the embedded schema inline, with a reference note pointing at the source package.
117117
- Generator adds the target package's `values.yaml` path to a sidecar manifest so that `make generate` knows the tenant chart must be regenerated whenever `packages/extra/etcd/values.yaml` changes. (Concretely: a one-line `# cozyvalues-gen:embed packages/extra/etcd` header in the generated artifacts so a pre-commit check flags stale generation.)
118118

@@ -128,7 +128,7 @@ Each module template normalizes bool-form to object-form and, when `enabled`, re
128128
{{- $etcd := .Values.etcd }}
129129
{{- if kindIs "bool" $etcd }}
130130
{{- /* Bool-form compatibility shim. Normalized to object-form. */ -}}
131-
{{- $etcd = dict "enabled" $etcd "valuesOverride" dict }}
131+
{{- $etcd = dict "enabled" $etcd "valuesOverride" (dict) }}
132132
{{- end }}
133133
{{- if $etcd.enabled }}
134134
---
@@ -171,7 +171,7 @@ metadata:
171171
type: Opaque
172172
stringData:
173173
values.yaml: |
174-
{{ toYaml (default dict $etcd.valuesOverride) | indent 4 }}
174+
{{ toYaml (default (dict) $etcd.valuesOverride) | indent 4 }}
175175
{{- end }}
176176
```
177177

0 commit comments

Comments
 (0)