Commit fc1f49da authored by Mark Schouten's avatar Mark Schouten
Browse files

Add configuration documentation

parent b61ee1d9
ypconfig reads a yaml-file (defaults to /etc/ypconfig/interfaces.yml). The configfile has the following syntax:
An array of interfaces, where each interface has the following options:
- addresses:
An array of addresses in the syntax address/prefixlen
- adminstate:
The state of the interface, may be ```UP``` or ```DOWN```, defaults to ```UP```
- mtu:
The MTU of the interface, defaults to ```1500```
- vlans:
An array of dictionaries like interfaces, but with the following exceptions:
- We do not (yet) support Q-in-Q, so ```vlans``` is not accepted
- The value ```vlanid``` is an integer for the vlan id.
- The value ```name``` is the name of the interface, defaults to ```parent.vlanid```
- ratelimit:
Or a single float-value where this value is the ratelimit in mbit/s, or a ```in``` value and/or ```out``` value, to differentiate between incoming and outgoing ratelimits.
EXAMPLE 1
=========
A single interface, nothing fancy
eth0:
addresses:
- 192.168.1.4/24
- fd00::192:168:1:4/64
adminstate: UP
mtu: 1500
lo:
addresses:
- 127.0.0.1/8
- ::1/128
mtu: 65536
EXAMPLE 2
=========
A vlan interface on eth0
eth0:
adminstate: UP
mtu: 1500
vlans:
- adminstate: UP
addresses:
- 192.168.1.4/24
- fd00::192:168:1:4/64
mtu: 1500
name: foobar
vlanid: 200
lo:
addresses:
- 127.0.0.1/8
- ::1/128
mtu: 65536
EXAMPLE 3
=========
Two interfaces, eth0 with jumbo frames and eth1 with a ratelimit of 10mbit up and 100mbit down
eth0:
adminstate: UP
mtu: 9000
addresses:
- 192.168.1.4/24
- fd00::192:168:1:4/64
eth1:
adminstate: UP
mtu: 1500
addresses:
- 192.168.2.4/24
- fd00::192:168:2:4/64
ratelimit:
up: 10
down: 100
lo:
addresses:
- 127.0.0.1/8
- ::1/128
mtu: 65536
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment