11305: expanded documentation for docker migration
[arvados.git] / doc / install / migrate-docker19.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Migrating Docker images
5 ...
6
7 If you have an existing Arvados installation using Docker 1.9 and wish to update to Docker 1.10+, you must migrate the Docker images stored in Keep.
8
9 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).
10
11 Requires Docker running on the local host (can be either 1.9 or 1.10+).
12
13 Usage:
14
15 # Install arvados/migrate-docker19 image: @docker pull arvados/migrate-docker19@. If you're unable to do this, you can run @arvados/docker/migrate-docker19/build.sh@ to create @arvados/migrate-docker19@ Docker image.
16 # Set ARVADOS_API_HOST and ARVADOS_API_TOKEN to the cluster you want to migrate.
17 # Your $TMPDIR should have the size of the biggest image in the cluster. You can set up a different dir (i.e. export TMPDIR=/mnt/tmp). Make sure that the user running the docker daemon has permissions to write in that directory
18 # Run @arv-migrate-docker19@ from the Arvados Python SDK on the host (not in a container).
19
20 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:
21
22 i) download the image from Arvados
23 ii) load it into Docker
24 iii) update the Docker version, which updates the image
25 iv) save the v2 format image and upload to Arvados
26 v) create a migration link
27
28 Once the Docker images in Keep have been migrated, upgrade the version of Docker used across the cluster.  Finally, update the API server configuration from "v1" to "v2" to reflect the supported Docker image version:
29
30 <pre>
31 docker_image_formats: ["v2"]
32 </pre>