Skip to content

docs: warn that agentsMd shadows PVC files at the same path #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Joseph19820124 wants to merge 1 commit into from
+11 −2
Closed

docs: warn that agentsMd shadows PVC files at the same path #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions charts/openab/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ agents:
# enabled: true
# storageClass: ""
# size: 1Gi
# agentsMd: ""
# agentsMd: "" # when set, shadows any existing file at the same path on the PVC
# resources: {}
# nodeSelector: {}
# tolerations: []
Expand Down Expand Up @@ -77,7 +77,7 @@ agents:
# enabled: true
# storageClass: ""
# size: 1Gi
# agentsMd: ""
# agentsMd: "" # when set, shadows any existing file at the same path on the PVC
# resources: {}
# image: "ghcr.io/openabdev/openab-opencode:latest"
image: ""
Expand Down Expand Up @@ -115,6 +115,9 @@ agents:
enabled: true
storageClass: ""
size: 1Gi # defaults to 1Gi if not set
# agentsMd: when set, the ConfigMap volumeMount takes precedence over any existing file
# at the same path on the PVC (e.g. AGENTS.md, CLAUDE.md, GEMINI.md). The PVC file is
# not deleted but becomes invisible to the agent. Remove agentsMd to restore PVC files.
agentsMd: ""
resources: {}
nodeSelector: {}
Expand Down
6 changes: 6 additions & 0 deletions docs/openab-upgrade-sop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,12 @@ Pay special attention to:
- Added or deprecated environment variables
- Any migration steps

> ⚠️ **`agentsMd` takes precedence over PVC files:** If you have `agentsMd` set in your Helm
> values, the ConfigMap volumeMount will shadow any existing file at the same path on the PVC
> (e.g. `AGENTS.md`, `CLAUDE.md`, `GEMINI.md`). The PVC file is not deleted but becomes
> invisible to the agent. If you rely on PVC-managed agent instruction files, either leave
> `agentsMd` empty or migrate its content to the PVC file before upgrading.

### 3. Check Node Resources

```bash
Expand Down
Loading