plugins/Documentation/ptp.md

# ptp plugin

## Overview
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.
The host-local IPAM plugin can be used to allocate an IP address to the container.
The traffic of the container interface will be routed through the interface of the host.

## Example network configuration
```
{
	"name": "mynet",
	"type": "ptp",
	"ipam": {
		"type": "host-local",
		"subnet": "10.1.1.0/24"
	},
	"dns": {
		"nameservers": [ "10.1.1.1", "8.8.8.8" ]
	}
}

## Network configuration reference

* `name` (string, required): the name of the network
* `type` (string, required): "ptp"
* `ipMasq` (boolean, optional): set up IP Masquerade on the host for traffic originating from this network and destined outside of it. Defaults to false.
* `mtu` (integer, optional): explicitly set MTU to the specified value. Defaults to value chosen by the kernel.
* `ipam` (dictionary, required): IPAM configuration to be used for this network.
* `dns` (dictionary, optional): DNS information to return as described in the [Result](/SPEC.md#result).
Rename veth plugin to ptp and add docs. ptp (point-to-point) better describes the nature of the plugin as veth pairs are also used by the bridge plugin. 2015-07-10 19:18:25 +00:00			`# ptp plugin`

			`## Overview`
			`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.`
update ptp docs to reflect changes in plugin 2015-09-23 20:11:25 +00:00			`The host-local IPAM plugin can be used to allocate an IP address to the container.`
			`The traffic of the container interface will be routed through the interface of the host.`
Rename veth plugin to ptp and add docs. ptp (point-to-point) better describes the nature of the plugin as veth pairs are also used by the bridge plugin. 2015-07-10 19:18:25 +00:00
			`## Example network configuration`
			```
			`{`
			`"name": "mynet",`
			`"type": "ptp",`
			`"ipam": {`
update ptp docs to reflect changes in plugin 2015-09-23 20:11:25 +00:00			`"type": "host-local",`
Rename veth plugin to ptp and add docs. ptp (point-to-point) better describes the nature of the plugin as veth pairs are also used by the bridge plugin. 2015-07-10 19:18:25 +00:00			`"subnet": "10.1.1.0/24"`
*: add "dns" field to the configuration appc/cni#76 added a "dns" field in the result JSON. But before this patch, the plugins had no way of knowing which name server to return. There could be two ways of knowing which name server to return: 1. add it as an extra argument ("CNI_ARGS") 2. add it in the network configuration as a convenience (received via stdin) I chose the second way because it is easier. In the case of rkt, it means the user could just add the DNS name servers in /etc/rkt/net.d/mynetwork.conf. 2016-01-26 17:54:56 +00:00			`},`
docs/ptp: update example and DNS description 2016-01-27 11:10:53 +00:00			`"dns": {`
			`"nameservers": [ "10.1.1.1", "8.8.8.8" ]`
			`}`
Rename veth plugin to ptp and add docs. ptp (point-to-point) better describes the nature of the plugin as veth pairs are also used by the bridge plugin. 2015-07-10 19:18:25 +00:00			`}`

			`## Network configuration reference`

			* `name` (string, required): the name of the network
			* `type` (string, required): "ptp"
			* `ipMasq` (boolean, optional): set up IP Masquerade on the host for traffic originating from this network and destined outside of it. Defaults to false.
			* `mtu` (integer, optional): explicitly set MTU to the specified value. Defaults to value chosen by the kernel.
			* `ipam` (dictionary, required): IPAM configuration to be used for this network.
docs/ptp: update example and DNS description 2016-01-27 11:10:53 +00:00			* `dns` (dictionary, optional): DNS information to return as described in the [Result](/SPEC.md#result).