Install Runtime Fabric on Azure

This topic describes how to install and register Anypoint Runtime Fabric on your Azure account.

Before running the installer, ensure that your infrastructure meets the minimum hardware, operating system, and networking requirements. An operations and networking specialist may be needed to provision the required infrastructure.

Before you Begin

Prepare the necessary steps and understand the core concepts prior to installing Runtime Fabric. In addition, ensure the following criteria have been met before beginning the installation:

  • Review the installation details to ensure you are ready to install Runtime Fabric.

  • Your Azure user has access to create VMs, Disks, Virtual Networks, Network Security Groups.

  • Your Azure account has enough quota for the infrastructure being provisioned.

  • If your organization does not allow using public IPs for VMs, you may need to use an existing Virtual Network. The Azure Resource Manager template can be modified to reference an existing Virtual Network.

Download Script

The installer script ZIP file includes the necessary scripts needed to install Runtime Fabric on Azure.

  1. Log in to Anypoint platform and navigate to Runtime Manager.

  2. On the left navigation pane, select "Runtime Fabrics".

  3. Click "Create Runtime Fabric".

  4. Click the "Download files" link.

  5. Once downloaded, unzip the file.

You’ll find a directory named azure containing the following:

  • ARM-template-dev.template: the Azure Resource Manager template describing the infrastructure per the development configuration requirements.

  • ARM-template-prod.template: the Azure Resource Manager template describing the infrastructure per the production configuration requirements.

  • a shell script used to insert the Mule Enterprise license digest and initialization script in the ARM templates, outputting the JSON templates to use when deploying to Azure.

Provision Infrastructure

First, the ARM templates will need to be generated to include the initialization script and Mule Enterprise license. The resulting templates will then be used to provision the infrastructure needed. The embedded script will automatically begin the process on each VM to install and register Runtime Fabric.

Prepare ARM Templates

