Flux

kind: flux

Description

The flux Autodiscovery plugin allows to automatically search and update content in Flux configuration file.

Updatecli proposes Helm Chart update when it identifies both a helmrelease and a helmrepository in the same namespace. Updatecli proposes version update when it detects OCIRepository

Please note that Updatecli doesn’t support yet GitRepository update, feel free to open an issue.

Manifests

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
digest boolean

digest allows to specify if the generated manifest should use OCI digest on top of the tag

default: true
files array

files allows to override default flux files

default: ["*.yaml", "*.yml"]
helmrelease boolean

helmRelease define if helmrelease file should be updated or not

default: true
ignore array

ignore allows to specify rule to ignore autodiscovery a specific Flux helmrelease based on a rule

default: empty
    artifacts object

Artifacts specifies the list of artifacts to check

The key is the artifact name and the value is the artifact version

An artifact can be a Helm Chart when used in the context of Helmrelease or an OCIRepository when used in the context of OCIRepository

If the value is empty, then the artifact name is enough to match If the value is a valid semver constraint, then the artifact version must match the constraint
    path string Path specifies a Flux filepath 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
ocirepository boolean

OCIRepository allows to specify if OCI repository files should be updated

default: true
only array

only allows to specify rule to only autodiscover manifest for a specific Flux helm release based on a rule

default: empty
    artifacts object

Artifacts specifies the list of artifacts to check

The key is the artifact name and the value is the artifact version

An artifact can be a Helm Chart when used in the context of Helmrelease or an OCIRepository when used in the context of OCIRepository

If the value is empty, then the artifact name is enough to match If the value is a valid semver constraint, then the artifact version must match the constraint
    path string Path specifies a Flux filepath 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 Flux files

default: . (current working directory) or scm root directory
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: "Flux Autodiscovery"
scms:
  default:
    kind: git
    spec:
      url: "https://github.com/updatecli-test/flux2-multi-tenancy.git"
      branch: main
autodiscovery:
  scmid: default
  crawlers:
    flux:
      digest: true
      versionfilter:
        kind: semver
        pattern: minoronly
Last modified on March 7, 2024
Edit this page on GitHub
← Dockerfile
Github Action →