Conversation
Signed-off-by: Dmitry Shmulevich <dshmulevich@nvidia.com>
Greptile SummaryThis PR updates three documentation files: it narrows the example Helm schema validation error in
Confidence Score: 3/5The two smaller file changes are accurate, but k8s.md now documents a schema error list that diverges from the actual values.schema.json, which will confuse operators who encounter the real error. The example error output in k8s.md was trimmed to 10 providers while the Helm schema still validates against 19. Any user who triggers that validation error will see a different list than the docs show, making the documentation actively misleading. The other two files look correct. docs/engines/k8s.md needs its example error output reconciled with charts/topograph/values.schema.json Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[helm install --set global.provider.name=X] --> B{Helm schema validation\nvalues.schema.json}
B -- "X in 19-item enum" --> C[Template renders successfully]
B -- "X not in enum" --> D[Error: value must be one of...\n19 providers listed]
D -.->|"Docs (k8s.md) show\nonly 10 providers"| E[User confusion:\ndocs don't match real error]
C --> F[Provider topology discovery\naws / oci / gcp / nscale / etc.]
F --> G[Node labels written\naccelerator / leaf / spine / core]
Reviews (1): Last reviewed commit: "chore(docs): update docs" | Re-trigger Greptile |
| Error: values don't meet the specifications of the schema(s) in the following chart(s): | ||
| topograph: | ||
| - at '/global/provider/name': value must be one of 'aws', 'aws-sim', 'cw', 'dra', 'dsx-sim', 'gcp', 'gcp-sim', 'infiniband-bm', 'infiniband-k8s', 'lambdai', 'lambdai-sim', 'nebius', 'nscale', 'netq', 'oci', 'oci-imds', 'oci-sim', 'test' | ||
| - at '/global/provider/name': value must be one of 'aws', 'oci', 'gcp', 'cw', 'infiniband-k8s', 'lambdai', 'nebius', 'nscale', 'netq', 'test' |
There was a problem hiding this comment.
Example error message no longer matches the real schema
The updated example only lists 10 providers (aws, oci, gcp, cw, infiniband-k8s, lambdai, nebius, nscale, netq, test), but charts/topograph/values.schema.json still enumerates 19 values: aws, aws-sim, cw, dra, gcp, gcp-sim, dsx-sim, infiniband-bm, infiniband-k8s, lambdai, lambdai-sim, nebius, netq, nscale, nscale-sim, oci, oci-imds, oci-sim, test. A user who supplies --set global.provider.name=bogus will see Helm emit the full 19-item list, not this abbreviated one, making the docs misleading. Either update values.schema.json to match the narrower list, or restore the full enum in the example.
Description
Checklist
git commit -s).