Enabling Clustering for API Gateway through the User Interface
About this task
Keep the following points in mind when enabling clustering for
API Gateway.
- You must have API Gateway administrator privileges to enable clustering.
- For a cluster configuration, the embedded API Data Store instances should also be clustered using standard Elasticsearch clustering properties, by modifying the SAG_root/InternalDataStore/config/elasticsearch.yml file on each instance.
- If you are using Terracotta Server Array for clustering, ensure
the following:
- To be in the same cluster, API Gateways must use the same Terracotta Server Array URLs and the same cluster name.
- An enterprise can have more than one cluster. To isolate multiple clusters on the same network, each cluster must have a different cluster name or different Terracotta Server Array or both.
- Before you enable clustering using Terracotta, perform the
following steps to ensure that Terracotta Server Array is ready for use by the
API Gateways
in the cluster.
- Install the Terracotta Server Array if you have not done
so already. For installation instructions, see
Installing Software AG
Products.
Note: Before you install your Terracotta Server Array, you have to decide how many Terracotta Servers will make up the array and whether or not you want to mirror those servers. To guide your decision, review the sections on high availability and architecture in the product documentation for the Terracotta Server Array or consult your Software AG representative.
- Configure the tc-config.xml file on the Terracotta Server Array. For details on installing and changing a Terracotta license, see webMethods Integration Server Administrator’s Guide.
- Install the Terracotta Server Array if you have not done
so already. For installation instructions, see
Installing Software AG
Products.
To enable clustering