Replacing Mule License Keys

When your Mule license expires, you must replace your Mule license key. Also use this procedure if you entered an incorrect license key during installation.

The steps to replace the license key depend on how Runtime Fabric was installed using rtfctl, Helm, or Red Hat OpenShift.

Perform the steps for your installation type in these sections. For rtfctl, perform the steps on the controller node used to start the installation. For Azure and AWS installations, this node is named rtf-controller-1 by default.

Prepare the License Key

All methods require the Mule .lic license file to be Base64 encoded. Encode the new license file provided by MuleSoft before applying it:

On MacOS, run this command in the terminal:

BASE64_ENCODED_LICENSE=$(base64 -b0 -i license.lic)

On Unix, run this command:

BASE64_ENCODED_LICENSE=$(base64 -w0 license.lic)

On Windows, choose one of the following:
- Use a WSL or Cygwin shell that includes the base64 tool and use the above Unix command.
- Use the base64.exe program included with Windows git (C:\Program Files\Git\usr\bin).
- Use the following Powershell command:
  $BASE64_ENCODED_LICENSE=[convert]::ToBase64String((Get-Content -path "license.lic" -Encoding byte))

Replace Using `rtfctl`

Use this method when Runtime Fabric was installed with rtfctl (VM, bare metal, or standard Kubernetes).

Prerequisites

The rtfctl utility is required. Follow the steps in Install RTFCTL before continuing.

Confirm that the rtfctl binary is present in the current working directory and in the user $PATH.

Run rtfctl commands as a privileged user.

Procedure

Use the rtfctl utility to apply the Base64 value of your license key. For more information on the rtfctl command, refer to RTFCTL commands.
```
rtfctl apply mule-license $BASE64_ENCODED_LICENSE
```
To verify the Mule license key has been applied correctly, retrieve the contents using the rtfctl utility:
```
rtfctl get mule-license
```

Replace Using Helm

Use this method when Runtime Fabric was installed with Helm.

Apply the license by running this command (ensure $BASE64_ENCODED_LICENSE is set from the Prepare the License Key section):

helm upgrade runtime-fabric rtf/rtf-agent --set muleLicense=$BASE64_ENCODED_LICENSE -n rtf --reuse-values --version <current-version>

Replace <current-version> with your current Runtime Fabric Helm chart version.

Replace on Red Hat OpenShift

Use this method when Runtime Fabric is installed on Red Hat OpenShift (operator-based installation).

You can apply the license either from the OpenShift console (by updating the Runtime Fabric instance custom resource) or using Helm. Ensure you have prepared the Base64-encoded license key as described in Prepare the License Key.

Apply the License Key from the OpenShift Console

To apply the license key from the OpenShift console, follow these steps:

Navigate to the Runtime Fabric operator.
Select the namespace in which the Runtime Fabric instance is installed.
Click on the Runtime Fabric tab.
Click on the runtime-fabric instance link.
Update the Runtime Fabric instance CR .yaml file by adding the muleLicense key with your Base64-encoded license value.

Apply the License Key Using Helm on OpenShift

To apply the license using Helm, run the following command (ensure $BASE64_ENCODED_LICENSE is set from the Prepare the License Key section):

helm upgrade runtime-fabric rtf/rtf-agent --set muleLicense=$BASE64_ENCODED_LICENSE -n rtf --reuse-values

Replace rtf with your Runtime Fabric namespace if different.

You need to restart your Runtime Fabric Mule apps for the new license to take effect.

Get License Expiry Date

The GET fabric API (/organizations/{organizationId}/fabrics/{id}) response includes an optional licenseExpiryDate field:

{
    "id": "fabric_id",
    "name": "anna-qa-gke-rtf-1",
    "region": "us-east-1",
    "vendor": "gke",
    "vendorMetadata": {},
    "organizationId": "organization_id",
    "version": "2.2.9",
    "status": "Active",
    "desiredVersion": "2.2.9",
    "availableUpgradeVersion": "2.2.29",
    "createdAt": 1679684859167,
    "secondsSinceHeartbeat": 192,
    "kubernetesVersion": "v1.24.11-gke.1000",
    "licenseExpiryDate": 1653523200000,
    "isManaged": false,
    "isHelmManaged": true,
    "clusterConfigurationLevel": "production",
    "features": {
        "enhancedSecurity": true,
        "persistentStore": false
    },
    "ingress": {
        "domains": []
    }
}

The Runtime Fabric Mule License Expiry Date is also exposed in the Runtime Manager UI, with a warning notification of License is expiring soon:

Runtime Manager UI with Mule License Expiry Date warning notification