Install Tableau Server with External File Store

This topic walks you through the process of configuring a network attached storage as your File Store for a new Tableau Server Installation. If you are trying to do this on an existing installation of Tableau Server that has File Store running locally, see Reconfigure File Store .

Prerequisites

  • You must use Tableau Server 2020.1 or later.
  • You must have a network attached storage solution you can use as your storage option. For recommendations on the storage solution, see Performance Considerations for External File Store.

    Use SMB share for Windows installations.

    Estimating the storage size: You must take into account the amount of storage needed for publishing and refreshing extracts. In addition, you must also take into account the repository backup size unless you specifically choose the option to do your repository backup separately as described in the Option 2: Backup Repository Separately topic.

    • Extracts:
      • Consider the number of extracts that will be published to Tableau Server and the size of each extract. Test your needs by publishing several extracts to Tableau Server, and then checking the disk space used. You can use this amount of disk space to help you figure out how many extracts will be published to Tableau Server over time as well as how each existing extract will increase in size.
      • Consider the space needed by the temp directory during an extract refresh. The temp directory, which is where an extract is stored to during a refresh, may require up to three times the final file size of the extract.

    • Repository Backup:
      • To obtain an estimate of the repository data, check the size of <data directory>/pgsql/data/base directory.

      • To obtain the exact size of the repository data, open the backup file and use the size of the workgroup.pg_dump file.
  • You must have a valid Server Management Add-on license activated on your server. To learn more about Server Management Add-on, see About Tableau Server Management Add-on.

Install Tableau Server with External File Store

You can install Tableau Server with File Store using a network attached storage to store Tableau Server data. This solution replaces the need for running the File Store process locally. To learn more about this solution and its benefits, see Tableau Server External File Store.

Use the following steps to install your Tableau Server with External File Store during install:

Step 1: Configure a network share

On your file server:

  1. Create and share a directory to use as the Tableau Server External File Store.
  2. Make sure the network attached storage is accessible as a directory in the same location on all the Tableau Server nodes.
  3. Create the tableau directory in your network share and give full access to the Network Service and the domain user account that are you planning to use for the Run As user .

    We recommend calling the directory 'tableau'.

    \\hostname\<network share>\tableau\

    Note:
    - The Network Service account can be used to access resources on remote computers within the same Active Directory domain, but we recommend that you configure a domain account for Run As service account to use in this scenario. For more information, see Run As Service Account.
    - Services that run as the Network Service account access network resources by using the credentials of the computer account in the format <domain_name>\<computer_name>$.
    If you are using Active Directory to manage permissions and access to users, here is a recommended way to manage the permissions to your network share:
    - Create an Active Directory security group.
    - Add the computer accounts for the Tableau cluster along with the Run-As user to this group.
    - Grant access to the security group on the network share. This way if you need to add or remove a computer from the cluster, you can just make the change to the security group.

  4. Validate that the network share is configured properly: From Tableau Server run a command to write to a network share and confirm that you are able to write to it.

     

Step 2: Download and install TSM

  1. Download the Tableau Server installer.
  2. Open a command prompt as a user with administrator access to the computer where you want to install Tableau Server.
  3. Run the Setup program from the command line using the /SILENT and /ACCEPTEULA options:

    tableau-setup-tsm-<branch>.<build>-x64.exe/SILENT/ACCEPTEULA

    Note: There are a number of different installation options you can specify during CLI installation, for example, to change installation and logging paths, or to specify the TSM controller port. For a complete list of switches that you can specify during CLI installation, see Install Switches and Properties for Tableau Server.

Step 3: Activate and register Tableau Server

Provide the Tableau Server Key and the Server Management Add-on key in the activate step. You will need to run the following command twice, first with the Tableau Server product key and then with the Server Management Add-on product key:

tsm licenses activate -k <product key>

Step 4. Enable External File Store

Configuring Tableau Server with external repository can only be done using TSM CLI.

  1. Enable the network storage feature using the following tsm commands:

    tsm topology external-services storage enable -network-share \\hostname\<network share>\tableau\

    The setup program automatically creates the following directory structure in the share:

    PostgreSQL data backups:

    tableau_data\tabsvc\pg_backups

    Note: This directory will be created the first time you create a backup.

    Extracts and workbook revisions:

    tableau_data tabsvc\dataengine\extracts

    tableau_data\tabsvc\dataengine\revisions

Step 5: Configure the initial node settings

Follow the instructions provided in the Configure Initial Node Settings topic.

Step 6: Complete the install

You must create the initial administrative account for Tableau Server.

  • If you configured a local identity store during setup, then specify a name and password that you want to use.
  • If you configured a LDAP or Active Directory identity store during setup, then you must specify a user account that is a member of the directory.

To create the initial user, run the following tabcmd command:

tabcmd initialuser --server localhost:80 --username '<new-admin-username>'

After you run the command, the shell will prompt for an administrative password.

Step 7: Post-installation tasks

After you have created the Tableau Server administrator account, continue your deployment by working through the configuration steps described in the Post Installation Tasks topics.

Who can do this

Tableau Server Administrators can install and configure Tableau Server and External File Store. In addition, you must have permissions and access to configure the network attached storage to use with Tableau Server.

Next

Backup and Restore with External File Store

Thanks for your feedback!