PatchRef¶
A PatchRef points to a patch file that can be overlaid onto a package to
modify part of its configuration without changing the base package
directly.
Patches are partial configuration blocks stored under the package
patches/ directory and applied using the package overlay workflow. They
operate on the Package object model and are merged using kustomize-style
strategic merge behavior.
Patch files are typically stored as:
{package-root}/patches/{patch-name}.yaml
A patch can target the current package, or it can reference a patch from an
installed dependency by setting dep to the dependency package name.
Patches currently apply to package configuration, such as databases and pipelines. They do not patch source code files directly.
Contexts¶
| Context | Relationship | Object Path | Package File Path |
|---|---|---|---|
Manifest.patches |
Package -> Manifest -> PatchRef |
$.manifest.patches[*] |
{package-root}/manifest.yaml |
Package.patches |
Package -> PatchRef |
$.patches[*] |
{package-root}/patches/{patch-name} |
Fields¶
| Field | Type | Required | Description | Constraints | Default |
|---|---|---|---|---|---|
name |
string |
yes | - | - | - |
dep |
string | null |
no | - | - | null |
group |
string | null |
no | - | - | null |
metadata |
ComponentMetadata | null |
no | - | - | null |
uuid |
string | null |
no | - | format: "uuid" |
- |
Links To¶
metadata:ComponentMetadata