Include root file-system changes in container migration

One of the last limitations when migrating a container using Podman's
'podman container checkpoint --export=/path/to/archive.tar.gz' was
that it was necessary to manually handle changes to the container's root
file-system. The recommendation was to mount everything as --tmpfs where
the root file-system was changed.

This extends the checkpoint export functionality to also include all
changes to the root file-system in the checkpoint archive. The
checkpoint archive now includes a tarstream of the result from 'podman
diff'. This tarstream will be applied to the restored container before
restoring the container.

With this any container can now be migrated, even it there are changes
to the root file-system.

There was some discussion before implementing this to base the root
file-system migration on 'podman commit', but it seemed wrong to do
a 'podman commit' before the migration as that would change the parent
layer the restored container is referencing. Probably not really a
problem, but it would have meant that a migrated container will always
reference another storage top layer than it used to reference during
initial creation.

Signed-off-by: Adrian Reber <areber@redhat.com>

2 files changed, 39 insertions, 1 deletions

diff --git a/libpod/container_internal_linux.go b/libpod/container_internal_linux.go
index aa477611f..77f607f0b 100644
--- a/libpod/container_internal_linux.go
+++ b/libpod/container_internal_linux.go
@@ -515,6 +515,25 @@ func (c *Container) exportCheckpoint(dest string) (err error) {
 		return errors.Errorf("Cannot export checkpoints of containers with named volumes or dependencies")
 	}
 	logrus.Debugf("Exporting checkpoint image of container %q to %q", c.ID(), dest)
+
+	// Get root file-system changes included in the checkpoint archive
+	rootfsDiffPath := filepath.Join(c.bundlePath(), "rootfs-diff.tar")
+	rootfsDiffFile, err := os.Create(rootfsDiffPath)
+	if err != nil {
+		return errors.Wrapf(err, "error creating root file-system diff file %q", rootfsDiffPath)
+	}
+	tarStream, err := c.runtime.GetDiffTarStream("", c.ID())
+	if err != nil {
+		return errors.Wrapf(err, "error exporting root file-system diff to %q", rootfsDiffPath)
+	}
+	_, err = io.Copy(rootfsDiffFile, tarStream)
+	if err != nil {
+		return errors.Wrapf(err, "error exporting root file-system diff to %q", rootfsDiffPath)
+	}
+	tarStream.Close()
+	rootfsDiffFile.Close()
+
+
 	input, err := archive.TarWithOptions(c.bundlePath(), &archive.TarOptions{
 		Compression:      archive.Gzip,
 		IncludeSourceDir: true,
@@ -524,6 +543,7 @@ func (c *Container) exportCheckpoint(dest string) (err error) {
 			"ctr.log",
 			"config.dump",
 			"spec.dump",
+			"rootfs-diff.tar",
 			"network.status"},
 	})
 
@@ -546,6 +566,8 @@ func (c *Container) exportCheckpoint(dest string) (err error) {
 		return err
 	}
 
+	os.Remove(rootfsDiffPath)
+
 	return nil
 }
 
@@ -792,6 +814,21 @@ func (c *Container) restore(ctx context.Context, options ContainerCheckpointOpti
 	if err := c.saveSpec(g.Spec()); err != nil {
 		return err
 	}
+
+	// Before actually restarting the container, apply the root file-system changes
+	rootfsDiffPath := filepath.Join(c.bundlePath(), "rootfs-diff.tar")
+	if _, err := os.Stat(rootfsDiffPath); err == nil {
+		// Only do this if a rootfs-diff.tar actually exists
+		rootfsDiffFile, err := os.Open(rootfsDiffPath)
+		if err != nil {
+			return errors.Wrapf(err, "Failed to open root file-system diff file %s", rootfsDiffPath)
+		}
+		if err := c.runtime.ApplyDiffTarStream(c.ID(), rootfsDiffFile); err != nil {
+			return errors.Wrapf(err, "Failed to apply root file-system diff file %s", rootfsDiffPath)
+		}
+		rootfsDiffFile.Close()
+	}
+
 	if err := c.ociRuntime.createContainer(c, c.config.CgroupParent, &options); err != nil {
 		return err
 	}
@@ -809,7 +846,7 @@ func (c *Container) restore(ctx context.Context, options ContainerCheckpointOpti
 		if err != nil {
 			logrus.Debugf("Non-fatal: removal of checkpoint directory (%s) failed: %v", c.CheckpointPath(), err)
 		}
-		cleanup := [...]string{"restore.log", "dump.log", "stats-dump", "stats-restore", "network.status"}
+		cleanup := [...]string{"restore.log", "dump.log", "stats-dump", "stats-restore", "network.status", "rootfs-diff.tar"}
 		for _, del := range cleanup {
 			file := filepath.Join(c.bundlePath(), del)
 			err = os.Remove(file)
diff --git a/pkg/adapter/checkpoint_restore.go b/pkg/adapter/checkpoint_restore.go
index 97ba5ecf7..1514a3414 100644
--- a/pkg/adapter/checkpoint_restore.go
+++ b/pkg/adapter/checkpoint_restore.go
@@ -55,6 +55,7 @@ func crImportCheckpoint(ctx context.Context, runtime *libpod.Runtime, input stri
 			"checkpoint",
 			"artifacts",
 			"ctr.log",
+			"rootfs-diff.tar",
 			"network.status",
 		},
 	}