Upgrade Tableau Server on Linux from 10.5

Important: Beginning with version 2020.4.0, if you are running version 10.5 of Tableau Server on Linux, you cannot upgrade directly to the latest version. You must upgrade to a version between 2018.1 and 2020.3 before upgrading to 2020.4 or later. Support for version 10.5 ended in July 2020 so direct upgrades to version 2020.4 or later are not supported. For information about supported versions, see the Tableau web site(Link opens in a new window).

When you upgrade Tableau Server on Linux from version 10.5, you need to take several specific steps to complete the upgrade. These are necessary because of a change made after version 10.5.0 was released, related to sudo privileges. For more information, see System User, sudo Privileges and systemd. You only need to do these extra steps once, during the upgrade to 2018.1 or later. This topic describes how to upgrade from version 10.5.0 or 10.5.x (10.5.1 or later) to version 2018.1 or later.

If you attempt to upgrade from 10.5.0 or 10.5.x without following these instructions, warnings will be displayed and the upgrade cancelled. You will not break your existing Tableau Server installation, but will not be able to continue with the upgrade.

To identify the version of your installation, see View Server Version.

Follow these steps to upgrade from 10.5.0:

  1. Upgrade to 10.5.x – If you are running version 10.5.0, you must first upgrade to 10.5.x (10.5.1 or higher) by installing 10.5.x and running the upgrade-tsm script in the 10.5.x scripts directory on your initial node.

  2. Install 2018.x or later, up to 2020.3.x – With 10.5.x installed and running as expected, install 2018.x or later, but do not upgrade to this version yet.

  3. Run TSM commands—Use TSM to stop the server and run three additional commands.

  4. Migrate 10.5.x to single userRun the migration script in the new version (2018.x or later) scripts directory. Do this on every node in your cluster.

  5. Upgrade to 2018.x or later, up to 2020.3.x – Upgrade Tableau Server by running the upgrade-tsm script from the new version scripts directory on your initial node.

  6. Upgrading from 2018.2 and Later – After upgrading to a version between 2018.x and 2020.3.x, you can upgrade Tableau Server to 2020.4 or later by following the instructions for here: Upgrading from 2018.1 and Later (Linux).

 

Upgrade to 10.5.x

If you are running version 10.5.0 of Tableau Server on Linux, the first step you need to take is to upgrade to a later version of 10.5. Beginning with version 10.5.1 changes were made that are needed in order to upgrade to 2018.1 or later. (If you are already on a version of 10.5 that is higher than 10.5.0, you can skip to the Install 2018.x or later, up to 2020.3.x step.)

To upgrade from 10.5.0 to a later version of 10.5:

  1. On each node in your cluster:
    1. Copy the Tableau Server version 10.5.x .rpm or .deb package to location that is accessible from the computer you are upgrading.

      If you are upgrading a distributed deployment of Tableau Server, copy the .rpm or .deb package to each node in the cluster or to a location accessible from each node.

    2. Log on as a user with sudo access to the computer you are upgrading.

    3. Navigate to the directory where you copied the .rpm or .debTableau Server package.

    4. Use the package manager to install the Tableau Server package.

      • On RHEL-like distributions, including CentOS, run the following command:

        sudo yum install tableau-server-<version>.x86_64.rpm

      • On Ubuntu, run the following commands:

        sudo gdebi -n tableau-server-<version>_amd64.deb

  2. Stop Tableau Server. If you are upgrading a cluster, do this after you have installed the new package on every node in your cluster.

    tsm stop

  3. With Tableau Server stopped, run the following command on your initial node. Do not run this command on any additional nodes:

    sudo /opt/tableau/tableau_server/packages/scripts.<version_code>/upgrade-tsm --accepteula

    where <version> is the 10.5.x version you are upgrading to.

    To see all the options available for the upgrade-tsm script, use the -h option. For example: 

    upgrade-tsm -h

  4. After the upgrade is completed, ensure your session is using the updated TSM version by doing one of the following:

    • Use the source command:

      source /etc/profile.d/tableau_server.sh

    • Exit the terminal session on the initial node and log in again.

  5. Start Tableau Server:

    tsm start

