From d9b689562967c8fd02f1e6cf8a79fbe1bea4d3a1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9gis=20Behmo?= <regis@behmo.com>
Date: Mon, 17 Jun 2019 20:00:30 +0200
Subject: [PATCH] Pin docker image tags to tutor versions

Having an identical "ironwood" tag for all releases is not practical, in
particular for breaking changes. Thus, docker images are now pinned to
the tutor version that they were build with.
---
 CHANGELOG.md               |  1 +
 docs/configuration.rst     | 12 ++++++------
 tutor/templates/config.yml | 10 +++++-----
 3 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 02e6c38..2cc195a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@ Note: Breaking changes between versions are indicated by "💥".
 
 ## Latest
 
+- [Improvement] Switch to pinned image tags for easier upgrades
 - 💥[Improvement] Remove the `-y/--yes` option: `tutor config save` is now non-interactive by default. Use `-i/--interactive` to force interactive mode.
 - 💥[Improvement] Replace the `databases` command by `init`.
 
diff --git a/docs/configuration.rst b/docs/configuration.rst
index affa83a..cde87d7 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -61,13 +61,13 @@ Docker
 Custom images
 *************
 
-- ``DOCKER_IMAGE_OPENEDX`` (default: ``"regis/openedx:ironwood"``)
-- ``DOCKER_IMAGE_ANDROID`` (default: ``"regis/openedx-android:ironwood"``)
-- ``DOCKER_IMAGE_FORUM`` (default: ``"regis/openedx-forum:ironwood"``)
-- ``DOCKER_IMAGE_NOTES`` (default: ``"regis/openedx-notes:ironwood"``)
-- ``DOCKER_IMAGE_XQUEUE`` (default: ``"regis/openedx-xqueue:ironwood"``)
+- ``DOCKER_IMAGE_OPENEDX`` (default: ``"regis/openedx:{{ TUTOR_VERSION }}"``)
+- ``DOCKER_IMAGE_ANDROID`` (default: ``"regis/openedx-android:{{ TUTOR_VERSION }}"``)
+- ``DOCKER_IMAGE_FORUM`` (default: ``"regis/openedx-forum:{{ TUTOR_VERSION }}"``)
+- ``DOCKER_IMAGE_NOTES`` (default: ``"regis/openedx-notes:{{ TUTOR_VERSION }}"``)
+- ``DOCKER_IMAGE_XQUEUE`` (default: ``"regis/openedx-xqueue:{{ TUTOR_VERSION }}"``)
 
-These configuration parameters define which image to run for each service.
+These configuration parameters define which image to run for each service. By default, the docker image tag matches the Tutor version it was built with.
 
 Custom registry
 ***************
diff --git a/tutor/templates/config.yml b/tutor/templates/config.yml
index a0f33dd..d5e70bf 100644
--- a/tutor/templates/config.yml
+++ b/tutor/templates/config.yml
@@ -33,11 +33,11 @@ OPENEDX_AWS_SECRET_ACCESS_KEY: ""
 ANDROID_RELEASE_STORE_PASSWORD: "android store password"
 ANDROID_RELEASE_KEY_PASSWORD: "android release key password"
 ANDROID_RELEASE_KEY_ALIAS: "android release key alias"
-DOCKER_IMAGE_OPENEDX: "regis/openedx:ironwood"
-DOCKER_IMAGE_ANDROID: "regis/openedx-android:ironwood"
-DOCKER_IMAGE_FORUM: "regis/openedx-forum:ironwood"
-DOCKER_IMAGE_NOTES: "regis/openedx-notes:ironwood"
-DOCKER_IMAGE_XQUEUE: "regis/openedx-xqueue:ironwood"
+DOCKER_IMAGE_OPENEDX: "regis/openedx:{{ TUTOR_VERSION }}"
+DOCKER_IMAGE_ANDROID: "regis/openedx-android:{{ TUTOR_VERSION }}"
+DOCKER_IMAGE_FORUM: "regis/openedx-forum:{{ TUTOR_VERSION }}"
+DOCKER_IMAGE_NOTES: "regis/openedx-notes:{{ TUTOR_VERSION }}"
+DOCKER_IMAGE_XQUEUE: "regis/openedx-xqueue:{{ TUTOR_VERSION }}"
 DOCKER_IMAGE_MEMCACHED: "memcached:1.4.38"
 DOCKER_IMAGE_MONGODB: "mongo:3.2.16"
 DOCKER_IMAGE_MYSQL: "mysql:5.6.36"