Project: Apache Mesos (Orchestration & Management / Scheduling & Orchestration)
File: network-port-mapping.md

title: Apache Mesos - Port Mapping Network Isolator layout: documentation The port mapping network isolator provides a way to achieve per-container network monitoring and isolation without relying on IP per container. The network isolator prevents a single container from exhausting the available network ports, consuming an unfair share of the network bandwidth or significantly delaying packet transmission for others. Network statistics for each active container are published through the endpoint on the agent. The port mapping network isolator is transparent for the majority of tasks running on an agent (those that bind to port 0 and let the kernel allocate their port). Port mapping network isolator is not supported by default. To enable it you need to install additional dependencies and configure it during the build process. Per-container network monitoring and isolation is only supported on Linux kernel versions 3.6 and above. Additionally, the kernel must include these patches (merged in kernel version 3.15). The following packages are required on the agent: >= 3.2.26 >= 2.6.39 is advised for debugging purpose but not required. Additionally, if you are building from source, you need will also need the libnl3 development package to compile Mesos: >= 3.2.26 To build Mesos with port mapping network isolator support, you need to add a configure option: $ ./configure --with-network-isolator $ make The port mapping network isolator is enabled on the agent by adding `network/port_mapping` to the agent command line `--isolation` flag. --isolation="network/port_mapping" If the agent has not been compiled with port mapping network isolator support, it will refuse to start and print an error: I0708 00:17:08.080271 44267 containerizer.cpp:111] Using isolation: network/port_mapping Failed to create a containerizer: Could not create MesosContainerizer: Unknown or unsupported isolator: network/port_mapping Without port mapping network isolator, all the containers on a host share the public IP address of the agent and can bind to any port allowed by the OS. When the port mapping network isolator is enabled, each container on the agent has a separate network stack (via Linux [network namespaces](http://lwn.net/Articles/580893/)). All containers still share the same public IP of the agent (so that the service discovery mechanism does not need to be changed). The agent assigns each container a non-overlapping range of the ports and only packets to/from these assigned port ranges will be delivered. Applications requesting the kernel assign a port (by binding to port 0) will be given ports from the container assigned range. Applications can bind to ports outside the container assigned ranges but packets from to/from these ports will be silently dropped by the host. Mesos provides two ranges of ports to containers: OS allocated "" ports are assigned by the OS in a range specified for each container by

Mesos allocated "non-ephemeral" ports are acquired by a framework using the same Mesos resource offer mechanism used for cpu, memory etc. for allocation to executors/tasks as required. Additionally, the host itself will require ephemeral ports for network communication. You need to configure these three non-overlapping port ranges on the host. The currently configured host ephemeral port range can be discovered at any time using the command `sysctl net.ipv4.iplocalport_range`. If ports need to be set aside for agent containers, the ephemeral port range can be updated in `/etc/sysctl.conf`. Rebooting after the update will apply the change and eliminate the possibility that ports are already in use by other processes. For example, by adding the following: net.ipv4.iplocalport_range = 57345 61000 The container ephemeral and non-ephemeral port ranges are configured using the agent `--resources` flag. The non-ephemeral port range is provided to the master, which will then offer it to frameworks for allocation. The ephemeral port range is sub-divided by the agent, giving `ephemeralportsper_container` (default 1024) to each container. The maximum number of containers on the agent will therefore be limited to approximately: number of ephemeralports / ephemeralportspercontainer The master `--maxexecutorsper_agent` flag is be used to prevent allocation of more executors on an agent when the ephemeral port range has been exhausted. It is recommended (but not required) that `ephemeralportsper_container` be set to a power of 2 (e.g., 512, 1024) and the lower bound of the ephemeral port range be a multiple of `ephemeralportsper_container` to minimize CPU overhead in packet processing. For example: --resources=ports:[31000-32000];ephemeral_ports:[32768-57344] \ --ephemeralportsper_container=512 Outbound traffic from a container to the network can be rate limited to prevent a single container from consuming all available network resources with detrimental effects to the other containers on the host. The `--egressratelimitpercontainer` flag specifies that each container launched on the host be limited to the specified bandwidth (in bytes per second). Network traffic which would cause this limit to be exceeded is delayed for later transmission. The TCP protocol will adjust to the increased latency and reduce the transmission rate ensuring no packets need be dropped. --egressratelimitpercontainer=100MB We do not rate limit inbound traffic since we can only modify the network flows after they have been received by the host and any congestion has already occurred. Delaying network data for later transmission can increase latency and jitter (variability) for all traffic on the interface. Mesos can reduce the impact on other containers on the same host by using flow classification and isolation using the containers port ranges to maintain unique flows for each container and sending traffic from these flows fairly (using the algorithm). Use the `--egressuniqueflowpercontainer` flag to enable. --egressuniqueflowpercontainer A complete agent command line enabling port mapping network isolator, reserving ports 57345-61000 for host ephemeral ports, 32768-57344 for container ephemeral ports, 31000-32000 for non-ephemeral ports allocated by the framework, limiting container transmit bandwidth to 300 Mbits/second

with unique flows enabled would thus be: mesos-agent \ --isolation=network/port_mapping \ --resources=ports:[31000-32000];ephemeral_ports:[32768-57344] \ --ephemeralportsper_container=1024 \ --egressratelimitpercontainer=37500KB \ --egressuniqueflowpercontainer Mesos exposes statistics from the Linux network stack for each container network on the agent endpoint. From the network interface inside the container, we report the following counters (since container creation) under the `statistics` key: <table class="table table-striped"> <thead> <tr><th>Metric</th><th>Description</th><th>Type</th> </thead> <tr> <td><code>netrxbytes</code></td> <td>Received bytes</td> <td>Counter</td> </tr> <tr> <td><code>netrxdropped</code></td> <td>Packets dropped on receive</td> <td>Counter</td> </tr> <tr> <td><code>netrxerrors</code></td> <td>Errors reported on receive</td> <td>Counter</td> </tr> <tr> <td><code>netrxpackets</code></td> <td>Packets received</td> <td>Counter</td> </tr> <tr> <td><code>nettxbytes</code></td> <td>Sent bytes</td> <td>Counter</td> </tr> <tr> <td><code>nettxdropped</code></td> <td>Packets dropped on send</td> <td>Counter</td> </tr> <tr> <td><code>nettxerrors</code></td> <td>Errors reported on send</td> <td>Counter</td> </tr> <tr> <td><code>nettxpackets</code></td> <td>Packets sent</td> <td>Counter</td> </tr> </table> Additionally, [Linux Traffic Control]( http://tldp.org/HOWTO/Traffic-Control-HOWTO/intro.html) can report the following statistics for the elements which implement bandwidth limiting and bloat reduction under the `statistics/nettrafficcontrol_statistics` key. The entry for each of these elements includes: <table class="table table-striped"> <thead> <tr><th>Metric</th><th>Description</th><th>Type</th> </thead> <tr> <td><code>backlog</code></td> <td>Bytes queued for transmission [1]</td> <td>Gauge</td> </tr> <tr> <td><code>bytes</code></td> <td>Sent bytes</td> <td>Counter</td> </tr> <tr> <td><code>drops</code></td> <td>Packets dropped on send</td> <td>Counter</td> </tr> <tr> <td><code>overlimits</code></td> <td>Count of times the interface was over its transmit limit when it attempted to send a packet. Since the normal action when the network is overlimit is to delay the packet, the overlimit counter can be incremented many times for each packet sent on a heavily congested interface. [2]</td> <td>Counter</td> </tr> <tr> <td><code>packets</code></td> <td>Packets sent</td> <td>Counter</td> </tr> <tr> <td><code>qlen</code></td> <td>Packets queued for transmission</td> <td>Gauge</td> </tr> <tr> <td><code>ratebps</code></td> <td>Transmit rate in bytes/second [3]</td> <td>Gauge</td> </tr> <tr> <td><code>ratepps</code></td> <td>Transmit rate in packets/second [3]</td> <td>Gauge</td> </tr> <tr> <td><code>requeues</code></td> <td>Packets failed to send due to resource contention (such as kernel locking) [3]</td> <td>Counter</td> </tr> </table> [1] `backlog` is only reported on the bloat_reduction interface. [2] `overlimits` are only reported on the bw_limit interface. [3] Currently always reported as 0 by the underlying Traffic Control element. For example, these are the statistics you will get by hitting the `/monitor/statistics` endpoint on an agent with network monitoring turned on: $ curl -s http://localhost:5051/monitor/statistics | python2.6 -mjson.tool [ { "executor_id": "job.1436298853", "executor_name": "Command Executor (Task: job.1436298853) (Command: sh -c 'iperf ....')", "framework_id": "20150707-195256-1740121354-5150-29801-0000", "source": "job.1436298853", "statistics": { "cpus_limit": 1.1, "cpusnrperiods": 16314, "cpusnrthrottled": 16313, "cpussystemtime_secs": 2667.06, "cpusthrottledtime_secs": 8036.840845388, "cpususertime_secs": 123.49, "memanonbytes": 8388608, "memcachebytes": 16384, "memcriticalpressure_counter": 0, "memfilebytes": 16384, "memlimitbytes": 167772160, "memlowpressure_counter": 0, "memmappedfile_bytes": 0, "memmediumpressure_counter": 0, "memrssbytes": 8388608, "memtotalbytes": 9945088, "netrxbytes": 10847, "netrxdropped": 0, "netrxerrors": 0, "netrxpackets": 143, "nettrafficcontrol_statistics": [ { "backlog": 0, "bytes": 163206809152, "drops": 77147, "id": "bw_limit", "overlimits": 210693719, "packets": 107941027, "qlen": 10236, "ratebps": 0, "ratepps": 0, "requeues": 0 }, { "backlog": 15481368, "bytes": 163206874168, "drops": 27081494, "id": "bloat_reduction", "overlimits": 0, "packets": 107941070, "qlen": 10239, "ratebps": 0, "ratepps": 0, "requeues": 0 } ], "nettxbytes": 163200529816, "nettxdropped": 0, "nettxerrors": 0, "nettxpackets": 107936874, "perf": { "duration": 0, "timestamp": 1436298855.82807 }, "timestamp": 1436300487.41595 } } ]