Configure Service Networking

Overview

This guide covers more complex and advanced cases of service networking. If you’ve never configured a Maestro service before, consider following our tutorial on port mapping first.

If you need an introduction to the concept of Service Networking, you can find one here.

Read our guide to using service.yml for more help on customizing your service configuration.

Non-HTTP ports (TCP and UDP)

If your application does not use HTTP traffic you can map ports by specifying the protocol (TCP or UDP).

Let’s imagine we have a service that listens on port 5454 on UDP and we would like to make it available to the outside world on port 111.

To achieve this via the edit service interface:

  1. Open the Application Overview from your Dashboard
  2. Click on the Services tab
  3. Click on the Edit service icon next to the service you wish to configure. This will open a panel on the left-hand side of your screen.
  4. Click on the YAML tab in the panel
  5. Change Container to 5454
  6. Delete any lines for HTTP and HTTPS (unless your service needs them)
  7. Add a new line: udp:111
  8. Save your changes and deploy your application

If you’d prefer to make these changes directly in the (full) service.yml the result would look similar to this:

services:
    my_service:
        ports:
          - container: 5454
            udp: 111

In the example below, our service listens to TCP port 8787 and we want to make it available on port 9000 to the outside world:

services:
    my_service:
        ports:
          - container: 8787
            tcp: 9000

Note that you don’t need to set the protocol for the container port - that is defined by the service itself. By specifying the protocol of the HTTP Port you’re ensuring that requests that reach the container are using the same networking protocol as the service itself.

Mapping multiple ports

Some services listen to multiple ports. An example is InfluxDB which listens to different ports for queries and admin controls. You can map these relationships using an array in the service.yml. For example:

services:
    my_service:
        ports:
          - container: 8787
            tcp: 9000
          - container: 8788
            tcp: 9001

Examples of default ports

Some example of default ports used by popular programming frameworks or application servers:

Application Default Port
Rack (webrick) 3000
Rack (unicorn, thin, puma) 9292
Node (Express) 3000
Java (Play) 9000
RethinkDB 8080
InfluxDB 8083, 8086, 8090, 8099
Python (Django) 8000