Skip to content

Keep cluster-specific install changes in overlays - #62

Open
josephschorr wants to merge 2 commits into
worktree-oap-render-gitopsfrom
install-overlays
Open

josephschorr wants to merge 2 commits into
worktree-oap-render-gitopsfrom
install-overlays

Conversation

@josephschorr

Copy link
Copy Markdown
Member

Stacked on #33.

Changes made by hand on a cluster, like raising the operator's memory limit after it was OOM-killed, are reset to the bundled value by the next oap install or upgrade. This lets people keep those changes in kustomize overlays they own instead, and replaces #52.

  • oap init, oap install and oap render take --overlay <dir>, repeatable and applied in order. An overlay is a kustomize Component, so the same directory works for direct installs and for GitOps renders.
  • Overlays are checked against everything oap installs before anything is built or applied. Two overlays that set the same field to different values are refused, with the resource, field and both values in the error. So are a patch that matches nothing and an overlay that adds or removes a resource.
  • Overlays can change any field. oap's own install-time settings (image references, pull secrets, mirrors) still take precedence on the fields they set.
  • A new "Customizing the install" docs page, linked from the upgrade and GitOps guides.

Not covered yet: an install run without its overlays still resets the values. Detecting that is a follow-up.

oap init, oap install and oap render take --overlay <dir> (repeatable): a
kustomize Component layered over the manifests oap installs, so a change such
as a raised memory limit survives every re-install and upgrade instead of being
reset to the bundled value.

Overlays are validated against every first-party manifest before anything is
built or applied. Two overlays setting one field to different values, a patch
that matches nothing, and an overlay that adds or removes a resource are all
refused with an error naming what to fix. Install's own per-document rewrites
(images, pull secrets, mirrors) still apply after the overlays.
@vercel

vercel Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
openagentprimitives Ready Ready Preview Nov 9, 2026 10:23pm UTC

Request Review

Overlays were reduced to patches derived from the bundled manifests, so a
change to a list with no merge key carried the bundle's whole list and undid
install's rewrite of an image ref inside it (an added operator arg reset the
runner image to its :dev tag). Apply now reruns the overlays with the document
install is about to write swapped into the base.

oap render now checks overlays against the resources it emits, so a patch for
a component it leaves out (Neo4j, Graphiti, Postgres without --with-postgres)
is refused up front instead of failing in the final build. Conflict detection
also keys volumeMounts and unnamed ports by their merge keys.

This branch was successfully deployed

1 active deployment
Preview — b376a14c Deployed Nov 9, 2026 by vercel[bot]
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