NatLabRockies / NatLabRockies/openstudio-server-helm
Chore: remove dead-code configmaps/nfs-cm.yaml and configmaps/nfs/exports
Nobody has claimed this yet.
- Dominant language
- Go Template
- Stars
- 12
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
Summary
Two files in the chart are dead code — they have never been rendered by
helm template and no template references them.
Files
-
openstudio-server/configmaps/nfs-cm.yaml— at the root of
configmaps/, not undertemplates/.helm templateonly
renders files undertemplates/, so this file is never emitted.
The helm-unittest output and the rendered chart confirm: no
ConfigMap ornfs-cmreference appears in the rendered output. -
openstudio-server/configmaps/nfs/exports— referenced only by
the deadnfs-cm.yaml(which uses
(.Files.Glob "configmaps/nfs/*").AsConfig). Since
nfs-cm.yamlis never rendered, the contents of thisexports
file are also never used.
Verification
helm template smoketest ./openstudio-server --set provider.name=google | grep -i "kind: ConfigMap"
# (no output)
helm template smoketest ./openstudio-server --set provider.name=google | grep -i "nfs-cm"
# (no output)
Background
The chart started on a helm create scaffold and was hand-rolled
after that. The NFS exports ConfigMap was originally meant to seed
the NFS server provisioner subchart, but the real NFS provisioning
path is the subchart's own PVC + RBAC, not a ConfigMap. The dead
files have been in the repo since the chart's inception and were
spotted during the PR #102 review.
Proposed change
Delete both files in a single chore commit. No template or value
changes; helm template output is byte-identical before and after.
git rm openstudio-server/configmaps/nfs-cm.yaml
git rm openstudio-server/configmaps/nfs/exports
# optionally: remove the now-empty configmaps/nfs/ directory
Out of scope
- The chart's other working NFS bits (templates/nfs/nfs-pvc.yaml,
the nfs-server-provisioner subchart in Chart.yaml) — these are
load-bearing and stay. - Any change to the rendered chart at default values.
Related
- PR #102 review (C2 finding)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect openstudio-server/configmaps/nfs-cm.yaml and openstudio-server/configmaps/nfs/exports, then run the provided helm template and grep commands to confirm neither file contributes rendered output. Remove both files without changing templates or values, and verify the rendered chart remains unchanged and the configmaps/nfs directory is empty or removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- infrastructure
- Issue type
- Refactor
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 91/100