From cd2fedf9d2eca713b8f2a7c6e6160583a46b6ab9 Mon Sep 17 00:00:00 2001
From: Priya Wadhwa <priyawadhwa@google.com>
Date: Tue, 25 Sep 2018 10:24:06 -0700
Subject: [PATCH] Update README to add information about layer caching

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 15775d9160..f55cdd59dc 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@ We do **not** recommend running the kaniko executor binary in another image, as
     - [Running kaniko in gVisor](#running-kaniko-in-gvisor)
     - [Running kaniko in Google Container Builder](#running-kaniko-in-google-container-builder)
     - [Running kaniko locally](#running-kaniko-locally)
+  - [Caching](#caching)
   - [Pushing to Different Registries](#pushing-to-different-registries)
   - [Additional Flags](#additional-flags)
   - [Debug Image](#debug-image)
@@ -188,6 +189,16 @@ We can run the kaniko executor image locally in a Docker daemon to build and pus
   ./run_in_docker.sh <path to Dockerfile> <path to build context> <destination of final image>
   ```
 
+### Caching
+kaniko currently can cache layers created by `RUN` commands in a remote repository. 
+Before executing a command, kaniko checks the cache for the layer.
+If it exists, kaniko will pull and extract the cached layer instead of executing the command.
+If not, kaniko will execute the command and then push the newly created layer to the cache.
+
+Users can opt in to caching by setting the `--cache=true` flag.
+A remote repository for storing cached layers can be provided via the `--cache-repo` flag.
+If this flag isn't provided, a cached repo will be inferred from the `--destination` provided.  
+
 ### Pushing to Different Registries
 
 kaniko uses Docker credential helpers to push images to a registry.
@@ -293,6 +304,19 @@ Set this flag if you want to connect to a plain HTTP registry. It is supposed to
 
 Set this flag to skip TLS certificate validation when connecting to a registry. It is supposed to be used for testing purposes only and should not be used in production!
 
+#### --cache
+
+Set this flag as `--cache=true` to opt in to caching with kaniko.
+
+#### --cache-repo
+
+Set this flag to specify a remote repository which will be used to store cached layers.
+
+If this flag is not provided, a cache repo will be inferred from the `--destination` flag.
+If `--destination=gcr.io/kaniko-project/test`, then cached layers will be stored in `gcr.io/kaniko-project/test/cache`.
+
+_This flag must be used in conjunction with the `--cache=true` flag._
+
 ### Debug Image
 
 The kaniko executor image is based off of scratch and doesn't contain a shell.