How To: Add a Worker Node
Many customers need to expand their Alteryx Server environment to support a growing number of users, additional departments, increased data sizes, frequent job queuing, or a myriad of other reasons. This document walks through the process of adding a Worker Node to an Alteryx Server environment. These steps apply regardless of the size of the existing Alteryx Server environment.
- Alteryx Server
- Additional required assets:
- Controller Hostname
- Controller Token
- Alteryx Server and Data installers
- Database Drivers
- Provision a new physical or virtual machine meeting the Alteryx Server minimum requirements. It is recommended to work with your Alteryx representative to understand what is an optimal system setup for your use cases, data set sizes, and business requirements.
- Install applicable database drivers. For ODBC Drivers, configure System or User DSNs to match the existing Worker(s). In-Database connections should also be created for any data sources where In-Database processing is being used.
- Install Alteryx Server and any Data packages using the same install files from your existing Alteryx Server environment. This ensures version compatibility between the Controller and the new Worker Node. There are a couple of ways to verify the same version is being used.
- Check the version reported in Gallery at https://MyGalleryHostname.com/#!help/version
- Check the version reported by Alteryx Designer running on the existing Alteryx Server machine.
- Ensure this matches the version reported by the file name of the Alteryx Server installable on the new Worker node.
- On the Alteryx Server Controller machine, open the System Settings and navigate to the Controller > General section. Copy the Controller Token and save it for step 6.
- On the new Worker Node where Alteryx Server has been installed, launch the System Settings wizard. For the Environment Setup Type, choose Custom - Enable Worker.
- Continue to the Controller -> Remote section. Enter your Controller Hostname and paste the Controller Token saved in step 4. Click Test to ensure the Alteryx Server version, Controller Hostname and Token match.
- Configure the Worker and Engine settings as desired. Typically this involves matching the settings of an existing Worker but there are situations where it makes sense to have different settings across Workers, such as the number of workflows allowed to run simultaneously, QoS settings, Job tags, Map Rendering, etc...
An example Worker ConfigurationAn example Worker Configuration
- Complete the System Settings wizard and validate the AlteryxService is Running on the new Worker node.
- Validate the new Worker shows up in the Gallery Admin > Diagnostics page in the Workers panel.
- Ensure the new Worker has access to any locally stored Macros or data sets. It is recommended to move all locally stored Macros and data sets to a network share or similar storage device that is accessible by all Workers, and then update Workflows based on the new locations. Storing files locally and copying to all Workers isn't recommended as it requires a method to keep them all in sync, increases data storage requirements, and introduces version differences across the environment.
- Finally, run a few representative workflows through the new Worker to verify everything is working as expected.
With just a few simple steps a new Worker node can be added to an Alteryx Server environment to provide redundancy, higher throughput, shorter job queue times, and many more benefits.