Install 2018.x or later, up to 2020.3.x

Install the new Tableau Server package but do not upgrade to this version yet. Before you do so, you need to run several commands and a migration script. You can install the new version package without stopping the server. When you install the new package, you are copying the software to your computer but not changing anything about the currently running version.

To install the new version package, on each node in your cluster:

  1. Copy the Tableau Server .rpm or .deb package to location accessible from the computer you are upgrading.

    If you are upgrading a distributed deployment of Tableau Server, then copy the .rpm or .deb package to each node in the cluster or to a location accessible from each node.

  2. Log on as a user with sudo access to the computer you are upgrading.

  3. Navigate to the directory where you copied the .rpm or .deb Tableau Server package.

  4. Use the package manager to install the Tableau Server package.

    • On RHEL-like distributions, including CentOS, run the following command:

      sudo yum install tableau-server-<version>.x86_64.rpm

    • On Ubuntu, run the following commands:

      sudo gdebi -n tableau-server-<version>_amd64.deb

 

Run TSM commands

Using version 10.5.x of Tableau Server that is installed and running:

  1. Stop the server:

    tsm stop

  2. Run these three commands:

    tsm configuration set -k service.linux.privileged_user -v 'tableau'

    tsm configuration set -k install.username -v 'tableau'

    tsm pending-changes apply

    where 'tableau' is the user name you specified with the initialize-tsm --unprivileged-user option when you first installed 10.5.x. If you did not specify a user, the default is 'tableau'.

Migrate 10.5.x to single user

Run this script from the 2018.x or later scripts directory:

sudo /opt/tableau/tableau_server/packages/scripts.<version_code>/migrate-to-single-user

where <version_code> is the long form of your new version number.

Important: If you have a multi-node installation, you must run this script on every node in your cluster.

At this point Tableau Server is running 10.5.x but configured to work with a single user. This is an interim stage. You should complete the upgrade to version 2018.x or later before using Tableau.

Upgrade to 2018.x or later, up to 2020.3.x

After completing the above steps:

  1. With Tableau Server stopped, run the upgrade script on the initial node. Do not run the script on any additional nodes. The options you need to include depend on the version you are upgrading to:

    • Version 2019.3 or later:

      sudo /opt/tableau/tableau_server/packages/scripts.<version_code>/upgrade-tsm --accepteula

      where <version_code> is the long form of new version you are upgrading to, for example scripts.20183.18.1128.2033.

      Starting with version 2019.3.0, when you upgrade from 2019.2.x or later, the script runs using the account you are logged in with. If you are prompted, enter your password. For more information, see What's Changed - Things to Know Before You Upgrade. You can specify a different user with administrative permissions using the -u option and specifying a user with administrative permissions on the computer where the initial node is installed. You will be prompted for the password for the administrative user.

    • Version 2018.1 to version 2019.2.x:

      sudo /opt/tableau/tableau_server/packages/scripts.<version_code>/upgrade-tsm -u <system_admin> --accepteula

      where <version_code> is the long form of new version you are upgrading to, for example scripts.20183.18.1128.2033, and <system_admin> is a user with administrative permissions on the computer where the initial node is installed. You will be prompted for the password for the administrative user.

      The -u option was added as of 2018.1. For more information, see What's Changed - Things to Know Before You Upgrade.

    To see all the options available for the upgrade-tsm script, use the -h option. For example: 

    sudo /opt/tableau/tableau_server/packages/scripts.<version_code>/upgrade-tsm -h
  2. After the upgrade is completed, ensure your session is using the updated TSM version by doing one of the following:

    • Use the source command:

      source /etc/profile.d/tableau_server.sh

    • Exit the terminal session on the initial node and log in again.

  3. Start Tableau Server:

    tsm start

Whenever you wish, you can remove Tableau Server on Linux version 10.5 from your server. Unlike most other programs that run on Linux, previous Tableau Server versions are not automatically removed as part of a successful upgrade. To learn more, see Remove Tableau Server from Your Computer.

Thanks for your feedback!Your feedback has been successfully submitted. Thank you!