The included Azure Resource Manager template files describe the required hardware and network settings needed to install and operate Runtime Fabric on Azure. Follow these steps to insert your organization’s Mule Enterprise license key and initialization script (located in scripts/ If you’re using Windows, you’ll need a shell terminal emulator (such as cygwin) or access to a Unix-based computer to follow these steps:

  1. Follow the steps to install your Mule Enterprise license and save the generated muleLicenseKey.lic file.

  2. Open a terminal/shell and navigate to the azure directory of the unzipped scripts.

  3. Run the following command to generate the ARM templates. It may be easier to use a text editor to prepare the script before running it:

    • The Mule License contents should be XML, and should be surrounded in single quotes when passed in the script.

  4. Confirm the output of the ARM-template-dev.json and ARM-template-prod.json files in the azure directory.

Deploy using ARM Template

There are multiple methods to apply the Azure Resource Manager Template to your Azure account. Below are instructions to apply the template via the Azure Portal.

You’ll need a private and public key as a PEM file to provision the VMs. This is required to enable secure access to your VMs via SSH (Secure Shell).
  1. Log into your Azure portal.

  2. Navigate to "Create a resource".

  3. On the "Search the marketplace" search bar, type in "Template deployment".

  4. Click "Create".

  5. Select "Build your own template in the editor."

  6. On the bar above the editor, click "Load file" and select the desired Azure Resource Manager template from the azure directory. A JSON file should be selected.

  7. After the editor is populated with the contents of the file, click "Save".

  8. Verify your Subscription selection, Resource group, and Region for deployment. In most cases, it’s recommended to create a separate Resource group.

  9. Under Settings, fill in the following parameters:

    Variable Description Example

    Public Key

    The public key string. This will enable you to SSH into each VM with your associated private key.

    ssh rsa …​

    Anypoint Authentication Token

    An active Anypoint authentication token, available on the Create Runtime Fabric page.

    Bearer 626d7810-0730-498b-bd48-544490c2226b

    Anypoint Broker Region

    The Anypoint broker region you’re registering to, available on the Create Runtime Fabric page.


    Anypoint Organization ID

    The ID for your Anypoint organization, available on the Create Runtime Fabric page.


    Anypoint Control Plane Host

    The Anypoint control plane you’re registering to, available on the Create Runtime Fabric page.

    Installer URL

    The URL of the Runtime Fabric installation package, available on the Create Runtime Fabric page.…​

    SSH User Name

    The user name to use when establishing a SSH connection to each VM.


    Runtime Fabric Name

    The name for your Runtime Fabric cluster.


    Runtime Fabric Token

    The token used to join each other VM to the installer VM. This should be a unique value to avoid conflicts during installation.


    Controller Instance Type

    The Azure machine type to provision for each controller VM. Default set to 2 cores and 8 GiB memory.


    Worker Instance Type

    The Azure machine type to provision for each worker VM. Default set to 2 cores and 16 GiB memory.


    Virtual Network CIDR

    The address range to specify for the Virtual Network. Refer to your network specialist for assistance, if necessary.

    Virtual Network Subnet

    The address range to specify for subnet to use within the Virtual Network. Refer to your network specialist for assistance, if necessary.

    Installer IP Address

    The IP address to assign the controller VM acting as the installer VM. This should be an available address which is within the subnet range specified.

    Availability Set Update Domains

    The number of update domains supported in the Azure region selected.


    Availability Set Fault Domains

    The number of fault domains supported in the Azure region selected.


  10. Review and select the Terms and Conditions on the bottom of the page, and click "Purchase".

By default, the ARM templates are configured to set a public IP address for each VM. The template can be modified to remove the publicIPAddresses, if necessary.

Common Errors

Depending on the policies set and the quotas defined with your Azure account, you may encounter errors during the provisioning process. The ARM template can be modified to accommodate the policies set by your organization. Consult your operations team as needed.

  • Exceed max core quota: File a ticket with Azure Support to increase quota for your deployment region. If you believe you have enough quota, ensure the right region is selected with the increased quota. Also, try modifying the Resource Group name to ensure it is unique to your account.

  • Network policy violation: By default, the Network Security Groups defined in the Azure Resource Template are associated at the subnet level and the NIC for each VM. Depending on your company’s policy, you may need to adjust the template to remove an association.

Monitoring the Provisioning

Your infrastructure will begin to be created and configured. Follow these steps to view the progress:

  1. On the left navigation bar, click on "Resource groups".

  2. Select the Resource group used to provision your Runtime Fabric infrastructure.

  3. On the Overview pane under Deployments, click on the link below, which may read "1 Deploying".

  4. Click on the Deployment Name "Microsoft.Template".

You should be able to see the list of infrastructure and its corresponding status as it’s being provisioned. Click the "Refresh" button to periodically refresh the pane and status.

This step will install Runtime Fabric across all servers to form a cluster. It may take 15-25 minutes or longer to complete.


The Azure Resource Manager template adds and runs the installation script on each VM after it’s provisioned. The installer VM will download the installer package, unpack it and begin installation. The other VMs will wait for the installer VM to progress with installation until it’s able to make the installer files transferrable. Each VM will then transfer the files from the installer VM and carry out their own installation procedure.

When installation has been completed, a cluster will be formed across all VMs. The installer VM will then carry out the registration step using the Anypoint Organization ID, token, and region specified.

After registration has completed, you’ll see the name used when provisioning Runtime Fabric in Anypoint Runtime Manager, under the Runtime Fabrics tab. The installation script on the installer VM will proceed to insert the Mule Enterprise license digest in Runtime Fabric.

When finished, verify the installation by running this command to view the health of the Runtime Fabric cluster on any VM; you should see each VM in the cluster with a status equal to healthy.

gravity status

Monitoring the Installation

It’s useful to monitor the installation on the installer VM to verify all pre-flight checks have passed; if an error were to occur during installation, it’s likely to be visible by viewing the installer VM’s log output.

To view the progress during the installation, you can tail the output log on each VM:

  1. Open a shell (or SSH session) to the VM.

  2. Tail the output log, located at /var/log/rtf-init.log

    tail -f /var/log/rtf-init.log
You can tail the same log on each VM to view its progress.

When the installation completes successfully, the file /opt/anypoint/runtimefabric/init-succeeded is created.

Next Steps

Before deploying applications on Anypoint Runtime Fabric, you’ll need to perform the following steps:

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.