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.
Before you get started, review Anypoint CLI prerequisites, installation, and authentication instructions.
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: |
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 |
---|---|---|
|
Artifact ID of the application retrieved from Exchange. |
|
|
ID of the deployment target. |
|
|
Name of the application to deploy. |
|
|
Runtime version of the deployment target. |
|
Besides the default --help
, -f
/--fields
and -o
/--output
options, this command also takes these options:
Value | Description | Example |
---|---|---|
|
Version of the Exchange application to use. |
|
|
Enables clustered nodes, which requires at least two replicas. |
|
|
Disables forwarding applications logs to Anypoint Monitoring. |
|
|
Enables SSL session forwarding. |
|
|
Group ID of the asset to deploy. |
|
|
Set the name of the JAVA version to be used for the selected Mule version. Supported values are |
|
|
Enables Last Mile Security. |
|
|
The amount of memory allocated to each replica of a Mule application or API gateway. |
|
|
Enables Object Store v2. |
|
|
Supplies the base path expected by the HTTP listener in your application. |
|
|
Sets a property. |
|
|
Replaces all properties with values from a selected file. |
|
|
Supplies endpoints to reach via the public internet. |
|
|
Set the name of the release channel to be used for the selected Mule version. Supported values are |
|
|
Number of replicas. Must be above |
|
|
Size of replicas in Vcores. |
|
|
The amount of vCPU guaranteed to the application and reserved for its use. |
|
|
Defines scope logging. |
|
|
Uploads a file to define scope logging. |
|
|
Updates the strategy used. |
|
|
The maximum amount of vCPU the application can use (the level to which it can burst). This is shared CPU on the worker node. |
|
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 |
---|---|---|
|
ID of the application retrieved from Exchange. |
|
|
Version of the Exchange application to use. |
|
|
Enables clustered nodes, which requires at least two replicas. |
|
|
Disables forwarding applications logs to Anypoint Monitoring. |
|
|
Enables SSL session forwarding. |
|
|
Group ID of the asset to deploy. |
|
|
Enables Last Mile Security. |
|
|
Enables object store v2. |
|
|
Supplies the base path expected by the HTTP listener in your application. |
|
|
Sets a property. |
|
|
Replaces all properties with values from a selected file. |
|
|
Supplies endpoints to reach via the public internet. |
|
|
Number of replicas. Must be above |
|
|
Size of replicas in Vcores. |
|
|
Runtime version of the deployment target. |
|
|
Defines scope logging. |
|
|
Uploads a file to define scope logging. |
|
|
Updates the strategy used. |
|
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.