Skip to content

docs: describe how transforms reach the pod today - #107

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

catinspace-au merged 1 commit into
mainfrom
docs/pre-public-cleanup

Conversation

@catinspace-au

Copy link
Copy Markdown
Contributor

DESIGN.md and MIGRATION.md said transforms are fetched from Artifactory by an init container. Nothing in the chart or the source does that, and an outside deployer has no such store. Docs only, no release.

How it works today:

  • The chart has no init container, no download step and no transform volume.
  • The wrapper loads transform YAML from config.transforms.dir (or the ordered config.transforms.files list). The image creates that directory empty at /etc/dfe-transform-vector/transforms.
  • The chart mounts only config.yaml (subPath), so the directory stays visible. tests/integration/deployment.rs asserts this.

What changed:

  • DESIGN.md: the volumes block of the architecture diagram shows the real config and transforms paths.
  • DESIGN.md: the chart parity table no longer says the ConfigMap carries transforms/.
  • MIGRATION.md: the "fetched from Artifactory" bullet now describes the transforms directory.
  • MIGRATION.md: the "transform delivery stays the same" bullet is gone, and the changes table has a Transform delivery row.
  • MIGRATION.md: the leftover mention of an artefact-store credential is removed.

Done when no doc names an init container or an artefact store for transforms.

The chart has no init container and no download step. The wrapper reads transform YAML from config.transforms.dir (an empty directory the image creates at /etc/dfe-transform-vector/transforms) or from config.transforms.files.

Fix the design diagram volumes and the chart parity table to match. Replace the migration notes on fetching transforms with that description, and drop the leftover mention of an artefact-store credential.
@catinspace-au
catinspace-au merged commit 0137744 into main Oct 6, 2026
7 checks passed
@catinspace-au
catinspace-au deleted the docs/pre-public-cleanup branch October 6, 2026 08:59
@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