Configure Service Networking
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:
- Open the Application Overview from your Dashboard
- Click on the Edit service icon on the right-hand side of the App Services panel
- On the Edit Services page, click the green Save changes button (you don’t need to make any changes first)
- On the Edit port settings page click the small planet icon to the left of the yellow Configure service networking panel
- Set the Container Port to
- Set the Public Internet Port to
- Save your changes and deploy your application
If you’d prefer to make these changes directly in the
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 Public Internet 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:
|Rack (unicorn, thin, puma)||9292|
|InfluxDB||8083, 8086, 8090, 8099|