Autodiscovery on

ArgoCD

Mon, 01 Jan 0001 00:00:00 +0000

Description

The argocd crawler looks recursively for every .yaml and .yml file from a root directory, and proposes an update for each Helm chart it finds declared in an ArgoCD application.

A source is picked up when repoURL, chart, and targetRevision are all set. It is read from any of:

spec.source and spec.sources[] - ArgoCD Application
spec.template.spec.source and spec.template.spec.sources[] - ArgoCD ApplicationSet

Multi-document YAML files are supported; each document is addressed by index in the generated manifest.

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 an argocd crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Important

Matching is structural, not by resource kind. apiVersion and kind are not checked, so any YAML document exposing spec.source.repoURL, .chart, and .targetRevision is treated as an ArgoCD application. Use only or ignore to narrow the scan when that is too broad.

Bazel

Mon, 01 Jan 0001 00:00:00 +0000

Description

The bazel crawler looks recursively for every MODULE.bazel file from a root directory, and updates each bazel_dep() declaration it contains.

# MODULE.bazel
bazel_dep(name = "rules_go", version = "0.46.0")
bazel_dep(name = "gazelle", version = "0.35.0", dev_dependency = True)

Both regular and dev_dependency declarations are updated.

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 bazel crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Cargo

Mon, 01 Jan 0001 00:00:00 +0000

Description

The cargo crawler looks recursively for all cargo crates from a specific root directory. Then for each of them, it tries to update dependencies specified in Cargo.toml.

Dependencies are read from:

[dependencies]
[dev-dependencies]
[build-dependencies]
the [workspace.dependencies] equivalents

This crawler can be enabled either automatically with default behavior 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 cargo crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Docker Compose

Mon, 01 Jan 0001 00:00:00 +0000

Description

The Docker compose crawler looks recursively for all docker compose manifests from a specific root directory. Then, for each of them, it tries to update each Docker image tag found.

Updatecli looks for the following file patterns:

docker-compose*.y*ml
compose*.y*ml

Those cover docker-compose.yaml, docker-compose.override.yml, and the Compose Specification’s compose.yaml. Override them with the filematch parameter.

The automatic discovery behavior can be tuned by providing a YAML manifest with a dockercompose crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Usage

The dockercompose autodiscovery can be used with or without manifest.

Without manifest

Without manifest available, Updatecli will enable all default crawlers, including dockercompose.

updatecli diff to run updatecli in dryrun updatecli apply to apply the changes locally

With a manifest

If a manifest is provided, Updatecli will only execute crawlers specified in the manifest such as in the following example

updatecli diff --config updatecli.d/default.yaml to run updatecli in dryrun
updatecli apply --config updatecli.d/default.yaml to apply the changes

# updatecli.d/default.yaml
name: "Docker compose autodiscovery using git scm"
scms:
 updatemonitor:
 kind: git
 spec:
 url: https://github.com/updatecli/updatemonitor.git

autodiscovery:
 # scmid is applied to all crawlers
 scmid: updatemonitor
 crawlers:
 dockercompose:
 ignore:
 - path: 'docker-compose.yaml'
 services:
 - traefik
 #only:
 # # - path: <filepath relative to scm repository>
 # services: <docker compoes service name to match>
 # platform: <docker compose service platform to match>
 # image: <docker compose image to match>

Dockerfile

Mon, 01 Jan 0001 00:00:00 +0000

Description

The Dockerfile crawler looks recursively for all Dockerfile from a specific root directory. Then, for each of them, it tries to update each Docker image tag found in a 'FROM' instruction.

Updatecli looks for the following file patterns:

Dockerfile
Dockerfile.*

Override them with the filematch parameter.

The automatic discovery behavior can be tuned by providing a YAML manifest with a dockerfile crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Usage

The dockerfile autodiscovery can use with or without manifest.

Without manifest

Without manifest available, Updatecli will enable all default crawlers, including dockerfile.

updatecli diff to run updatecli in dryrun updatecli apply to apply the changes locally

With a manifest

If a manifest is provided, Updatecli will only execute crawlers specified in the manifest such as in the following example

updatecli diff --config updatecli.d/default.yaml to run updatecli in dryrun
updatecli apply --config updatecli.d/default.yaml to apply the changes

