Contact Us 1-800-596-4880

Creating Servers

Create and manage individual Mule runtime engine instances (servers) through Anypoint Runtime Manager to deploy and monitor your applications in hybrid standalone environments. Manage servers either individually or in server groups or clusters.

Understanding Servers

Servers communicate with Runtime Manager using the Runtime Manager agent. After creating a server, use Runtime Manager to deploy applications to the Mule instance and view information about the environment where you installed Mule.

For each Mule instance that you want to manage, add a server to Runtime Manager. In environments with multiple Mule instances, use server groups and clusters for redundancy, high availability, and ease of management.

Before You Begin

Before adding a server to Runtime Manager:

  • Have a current enterprise license.

  • Run Mule 4.x or later.

  • Install the Runtime Manager agent.

  • Have an Enterprise support account if downloading the agent.

  • Remove existing server registration if already registered in another Runtime Manager instance.

Create a Server

To create a server, add it to Runtime Manager:

  1. From Anypoint Platform, select Runtime Manager.

  2. Click Servers in the menu.

  3. Click the Add Server button.

  4. Enter a name for your server.

    Server names can contain up to 60 alphanumeric characters (a-z, A-Z, 0-9), periods (.), hyphens (-), and underscores (_), but not spaces or other special characters. Runtime Manager supports Unicode characters in server names.

    The server name must be unique in the environment, but it can be the same for the same organization in different environments.

    Runtime Manager generates the amc_setup command. This command includes the server name you specified (server-name) and the registration token (token) required to register Mule in your environment. The registration token includes your organization ID and the current environment.

    amc_setup command in the Add Server window
    Figure 1. The arrow shows the amc_setup command in the Add Server window.
  5. Click Copy command to copy the amc_setup command.

    This button appears only if the server name you specify is valid.

  6. In a terminal window, change to the $MULE_HOME/bin directory for the Mule instance that you’re registering.

  7. Paste the command on the command line.

  8. Include any other parameters on the amc_setup command line.

    For information, see amc_setup Parameters.

  9. If your environment requires all outbound calls to go through a proxy, specify proxy settings in either the $MULE_HOME/conf/mule-agent.yml file or the $MULE_HOME/conf/wrapper.conf file.

  10. If you are using the IBM JVM, see Configure IBM JVM.

When the amc_setup command completes successfully, you see:

Mule Agent configured successfully
Connecting to Access Management to extract client_id and client_secret
Credentials extracted correctly, updating wrapper conf file

After the script completes successfully, the name of your server appears on the Servers tab of Runtime Manager with a status of Created.

If the server was running when you ran the amc_setup script, restart the server to reconnect with Runtime Manager.

Configure IBM JVM

When creating a server using the IBM Java Virtual Machine (JVM), you must use a different truststore file than the default truststore installed by the Runtime Manager agent.

  1. Download the custom truststore from this knowledge base article:

  2. Depending on your Mule version, rename the truststore file in $MULE_HOME/conf to one of these file names:

    • anypoint-truststore.jks (Mule 4.1.3 with Agent 2.1.4 and later)

    • truststore.jks (Mule 4.1.2 with Agent 2.1.3)

  3. Copy the custom truststore into the $MULE_HOME/conf folder

  4. Restart Mule.

Remove a Server from Another Runtime Manager Instance

If the server you want to add is already registered with a different instance of Runtime Manager, you must remove it before you can register the new one.

To remove the server:

  1. From Anypoint Platform, select Runtime Manager.

  2. Select Servers.

  3. Click the server name.

  4. Click Settings.

  5. From the Actions menu, select Delete.

  6. In the $MULE_HOME/conf directory, delete the mule-agent.yaml and mule-agent.jks files.

For details, refer to Managing Servers.

Next Steps

After creating servers, you can:

  • Deploy applications to your servers

  • Organize servers into groups or clusters for better management

  • Configure monitoring and alerts for server health

  • Set up properties and environment variables for your applications