renovate/lib/modules/manager/helmv3
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(manager/helmv3): add support for ECR credentials (#24432) 2023-09-23 05:34:32 +00:00
__snapshots__ fix(helmv3): use shlex 2024-02-19 12:07:47 +01:00
artifacts.spec.ts build(deps): update aws-sdk-js-v3 monorepo (#32262) 2024-11-12 07:17:38 +00:00
artifacts.ts refactor: centralize OCI detection and deletion (#28544) 2024-04-20 11:16:24 +00:00
common.ts refactor(prettier): Force trailing commas (#25631) 2023-11-07 15:50:29 +00:00
extract.spec.ts test(perf): improve test speed (#24323) 2023-09-08 11:40:04 +00:00
extract.ts refactor: use yaml instead of js-yaml for parsing YAML files (#31336) 2024-09-16 18:03:23 +00:00
index.ts docs(managers): add missing url and displayName (#32621) 2024-12-01 08:47:27 +00:00
oci.ts refactor: centralize OCI detection and deletion (#28544) 2024-04-20 11:16:24 +00:00
readme.md docs: fix versioning links (#28341) 2024-04-11 13:23:20 +00:00
types.ts refactor: lib/modules (#14488) 2022-03-04 09:04:02 +01:00
update.spec.ts refactor(utils/yaml): centralize YAML parsing to allow central templating handling (#26068) 2023-12-01 11:58:43 +00:00
update.ts chore: eslint to enforce for typed imports (#30844) 2024-08-19 13:15:27 +00:00
utils.spec.ts refactor: centralize OCI detection and deletion (#28544) 2024-04-20 11:16:24 +00:00
utils.ts refactor: centralize OCI detection and deletion (#28544) 2024-04-20 11:16:24 +00:00

readme.md

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"]
}