How to install Anypoint Flex Gateway in local mode as a Linux service

Tutorials
How to install Anypoint Flex Gateway in local mode as a Linux service

10 min read

This tutorial was updated in October 2022 and is based on Flex Gateway 1.2.0.

You can use Flex Gateway locally or in connected mode. If you use it locally, you will only be able to run it from your local machine, but you can’t manage the APIs from Anypoint Platform. In connected mode, you can view your gateways, your API instances, and policy configurations in API Manager. In this case, we’ll register and run Flex Gateway in local mode using Flex Gateway as a Linux service.

In this tutorial, you’ll learn how to:

Install the Flex Gateway Linux service
Register the gateway in local mode
Start the gateway
Remove the gateway

Prerequisites

Anypoint Platform - We’ll need an Anypoint Platform account to create a new flex gateway. Even though you’re installing Flex Gateway in local mode, you will need some information from your account. You can sign up for a free trial account here.
Flex Gateway permissions - You shouldn’t need to assign any specific permissions to follow this tutorial when using a new free trial account. However, if you experience permission issues, please see Flex Gateway prerequisites.
Linux - Make sure you’re using one of the Linux distributions supported by Flex Gateway. See Software Requirements for Linux Deployments for a complete list. You can confirm this by running lsb_release --all.
Linux packages - The following packages need to be installed in your system before running the tutorial. You can install them with the following command:
sudo apt install curl gnupg2 lsb-release systemd
- curl - A command line tool needed to install Flex Gateway in Linux.
- gnupg2 - A free implementation of the OpenPGP standard to encrypt and sign data.
- lsb-release - The command lsb_release is used to print distribution information.
- systemd - The command systemctl is used to start/stop the Flex Gateway service.
(Optional) Overview and introduction - If you want to first see an overview and introduction to Flex Gateway without a technical how-to, see this tutorial.

Set up Flex Gateway in Runtime Manager

1 - Log in to Anypoint Platform and navigate to Runtime Manager. Click on the Flex Gateways tab on the left and select Add Gateway.

If this is the first time you access Anypoint Platform, it may ask you to select an environment. Choose Sandbox.

2 - You will see different options to select where to set up your Flex Gateway. Let’s select Linux.

Install Flex Gateway in Linux

1 - To retrieve the public package keys, add the package repository, update the package list, and install the package, run the following commands.

1
2
3
4
5
curl -XGET https://flex-packages.anypoint.mulesoft.com/ubuntu/pubkey.gpg | sudo apt-key add -
echo "deb https://flex-packages.anypoint.mulesoft.com/ubuntu $(lsb_release -cs) main" \
  | sudo tee /etc/apt/sources.list.d/mulesoft.list
sudo apt update
sudo apt install -y flex-gateway

Make sure the commands were successful and no errors were received.

2 - Verify the package was correctly installed by running the following command.

Command:

1
flexctl help

Output:

1
2
3
4
5
6
7
8
Usage:
  flexctl [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  dump        Retrieve all gateway configuration
  help        Help about any command
...

Register the gateway in local mode

1 - Copy the command from Runtime Manager to register your gateway. It already contains the token and organization ID you need to authenticate and connect the gateway with your Anypoint Platform account.

This command is using Auth Token as the authentication mechanism for registering the gateway. You can also choose to connect it using a Connected App or your Anypoint Platform Username and Password.

1
2
3
4
sudo flexctl register <gateway-name> \
--token=<your-token> \
--organization=<your-org-id> \
--output-directory=/usr/local/share/mulesoft/flex-gateway/conf.d

2 - Replace <gateway-name> with your own name (i.e. my-gateway).

3 - Remove the --connected=true parameter or change it to --connected=false to run in local mode instead of connected mode.

It’s better to run this command in a new folder or in a known location to quickly identify the files that will be created.

If you are in the Europe region, you will need to add the following flag to your command
--anypoint-url=https://eu1.anypoint.mulesoft.com

Your final command after substituting the values will look like this:

Command:

1
2
3
4
sudo flexctl register my-gateway \
  --token=35e1aa50-f2bb-453b-9dcf-cddfd7543e8d \
  --organization=371a3df1-1566-4775-b26d-932a04f9ce05 \
  --output-directory=/usr/local/share/mulesoft/flex-gateway/conf.d

Output:

1
2
Starting registration, please be patient.
Registration completed, the configuration files were written in directory "/usr/local/share/mulesoft/flex-gateway/conf.d". For security, modify the file permissions to restrict production scenario access to the user running flex.

4 - Verify there is a registration.yaml file in /usr/local/share/mulesoft/flex-gateway/conf.d.

Start the gateway

1 - Run the following command to start the Flex Gateway service.

1
sudo systemctl start flex-gateway

2 - Verify that the service is running in your local with the following command.

Command:

1
systemctl list-units flex-gateway*

Output:

1
2
3
4
5
6
7
8
9
10
11
12
UNIT                        LOAD   ACTIVE SUB     DESCRIPTION                
flex-gateway-agent.service  loaded active running flex-gateway-agent.service 
flex-gateway-envoy.service  loaded active running flex-gateway-envoy.service 
flex-gateway-fluent.service loaded active running flex-gateway-fluent.service
flex-gateway.service        loaded active exited  Application                

LOAD   = Reflects whether the unit definition was properly loaded.
ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
SUB    = The low-level unit activation state, values depend on unit type.

4 loaded units listed. Pass --all to see loaded but inactive units, too.
To show all installed unit files use 'systemctl list-unit-files'.

Remove a gateway

1 - To stop the gateway, you can run the following command.

1
sudo systemctl stop flex-gateway

2 - Verify that the service is no longer running in your local with the following command.

Command:

1
systemctl list-units flex-gateway*

Output:

1
2
3
4
5
6
7
8
9
  UNIT                       LOAD   ACTIVE SUB    DESCRIPTION               
● flex-gateway-agent.service loaded failed failed flex-gateway-agent.service

LOAD   = Reflects whether the unit definition was properly loaded.
ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
SUB    = The low-level unit activation state, values depend on unit type.

1 loaded units listed. Pass --all to see loaded but inactive units, too.
To show all installed unit files use 'systemctl list-unit-files'.