Updatecli
Docs

Rancher Fleet

Description

The Rancher Fleet crawler looks recursively for every fleet.yaml or fleet.yml bundle from a specific root directory, and tries to update the Helm chart version each one pins.

A bundle is picked up when both helm.chart and helm.repo are set:

defaultNamespace: cert-manager
helm:
  chart: cert-manager
  repo: https://charts.jetstack.io
  version: 1.14.0

This crawler is enabled by default, so it can be used either automatically by running updatecli diff from a directory containing the files to update, or by providing a manifest. The automatic discovery behavior can be tuned by providing a YAML manifest with a rancher/fleet crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Generated manifests

Each bundle produces one manifest containing:

  • a helmchart source resolving the latest chart version from helm.repo,

  • two yaml conditions asserting that helm.chart and helm.repo still hold the discovered values,

  • a yaml target writing the new version to helm.version.

Only the version is rewritten; the rest of the bundle is left untouched.

Authentication

Use auths to reach private chart repositories. Entries are keyed by repository host and accept either a token or a username/password pair.

Version filtering

If unspecified, the version filter defaults to kind semver with pattern *, since Helm charts are expected to follow semantic versioning.

More details on the "Version Filtering" page.

Manifest

Parameters

NameTypeDescriptionRequired
authsobject

“auths” defines the Helm repository credentials, keyed by repository host without scheme.

remark:

  • only the host part of the repository URL, such as “domain[:port]”, is used to look up credentials.

example:

auths:
  "my-helm-repo.com":
    token: "my-secret-token"
    tokenstring
ignorearray

“ignore” defines rules to exclude matching Helm charts from the autodiscovery.

remark:

  • a Helm chart is ignored when it matches at least one rule.
    chartsobject

“charts” defines the Helm charts to match, keyed by chart name.

remark:

  • an empty value matches any version.
  • otherwise the value is a semantic version constraint, such as “>=1.0.0”.
  • when the version or the constraint cannot be parsed, the value must equal the version.
    pathstring

“path” defines a Fleet bundle file path pattern.

remark:

  • the pattern must match the whole path, not just a substring.
  • the pattern follows the Go filepath.Match syntax, such as “*” or “?”.
    repositoriesarray

“repositories” defines the Helm repository URLs to match.

remark:

  • a repository URL must be identical to one of the entries.
onlyarray

“only” defines rules to restrict the autodiscovery to matching Helm charts.

remark:

  • a Helm chart is kept only when it matches at least one rule.
    chartsobject

“charts” defines the Helm charts to match, keyed by chart name.

remark:

  • an empty value matches any version.
  • otherwise the value is a semantic version constraint, such as “>=1.0.0”.
  • when the version or the constraint cannot be parsed, the value must equal the version.
    pathstring

“path” defines a Fleet bundle file path pattern.

remark:

  • the pattern must match the whole path, not just a substring.
  • the pattern follows the Go filepath.Match syntax, such as “*” or “?”.
    repositoriesarray

“repositories” defines the Helm repository URLs to match.

remark:

  • a repository URL must be identical to one of the entries.
rootdirstring

“rootdir” defines the directory where the crawler starts searching for Fleet bundle files.

default: the scm directory when “scmid” is set, otherwise the directory relative paths resolve from, by default the working directory.

remark:

  • a relative path is resolved from the default directory.
  • an absolute path is used as is, instead of the scm directory.
versionfilterobject

“versionfilter” defines the version filter used by the generated manifests.

default: kind “semver” with pattern “*”, the latest version.

remark:

  • with kind “semver”, “pattern” accepts:
    • “prerelease”: the latest prerelease of the current version.
    • “patch”: patch updates only.
    • “minor”: patch and minor updates.
    • “minoronly”: minor updates only.
    • “major”: patch, minor and major updates.
    • “majoronly”: major updates only.
    • a version constraint, such as “>= 1.0.0”.
  • with kind “regex”, “pattern” accepts a regular expression.
  • more examples at https://www.updatecli.io/docs/core/versionfilter/

example:

versionfilter:
  kind: semver
  pattern: minor
    kindstring

“kind” defines the versioning scheme used to select a version.

default: latest

remark:

  • accepted values are “latest”, “semver”, “regex”, “regex/semver”, “time”, “regex/time”, “lex” and “pep440”.
  • “latest” returns the last version of the list.
  • “lex” sorts the versions lexicographically and returns the last one.
  • “pep440” follows https://peps.python.org/pep-0440/

example:

  • kind: semver
    patternstring

“pattern” defines the version pattern, according to “kind”.

default:

  • latest: “latest”
  • semver and pep440: “*”
  • regex: “.*”
  • time and regex/time: “2006-01-02”

remark:

  • for “latest”, “latest” returns the last version, any other value must match a version exactly.
  • for “semver” and “regex/semver”, it is a semantic versioning constraint.
  • for “pep440”, it is a pep440 version specifier.
  • for “regex”, it is a regular expression.
  • for “time” and “regex/time”, it is a Go date layout.
  • ignored by “lex”.

example:

  • pattern: ~1.2
  • pattern: “>=1.0.0 <2.0.0”
  • pattern: ^v\d+.\d+.\d+$
    regexstring

“regex” defines the regular expression extracting the version from each entry.

remark:

  • only used by the kinds “regex/semver” and “regex/time”.
  • the value of the first capture group is used as the version.

example:

  • regex: ^v(\d+.\d+.\d+)$
    replaceallobject

“replaceall” applies a regular expression replacement to each version before filtering.

remark:

  • only used by the kinds “regex”, “regex/semver” and “regex/time”.
  • the replacement runs before “pattern” or “regex” is evaluated.

example:

replaceall:
  pattern: "_"
  replacement: "."

turns “curl-8_15_0” into “curl-8.15.0”.

        patternstring

“pattern” defines the regular expression matching the text to replace.

example:

  • pattern: “_”
        replacementstring

“replacement” defines the text replacing each match of “pattern”.

remark:

  • capture groups can be referenced with $1, $2, and so on.

example:

  • replacement: “.”
    strictboolean

“strict” enforces strict semantic versioning rules when parsing versions.

default: false

remark:

  • only used by the kinds “semver” and “regex/semver”.
⚠ This table is generated from the Updatecli codebase and may contain inaccurate data. Feel free to report them on github.com/updatecli/updatecli
Note
only and ignore rules accept path (a bundle path pattern that must match the whole path), charts (a map of chart name to version), and repositories (a list of chart repository URLs).

Example

# updatecli.d/default.yaml
name: "Fleet Autodiscovery using github scm"
scms:
  fleet-lab:
    kind: github
    spec:
      owner: olblak
      repository: fleet-lab
      token: '{{ requiredEnv "GITHUB_TOKEN" }}'
      username: '{{ requiredEnv "GITHUB_ACTOR" }}'
      branch: main

actions:
  fleet-lab:
    kind: github/pullrequest
    scmid: fleet-lab
    spec:
      labels:
        - dependencies

autodiscovery:
  # scmid is applied to all crawlers
  scmid: fleet-lab
  actionid: fleet-lab
  crawlers:
    rancher/fleet:
      # To ignore specific path
      #ignore:
      # - path: <filepath relative to scm repository>
      # To only update a specific file
      #only:
      #  - path: <filepath relative to scm repository>
Last updated on September 26, 2026
Prev
Pyproject
Next
Terraform