From bc2397c72938f104667dfbfa107dbce49624b7a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iago=20L=C3=B3pez=20Galeiras?= Date: Wed, 8 Nov 2017 15:11:52 +0100 Subject: [PATCH] Documentation: add upgrading doc --- Documentation/upgrading.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 Documentation/upgrading.md diff --git a/Documentation/upgrading.md b/Documentation/upgrading.md new file mode 100644 index 00000000..321f65c9 --- /dev/null +++ b/Documentation/upgrading.md @@ -0,0 +1,13 @@ +## Upgrading rkt + +Usually, upgrading rkt should work without doing anything special: pods started with the old version will continue running and new pods will be started with the new version. +However, in some cases special care must be taken. + +### When the rkt api-service is running + +If the api-service is running and the new version of rkt does a store version upgrade that requires migration, new invocations of rkt will be blocked. +This is so because the api-service is a long running process that holds a lock on the store, and the store migration needs to take an exclusive lock on it. + +For this reason, it is recommended to stop the api-service and start the latest version when upgrading rkt. + +This recommendation doesn't apply if the new api-service is listening on a different port and using a different [rkt data directory](commands.md#global-options) via the `--dir` flag.