Kubernetes

kind: kubernetes

Description

The kubernetes Autodiscovery plugin allows to automatically search and update container tags defined in Kubernetes.yaml files.

Manifests

Parameters

NameTypeDescriptionRequired
authsobject

auths provides a map of registry credentials where the key is the registry URL without scheme if empty, updatecli relies on OCI credentials such as the one used by Docker.

example:

auths: “ghcr.io”: token: “xxx” “index.docker.io”: username: “admin” password: “password”

    passwordstring

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
    tokenstring

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
    usernamestring

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
digestbooleandigest provides parameters to specify if the generated manifest should use a digest on top of the tag.
filesarray

Files allows to specify a list of Files to analyze.

The pattern syntax is: pattern: { term } term: ‘’ matches any sequence of non-Separator characters ‘?’ matches any single non-Separator character ‘[’ [ ‘^’ ] { character-range } ‘]’ character class (must be non-empty) c matches character c (c != ‘’, ‘?’, ‘\’, ‘[’) ‘\’ c matches character c

character-range: c matches character c (c != ‘\’, ‘-’, ‘]’) ‘\’ c matches character c lo ‘-’ hi matches character c for lo <= c <= hi

Match requires pattern to match all of name, not just a substring. The only possible returned error is ErrBadPattern, when pattern is malformed.

On Windows, escaping is disabled. Instead, ‘\’ is treated as path separator.

ignorearrayIgnore allows to specify rule to ignore autodiscovery a specific Kubernetes manifest based on a rule
    imagesarrayImages specifies the list of container image to check
    pathstringPath specifies a Fleet bundle path pattern, the pattern requires to match all of name, not just a subpart of the path.
onlyarrayOnly allows to specify rule to only autodiscover manifest for a specific Kubernetes manifest based on a rule
    imagesarrayImages specifies the list of container image to check
    pathstringPath specifies a Fleet bundle path pattern, the pattern requires to match all of name, not just a subpart of the path.
rootdirstringRootDir defines the root directory used to recursively search for Kubernetes files
versionfilterobject

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

More information available at https://www.updatecli.io/docs/core/versionfilter/

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

More version filter available at https://www.updatecli.io/docs/core/versionfilter/

    kindstringspecifies the version kind such as semver, regex, or latest
    patternstringspecifies 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
    regexstringspecifies the regex pattern, used for regex/semver and regex/time. Output of the first capture group will be used.
    strictbooleanstrict 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: "Kubernetes autodiscovery"
scms:
  default:
    kind: git 
    spec:
      url: "https://github.com/jenkins-infra/release.git"
      branch: master
autodiscovery:
  scmid: default
  crawlers:
    kubernetes:
      digest: true
      versionfilter:
        kind: semver
        pattern: minoronly
      ## To ignore specific path
      #ignore:
      #  - images:
      #      - "mcr.microsoft.com/dotnet/framework/sdk"
      only:
        - images:
            - "mcr.microsoft.com/dotnet/framework/sdk"

Supported Kubernetes Resources

  • Standard Kubernetes Pod Spec (Pod, Deployment, DaemonSet, …​)

  • [Kustomize](https://kustomize.io/)

  • Templated files

Last modified on September 2, 2024
Edit this page on GitHub
← Ko
Maven →