Movatterモバイル変換

NotificationsYou must be signed in to change notification settings
Fork88
Star829

A tc command wrapper. Make it easy to set up traffic control of network bandwidth/latency/packet-loss/packet-corruption/etc. to a network-interface/Docker-container(veth).

tcconfig.rtfd.io/

License

MIT license

829 stars 88 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,707 Commits
.github		.github
docs		docs
info		info
requirements		requirements
scripts		scripts
tcconfig		tcconfig
test		test
.gitignore		.gitignore
.readthedocs.yaml		.readthedocs.yaml
CHANGELOG.md		CHANGELOG.md
CODEOWNERS		CODEOWNERS
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
Makefile		Makefile
README.rst		README.rst
cli_tcdel.py		cli_tcdel.py
cli_tcset.py		cli_tcset.py
cli_tcshow.py		cli_tcshow.py
pyproject.toml		pyproject.toml
setup.py		setup.py
tox.ini		tox.ini

Repository files navigation

tcconfig

Summary

tcconfig is a tc command wrapper. Make it easy to set up traffic control of network bandwidth/latency/packet-loss/packet-corruption/etc. to a network-interface/Docker-container(veth).

Traffic control

Setup traffic shaping rules

Easy to apply traffic shaping rules to specific networks:

Outgoing/Incoming packets
Source/Destination IP-address/network (IPv4/IPv6)
Source/Destination ports

Available Parameters

The following parameters can be set to network interfaces:

Network bandwidth rate[G/M/K bps]
Network latency[microseconds/milliseconds/seconds/minutes]
Packet loss rate[%]
Packet corruption rate[%]
Packet duplicate rate[%]
Packet reordering rate[%]
Packet limit count[COUNT]

Targets

Network interfaces: e.g.eth0
Docker container (veth corresponding with a container)

Usage

Set traffic control (`tcset` command)

tcset is a command to add a traffic control rule to a network interface (device).

e.g. Set a limit on bandwidth up to 100Kbps

#tcset eth0 --rate 100Kbps

e.g. Set network latency

You can use time units (such as us/sec/min/etc.) to designate delay time.

Set 100 milliseconds of network latency

#tcset eth0 --delay 100ms

Set 10 seconds of network latency

#tcset eth0 --delay 10sec

Set 0.5 minutes (30 seconds) network latency

#tcset eth0 --delay 0.5min

You can also use the following time units:

Unit	Available specifiers (str)
hours	`h`/`hour`/`hours`
minutes	`m`/`min`/`mins`/`minute`/`minutes`
seconds	`s`/`sec`/`secs`/`second`/`seconds`
milliseconds	`ms`/`msec`/`msecs`/`millisecond`/`milliseconds`
microseconds	`us`/`usec`/`usecs`/`microsecond`/`microseconds`

e.g. Set 0.1% packet loss

#tcset eth0 --loss 0.1%

e.g. All of the above settings at once

#tcset eth0 --rate 100Kbps --delay 100ms --loss 0.1%

e.g. Specify the IP address of the traffic control

#tcset eth0 --delay 100ms --network 192.168.0.10

e.g. Specify the IP network and port of traffic control

#tcset eth0 --delay 100ms --network 192.168.0.0/24 --port 80

Set traffic control to a docker container

Executetcconfig with--docker option on a Docker host:

#tcset<container name or ID> --docker ...

You could use--src-container/--dst-container options to specify the source/destination container.

Set traffic control within a docker container

You need to run a container with--cap-add NET_ADMIN optionif you would like to set a tc rule within a container:

docker run -d --cap-add NET_ADMIN -t <docker image>

A container image that builtin tcconfig can be available athttps://hub.docker.com/r/thombashi/tcconfig/

Delete traffic control (`tcdel` command)

tcdel is a command to delete traffic shaping rules from a network interface (device).

e.g. Delete traffic control of`eth0`

You can delete all of the shaping rules for theeth0 with-a/--all option:

#tcdel eth0 --all

Display traffic control configurations (`tcshow` command)

tcshow is a command to display the current traffic control settings for network interface(s).

Example

#tcset eth0 --delay 10ms --delay-distro 2  --loss 0.01% --rate 0.25Mbps --network 192.168.0.10 --port 8080#tcset eth0 --delay 1ms --loss 0.02% --rate 500Kbps --direction incoming#tcshow eth0{    "eth0": {        "outgoing": {            "dst-network=192.168.0.10/32, dst-port=8080, protocol=ip": {                "filter_id": "800::800",                "delay": "10.0ms",                "delay-distro": "2.0ms",                "loss": "0.01%",                "rate": "250Kbps"            }        },        "incoming": {            "protocol=ip": {                "filter_id": "800::800",                "delay": "1.0ms",                "loss": "0.02%",                "rate": "500Kbps"            }        }    }}

sudo pip install tcconfig

Installation: dpkg (Debian/Ubuntu)

curl -sSL https://raw.githubusercontent.com/thombashi/tcconfig/master/scripts/installer.sh | sudo bash

Dependencies

Python 3.9+
Python package dependencies (automatically installed)

Linux packages

mandatory: required fortc command:
- Ubuntu/Debian:iproute2
- Fedora/RHEL:iproute-tc
optional: required when you use the--iptables option:
- iptables

Linux kernel module

sch_netem

Optional Python packages

Pygments

About

A tc command wrapper. Make it easy to set up traffic control of network bandwidth/latency/packet-loss/packet-corruption/etc. to a network-interface/Docker-container(veth).

tcconfig.rtfd.io/