Release Upgrades

Applying a release upgrade

After generating a tarball containing a relup file that describes the upgrade from version to another we must apply it to a running system, this section describes how you go about doing that.

Step 1: deploying the tarball

We assume that you are in possession of a tarball containing a valid relup, the typical filename of this tarball will be <release_name>-<version>.tar.gz, you will need to place it somewhere it can be picked up and applied to your running system, relx looks in 3 different places:

• releases/<release_name>-<version>.tar.gz
• releases/<version>/<release_name>-<version>.tar.gz
• releases/<version>/<release_name>.tar.gz

Step 2: performing the release upgrade

Now that the relup tarball is put in place we can move forward with the actual upgrade, first thing is checking the current versions:

bin/<release_name> versions

Now apply the actual upgrade, you have the choice of unpacking it first and then upgrading/downgrading:

bin/<release_name> unpack <version>
bin/<release_name> upgrade/downgrade <version>

or upgrading directly (which unpacks and upgrades):

bin/<release_name> upgrade/downgrade <version>

The upgrade/downgrade/install commands take optional arguments:

--no-permanent After performing the upgrade/downgrade the installed release will not be marked as permanent (by default it is), this means that if you restart the node the previous version will run instead

Step 3: cleaning up

After the upgrade/downgrade is completed and you are satisfied with the result you can proceed with the uninstall of the old version, first you should check the status of the versions installed

bin/<release_name> versions

and now uninstall old/unpacked versions that are taking space and are not needed anymore

bin/<release_name> uninstall <version>