Merge pull request #495 from osscontainertools/docs

docs

Author: mzihlmann

CHANGELOG.md

@@ -1,19 +1,21 @@
 # v1.26.5 Release 2026-02-05
 ## Community Update
-* @Bixilon made their first contribution in https://github.com/osscontainertools/kaniko/pull/458
+@Bixilon made their first contribution in https://github.com/osscontainertools/kaniko/pull/458
+
+Also many thanks to @BlackTurtle123 and @xathon for reporting the issues fixed in this release.
 
 ## What's Changed
 ### Security
 * go stdlib v1.25.5: CVE-2025-61726 CVE-2025-61728 CVE-2025-61730 CVE-2025-68121
 
 ### Bugfixes
-* dockerfile: don't use +x for chmod: by @Bixilon in https://github.com/osscontainertools/kaniko/pull/458
-* fix KANIKO_DIR bootstrapping: https://github.com/osscontainertools/kaniko/pull/475
+* dockerfile: don't use `+x` for chmod: by @Bixilon in https://github.com/osscontainertools/kaniko/pull/458
+* fix `KANIKO_DIR` bootstrapping: https://github.com/osscontainertools/kaniko/pull/475
 * cache mount fails to rename across filesystems: https://github.com/osscontainertools/kaniko/pull/455
 * cleanup kaniko workspace on failure too: https://github.com/osscontainertools/kaniko/pull/453
 
 ### Standardization
-* resolve remote ONBUILD instructions: https://github.com/osscontainertools/kaniko/pull/354
+* resolve remote `ONBUILD` instructions: https://github.com/osscontainertools/kaniko/pull/354
 
 ### Usability
 * dynamically determine kanikoDir: https://github.com/osscontainertools/kaniko/pull/454

CHANGELOG_OVERVIEW.md

@@ -37,7 +37,7 @@
 * `FF_KANIKO_RUN_MOUNT_SECRET=false` secret mounts: https://github.com/osscontainertools/kaniko/pull/391 https://github.com/osscontainertools/kaniko/pull/409
 * `FF_KANIKO_RUN_VIA_TINI=false` reap zombie processes: https://github.com/osscontainertools/kaniko/pull/211 https://github.com/osscontainertools/kaniko/pull/450
 * Skip chown/chmod for paths in ignore list: by @mesaglio in https://github.com/osscontainertools/kaniko/pull/435
-* resolve remote ONBUILD instructions: https://github.com/osscontainertools/kaniko/pull/354
+* resolve remote `ONBUILD` instructions: https://github.com/osscontainertools/kaniko/pull/354
 ### Caching
 * sourceImage's CreatedAt timestamp should not be included in cache key: https://github.com/mzihlmann/kaniko/pull/1
 * ignore labels on base image for cache: https://github.com/mzihlmann/kaniko/pull/2

README.md

@@ -134,6 +134,7 @@ expect - see [Known Issues](#known-issues).
       - [Flag `FF_KANIKO_NEW_CACHE_LAYOUT`](#flag-ff_kaniko_new_cache_layout)
       - [Flag `FF_KANIKO_OCI_STAGES`](#flag-ff_kaniko_oci_stages)
       - [Flag `FF_KANIKO_DISABLE_HTTP2`](#flag-ff_kaniko_disable_http2)
+      - [Flag `FF_KANIKO_OCI_WARMER`](#flag-ff_kaniko_oci_warmer)
       - [Flag `FF_KANIKO_RUN_VIA_TINI`](#flag-ff_kaniko_run_via_tini)
     - [Debug Image](#debug-image)
   - [Security](#security)
@@ -1271,7 +1272,7 @@ multiple times for multiple registries.
 
 Builds only used stages.  If set to `false` it builds all stages, even the unnecessary ones until it reaches the target stage / end of Dockerfile.
 Defaults to `true`.
-Will be deprecated in `v1.27.0`.
+Will be deprecated in `v1.27.0`, if we manage to implement multi-target builds by then.
 
 #### Flag `--snapshot-mode`
 
@@ -1401,6 +1402,13 @@ We noticed that there is a significant performance gap when using http/2.0 toget
 Defaults to `false`.
 Currently no plans to activate.
 
+#### Flag `FF_KANIKO_OCI_WARMER`
+
+Warmer stores images in a tarball via go-containerregistry. However, this approach creates two problems. The tarball writer only supports dockerv2 mediatype, so building from warmer cache might result in a different output image than building from remote, as we forcefully rewrite all images to that mediatype. Secondly, the performance/usability of that approach is suboptimal, as we either store the manifest in a separate file, causing consistency issues or recalculate upon load (see [`FF_KANIKO_IGNORE_CACHED_MANIFEST`](#flag-ff_kaniko_ignore_cached_manifest)). With this change we use ocilayout instead. Ocilayout folders support arbitrary mediatypes and store the manifest alongside the image data.
+Set this flag to `true` to store warmer cache images as ocilayout. Note that this flag has to be passed to both warmer and executor. Note that currently there is no mutex lock mechanism yet, so it does not support multiple parallel writes.
+Defaults to `false`.
+Becomes default in `v1.27.0`, if we manage to resolve the mutex lock issue by then.
+
 #### Flag `FF_KANIKO_RUN_VIA_TINI`
 
 Kaniko usually runs as PID1 in the container, but kaniko currently does not implement reaping of zombie processes, nor does it offload that task to the kernel. As a result, any short-lived child processes spawned by your `RUN` command may linger around as zombies and potentially cause your build to hang.