Upgrading

• Basic upgrading procedure
• Create a backup of the current version
• Upgrade and start from backup
• Upgrade Clients and Servers
• Additional Options
  • Alluxio worker ramdisk cache persistence

Basic upgrading procedure

In normal cases, users can directly shut down the current Alluxio processes, change the Alluxio binaries to a newer version, configure Alluxio clusters similar to before, and start Alluxio processes with the existing journal folder/address for upgrading. Alluxio can read the previous journal files and recover the Alluxio metadata automatically.

There are two cases where master journals are not backward compatible and additional steps are required to upgrade the Alluxio cluster:

• Upgrading from Alluxio 1.x to Alluxio 2.x
• Upgrading from Alluxio 2.3.x and below to Alluxio 2.4.0 and above when using embedded journal.

This document goes over how to upgrade Alluxio to a non-backward compatible version. Even when upgrading to a backward-compatible version, it is still recommended to follow the steps below to create a backup before upgrading.

Create a backup of the current version

alluxio-1.8.1 introduced a journal backup feature. Please note that the Alluxio binaries should not be changed before taking the backup. With versions older than 1.8.1 master(s) running, create a journal backup by running

$ ./bin/alluxio fsadmin backup
Successfully backed up journal to ${BACKUP_PATH}

${BACKUP_PATH} will be determined by the date, and the configuration of your journal. By default, the backup file will be saved to the alluxio.master.backup.directory of your cluster root UFS. One can also backup to the local filesystem of the current leading master node with backup [local_address] --local command.

Upgrade and start from backup

After stopping your existing Alluxio cluster, download and untar the newer version of Alluxio. Copy over the old configuration files from the /conf directory. Then format the cluster with

$ ./bin/alluxio format

• WARNING: This will re-format the ramdisks on the Alluxio workers (i.e: wipe their contents). If you wish to preserve the worker ramdisks please see Alluxio worker ramdisk cache persistence.

Then start the cluster with the -i ${BACKUP_PATH} argument, replacing ${BACKUP_PATH} with your specific backup path.

$ ./bin/alluxio-start.sh -i ${BACKUP_PATH} all

Note that the ${BACKUP_PATH} should be a full path like HDFS address that can be accessed by all the Alluxio masters. If backing up to a local filesystem path, remember to copy the backup file to the same location of all masters nodes, and then start all the masters with the local backup file path.

Upgrade Clients and Servers

Alluxio 2.x makes significant changes in the RPC layer, so pre-2.0.0 clients do not work with post-2.0.0 servers, and vice-versa. Upgrade all applications to use the alluxio-2.x client.

Please refer to the following steps：

1. Back up the metadata of the files in Alluxio. Please refer to the documentation on backup command.
2. Stop the Alluxio cluster

   $ ./bin/alluxio-stop.sh all
   

3. Update the Alluxio client jar path for all your applications. For example, Yarn, Spark, Hive and Presto. eg., In the “YARN (MR2 Included)” section of the Cloudera Manager, in the “Configuration” tab, search for the parameter “Gateway Client Environment Advanced Configuration Snippet (Safety Valve) for hadoop-env.sh”. Then add the following line to the script:

   $ export HADOOP_CLASSPATH=/<PATH_TO_ALLUXIO>/client/alluxio-2.10.0-SNAPSHOT-client.jar:${HADOOP_CLASSPATH}
   

   It should look like:

4. Start the Alluxio cluster

   $ ./bin/alluxio-start.sh all
   

5. If you have updated the Alluxio client jar for an application, restart that application to use the new Alluxio client jar.

Additional Options

Alluxio worker ramdisk cache persistence

If you have configured Alluxio workers with ramdisk caches, you may persist and restore the contents of those caches using another storage medium (eg., the host machine’s local disk).

Use the -c flag with alluxio-stop.sh to specify a path for the workers to save the contents of their ramdisks to (workers will save contents to their own host’s filesystems):

$ ./bin/alluxio-stop.sh workers -c ${CACHE_PATH}

• WARNING: This will overwrite and replace any existing contents in the provided ${CACHE_PATH}

Afterward, use the -c flag with alluxio-start.sh to specify the directory containing the workers’ ramdisk caches.

$ ./bin/alluxio-start.sh workers NoMount -c ${CACHE_PATH}

• WARNING: This will overwrite and replace any existing contents in the configured workers’ ramdisk paths.