renovate/lib/modules/manager/helmv3
Michael Kriese ec4b17b8b6
feat(config)!: default dockerImagePrefix to containerbase (#20150)
Sidecar containers will now use `containerbase/` prefix instead of `renovate/` prefix.

BREAKING CHANGE: containerbase/ account used for sidecar containers instead of renovate/
2023-03-10 09:34:40 +01:00
..
__fixtures__ fix(helmv3): do not attempt to update locks for local references (#15382) 2022-05-02 07:49:17 +00:00
__snapshots__ feat(config)!: default dockerImagePrefix to containerbase (#20150) 2023-03-10 09:34:40 +01:00
artifacts.spec.ts test: replace as with partial (#20241) 2023-02-06 15:10:24 +00:00
artifacts.ts feat(core): centralize sidecar image usage (#19545) 2022-12-23 09:45:15 +00:00
extract.spec.ts refactor: merge extract config types (#16204) 2022-08-09 05:26:35 +00:00
extract.ts refactor: PackageFile -> PackageFileContent (#20502) 2023-02-19 12:43:48 +00:00
index.ts fix(manager): correctly escape the dot character in fileMatch (#17048) 2022-08-08 17:20:16 +02:00
readme.md fix(docs): use correct folder name in README for helm Subchart archives (#19588) 2022-12-27 17:33:27 +01:00
types.ts refactor: lib/modules (#14488) 2022-03-04 09:04:02 +01:00
update.spec.ts refactor: strict manager tests (#16155) 2022-06-20 17:05:39 +02:00
update.ts refactor: reduce debug metadata (#18466) 2022-10-29 12:11:09 +00:00
utils.spec.ts feat(manager/terraform): support OCI charts in helm_release (#19869) 2023-01-19 18:50:40 +01:00
utils.ts feat(manager/terraform): support OCI charts in helm_release (#19869) 2023-01-19 18:50:40 +01:00

Renovate supports updating Helm Chart references in:

  • requirements.yaml files, for Helm v2
  • Chart.yaml files, for Helm v3

The helmv3 manager defines this default registryAlias:

{
  "registryAliases": {
    "stable": "https://charts.helm.sh/stable"
  }
}

If you use repository aliases in your Helm charts then you must set an registryAliases object in your configuration file so Renovate knows where to find the repository. Alias values must be properly formatted URIs.

If you need to change the versioning format, read our versioning documentation to learn more.

Private repositories and registries

To use private sources in your Helm charts, you must set the password and username you use to authenticate to the private source. For this you use a custom hostRules array.

OCI registries

{
  hostRules: [
    {
      // Global login
      matchHost: 'registry.gitlab.com',
      hostType: 'docker',
      username: '<some-username>',
      password: '<some-password>',
    },
    {
      // For repository string oci://registry.gitlab.com/user/oci-helm-test
      matchHost: 'https://registry.gitlab.com/user/oci-helm-test',
      hostType: 'docker',
      username: '<some-username>',
      password: '<some-password>',
    },
  ],
}

Helm repository

{
  hostRules: [
    {
      // Global login for 'gitlab.com' if using Helm
      matchHost: 'gitlab.com',
      hostType: 'helm', // this is optional, but else the credentials will be used for all requests matching `matchHost`
      username: '<some-username>',
      password: '<some-password>',
    },
    {
      // Specific repository
      matchHost: 'https://gitlab.com/api/v4/projects/xxxxxxx/packages/helm/stable',
      hostType: 'helm', // this is optional
      username: '<some-username>',
      password: '<some-password>',
    },
  ],
}

Subchart archives

To get updates for subchart archives put helmUpdateSubChartArchives in your postUpdateOptions configuration. Renovate now updates archives in the /charts folder.

{
  "postUpdateOptions": ["helmUpdateSubChartArchives"]
}