deploy(Mule)

The deploy operation deploys a Mule Application. It should be used in deploy workflows.

Properties Management

It is always recommended to externalize any configuration parameters (user names, passwords, URLs etc.). Instead of hard-coding these values inside application code, we recommend creating a properties file for your mule application. Please follow these steps to achieve property replacement in FlexDeploy.


1. Create a properties file in your Mule application (eg: orderapi.properties)
2. Place values for all the properties for Anypoint Studio local testing. 
3. Use these property keys in your Mule Application instead of hard-coding (eg: ${DB_USERNAME})
4. In FlexDeploy create these properties in your Workflow with the MULE_ prefix (eg: MULE_DB_USERNAME)
5. Provide values to these properties on the Environment Instance page.
6. Specify the Property file name in the Project Properties page (Property File Name to Create)
7. FlexDeploy replaces/creates the property file with the values for the environment it is deploying to.


Deploy operation is compatible with the following types of servers:

FDMULE_TYPENotes Specific to the Mule Type
CloudHub
Anypoint Runtime Manager
Runtime Agent
Standalone

This operation runs on the Mule server endpoint(s).

In order to deploy an application to an entire cluster, set up multiple instances or endpoints.

The deployment will be run on all of them so the application will be deployed to all of the cluster members.

  

Environment/Instance Properties

Property Name

Property Code

Required for which Mule Type

Description

Mule Home

FDMULE_HOMEStandalone

Path to the Mule Standalone Install

Anypoint UsernameFDMULE_USERCloudHub, Anypoint Runtime ManagerAnypoint Platform Username
Anypoint PasswordFDMULE_PASSWORDCloudHub, Anypoint Runtime ManagerAnypoint Platform Password
Mule TypeFDMULE_TYPEAll

The type Mule server that this environment includes.

(CloudHub, Anypoint Runtime Manager, Runtime Agent, Standalone)

Organization NameFDMULE_ORG_NAMECloudHub, Anypoint Runtime ManagerMule Organization Name
Environment NameFDMULE_ENV_NAMECloudHub, Anypoint Runtime Manager

Mule Environment Name

Defaults to $FD_ENVIRONMENT_CODE

Timeout in MillisecondsFDMULE_TIMEOUTNone

Timeout for deployment and utility operations such as start and stop application.

Defaults to 600000 which is 10 minutes.

Anypoint URLFDMULE_ANYPOINT_URLCloudHub, Anypoint Runtime Manager

The URL of Anypoint Runtime Manager

Defaults to https://anypoint.mulesoft.com

Runtime Agent URLFDMULE_AGENT_URLRuntime AgentThe URL of Runtime Agent
Mule Region CodeFDMULE_REGIONNone. Used for CloudHub, but optional.Region Code for Mule

  

Project Properties

Property Name

Property Code

Required for which Mule Type

Description

Mule Application Name

FDMULE_APP_NAME

All

Name of the Mule Application to stop

Target Server TypeFDMULE_TARGET_TYPEAnypoint Runtime Manager

Mule Target Server Type

(Server, Cluster, ServerGroup)

If necessary, this property can be overridden at the property/environment/instance level.

Target NameFDMULE_TARGET_NAMEAnypoint Runtime Manager

Name for the Target Server, Cluster or Group

If necessary, this property can be overridden at the project/environment/instance level.

Static IP AddressFDMULE_STATIC_IPADDRESSNone. Used for CloudHub, but optional

Static IP Address for the Application

If necessary, this property can be overridden at the project/environment/instance level.

FDMULE_WORKERS_COUNTNone. Used for CloudHub, but optional.Workers Count
FDMULE_WORKER_TYPENone. Used for CloudHub, but optional.

Type of the Worker Size

(Micro,Small,Medium,Large,xLarge,xxLarge)

Defaults to Small

FDMULE_PERSISTENT_QUEUESNone. Used for CloudHub, but optional.

Enable Persistent Queues

Defaults to false

FDMULE_PROPERTY_FILENone. Used for CloudHub, but optional.Name of the property file to create with Mule Properties
FDMULE_AUTO_STARTNone. Used for CloudHub, but optional.Defaults to true
FDMULE_MONITORING_ENABLEDNone. Used for CloudHub, but optional.Defaults to true

  

Inputs

Input Name

Input Code

Required

Description





  

Outputs

Output Name

Required

Description




  

Artifacts

This operation consumes Mule Application and Domain artifacts from the artifacts repository.

  

Endpoint Selection

This operation will select all available endpoints associated to the environment/instance.

  

Endpoint Execution

This operation will execute on all of the selected endpoints.