Merge branch '11305-migrate-docker19-doc'
authorNico Cesar <nico@curoverse.com>
Wed, 26 Apr 2017 18:25:22 +0000 (14:25 -0400)
committerNico Cesar <nico@curoverse.com>
Wed, 26 Apr 2017 18:25:22 +0000 (14:25 -0400)
Documentation for the migration process from Docker 1.9 or less  to Docker 1.10+

Docker changed the format of the images, and there is an arvados tool arvados-migrate-docker19,
this commit explains how to migrate

refs #11305

doc/install/migrate-docker19.html.textile.liquid

index 2dca03904c52e482349bd9cfe9d10db6b9f640d7..37a9364218b0701dd59d6563c244e4d44bcb60aa 100644 (file)
@@ -8,13 +8,16 @@ If you have an existing Arvados installation using Docker 1.9 and wish to update
 
 The @arv-migrate-docker19@ tool converts Docker images stored in Arvados from image format v1 (Docker <= 1.9) to image format v2 (Docker >= 1.10).
 
-Requires Docker running on the local host (can be either 1.9 or 1.10+).
+Requires Docker running on the local host (can be either 1.9 or 1.10+). Linux kernel >= 3.18-rc6 to support overlayfs.
 
 Usage:
 
-# Run @arvados/docker/migrate-docker19/build.sh@ to create @arvados/migrate-docker19@ Docker image.
+# Install arvados/migrate-docker19 image: @docker pull arvados/migrate-docker19:1.0@. If you're unable to do this, you can run @arvados/docker/migrate-docker19/build.sh@ to create @arvados/migrate-docker19@ Docker image.
+# Make sure you have the right modules installed: @sudo modprobe overlayfs bridge br_netfilter nf_nat@
 # Set ARVADOS_API_HOST and ARVADOS_API_TOKEN to the cluster you want to migrate.
-# Run @arv-migrate-docker19@ from the Arvados Python SDK on the host (not in a container).
+# Your temporary directory should have the size of all layers of the biggest image in the cluster, this is hard to estimate, but you can start with five times that size. You can set up a different directory by using the @--tmp-dir@ switch. Make sure that the user running the docker daemon has permissions to write in that directory.
+# Run @arv-migrate-docker19 --dry-run@ from the Arvados Python SDK on the host (not in a container). This will print out some information useful for the migration.
+# Finally to make the migration run @arv-migrate-docker19@ from the Arvados Python SDK on the host (not in a container).
 
 This will query Arvados for v1 format Docker images.  For each image that does not already have a corresponding v2 format image (as indicated by a docker_image_migration tag) it will perform the following process: