title | description | lead | draft | images | menu | weight | toc | plugins | |||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Dockerfile |
Discover Dockerfile image tag update |
kind: dockerfile |
false |
|
130 |
true |
|
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.*
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.
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
{{<include "assets/code_example/docs/plugins/autodiscovery/dockerfile/updatecli.d/default.yaml">}}
The Docker ecosystem has no versioning guidelines. This means that it’s the wild west out there and pretty much impossible to detect all cases. Hence why Updatecli manifest was created.
That being said we are still interested in an autodiscovery feature that would detect as many cases as possible. This section is about documentation what is covered and what’s missing. Do not hesitate to look at the contributing section
Semantic Versioning
In the Docker ecosystem, many tags look like semver but are not.
For instance, node:18.12.1-alpine
would match the semver regular expression but the prerelease -alpine
is not a prerelease information as per semver convention but a variant of node:18.12.1-buster
or node:18.12.1
.
This means that we would expect a newer version with the -alpine
such as node:19.0.0-alpine
.
The dockerfile autodiscovery will handle the following scenarios
-
1
will suggest a version such2
otherwise stick to1
-
1-alpine
will suggest a version such2-alpine
otherwise stick to1-alpine
-
1.0
will suggest a version such2.1
otherwise stick to1.0
-
1.0-alpine
will suggest a version such2.1-alpine
otherwise stick to1.0-alpine
-
1.0.0
will suggest a version such2.1.0
otherwise stick to1.0.0
-
1.0.0-alpine
will suggest a version such2.1.0-alpine
otherwise stick to1.0.0-alpine
Any other version pattern such as PEP 440 are ignored in the current state. We are planning to add new versionFilter kinds in the future as the need raise.
Feel free to: