Skip to content

docs: match the design doc to the chart paths and values - #108

Merged
catinspace-au merged 1 commit into
mainfrom
chore/pre-public-followups
Oct 6, 2026
Merged

catinspace-au merged 1 commit into
mainfrom
chore/pre-public-followups

Conversation

@catinspace-au

Copy link
Copy Markdown
Contributor

docs/DESIGN.md still described a chart and image layout that no longer exists, and this repo is going public.

  • The volumes diagram no longer calls /var/run/vector/config an emptyDir, because the chart has none and the image creates the directory
  • Section 5.1 uses /etc/dfe-transform-vector/config.yaml and /etc/dfe-transform-vector/transforms, the paths the chart and image use
  • Section 9.2 shows the abridged shape of chart/values.yaml and notes that the chart has no transforms value
  • Docs only, nothing else in the file is touched, so no release

Done when every path and value named in those spots matches chart/ and the Dockerfile.

The chart has no emptyDir for /var/run/vector/config. The image creates that directory, so the volumes diagram now says so.

Section 5.1 pointed at /etc/dfe/config.yaml and /etc/dfe/transforms. Both now use /etc/dfe-transform-vector, as the chart and image do.

Section 9.2 now shows the abridged shape of chart/values.yaml, in place of a values layout the chart no longer has. It also says the chart has no transforms value.
@catinspace-au
catinspace-au merged commit 55e6fa3 into main Oct 6, 2026
7 checks passed
@catinspace-au
catinspace-au deleted the chore/pre-public-followups branch October 6, 2026 09:34
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant