Cloud Foundry logo in white on a blue background
blog single gear

TCP Routing comes to Cloud Foundry

It was announced on the cf-dev mailing list and demo’d in CF Summit 2016…yes, TCP Routing is now available on Cloud Foundry. It will allow developers to bring non-http workloads to Cloud Foundry. It will open up the platform and its benefits to all kind of new applications!

I would like to give readers a quick tour of TCP Routing feature in Cloud Foundry. TCP routes in Cloud Foundry are based on reserving external/frontend port of TCP router group for an application. Any traffic coming on that port will be forwarded to one or more instances of that application (using round-robin load balancing policy). TCP router groups are collection of one or more TCP routers (HAProxy) that are identically configured. This is done for high availability of TCP routing layer. Also, this concept of router groups allows for adding multiple router groups of different types to allow different routing functionality to be added to Cloud Foundry in future. Currently, there is only one router group of type TCP. But this could be easily changed to add multiple TCP router groups thereby allowing different applications to reserve the same port on different router groups.

At Cloud Foundry we strive to keep the developer experience simple and similar to existing UX. With that as our guiding principle, we developed TCP routing user experience. So lets take a look at developer experience of TCP routing.

How to Create a TCP Route in Cloud Foundry

1. Create a TCP Domain

To create a TCP route you should first create a TCP domain. Creation of TCP domain is very similar to http domains, you just need to specify router group when creating TCP domain as follows:

 cf create-shared-domain --router-group default-tcp

2. Specifcy TCP Router Group

You can see that while creating a TCP shared domain you just need to specify TCP router group. You can get all the router groups available in your deployment by running following command:

cf router-groups
Getting router groups as admin ...
name type
default-tcp tcp

There is only one router group available today with routing deployment and that is named default-tcp.

3. Create and Map TCP Routes

Now you are ready to create and map TCP routes to your application. Of course, here we are assuming that dns entries for above created TCP domain will resolve to load balancer in front of TCP router groups or if TCP routers have public IP addresses then it will resolve to TCP routers. This has to be done by the operator/administrator of your Cloud Foundry deployment.

Now lets push an application, create a TCP route and map it to the application and lets do it all in one command…yes one command!

cf push mqttbroker --docker-image toke/mosquitto -d --random-route

There are many things going on here. Lets break it down:

  1. A docker image toke/mosquitto is being downloaded from docker hub.
  2. It is staged (a droplet is created).
  3. A random TCP route is created. This is achieved by specifying TCP domain through -d option and –random-route option. As explained above TCP route consists of reserving an external port on TCP router group, by specifying random-route option we let system choose the free port from available ports on router-group and reserve that port for creating a TCP route.
  4. This TCP route is mapped to the application mqttbroker.
  5. Staged application is now deployed and run.
  6. Application is now ready to receive the traffic on TCP route that is mapped to the application.

With above command we have pushed a MQTT broker (mosquitto) as CF App! We can now give the TCP route mapped to this MQTT broker to publishers and subscribers to publish and subscribe MQTT messages.

Like http routes, you can create and map TCP route independent of cf push. This is how you can do it:

cf create-route SPACE DOMAIN (--port PORT | --random-port)
e.g. cf create-route s1 --port 8883
e.g. cf create-route s1 --random-port

The above command will allow you to create a TCP route. Notice that it allows you to let system choose a port for you (–random-port) or you can specify the port of your choice (–port 8883). Of course, if you specify the port of your choice and if it is unavailable then route creation will fail and you will get an error message indicating that port is already reserved and not available.

Once the TCP route is created, you can map it to application (again, very similar to how you will map http routes). Note that if the TCP route being mapped is not present then it will be created (again, very much like http routes), so you don’t need to create TCP route before hand if you have the application to bind to. The only time you will need to create a TCP route is if you need to reserve a port and use it later to bind to an app.

cf map-route APP_NAME DOMAIN (--port PORT | --random-port)
e.g. cf map-route myapp --port 8883 
e.g. cf map-route myapp --random-port 

This command will map the TCP route to app and create the TCP route if one doesn’t exist.

That’s it! Your apps that need non-http protocol support can now happily run on Cloud Foundry. Now all the great benefits that web apps got from Cloud Foundry are available to non-http apps as well.

As always, we love feedback—please share your experiences in the comments!


Abbey Weintraub-Sklar Profile Image

Abbey Weintraub-Sklar, AUTHOR