curl -L https://anypoint.mulesoft.com/runtimefabric/api/download/rtfctl-windows/latest -o rtfctl.exe
Install the Runtime Fabric Command Line Tool
Install and use the rtfctl
utility to locally manage Runtime Fabrics. The rtfctl
utility supports the following actions:
-
Get the status of a Runtime Fabric.
-
Perform a heap dump or a thread dump of a running application.
-
Display memory usage of a running application.
-
Manage proxy settings.
-
Manage secure properties.
-
Manage a Mule license.
-
Manage the alert sender email address.
Install rtfctl
The tasks in the section must be performed by an IT administrator. |
Runtime Fabric on Self-Managed Kubernetes uses the rtfctl
command-line utility for installation and management tasks. See Install the Runtime Fabric Command Line Tool.
For Runtime Fabric on Self-managed Kubernetes:
-
Download the
rtfctl
command-line utility:rtfctl
is supported on Windows, MacOS (Darwin), and Linux. Download this utility using the URLs below:Windows:
MacOS (Darwin):
curl -L https://anypoint.mulesoft.com/runtimefabric/api/download/rtfctl-darwin/latest -o rtfctl
Linux:
curl -L https://anypoint.mulesoft.com/runtimefabric/api/download/rtfctl/latest -o rtfctl
-
Change file permissions for the
rtfctl
command-line utility:sudo chmod +x rtfctl
For Runtime Fabric on appliance:
-
Download the
rtfctl
command-line utility:rtfctl
is supported on Windows, MacOS (Darwin), and Linux. Download this utility using the URLs below:Windows:
curl -L https://anypoint.mulesoft.com/runtimefabric/api/download/rtfctl-appliance-windows/latest -o rtfctl.exe
MacOS (Darwin):
curl -L https://anypoint.mulesoft.com/runtimefabric/api/download/rtfctl-appliance-darwin/latest -o rtfctl
Linux:
curl -L https://anypoint.mulesoft.com/runtimefabric/api/download/rtfctl-appliance/latest -o rtfctl
-
Change file permissions for the
rtfctl
command-line utility:sudo chmod +x rtfctl
Supported Commands
Command | Description |
---|---|
appliance |
Specifies an appliance on which to perform operations. |
apply |
Applies changes to a Runtime Fabric configuration. |
backup |
Backs up the local Runtime Fabric state. |
disk |
Displays the disk space used by an application. |
get |
Displays one or more resources. |
heapdump |
Triggers a JVM heap dump. |
help |
Displays help for a command. |
memory |
Displays the JVM memory usage in a pod. |
package |
Creates a debugging information package for an application. |
ping |
Tests network connectivity. |
report |
Generates a diagnostics report. |
restart |
Restarts an application. |
restore |
Restores the local Runtime Fabric state from a backup. |
status |
Displays status of Runtime Fabric. |
test |
Tests Runtime Fabric environment. |
threaddump |
Displays the JVM thread dump for an application. |
uninstall |
Uninstall Runtime Fabric. |
update |
Updates |
upgrade-cluster |
Upgrades the Runtime Fabric cluster. |
validate |
Validate cluster for Runtime Fabric installation. |
version |
Displays version information. |
Flag | Description |
---|---|
-h, --help |
Displays |
-n, --namespace string |
If present, displays the namespace scope. |
--pod string |
If present, displays the pod name. |
Usage
-
To list all supported commands, run
rtfctl -h
. -
For more information about a specific command, run
rtfctl <command> -h
.
Install a Mule license:
-
Make sure to base64 encode the license, following the instructions in Base64 Encode your Mule License Key.
-
Run the following command:
$ sudo ./rtfctl apply mule-license '<license-key-information>' Updating rtf namespace... OK