What would you like to be added:
Please update the HAMi configuration doc to explain the risk of editing Helm-managed ConfigMaps with kubectl edit.
Current doc says users can edit the global device config with:
kubectl edit configmap hami-scheduler-device -n <namespace>
But hami-scheduler-device is also managed by the Helm chart.
Suggested doc changes:
- Recommend Helm values / chart config as the main way to make persistent config changes.
- Keep
kubectl edit, but mark it as a temporary or troubleshooting method.
- Add a note that changes made with
kubectl edit may be overwritten by the next helm upgrade.
- If users must edit the ConfigMap manually, suggest backing up the current config before upgrade.
- After upgrade, users should restore only the fields they need to keep. They should not replace the whole old ConfigMap.
- For fields that already have chart values, suggest using chart values first.
Why is this needed:
The current doc does not explain that hami-scheduler-device is managed by Helm.
If a user changes this live ConfigMap with kubectl edit, the change is not saved back to Helm values or the chart manifest. On the next helm upgrade, Helm may render the ConfigMap again and overwrite the manual change.
This can confuse users. They may think kubectl edit is a stable way to keep this config, but it is not safe across Helm upgrades.
Anything else we need to know?:
Related doc:
https://project-hami.io/docs/userguide/configure
Related sections:
Device Configs: ConfigMap
Node Configs: ConfigMap
Chart Config: Parameters
What would you like to be added:
Please update the HAMi configuration doc to explain the risk of editing Helm-managed ConfigMaps with
kubectl edit.Current doc says users can edit the global device config with:
But
hami-scheduler-deviceis also managed by the Helm chart.Suggested doc changes:
kubectl edit, but mark it as a temporary or troubleshooting method.kubectl editmay be overwritten by the nexthelm upgrade.Why is this needed:
The current doc does not explain that
hami-scheduler-deviceis managed by Helm.If a user changes this live ConfigMap with
kubectl edit, the change is not saved back to Helm values or the chart manifest. On the nexthelm upgrade, Helm may render the ConfigMap again and overwrite the manual change.This can confuse users. They may think
kubectl editis a stable way to keep this config, but it is not safe across Helm upgrades.Anything else we need to know?:
Related doc:
https://project-hami.io/docs/userguide/configure
Related sections:
Device Configs: ConfigMapNode Configs: ConfigMapChart Config: Parameters