Tableau Server Cluster InstallandConfig Instruction Document V 1.0
Tableau Server Cluster InstallandConfig Instruction Document V 1.0
Hardware Recommendations:
64-bit (x64
chipsets) 8-
core,
2.0
32 GB 50 GB
GHz
or
ARM-based higher
Single node processors are
not supported
If you are adding Tableau Prep Conductor to your Tableau
Server installation, we recommend you add a second node
and dedicate this to running Tableau Server Prep
Conductor. This node should have a minimum of 4 cores
(8 vCPUs), and 16 GB of RAM.
Important: The disk space requirement cannot be checked until you initialize TSM.
Hardware Guidelines for High Availability:
Failover—three computers: To configure a cluster that provides failover support for the file
store and repository processes, you need at least three computers or VMs: one for the initial
Tableau Server node and two for additional nodes.
Multiple gateways—three computers and a load balancer: Adding multiple Gateway
processes to your Tableau Server installation and using a load balancer to automatically
distribute requests to those gateways enhances the reliability of Tableau further. To
configure a cluster that provides failover support and multiple gateways, you need to add a
load balancer to front your three-node cluster.
Failover & multiple gateway support—three computers and a load balancer: To configure a
cluster that provides the above plus support for multiple gateways, you need at least three
computers or VMs, and a load balancer to front the cluster.
Initial computers: If you configure for high availability, the initial Tableau Server node may
be running few or no Tableau Server processes. Therefore, the computer that serves as the
initial node does not need as many cores as the ones running your additional nodes. You
will, however, need adequate disk space for backups because the initial computer is used
during the backup and restore processes.
Software:
1. All nodes in a distributed installation must be running the same version of Tableau
Server.
Note: All nodes in a multi-node cluster must have the same type of operating system. You
cannot install a multi-node instance of Tableau Server on a combination of Linux and Windows
nodes.
Installation location:
The installation location for Tableau Server must be the same on all nodes in a cluster. This is true
whether you install to the default location or to a non-default location.
1.1.2 Follow the on-screen instructions to complete Setup and install the application.
The default installation path is C:\Program Files\Tableau\Tableau
server\<version>.
1.1.3 After the installation completes, click Finish. Setup will then open the TSM
configuration web page on the computer where you are installing Tableau
Server.
Note: If you are prompted by Windows Defender Firewall, click Allow access.
You may need to do this multiple times for the installation to complete.
1.2 Activate and Register Tableau Server:
1.2.1 Sign in to Tableau Services Manager Web UI .The account you use must have
administrative privileges on the computer where TSM is installed.
1.2.2 On the Activate page, Enter or paste your product key and click Activate License.
1.2.3 On the Register page, enter your information into the fields and click Register.
Important: Include the domain name with the user name—for example,
example\tableaurunas. Enter the password that you created for this account.
1.3.3 Gateway port: The default port for web access to Tableau Server (via HTTP) is
port 80. If the installation program determines that port 80 is in use when you
first install Tableau Server, an alternate port (for example 8000) is used and
shown in the Port number box.
1.3.4 Product usage data: By default, Tableau Server shares usage data with
Tableau that helps us better understand how you use our products, improve
your overall experience, and build highly intelligent features that make Tableau
even more powerful. Clear this option if you do not want usage data sent to
Tableau.
You can also change this setting after installation, on the
TSM Maintenance tab in the TSM Web UI, or using the TSM CLI.
1.3.5 Sample workbook installation: By default, Tableau Server will install
sample workbooks in the Default site when you initialize the server.
Alternatively, you can publish samples after installation by using the publish
samples tabcmd command.
1.3.6 Initializing install: After you have configured the options on this page, click
Initialize. The initialization process can take a while. When initialization is
complete the following page is displayed:
Click Continue.
4. Configure your additional node with the processes you want to run on it.
4.1 open a window and navigate to TSM: https://<tsm-computer-name>:8850
4.2 Click the Configuration tab. A message should tell you that the new node was added.
If you are configuring a cluster with three or more nodes, a Coordination Service
ensemble warning displays. You can continue. You will deploy a Coordination Service
ensemble in a separate step.
4.5 Click Apply Changes and Restart and Confirm to confirm a restart of Tableau Server.
After Tableau Server restarts, the node is included with the minimum topology
necessary and any additional processes you configured.
5. Repeat Steps 3 and 4 for any additional nodes you want to install.
6. Deploy a new Coordination Service ensemble.
6.1 On the initial node, open a command prompt as administrator.
6.2 Stop Tableau Server: tsm stop. If prompted, sign in as a TSM administrator.
6.3 Confirm there are no pending changes: tsm pending-changes list
6.4 If there are pending changes, you need to either discard the changes or apply them.
Applying pending changes will take some time:
Discard the changes: tsm pending-changes discard OR
Apply the changes: tsm pending-changes apply
6.5 Get the node IDs for each node in the cluster: tsm topology list-nodes –v
6.6 Use the tsm topology deploy-coordination-service command to add a new Coordination
Service ensemble by adding the Coordination Service to specified nodes.
For example, deploy the Coordination Service to all three nodes of a three-node cluster,
where the nodes are node1, node2, and node3:
tsm topology deploy-coordination-service -n node1,node2,node3
6.7 If the deployment fails, you need to run the tsm topology cleanup-coordination-service
command to remove the unsuccessfully deployed ensemble.
6.8 Start Tableau Server: tsm start
7. Add Client File Service to every node that is running the Coordination Service.
7.1 On the initial node, open a command prompt as administrator.
7.2 Find the node ID for the node you are adding CFS to: tsm topology list-nodes –v
7.3 Add CFS on the node by specifying the node, the process, and a single instance.
For example, this command adds an instance of CFS to node2:
tsm topology set-process -n node2 -pr clientfileservice -c 1
NOTE: If you attempt to add an instance of CFS to a node that already is configured with
CFS, an error message will let you know there is already an instance on the node.
To add CFS to additional nodes, repeat this step for each node.
7.4 Apply the changes:
tsm pending-changes apply