How to install Anypoint Flex Gateway in local mode as a Docker container

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

You can use Flex Gateway in a local or 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 tutorial, we will register and run Flex Gateway in local mode using the Flex Gateway Docker image.

In this tutorial, you’ll learn how to:

• Install the Flex Gateway Docker image on your local computer
• 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.
• Docker - We’ll need to install Docker to download, install, and run the Flex Gateway image on our local machine. You can download Docker Desktop here.
• (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 Docker.

Install the Flex Gateway Docker image

1 - Download the Flex Gateway Docker image by running the following command. We will be using the latest version in this tutorial.

1
docker pull mulesoft/flex-gateway:latest

2 - Verify the image was correctly installed by running docker images or checking your images from the Docker Desktop app. You should see the new mulesoft/flex-gateway image.

Command-line output:

1
2
REPOSITORY              TAG       IMAGE ID       CREATED      SIZE
mulesoft/flex-gateway   latest    4ba042860c8f   7 days ago   273MB

Docker Desktop preview:

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. Even though you will not be using Anypoint Platform to manage your APIs, the gateway still needs to be linked to an organization.

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
5
6
7
8
docker run --entrypoint flexctl \
-v "$(pwd)":/registration mulesoft/flex-gateway \
register \
--organization=<your-org-id> \
--token=<your-token> \
--output-directory=/registration \
--connected=true \
<gateway-name>

If you’re running this command in MacOS, Linux, or a Unix-based command line, it’s ok to run it as-is. If you’re running the command from a Windows computer, you will need to change the "$(pwd)" part with the absolute path to your current directory.

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

3 - Remove the version from the flex-gateway image to use the one you previously downloaded.

4 - 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
5
6
7
docker run --entrypoint flexctl \
-v "$(pwd)":/registration mulesoft/flex-gateway \
register \
--organization=e04b331c-a0d3-4b0b-b40c-55254205c981 \
--token=4c3fa08c-5d08-431f-ba9a-cb4416db7dc7 \
--output-directory=/registration \
my-gateway

Output:

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

5 - Verify there is a registration.yaml file in the same directory you executed the command.

Start the gateway

1 - Run the following command to start your gateway using port 8081.

1
2
3
4
docker run --rm \
-v "$(pwd)":/usr/local/share/mulesoft/flex-gateway/conf.d \
-p 8081:8081 \
mulesoft/flex-gateway

You should see an output similar to the following. Note that the command doesn’t finish running. If you kill the process from your local, your gateway will be disconnected.

1
2
3
4
5
6
7
8
...
[flex-gateway-agent][info] Validating gateway
[flex-gateway-agent][info] Generating config
[flex-gateway-agent][info] Gateway default/9fd77888f949: Adding Service default/internal-pe-anypoint-metrics http://127.0.0.1:15100/
[flex-gateway-agent][info] Writing envoy bootstrap configuration to /tmp/envoy.json
[flex-gateway-agent][info] Gateway: Platform=https://anypoint.mulesoft.com OrgID=e04b331c-a0d3-4b0b-b40c-55254205c981 EnvID=36df410e-a800-44ab-be86-853820d277b2 Name=3952d507-3044-4a28-be97-1d89c5d97418 Mode=connected ReplicaName=9fd77888f949.default
[flex-gateway-envoy][info] cds: add 1 cluster(s), remove 3 cluster(s)
[flex-gateway-envoy][info] cds: added/updated 1 cluster(s), skipped 0 unmodified cluster(s)

2 - You can verify that the container is running in your local with docker container ls in a new command line, or check if there’s a running container in Docker Desktop.

Command-line output:

1
2
CONTAINER ID  IMAGE                   COMMAND   CREATED         STATUS         PORTS                    NAMES
2d55079f848e  mulesoft/flex-gateway   "/init"   6 minutes ago   Up 6 minutes   0.0.0.0:8081->8081/tcp   stupefied_kalam

Docker Desktop preview:

Remove the gateway

1 - To remove the gateway, you can stop running the docker run command and this will remove the container. Alternatively, you can run docker container stop <container-name> (i.e., docker container stop stupefied_kalam) or stop the container from Docker Desktop by clicking on the Stop button on the right side of the container.

2 - You can verify no containers are running with docker container ls or in Docker Desktop.

Command-line output:

1
CONTAINER ID   IMAGE     COMMAND   CREATED   STATUS    PORTS     NAMES

Docker Desktop preview:

Next Steps

In this tutorial, you learned how to:

• Install the Flex Gateway Docker image on your local computer
• Register the gateway in local mode
• Start the gateway
• Remove the gateway

In the next tutorial, you’ll learn how to manage your APIs locally with a configuration file using the Flex Gateway you created in this tutorial.

Click on the Next button below to continue to the next tutorial.

Previous Next