Automated Dependency Updates for Helmv3
Categories: helm
, kubernetes
Renovate supports updating Helmv3 dependencies.
File Matching¶
By default, Renovate will check any files matching the following regular expression: (^|/)Chart\.ya?ml$
.
For details on how to extend a manager's fileMatch
value, please follow this link.
Supported datasources¶
This manager supports extracting the following datasources: docker
, helm
.
Default config¶
{
"registryAliases": {
"stable": "https://charts.helm.sh/stable"
},
"commitMessageTopic": "helm chart {{depName}}",
"fileMatch": [
"(^|/)Chart\\.ya?ml$"
]
}
Additional Information¶
Renovate supports updating Helm Chart references in:
requirements.yaml
files, for Helm v2Chart.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"]
}