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 to create 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_TYPE	Notes 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_HOME`	Standalone	Path to the Mule Standalone Install
Anypoint Username	`FDMULE_USER`	CloudHub, Anypoint Runtime Manager	Anypoint Platform Username
Anypoint Password	`FDMULE_PASSWORD`	CloudHub, Anypoint Runtime Manager	Anypoint Platform Password
Mule Type	`FDMULE_TYPE`	All	The type Mule server that this environment includes. (CloudHub, Anypoint Runtime Manager, Runtime Agent, Standalone)
Organization Name	`FDMULE_ORG_NAME`	CloudHub, Anypoint Runtime Manager	Mule Organization Name
Environment Name	`FDMULE_ENV_NAME`	CloudHub, Anypoint Runtime Manager	Mule Environment Name Defaults to `$FD_ENVIRONMENT_CODE`
Timeout in Milliseconds	`FDMULE_TIMEOUT`	None	Timeout for deployment and utility operations such as start and stop application. Defaults to 600000 which is 10 minutes.
Anypoint URL	`FDMULE_ANYPOINT_URL`	CloudHub, Anypoint Runtime Manager	The URL of Anypoint Runtime Manager Defaults to https://anypoint.mulesoft.com
Runtime Agent URL	`FDMULE_AGENT_URL`	Runtime Agent	The URL of Runtime Agent
Mule Region Code	`FDMULE_REGION`	None. 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 Type	`FDMULE_TARGET_TYPE`	Anypoint Runtime Manager	Mule Target Server Type (Server, Cluster, ServerGroup) If necessary, this property can be overridden at the property/environment/instance level.
Target Name	`FDMULE_TARGET_NAME`	Anypoint 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 Address	`FDMULE_STATIC_IPADDRESS`	None. Used for CloudHub, but optional	Static IP Address for the Application If necessary, this property can be overridden at the project/environment/instance level.
Number of Workers	`FDMULE_WORKERS_COUNT`	None. Used for CloudHub, but optional.	Workers Count
Worker Size Type	`FDMULE_WORKER_TYPE`	None. Used for CloudHub, but optional.	Type of the Worker Size (Micro,Small,Medium,Large,xLarge,xxLarge) Defaults to Small
Persistent Queues	`FDMULE_PERSISTENT_QUEUES`	None. Used for CloudHub, but optional.	Enable Persistent Queues Defaults to false
Static IP Address	`FDMULE_STATIC_IPADDRESS`	None. Used for CloudHub, but optional.	Static IP Address for the Application
Property File Name to Create	`FDMULE_PROPERTY_FILE`	None. Used for CloudHub, but optional.	Name of the property file to create with Mule Properties
Auto Start	`FDMULE_AUTO_START`	None. Used for CloudHub, but optional.	Defaults to true
Enable Monitoring	`FDMULE_MONITORING_ENABLED`	None. 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.