Contact Us 1-800-596-4880

Deploying Mule Apps to CloudHub and CloudHub 2.0

logo cloud IDE Cloud IDE

logo desktop IDE Desktop IDE

Open Beta Release: The cloud IDE is in open beta. Any use of Anypoint Code Builder in its beta state is subject to the applicable beta services terms and conditions, available from the IDE.

You can use Anypoint Code Builder to deploy your Mule application to CloudHub.

Before You Begin

Deploy an App to CloudHub or CloudHub 2.0

When you deploy an application to CloudHub or CloudHub 2.0, Anypoint Code Builder configures a default deploy.json or deploy_ch2.json file in your src/main/resources directory. If you intend to configure properties at deployment time, for example, to create secure properties, Anypoint Code Builder prompts you to modify deploy.json or deploy_ch2.json during the deployment process.

For CloudHub 2.0 deployments, you must update your pom.xml file:

  • Modify groupId to match your Anypoint Platform business group (organization) ID.

    For more information, see Finding your Business Group ID.

  • Remove the -SNAPSHOT suffix from version.

  • Increment version when redeploying.

To deploy your app to CloudHub or CloudHub 2.0:

  1. Open any configuration XML file for the Mule app to deploy.

  2. Click the (Deploy to CloudHub) icon.

    Alternatively, open the Command Palette and select MuleSoft: Deploy to CloudHub.

  3. If prompted, click Allow to allow sign in using Anypoint Platform and select the business group.

  4. Select a Business Group to use for deployment.

  5. When prompted via the VSCode command palette, select the deployment target: CloudHub 2.0 or CloudHub 1.0.

    If you select CloudHub 2.0, you are prompted to select the space to deploy your application, for example: “myprivspace”.

    If the project doesn’t already have a deploy.json or deploy_ch2.json file, Anypoint Code Builder indicates that a deployment configuration file has been created and opens it for you to review, for example:

    Review deploy.json file

    For applications deployed to CloudHub 2.0, ensure that the deploy_ch2.json file contains the value for the deployment model. You can set this to the default value of rolling.

    The applicationName property defines part of the URL that you use to access your application on CloudHub.

    This name must be unique across all applications deployed to CloudHub.

  6. After reviewing the deployment configuration, click Deploy to deploy the application to CloudHub or CloudHub 2.0. The VSCode status bar shows the progress of the deployment.

  7. At the prompt, select the environment to deploy to.

    Anypoint Code Builder packages the application and deploys it to CloudHub or CloudHub 2.0. The Output panel opens with Mule Maven Output selected:

    Output panel with Mule Maven Output selected
  8. After deployment completes, click Open in Runtime Manager.

    Your app opens in Runtime Manager in Anypoint Platform.

    The domain name of the application varies, but it follows a similar structure such as: app-with-40-schedulers.us-w1.cloudhub.io.

  9. Open your preferred REST client and make a GET request to the domain name as displayed in Runtime Manager, for example, http://app-with-100-schedulers.us-w1.cloudhub.io/api/flights.

Change a Value in deploy.json

Use auto-complete to select a preconfigured value in deploy.json or deploy_ch2.json.

  1. Open deploy.json or deploy_ch2.json from the Explorer.

    The file is located in the project’s src/main/resources directory. The file opens to a deploy.json or deploy.json_ch2 tab in the IDE.

  2. In deploy.json or deploy_ch2.json, highlight the value to update.

  3. Press Ctrl+Space.

  4. Select a different value.

Deployment Properties

The deploy.json and deploy_ch2.json files contain the following properties for deployments of Mule applications to CloudHub and CloudHub 2.0, respectively, from Anypoint Code Builder.

Property Description Host

runtime

Provides the Mule runtime version used by the project.

CloudHub or CloudHub 2.0

workersize

Sets the worker memory relative to a single worker or a number of available workers. The default is 0.1. For more information, see CloudHub Workers in the CloudHub documentation.

CloudHub

replicaSize

Sets the replica specific amount of memory capacity and processing power. The default value is 0.1. For more information, see CloudHub 2.0 Replicas in the CloudHub 2.0 documentation.

CloudHub 2.0

applicationName

Provides the hyphenated, lowercase name of the Mule application.

CloudHub or CloudHub 2.0

workers

Sets the number of Mule runtime instances for running this Mule application. The default is 1. For more information, see CloudHub Workers in the CloudHub documentation.

CloudHub

replicas

Sets dedicated instances of Mule runtime engine for running this Mule application. The default is 1. For more information, see CloudHub 2.0 Replicas in the CloudHub 2.0 documentation.

CloudHub

autoStart

Indicates whether to start the application automatically after the deployment process completes. The default value is true.

CloudHub or CloudHub 2.0

deploymentModel

Indicates the model by which you want the replicas of your application to be updated or redeployed. The default value is rolling. For more information, see Rolling Update vs. Recreate Deployment Model in the CloudHub 2.0 documentation.

CloudHub 2.0

ObjectStoreV2

Indicates whether Object Store v2 is enabled for this application. The default value is true. For more information, see Object Store v2 Overview

CloudHub or CloudHub 2.0