summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorAditya R <arajan@redhat.com>2022-08-08 11:58:31 +0530
committerMatthew Heon <mheon@redhat.com>2022-08-10 16:46:04 -0400
commit9b0a1fa75293fbad724c34f54e3efb1cb56d7683 (patch)
tree4b1ffb3a86c517e3596f8e5b3e4bb60761f4262f /docs/source
parenta382bd329eae87d8ee963d33853e3300e609a616 (diff)
downloadpodman-9b0a1fa75293fbad724c34f54e3efb1cb56d7683.tar.gz
podman-9b0a1fa75293fbad724c34f54e3efb1cb56d7683.tar.bz2
podman-9b0a1fa75293fbad724c34f54e3efb1cb56d7683.zip
build: implement --cache-to,--cache-from and --cache-ttl
[NO NEW TESTS NEEDED] [NO TESTS NEEDED] Signed-off-by: Aditya R <arajan@redhat.com>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/podman-build.1.md39
1 files changed, 37 insertions, 2 deletions
diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md
index ba7081ff5..a5011f4aa 100644
--- a/docs/source/markdown/podman-build.1.md
+++ b/docs/source/markdown/podman-build.1.md
@@ -120,8 +120,43 @@ The value of [name] is matched with the following priority order:
#### **--cache-from**
-Images to utilize as potential cache sources. Podman does not currently support
-caching so this is a NOOP. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
+Repository to utilize as a potential cache source. When specified, Buildah will try to look for
+cache images in the specified repository and will attempt to pull cache images instead of actually
+executing the build steps locally. Buildah will only attempt to pull previously cached images if they
+are considered as valid cache hits.
+
+Use the `--cache-to` option to populate a remote repository with cache content.
+
+Example
+
+```bash
+# populate a cache and also consult it
+buildah build -t test --layers --cache-to registry/myrepo/cache --cache-from registry/myrepo/cache .
+```
+
+Note: `--cache-from` option is ignored unless `--layers` is specified.
+
+#### **--cache-to**
+
+Set this flag to specify a remote repository that will be used to store cache images. Buildah will attempt to
+push newly built cache image to the remote repository.
+
+Note: Use the `--cache-from` option in order to use cache content in a remote repository.
+
+Example
+
+```bash
+# populate a cache and also consult it
+buildah build -t test --layers --cache-to registry/myrepo/cache --cache-from registry/myrepo/cache .
+```
+
+Note: `--cache-to` option is ignored unless `--layers` is specified.
+
+#### **--cache-ttl**
+
+Limit the use of cached images to only consider images with created timestamps less than *duration* ago.
+For example if `--cache-ttl=1h` is specified, Buildah will only consider intermediate cache images which are created
+under the duration of one hour, and intermediate cache images outside this duration will be ignored.
#### **--cap-add**=*CAP\_xxx*