Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document udp and alloc backends and their configuration values #46

Merged
merged 1 commit into from
Sep 19, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,35 @@ to the first subnet of Network.
* ```SubnetMax``` (string): The end of the IP range at which the subnet allocation should end with. Defaults to
the last subnet of Network.

* ```Backend``` (dictionary): Type of backend to use and specific configurations for that backend. The list
of available backends and the keys that can be put into the this dictionary are listed below. Defaults to
"udp" backend.

### Backends
* udp: use UDP to encapsulate the packets.
* ```Type``` (string): ```udp```
* ```Port``` (number): UDP port to use for sending encapsulated packets. Defaults to 8285

* alloc: only perform subnet allocation (no forwarding of data packets)
* ```Type``` (string): ```alloc```

### Example configuration JSON

The following confiuration illustrates the use of most options.

```
{
"Network": "10.0.0.0/8",
"SubnetLen": 20,
"SubnetMin": "10.10.0.0",
"SubnetMax": "10.99.0.0",
"Backend": {
"Type": "udp",
"Port": 7890
}
}
```

### Firewalls
flannel uses UDP port 8285 for sending encapsulated packets. Make sure that your firewall rules allow
this traffic for all hosts participating in the overlay network.
Expand Down