ITQC/containernetworking-plugins
24
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 34 Wiki Activity

update ptp docs to reflect changes in plugin

Browse Source
This commit is contained in:
Stefan Junker 2015-09-23 22:11:25 +02:00
parent 60be55a7d1
commit 6737bc8207
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/ptp.md
View File

@ -3,10 +3,8 @@
## Overview ## Overview
The ptp plugin creates a point-to-point link between a container and the host by using a veth device. The ptp plugin creates a point-to-point link between a container and the host by using a veth device.
One end of the veth pair is placed inside a container and the other end resides on the host. One end of the veth pair is placed inside a container and the other end resides on the host.
Both ends receive an IP address out of a /31 range. The host-local IPAM plugin can be used to allocate an IP address to the container.
The IP of the host end becomes the gateway address inside the container. The traffic of the container interface will be routed through the interface of the host.
Because ptp plugin requires a pair of IP addresses for each container, it should be used in conjunction with host-local-ptp IPAM plugin.
## Example network configuration ## Example network configuration
``` ```
@ -14,7 +12,7 @@ Because ptp plugin requires a pair of IP addresses for each container, it should
"name": "mynet", "name": "mynet",
"type": "ptp", "type": "ptp",
"ipam": { "ipam": {
"type": "host-local-ptp", "type": "host-local",
"subnet": "10.1.1.0/24" "subnet": "10.1.1.0/24"
} }
} }