Contact Us 1-800-596-4880
  1. Homepage
  2. Anypoint Platform Private Cloud Edition (4.3)
  3. Deploying Mule Applications to Anypoint Platform PCE

  4. Deploying Mule Applications Using Anypoint Code Builder

Deploying Mule Applications Using Anypoint Code Builder

Follow these steps to develop, package, and deploy Mule applications to Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) using Anypoint Code Builder in VS Code. You can complete this workflow without MuleSoft Vibes by following the standard Anypoint Code Builder documentation. MuleSoft Vibes is optional.

  1. Connect Anypoint Platform PCE with Anypoint Code Builder

  2. Develop Mule Application

  3. Package and Export the Mule Application

  4. Deploy to Runtime Manager

  5. Publish to Exchange

  6. Validate the Deployment

Connect Anypoint Platform PCE with Anypoint Code Builder

To connect Anypoint Platform PCE with Anypoint Code Builder, follow the instructions in Configuring Anypoint Code Builder for Anypoint Platform PCE.

Private cloud mode connects Anypoint Code Builder on your machine to the Anypoint Platform PCE control plane. Sign-in uses OAuth or OIDC with the identity provider hosted by Anypoint Platform PCE. Anypoint Code Builder keeps application metadata in your network and blocks standard cloud telemetry.

Develop Mule Application

Build the Mule application in VS Code with Anypoint Code Builder. You can create the specification, the flow, DataWeave transformations, and security configuration without MuleSoft Vibes. Follow the standard Anypoint Code Builder documentation:

MuleSoft Vibes is optional. If you use it, Vibes skills can generate the specification, the flow, DataWeave transformations, and security configuration.

These skills are available in the skill pack:

  • build-mule-integration generates integration flows, configures endpoints, and scaffolds orchestration.

  • secure-mule-app scans the configuration for security risks, applies encryption, and suggests logging.

  • DataWeave skills generate transformations and map payload schemas.

You can add organization-specific skills that enforce naming conventions, header standards, and logging policies. Package those skills in a repository and use them with Anypoint Code Builder.

  1. In VS Code, open the Command Palette and run MuleSoft: Design an API to create the API specification. Anypoint Code Builder validates the specification locally.

  2. To mock the API on your machine, use the API Console.

  3. Run MuleSoft: Implement an API Specification to stub the interface and connect the services.

  4. To create a project from the canvas instead, select the Anypoint Code Builder icon in the primary side bar, select Develop an Integration, and create a Mule project.

  5. To import an asset from Exchange, run MuleSoft: Import Asset From Exchange. Select the asset type and add it to the project.

  6. Develop the flow, DataWeave transformations, and security configuration in Anypoint Code Builder. If you use MuleSoft Vibes, you can use natural language prompts for flow logic, DataWeave mappings, and the secure-mule-app skill.

  7. Create and run MUnit tests in the project before you package the application.

  8. Run a local debug session from the Run and Debug sidebar to test the logic before packaging.

Anypoint Code Builder in VS Code, with the command palette open to MuleSoft: Login to Anypoint Platform, a Mule flow on the canvas, and the local runtime in the terminal

Package and Export the Mule Application

Manually create the deployable Mule application artifact:

  1. In the VS Code Explorer, right-click your mule-artifact.json file or any XML file in src/main/mule.

  2. Select MuleSoft: Export Mule Project.

  3. Choose Deployable JAR and select Include project sources.

    Including project sources enables you to re-import the project later if needed.

  4. Save the JAR to your local machine.

Deploy to Runtime Manager

Upload the JAR to your hybrid server. The server must be registered and in the Running state.

  1. Log in to Anypoint Platform PCE and navigate to Runtime Manager.

  2. Select the correct environment, and then click Deploy Application.

  3. Set the Deployment Target to your hybrid server or cluster.

  4. Click Choose File > Upload File and select the JAR you exported.

  5. Click Deploy Application.

After the application status is Started, apply API Manager policies to the endpoints. Use API Manager in Anypoint Platform PCE, or the Anypoint CLI API Manager plugin from Configuring Anypoint Code Builder for Anypoint Platform PCE.

Publish to Exchange

Publishing an asset directly from Anypoint Code Builder to Exchange in Anypoint Platform PCE has partial support. Publish the deployable JAR from Exchange in Anypoint Platform PCE:

  1. In Anypoint Platform PCE, navigate to Exchange.

  2. Click Publish New Asset.

  3. Provide an asset name and select Mule Application as the asset type.

  4. Upload the same JAR file.

    This publishes the project to your organization’s private library.

Validate the Deployment

To validate the deployment, follow these steps:

  1. In Runtime Manager, wait until the application status is Started.

  2. Use an API client such as Postman or the VS Code Thunder Client to send a request to the server IP and the port defined in your HTTP Listener.

    For example: http://10.x.x.x:8081/api/test

  3. Check the Logs tab in Runtime Manager to verify that the request was processed successfully.

See Also