Helmfile

kind: helmfile

Description

The Helmfile crawler looks recursively for all Helmfile manifests from a specific root directory. Then for each of them, it tries to update each Helm Chart version found.

Manifest

Parameters

Name Type Description Required
auths object Auths provides a map of registry credentials where the key is the registry URL without scheme
    password string

password specifies the container registry password to use for authentication. Not compatible with token

	compatible:
		* source
		* condition
		* target

	default:
		by default credentials are fetch from the local environment such as `~/.docker/config.json`.

	remark:
		Not compatible with token
    token string

token specifies the container registry token to use for authentication.

	compatible:
		* source
		* condition
		* target

	default:
		by default credentials are fetch from the local environment such as `~/.docker/config.json`.

	remark:
		Not compatible with username/password
    username string

username specifies the container registry username to use for authentication.

	compatible:
		* source
		* condition
		* target

	default:
		by default credentials are fetch from the local environment such as `~/.docker/config.json`.

	remark:
		Not compatible with token
ignore array Ignore allows to specify rule to ignore autodiscovery a specific Helmfile based on a rule
    charts object Charts specifies the list of Helm Chart repository to check
    path string Path specifies a Helmfile chart path pattern, the pattern requires to match all of name, not just a subpart of the path.
    repositories array Repositories specifies the list of Helm Chart repository to check
only array Only allows to specify rule to only autodiscovery manifest for a specific Helmfile based on a rule
    charts object Charts specifies the list of Helm Chart repository to check
    path string Path specifies a Helmfile chart path pattern, the pattern requires to match all of name, not just a subpart of the path.
    repositories array Repositories specifies the list of Helm Chart repository to check
rootdir string rootdir defines the root directory used to recursively search for Helmfile manifest
versionfilter object

versionfilter provides parameters to specify the version pattern used when generating manifest.

kind - semver versionfilter of kind semver uses semantic versioning as version filtering pattern accepts one of: prerelease - Updatecli tries to identify the latest prerelease whatever it means patch - Updatecli only handles patch version update minor - Updatecli handles patch AND minor version update minoronly - Updatecli handles minor version only major - Updatecli handles patch, minor, AND major version update majoronly - Updatecli only handles major version update a version constraint such as >= 1.0.0

kind - regex versionfilter of kind regex uses regular expression as version filtering pattern accepts a valid regular expression

example:

  versionfilter:
    kind: semver
    pattern: minor

and its type like regex, semver, or just latest.

More examples can be found at https://www.updatecli.io/docs/core/versionfilter/
    kind string specifies the version kind such as semver, regex, or latest
    pattern string specifies the version pattern according the version kind for semver, it is a semver constraint for regex, it is a regex pattern for time, it is a date format
    regex string specifies the regex pattern, used for regex/semver and regex/time. Output of the first capture group will be used.
    replaceall object replaceAll applies a regex replacement to version strings before filtering. This is useful for transforming versions (e.g., curl-8_15_0 to curl-8.15.0) before regex extraction.
        pattern string Pattern specifies the regex pattern to match for replacement
        replacement string Replacement specifies the replacement string (supports $1, $2, etc. for captured groups)
    strict boolean strict enforce strict versioning rule. Only used for semantic versioning at this time
⚠ This table is generated from the Updatecli codebase and may contain inaccurate data. Feel free to report them on github.com/updatecli/updatecli

Example

# updatecli.d/default.yaml
name: Test Helmfile Autodiscovery

scms:
  default:
    kind: git
    spec:
      url: https://github.com/olblak/k8s-lab.git
      branch: main
    
autodiscovery:
  # scmid is applied to all crawlers
  scmid: default
  crawlers:
    helmfile:
      # To ignore specific path
      #ignore:
      #  # - path: <filepath relative to scm repository>
      #  # - path: chart/*
      only:
        - path: helmfile.d/*
#
Last modified on February 23, 2023
Edit this page on GitHub
← Helm
Ko →