Contact Us 1-800-596-4880

Deploying Mule Apps to Runtime Fabric Using Anypoint CLI

Use these Anypoint Platform CLI commands for deploying and managing applications in Runtime Fabric. The CLI supports both the interactive shell and standard CLI modes.

Runtime Fabric currently supports only Anypoint CLI version 3.x.

Starting with Mule 4.5, MuleSoft introduces two new release channels, Edge and Long-term Support (LTS). The Mule runtime versioning schema for the new release channels is:

Major[numeric] . Minor[numeric] . Patch[numeric] : Build[numeric] Channel[e for edge, nothing for LTS]

Some examples of these values are: 4.5.0:1e for Edge, and 4.6.0:1 for LTS.

Command Description

Deletes an application

Deploys an application to a specified target using an Exchange application and runs the specified runtime version

Describes an application

Describes an application in a raw JSON response

Downloads logs of an application from a specification to a specified directory

Lists all applications in an organization

Modifies a deployed application

Starts a stopped application

Stops running an application

Tails an application’s logs from a specification

runtime-mgr application delete

> runtime-mgr application delete [options] <appID>

Deletes the running application specified in <appID>. To get this ID, run the runtime-mgr application list command.

This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation.

This command accepts only the default options: --help, -f/--fields and -o/--output

runtime-mgr application deploy

> runtime-mgr application deploy [options] <appID> <deploymentTargetID> <runtimeVersion> <artifactID>

Deploys the application specified in <appID> to the deployment target specified using the following options:

Value Description Example

ArtifactId

Artifact ID of the application retrieved from Exchange.

mule-test-plugin

deploymentTargetID

ID of the deployment target.
You can get this ID directly from Runtime Manager.

app.runetime

name

Name of the application to deploy.

testCloudhub2app

runtimeVersion

Runtime version of the deployment target.

1.0.1

Besides the default --help, -f/--fields and -o/--output options, this command also takes these options:

Value Description Example

assetVersion

Version of the Exchange application to use.
Default: latest application version

2.0.4

clustered

Enables clustered nodes, which requires at least two replicas.
Default:.disabled
Supported values: true, false

false

disableAmLogForwarding

Disables forwarding applications logs to Anypoint Monitoring.
Default: enabled
Supported values: true, false

true

forwardSslSession

Enables SSL session forwarding.
Default: disabled
Values: true, false

false

groupID

Group ID of the asset to deploy.
Default: selected organization ID

org.mule.test

javaVersion

Set the name of the JAVA version to be used for the selected Mule version. Supported values are 8 and 17. If you do not specify a value, Runtime Fabric imposes the default value. The default JAVA version for Mule 4.6 and earlier versions is '8'. If you don’t specify a Mule version, the default Mule version for the selected JAVA version is used. If the JAVA version you select is not available for the specified Mule version, you get an error.

8

lastMileSecurity

Enables Last Mile Security.
Default: disabled
Supported values: true, false

true

memory

The amount of memory allocated to each replica of a Mule application or API gateway.

0.7

objectStoreV2

Enables Object Store v2.
Default: disabled
Supported values: true, false

true

pathRewrite

Supplies the base path expected by the HTTP listener in your application.
Format: must begin with /

/http://localhost:3000

property

Sets a property.
Format: name:value

testproperty:true

propertiesFile

Replaces all properties with values from a selected file.
Format: one or more lines in name: value style

/Users/mule/Documents/properties.txt

publicEndpoints

Supplies endpoints to reach via the public internet.
Format: separated by commas, no spaces

my-superapp-example:/status?limit=10

releaseChannel

Set the name of the release channel to be used for the selected Mule version. Supported values are NONE, EDGE, and LTS. If you do not specify a value, Runtime Fabric imposes the default value. The default release channel is EDGE. If you don’t specify a Mule version, the default Mule version for the selected release channel is used. If the selected release channel doesn’t exist, you get an error.

EDGE

replicas

Number of replicas. Must be above 0.
Default: 1

2

replicaSize

Size of replicas in Vcores.
Default: 0.1

0.5

reservedCPU

The amount of vCPU guaranteed to the application and reserved for its use.

0.02

scopeLoggingConfig

Defines scope logging.
Format: scopeName: logLevel, separated by commas, no spaces

testscope1:WARN,testscope2:DEBUG

scopeLoggingConfigFile

Uploads a file to define scope logging.
Format: one tupple per line, style: {scope: scopeName, logLevel: logLevelType} enclosed with {} () or []

