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
auths	object	auths provides a map of registry credentials where the key is the registry URL without scheme
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: `patch` - patch only update patch version `minor` - minor only update minor version `major` - major only update major versions `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.
kind	string	specifies the version kind such as semver, regex, or latest
pattern	string	specifies the version pattern according the version kind
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