Installing Runtime Fabric on Self-Managed Kubernetes

You can use the Runtime Fabric command line tool, rtfctl, to install Anypoint Runtime Fabric on an Amazon Elastic Kubernetes Service (Amazon EKS), Azure Kubernetes Service (AKS) or Google Kubernetes Engine (GKE) installation that you manage.

Before you Begin

Before installing Anypoint Runtime Fabric in a self-managed Kubernetes environment, ensure:

You have reviewed the architecture and requirements outlined in Runtime Fabric on Self-Managed Kubernetes
You have configured your network to support Runtime Fabric on Self-Managed Kubernetes
You have installed and configured your Kubernetes environment with:
- An EKS, AKS, or GKE Kubernetes environment. Other Kubernetes environments are not supported.
- A supported Kubernetes version
- An ingress controller to send external requests to applications.
You create your clusters using the latest Runtime Fabric agent version available. If you can’t do so, refer to How to Specify the RTF Agent Version in Upgrades.

If you want to use a local registry with Runtime Fabric, follow the installation instructions in Using a Local Registry with Runtime Fabric on Self-Managed Kubernetes. You must set up the local registry during installation.

Create a Runtime Fabric using Runtime Manager

To install Runtime Fabric on Self-Managed Kubernetes, first create a Runtime Fabric using Runtime Manager. This is required to obtain the activation data which is needed during installation.

From Anypoint Platform, select Runtime Manager.
Click Runtime Fabrics.
Click Create Runtime Fabric.
Enter the name of the new Runtime Fabric, then select one of the following options:
- Amazon Elastic Kubernetes Service
- Azure Kubernetes Service
- Google Kubernetes Engine
Click Next.
Click rtfctl.
Review the Support responsibility disclaimer, then if you agree click Accept.

Runtime Manager creates the Runtime Fabric and displays the Activation State page. This page displays the activation data used to install Runtime Fabric on a Kubernetes service. Copy this data to the clipboard for use in the next section.

Download the rtfctl Utility

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.

Download the rtfctl command-line utility:

rtfctl is supported on Windows, MacOS (Darwin), and Linux. Choose the appropriate method:

Windows

curl -L https://anypoint.mulesoft.com/runtimefabric/api/download/rtfctl-windows/latest -o rtfctl.exe

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
```

Install Runtime Fabric

After creating a Runtime Fabric in Runtime Manager and obtaining the activation data, install Runtime Fabric into your Kubernetes service using the rtfctl command-line utility.

If your Kubernetes configuration is not located in the \~/.kube/config directory, set the KUBECONFIG environment variable before running rtfctl:

export KUBECONFIG=<path-to-kubeconfig>

Validate that your Kubernetes environment is read for installation:
```
rtfctl validate <activation_data>
```
The validate option verifies that:
- The Kubernetes environment is running.
- All required components exist.
- All required services are available.
  
  The rtfctl command-line utility outputs any incompatibilities with the Kubernetes environment.
Install Runtime Fabric:
```
rtfctl install <activation_data>
```
<activation_data> is the activation data obtained after creating the Runtime Fabric using Runtime Manager. During installation, the rtfctl utility displays any errors encountered.

Insert the Mule License Key

The procedures in the section must be performed by an IT administrator.

After the installation has completed succesfully, insert the Mule license key.

Base64 encode the new Mule .lic license file provided by MuleSoft:
- On MacOS, run the following command:
  BASE64_ENCODED_LICENSE=$(base64 -b0 license.lic)
- On Unix, run the following 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))
On the controller node acting as the leader during installation (the installer node), use the rtfctl utility with the Base64 value of your license key:
```
rtfctl apply mule-license $BASE64_ENCODED_LICENSE
```
To verify the Mule license key has applied correctly, run:
```
rtfctl get mule-license
```

Configure the Ingress Resource Template

The procedures in this section should be performed by an IT administrator.

If your ingress controller requires custom annotations and ingress class definition, follow the instructions in Defining a Custom Ingress Configuration.

For GKE customers, the ingress controller included with GKE will provision a separate HTTP load balancer per application by default. Please read this KB article for more details.

Validate Your Runtime Fabric