Move the File Store Process


This topic describes File Store process when configured to run locally on Tableau Server. However, File Store can be run locally as well as external to Tableau Server. For more information on Tableau Server External File Store, see Tableau Server External File Store.

You cannot remove an instance of File Store if it is the only instance on the server. You cannot run Tableau Server without at least one instance of File Store. This means if you need to move the File Store, or if you are deleting a server node that is hosting the only instance of the File Store, you must first move File Store to another node.

Moving the File Store is a two-part process:

  • Adding a second instance of File Store (if there is not an existing second instance).

  • Decommissioning and removing the original instance of File Store.

This article assumes you have installed Tableau Server on an initial node and at least one additional node. For more information on adding nodes to Tableau Server, see Install and Configure Additional Nodes.

Adding a second instance of File Store

This procedure assumes you have added an additional node. For more information on adding nodes to Tableau Server, see Install and Configure Additional Nodes.

  1. Open TSM in a browser:

    https://<tsm-computer-name>:8850

    For more information, see Sign in to Tableau Services Manager Web UI.

  2. Click the Configuration tab.

  3. For the node you want to add an instance of File Store on, select File Store.

    Adding File Store to a node will also add an instance of Data Engine if one is not already on the node.

  4. Click Pending Changes at the top of the page:

    The Pending Changes list displays.

    A Coordination Service ensemble warning displays because you are configuring a three-node cluster. You can continue. You will deploy a Coordination Service ensemble in an upcoming step.

  5. Click Apply Changes and Restart and Confirm to confirm a restart of Tableau Server.

Decommissioning and removing an instance of file store

  1. In TSM, on the Status tab, verify that all processes are active.

  2. Click the Configuration tab.

  3. For the node you're removing File Store from, clear the File Store box.

    This will generate a warning about decommissioning the File Store before removing it. You cannot remove an instance of File Store unless it has been decommissioned. Click OK to decommission and remove the file store. Data Engine will also be removed unless an instance of one of these processes is installed on the node: VizQL Server, Application Server (Vizportal), Data Server or Backgrounder.

  4. If you are removing File Store from a node that also has the TSM Administrative Controller (usually the initial node), a warning will caution you about impact to server backup performance.

    Click Continue to decommission File Store.

  5. Click the Status tab to see the status of the decommission. When the instance of File Store is marked "Ready for removal" you can continue.

  6. Click Pending Changes at the top of the page.

    Note: If you are configuring a three- or five-node cluster, a Coordination Service ensemble warning will display. You can continue to apply pending changes and deploy a Coordination Service ensemble in a separate step. For information on deploying a Coordination Service ensemble, see Deploy a Coordination Service Ensemble.

  7. Click Apply Changes and Restart and Confirm to confirm a restart of Tableau Server.

Adding a second instance of file store

  1. Create a full backup of Tableau Server. For more information, see Back up Tableau Server Data.

  2. Add the File Store to a second node.

    tsm topology set-process -n <nodeID> -pr filestore -c 1

    The File Store is automatically added. Data engine is also added if it is not already on the node.

    Apply the configuration changes:

    tsm pending-changes apply

    If the pending changes require a server restart, the pending-changes apply command will display a prompt to let you know a restart will occur. This prompt displays even if the server is stopped, but in that case, there is no restart. You can suppress the prompt using the --ignore-prompt option, but this does not change the restart behaviour. If the changes do not require a restart, the changes are applied without a prompt. For more information, see tsm pending-changes apply.

  3. Check the status of the new file store instance.

    tsm status -v

    Wait for the new File Store to synchronise with the File Store on the first node. When synchronisation is complete the new File Store has a status of "running" instead of "synchronising".

Decommissioning and removing an instance of File Store

Once you have a second instance of File Store installed and synchronised you can decommission and remove the original instance. You must decommission the original instance before you remove it. Doing this guarantees that any unique files on the File Store node are duplicated to another file store node.

  1. Decommission the original File Store:

    tsm topology filestore decommission -n <nodeID> --override

  2. When the decommission command completes, remove the File Store from the node by applying the pending configuration changes. The File Store is automatically removed. Data Engine is also removed unless an instance of one of these processes is installed on the node: VizQL Server, Application Server (Vizportal), Data Server or Backgrounder.

    tsm pending-changes apply

    If the pending changes require a server restart, the pending-changes apply command will display a prompt to let you know a restart will occur. This prompt displays even if the server is stopped, but in that case, there is no restart. You can suppress the prompt using the --ignore-prompt option, but this does not change the restart behaviour. If the changes do not require a restart, the changes are applied without a prompt. For more information, see tsm pending-changes apply.

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