docs: warn that agentsMd shadows PVC files at the same path#376
Closed
Joseph19820124 wants to merge 1 commit intoopenabdev:mainfrom
Closed
docs: warn that agentsMd shadows PVC files at the same path#376Joseph19820124 wants to merge 1 commit intoopenabdev:mainfrom
Joseph19820124 wants to merge 1 commit intoopenabdev:mainfrom
Conversation
When agentsMd is set, the ConfigMap volumeMount takes precedence over any existing file at the same path on the PVC (AGENTS.md, CLAUDE.md, GEMINI.md, etc.). The PVC file is not deleted but becomes invisible to the agent with no warning emitted. - Add inline comment in values.yaml next to agentsMd explaining the shadowing behaviour (active block + both commented-out examples) - Add a callout in the upgrade SOP (Section I, step 2) so operators are reminded to check agentsMd before upgrading Fixes openabdev#360
github-actions
bot
added
the
closing-soon
|
All PRs must reference a prior Discord discussion to ensure community alignment before implementation. Please edit the PR description to include a link like: This PR will be automatically closed in 3 days if the link is not added. |
github-actions
bot
added
needs-rebase
pending-contributor
and removed
needs-rebase
pending-contributor
labels
|
🔒 Auto-closing: this PR has had the Feel free to reopen after adding the discussion link to the PR body. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #360
When
agentsMdis set in Helm values, the ConfigMap volumeMount silently shadows any existing file at the same path on the PVC (AGENTS.md,CLAUDE.md,GEMINI.md, etc.). The PVC file is not deleted but becomes invisible to the agent. This is standard Kubernetes behaviour but there was no documentation warning about it.Changes
charts/openab/values.yamlAdded an inline comment next to
agentsMdin the active agent block and both commented-out example blocks explaining the shadowing behaviour and how to restore PVC files.docs/openab-upgrade-sop.mdAdded a callout under "Pay special attention to" in Section I (Read the Release Notes) so operators are reminded to check their
agentsMdsetting before upgrading.No code changes
This is a documentation-only fix. No logic, templates, or chart behaviour was modified.