Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add cache option for run command #2032

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ as a remote image destination:
### Caching

#### Caching Layers
kaniko can cache layers created by `RUN` (and `COPY`, configured by the `--cache-copy-layers` flag) commands in a remote repository.
kaniko can cache layers created by `RUN`(configured by flag `--cache-run-layers`) and `COPY` (configured by flag `--cache-copy-layers`) 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.
Expand Down Expand Up @@ -669,6 +669,10 @@ _This flag must be used in conjunction with the `--cache=true` flag._

Set this flag to cache copy layers.

#### --cache-run-layers

Set this flag to cache run layers (default=true).

#### --cache-ttl duration

Cache timeout in hours. Defaults to two weeks.
Expand Down
1 change: 1 addition & 0 deletions cmd/executor/cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ func addKanikoOptionsFlags() {
RootCmd.PersistentFlags().BoolVarP(&opts.RunV2, "use-new-run", "", false, "Use the experimental run implementation for detecting changes without requiring file system snapshots.")
RootCmd.PersistentFlags().Var(&opts.Git, "git", "Branch to clone if build context is a git repository")
RootCmd.PersistentFlags().BoolVarP(&opts.CacheCopyLayers, "cache-copy-layers", "", false, "Caches copy layers")
RootCmd.PersistentFlags().BoolVarP(&opts.CacheRunLayers, "cache-run-layers", "", true, "Caches run layers")
RootCmd.PersistentFlags().VarP(&opts.IgnorePaths, "ignore-path", "", "Ignore these paths when taking a snapshot. Set it repeatedly for multiple paths.")
RootCmd.PersistentFlags().BoolVarP(&opts.ForceBuildMetadata, "force-build-metadata", "", false, "Force add metadata layers to build image")

Expand Down
6 changes: 3 additions & 3 deletions pkg/commands/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ type DockerCommand interface {
ShouldDetectDeletedFiles() bool
}

func GetCommand(cmd instructions.Command, fileContext util.FileContext, useNewRun bool, cacheCopy bool) (DockerCommand, error) {
func GetCommand(cmd instructions.Command, fileContext util.FileContext, useNewRun bool, cacheCopy bool, cacheRun bool) (DockerCommand, error) {
switch c := cmd.(type) {
case *instructions.RunCommand:
if useNewRun {
return &RunMarkerCommand{cmd: c}, nil
return &RunMarkerCommand{cmd: c, shdCache: cacheRun}, nil
}
return &RunCommand{cmd: c}, nil
return &RunCommand{cmd: c, shdCache: cacheRun}, nil
case *instructions.CopyCommand:
return &CopyCommand{cmd: c, fileContext: fileContext, shdCache: cacheCopy}, nil
case *instructions.ExposeCommand:
Expand Down
5 changes: 3 additions & 2 deletions pkg/commands/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ import (

type RunCommand struct {
BaseCommand
cmd *instructions.RunCommand
cmd *instructions.RunCommand
shdCache bool
imjasonh marked this conversation as resolved.
Show resolved Hide resolved
}

// for testing
Expand Down Expand Up @@ -193,7 +194,7 @@ func (r *RunCommand) RequiresUnpackedFS() bool {
}

func (r *RunCommand) ShouldCacheOutput() bool {
return true
return r.shdCache
}

type CachingRunCommand struct {
Expand Down
7 changes: 4 additions & 3 deletions pkg/commands/run_marker.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ import (

type RunMarkerCommand struct {
BaseCommand
cmd *instructions.RunCommand
Files []string
cmd *instructions.RunCommand
Files []string
shdCache bool
}

func (r *RunMarkerCommand) ExecuteCommand(config *v1.Config, buildArgs *dockerfile.BuildArgs) error {
Expand Down Expand Up @@ -77,7 +78,7 @@ func (r *RunMarkerCommand) RequiresUnpackedFS() bool {
}

func (r *RunMarkerCommand) ShouldCacheOutput() bool {
return true
return r.shdCache
}

func (r *RunMarkerCommand) ShouldDetectDeletedFiles() bool {
Expand Down
1 change: 1 addition & 0 deletions pkg/config/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ type KanikoOptions struct {
SkipUnusedStages bool
RunV2 bool
CacheCopyLayers bool
CacheRunLayers bool
ForceBuildMetadata bool
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/executor/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ func newStageBuilder(args *dockerfile.BuildArgs, opts *config.KanikoOptions, sta
}

for _, cmd := range s.stage.Commands {
command, err := commands.GetCommand(cmd, fileContext, opts.RunV2, opts.CacheCopyLayers)
command, err := commands.GetCommand(cmd, fileContext, opts.RunV2, opts.CacheCopyLayers, opts.CacheRunLayers)
if err != nil {
return nil, err
}
Expand Down
17 changes: 9 additions & 8 deletions pkg/executor/build_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@ COPY %s foo.txt
expectedCacheKeys: []string{copyCommandCacheKey},
// CachingCopyCommand is not pushed to the cache
pushedCacheKeys: []string{},
commands: getCommands(util.FileContext{Root: dir}, cmds, true),
commands: getCommands(util.FileContext{Root: dir}, cmds, true, false),
fileName: filename,
}
}(),
Expand Down Expand Up @@ -970,7 +970,7 @@ COPY %s foo.txt
rootDir: dir,
expectedCacheKeys: []string{hash},
pushedCacheKeys: []string{hash},
commands: getCommands(util.FileContext{Root: dir}, cmds, true),
commands: getCommands(util.FileContext{Root: dir}, cmds, true, false),
fileName: filename,
}
}(),
Expand Down Expand Up @@ -1034,7 +1034,7 @@ COPY %s bar.txt
cmds := stage.Commands
return testcase{
description: "cached run command followed by uncached copy command results in consistent read and write hashes",
opts: &config.KanikoOptions{Cache: true, CacheCopyLayers: true},
opts: &config.KanikoOptions{Cache: true, CacheCopyLayers: true, CacheRunLayers: true},
rootDir: dir,
config: &v1.ConfigFile{Config: v1.Config{WorkingDir: destDir}},
layerCache: &fakeLayerCache{
Expand All @@ -1045,7 +1045,7 @@ COPY %s bar.txt
// hash1 is the read cachekey for the first layer
expectedCacheKeys: []string{hash1, hash2},
pushedCacheKeys: []string{hash2},
commands: getCommands(util.FileContext{Root: dir}, cmds, true),
commands: getCommands(util.FileContext{Root: dir}, cmds, true, true),
}
}(),
func() testcase {
Expand Down Expand Up @@ -1108,7 +1108,7 @@ RUN foobar
cmds := stage.Commands
return testcase{
description: "copy command followed by cached run command results in consistent read and write hashes",
opts: &config.KanikoOptions{Cache: true},
opts: &config.KanikoOptions{Cache: true, CacheRunLayers: true},
rootDir: dir,
config: &v1.ConfigFile{Config: v1.Config{WorkingDir: destDir}},
layerCache: &fakeLayerCache{
Expand All @@ -1118,7 +1118,7 @@ RUN foobar
image: image,
expectedCacheKeys: []string{runHash},
pushedCacheKeys: []string{},
commands: getCommands(util.FileContext{Root: dir}, cmds, false),
commands: getCommands(util.FileContext{Root: dir}, cmds, false, true),
}
}(),
func() testcase {
Expand Down Expand Up @@ -1331,14 +1331,15 @@ func assertCacheKeys(t *testing.T, expectedCacheKeys, actualCacheKeys []string,
}
}

func getCommands(fileContext util.FileContext, cmds []instructions.Command, cacheCopy bool) []commands.DockerCommand {
func getCommands(fileContext util.FileContext, cmds []instructions.Command, cacheCopy, cacheRun bool) []commands.DockerCommand {
outCommands := make([]commands.DockerCommand, 0)
for _, c := range cmds {
cmd, err := commands.GetCommand(
c,
fileContext,
false,
cacheCopy,
cacheRun,
)
if err != nil {
panic(err)
Expand Down Expand Up @@ -1434,7 +1435,7 @@ func Test_stageBuild_populateCompositeKeyForCopyCommand(t *testing.T) {
}

fc := util.FileContext{Root: "workspace"}
copyCommand, err := commands.GetCommand(instructions[0], fc, false, true)
copyCommand, err := commands.GetCommand(instructions[0], fc, false, true, true)
if err != nil {
t.Fatal(err)
}
Expand Down