/Users/mule/Documents/cert.txt

updateStrategy

Updates the strategy used.
Default: rolling

recreate

vCPULimit

The maximum amount of vCPU the application can use (the level to which it can burst). This is shared CPU on the worker node.

3.9

runtime-mgr application describe

> runtime-mgr application describe [options] <appID>

Displays information about the application specified in <appID>. To get this ID, run the runtime-mgr application list command.

This command accepts only the default options: --help, -f/--fields and -o/--output

runtime-mgr application describe-json

> runtime-mgr application describe-json [options] <appID>

Displays a raw JSON response from the application specified in <appID>. To get this ID, run the runtime-mgr application list command.

This command accepts only the default options: --help, -f/--fields and -o/--output

runtime-mgr application download-logs

> runtime-mgr application download-logs [options] <appID> <directory> <specID>

Downloads logs for the application specified in <appID> from the specification specified in <specID> to the selected directory.

To get the <appID>, run the runtime-mgr application list command.

To get the <specID> run the runtime-mgr application describe command.

This command accepts only the default options: --help, -f/--fields and -o/--output

runtime-mgr application list

> runtime-mgr application list [options]

Lists all applications in your organization.

This command accepts only the default options: --help, -f/--fields and -o/--output

runtime-mgr application modify

> runtime-mgr application modify [options] <appID> <certificateName>

Updates the settings of an existing application specified in <appID>. To get the <appID>, run the runtime-mgr application list command.

Besides the default --help, -f/--fields and -o/--output options, this command also takes these options:

Value Description Example

ArtifactId

ID of the application retrieved from Exchange.

mule-maven-plugin

assetVersion

Version of the Exchange application to use.
Default: latest application version

2.0.4

clustered

Enables clustered nodes, which requires at least two replicas.
Default: disabled
Supported values: true, false

false

disableAmLogForwarding

Disables forwarding applications logs to Anypoint Monitoring.
Default: enabled
Supported values: true, false

true

forwardSslSession

Enables SSL session forwarding.
Default: disabled
Values: true, false

false

groupID

Group ID of the asset to deploy.
Default: selected organization ID.

org.mule.testgroup

lastMileSecurity

Enables Last Mile Security.
Default: disabled
Supported values: true, false

true

objectStoreV2

Enables object store v2.
Default: disabled
Supported values: true, false

true

pathRewrite

Supplies the base path expected by the HTTP listener in your application.
Format: must begin with /

/http://localhost:3000.

property

Sets a property.
Format: name:value

testproperty:true

propertiesFile

Replaces all properties with values from a selected file.
Format: one or more lines in name: value style

/Users/mule/Documents/properties.txt

publicEndpoints

Supplies endpoints to reach via the public internet.
Format: separated by commas, no spaces

my-superapp-example: /status?limit=10

replicas

Number of replicas. Must be above 0.
Default: 1

2

replicaSize

Size of replicas in Vcores.
Default: 0.1

0.5

runtimeVersion

Runtime version of the deployment target.

1.0.1

scopeLoggingConfig

Defines scope logging.
Format: scopeName: logLevel, separated by commas, no spaces

testscope1:WARN,testscope2:DEBUG

scopeLoggingConfigFile

Uploads a file to define scope logging.
Format: 1 tupple per line, style: {scope: scopeName, logLevel: logLevelType} enclosed with {} () or []

/Users/mule/Documents/cert.txt

updateStrategy

Updates the strategy used.
Default: rolling

recreate

runtime-mgr application start

> runtime-mgr application start [options] <appid>

Starts running the application specified in <appid>. To get this ID, run the runtime-mgr application list command.

This command accepts only the default option --help.

runtime-mgr application stop

> runtime-mgr application stop [options] <appID>

Stops running the application specified in <appID>. To get this ID, run the runtime-mgr application list command.

This command accepts only the default option --help.

runtime-mgr application tail-logs

> runtime-mgr:application:tail-logs [options] <appID> <specID>

Tails application logs for the application specificied in <appID> from the specification specified in <specID>.

To get the <appID>, run the runtime-mgr application list command.

To get the <specID> run the runtime-mgr application describe command.

This command accepts only the default option --help.

runtime-mgr rtf list

> runtime-mgr rtf list [options]

This command lists available Runtime Fabric instances.

This command accepts only the default options: --help, -f/--fields and -o/--output.

For information about managing your Runtime Fabric instances using the command line, see Supported rtfctl Commands.