Best Practices and Recommendations to Configure Gateway in Azure

The following are the recommendations you can follow while configuring the Gateway in Azure.
The following are the recommendations you can follow while configuring the Gateway in Azure.
  • Set up Gateway in a virtual network within ARM environment.
  • Use single load balancer into the network (internal load balancer).
  • Use single load balancer outside of network (external load balancer).
  • If you use load balancer for SSL termination, then load the Gateway certificates into the load balancer
For more details on considerations for load balancer, see Azure Load Balancer overview.
  • CA Technologies do not specifically recommend ClearDB solutions.
  • You can use the database that ships with the CA API Gateway.
  • You can also create an instance of MySQL in Azure, and connect to the created MySQL. The size limit is 10 GB and up to 50 connections.
Connect Gateway with External Database
By default, CA API Gateway comes with MySQL database server. To connect to MySQL external database server, follow these steps:
  1. Open the Azure portal and go to Marketplace.
  2. Click + (New) icon and search for MySQL.
  3. Select the MySQL database server type that you want to connect and click
    Do not select the publisher type with ClearDB MySQL Database servers.
  4. Configure the Azure virtual machine.
    MySQL is a pre-configured virtual machine, define what type of VM you need.
    1. Basics:
      Configure basic settings of the virtual machine.
      • Name for the virtual machine.
      • User name for the default admin/root account.
      • Authentication type and a password or SSH public key.
        We recommended that you use SSH Public Key for Linux.
      • Subscription to deploy the virtual machine.
      • Name of the Resource Group.
      • Location for the virtual machine.
    2. Size:
      Select size of the virtual machine.
      The size of your virtual machine depends on how the MySQL server is queried, timespan to run queries, and the database size.
    3. Settings:
      Configure optional features.
    4. Review the summary and click
    5. Click
      The virtual machine takes few seconds to deploy and you are ready to use MySQL server.
  5. To view the IP address of the Azure virtual machine go to
    All resources
    your virtual machine
    and select
  6. To view the password of the MySQL database server go to
    Boot diagnostics
    Search for the default password that is provided by the application. For example, the password for Bitnami is located under
    Setting Bitnami application password
  7. Verify that the MySQL database server is available for root user on the Azure virtual machine. Open the Azure virtual machine in a terminal application such as PuTTY and run the following command:
    mysql -u root –p
    The virtual machine prompts for password. Use the password that is provided in the Azure virtual machine.
    After connecting to the database, you can change the password.
  8. Connect CA API Gateway application with the database server that is configured on Azure virtual machine.
  9. Open the Gateway appliance and configure the database as specified in Gateway Configuration Menu.
The default Read timeout for connecting to an external database is 10 minutes. To alter the timeout period, add the following entry to the file
Where the
value is in milliseconds. Run
service ssg restart
in a privileged shell for the new value to take effect.
For more information on creating an instance of MySQL, refer to the article "How to deploy and use MySQL from the Azure Marketplace".
For more information on creating a MySQL database using Azure, refer to the article "Create an Azure Database for MySQL server by using the Azure portal".
Disaster Recovery
You must create a machine storage account for disaster recovery.
  • You can create BLOB storage with a container in azure storage.
  • You can back up the VHD through portal, and store it.
  • In the event of disaster, use the backed up disk to create new system.
  • You can create another image using existing marketplace.
  • You can attach backup disk to the new VM.
  • You can use Microsoft OMS backup and recovery tools for backup and recovery process.
For more information about disaster recovery, refer to the article "What is Site Recovery" from Microsoft.