Backup and Recovery of Tableau Server using TSM


In order to make your Tableau Server as a full backed up system, you would need to understand what are the available backup options and how best you can use them. By default, Tableau has 2 types of backups. It is essential to have these two with you to fully recover your tableau server. In addition to these, external files like SSL certs, keytabs, keystores, etc will need to be taken care manually. I will covery all of these in a series of posts.


Let's start with repository.


1) tsm maintenance backup


In short, it's your repository. It contains views, data sources, data extract files, and site configuration data. This backup is handy when you loose any content, user related data, etc. You can take this backup using tsm.


tsm maintenance backup --file [options]


Below is an example case on where and when is this repository backup is helpful. We will see how backup is restored to bring back the lost content.


S1) Let's take a backup using tsm maintenance backup --file backup -d (-d will append the date to your backup file name) and the backup has been saved as C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups\backup-2019-01-11.tsbak. By default, Tableau will save backup files to C:\ProgramData\Tableau\Tableau Server\data\tabsvc\files\backups directory.



S2) We will remove some content. Let's say a schedule, user and a project like below.



Those are removed now.



S3) Now We will see the restoring of backup(backup-2019-01-11.tsbak) to check if it brings back the lost/removed data. Restore is performed using tsm maintenance restore --file backup-2019-01-11.tsbak --restart-server. On a high level note, It stops server, restores data and starts the server with your restored data.



S4) Once the restore is sucessfull, login to tableau server and check. 



This is the process to take the backup and restore it when required. How ever, it's not always a good time or good place to take this backup. Below are the best practices you can follow to put it in a right direction.


Best Practices to follow.


  • Depends on size of your data, backup process can take time. So make sure you run backup job during your off businsess hours. No other jobs can run in parallel to backup job. 
  • Once backup job is successful, make sure the backup file is copied to a different server. So that it can be resored even in case of a server's loss.
  • Always use option -d which appends the date.


With this, you are good with your repository data. But as I said, a complete recovery of tableau server isn't just restoring the repository. Along with it, we need to have server topology, configuration and the key files like keystore, ssl certs, customisations,etc.


This post is taken from AskLakshmi.