# updatecli.d/default.yaml
name: "[asciidoctor/docker-asciidoctor] Dockerfile autodiscovery using git scm"
scms:
 asciidoctor:
 kind: git
 spec:
 url: https://github.com/asciidoctor/docker-asciidoctor.git
 branch: main

autodiscovery:
 # scmid is applied to all crawlers
 scmid: asciidoctor
 crawlers:
 dockerfile:
 #rootdir: <custom root directory, overriden by scm configuration>
 #
 ## Ignore Dockerfile update matching following rules
 #ignore:
 # - archs:
 # - "amd64"
 # path: "qa/*"
 # images:
 # - alpine
 # - alpine:3
 # 
 ## Only update Dockerfile matching following rules
 #only:
 # - archs:
 # - "amd64"
 # path: "qa/*"
 # images:
 # - alpine
 # - alpine:3
 #
 # auths:
 # Override default dockerfile filematch
 #filematch:
 # - "Dockerfile.example"

Flux

Mon, 01 Jan 0001 00:00:00 +0000

Description

The flux crawler looks recursively for every .yaml and .yml file from a root directory, and updates two kinds of Flux resource:

HelmRelease - the chart version is updated when a HelmRepository matching the release’s sourceRef is found in the same namespace. Disable with helmrelease: false.
OCIRepository - the artifact tag is updated. Disable with ocirepository: false.

Both are enabled by default. Override the scanned file names with the files parameter.

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 flux crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Github Action

Mon, 01 Jan 0001 00:00:00 +0000

Description

The github/action crawler looks recursively for workflow files and Composite Actions, then tries to update every action reference found in them.

It scans two kinds of file:

Workflows - files matching .yaml or .yml located directly inside a workflows directory whose parent is .github, .gitea, or .forgejo.
Composite Actions - files named action.yaml or action.yml, in any directory.

Despite its name, the crawler is not GitHub-only: .gitea/workflows and .forgejo/workflows are scanned as well, and the provider is detected from each action reference.

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 github/action crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Note	The crawler key is `github/action`. The alias `gitea/action` maps to the same implementation, but it is not part of the default crawlers, so it only runs when explicitly declared.

Golang

Mon, 01 Jan 0001 00:00:00 +0000

Description

The golang crawler looks recursively for every go.mod file from a root directory, and updates two independent things:

the Go version declared by the go directive. Restrict to this with onlygoversion: true.
the module versions declared in require and replace directives. Restrict to these with onlygomodule: true.

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 golang crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Note	The aliases `go` and `golang/gomod` can also be used instead of `golang`.

Helm

Mon, 01 Jan 0001 00:00:00 +0000

Description

The helm crawler looks recursively for all Helm charts from a specific root directory. A directory is treated as a chart root when it contains a Chart.yaml or Chart.yml file.

For each chart it performs two independent kinds of update:

Chart dependencies declared in Chart.yaml. Disable with ignorechartdependency: true.
Container images declared in values.yaml or values.yml. Disable with ignorecontainer: true.

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 helm crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Container image patterns

Updatecli looks for the following patterns in the chart values, where registry is optional:

image:
 registry: ghcr.io
 repository: updatecli/updatecli
 tag: 0.37.0

images:
 backend:
 repository: ghcr.io/updatecli/updatemonitor
 tag: 0.1.0
 front:
 repository: ghcr.io/updatecli/updatemonitor-ui
 tag: 0.1.0

An image with no tag is assumed to be latest. An image with no repository is skipped. A digest already present in repository, such as image@sha256:…, is stripped before the lookup.

Helmfile

Mon, 01 Jan 0001 00:00:00 +0000

Description

The Helmfile crawler looks recursively for every .yaml and .yml file from a specific root directory, and tries to update the Helm chart version of each release it finds.

A release is picked up when its chart is written as <repository>/<chart> and that repository is declared in the same file:

repositories:
 - name: jetstack
 url: https://charts.jetstack.io
releases:
 - name: cert-manager
 chart: jetstack/cert-manager
 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 helmfile crawler in top-level directive autodiscovery as explained in the "Autodiscovery" page.

Note	Every YAML file is inspected, not only files named `helmfile.yaml`, since Helmfile splits its releases across arbitrary file names. Files without a usable `releases` list simply yield nothing.