renovate/lib/modules/manager/kustomize
Risu 397ab49ef3
docs(managers): add missing url and displayName (#32621)
Co-authored-by: Michael Kriese <michael.kriese@gmx.de>
2024-12-01 08:47:27 +00:00
..
__fixtures__ feat(kustomize): support OCI helm charts (#27163) 2024-03-13 15:48:06 +00:00
__snapshots__ feat(kustomize): support OCI helm charts (#27163) 2024-03-13 15:48:06 +00:00
extract.spec.ts fix(manager/kustomize): fix parsing kustomize resource URLs with additional query parameters (#32746) 2024-11-28 06:19:53 +00:00
extract.ts fix(manager/kustomize): fix parsing kustomize resource URLs with additional query parameters (#32746) 2024-11-28 06:19:53 +00:00
index.ts docs(managers): add missing url and displayName (#32621) 2024-12-01 08:47:27 +00:00
readme.md feat(kustomize): support OCI helm charts (#27163) 2024-03-13 15:48:06 +00:00
types.ts feat(flux): support kustomization (#29224) 2024-05-24 07:49:39 +00:00

readme.md

Renovate can manage these parts of the kustomization.yaml file:

  1. remote resources
  2. image tags
  3. components
  4. helm charts
  5. remote bases (deprecated since Kustomize v2.1.0)

How It Works

  1. Renovate searches in each repository for any kustomization.yaml files
  2. Dependencies are extracted from remote bases, image tags and Helm charts
  3. Renovate resolves the dependency's source repository and checks if there are SemVer tags
  4. If Renovate finds an update, then it updates the kustomization.yaml file

This manager uses three depTypes to allow fine-grained control of which dependencies are upgraded:

  • Component
  • Kustomization
  • HelmChart
  • OCIChart

Limitations

  • Using HTTPS to fetch the repositories is not tested
  • The keys for the image tags can be in any order
- name: image/name
  newTag: v0.0.1
# or
- newTag: v0.0.1
  name: image/name
  • Digests can be pinned in newTag or digest:
- name: image/name
  newTag: v0.0.1@sha256:3eeba3e2caa30d2aba0fd78a34c1bbeebaa1b96c7aa3c95ec9bac44163c5ca4f
# without a version, digests are tracked as :latest
- name: image/name
  digest: sha256:3eeba3e2caa30d2aba0fd78a34c1bbeebaa1b96c7aa3c95ec9bac44163c5ca4f
  • The image's repository can be changed with newName:
- name: image/name
  newName: custom-image/name:v0.0.1
- name: image/name
  newName: custom-image/name:v0.0.1@sha256:3eeba3e2caa30d2aba0fd78a34c1bbeebaa1b96c7aa3c95ec9bac44163c5ca4f
- name: image/name
  newName: custom-image/name@sha256:3eeba3e2caa30d2aba0fd78a34c1bbeebaa1b96c7aa3c95ec9bac44163c5ca4f
- name: image/name
  newName: custom-image/name
  newTag: v0.0.1@sha256:3eeba3e2caa30d2aba0fd78a34c1bbeebaa1b96c7aa3c95ec9bac44163c5ca4f
- name: image/name
  newName: custom-image/name
  digest: sha256:3eeba3e2caa30d2aba0fd78a34c1bbeebaa1b96c7aa3c95ec9bac44163c5ca4f
  • Images with values ignored by Kustomize will be skipped to avoid ambiguity:
# bad: skipped because newTag: is ignored when digest: is set
- name: image/name
  newTag: v0.0.1
  digest: sha256:3eeba3e2caa30d2aba0fd78a34c1bbeebaa1b96c7aa3c95ec9bac44163c5ca4f
# good:
- name: image/name
  newTag: v0.0.1@sha256:3eeba3e2caa30d2aba0fd78a34c1bbeebaa1b96c7aa3c95ec9bac44163c5ca4f