rancher/plugins
1
0
Fork 1
mirror of https://github.com/rancher/plugins.git synced 2025-09-20 20:19:13 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #218 from hwchiu/fix-readme

Browse Source 
fix the typo of macvlan and also modify documents to meet the current plugins.
This commit is contained in:
Dan Williams
2018-11-07 09:30:29 -06:00
committed by GitHub
parent 534bfafe99 f006155b66
commit 5fc8209482
3 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -14,12 +14,14 @@ Read [CONTRIBUTING](CONTRIBUTING.md) for build and test instructions.
* `macvlan`: Creates a new MAC address, forwards all traffic to that to the container. * `macvlan`: Creates a new MAC address, forwards all traffic to that to the container.
* `ptp`: Creates a veth pair. * `ptp`: Creates a veth pair.
* `vlan`: Allocates a vlan device. * `vlan`: Allocates a vlan device.
* `host-device`: Move an already-existing device into a container.
#### Windows: windows specific #### Windows: windows specific
* `win-bridge`: Creates a bridge, adds the host and the container to it. * `win-bridge`: Creates a bridge, adds the host and the container to it.
* `win-overlay`: Creates an overlay interface to the container. * `win-overlay`: Creates an overlay interface to the container.
### IPAM: IP address allocation ### IPAM: IP address allocation
* `dhcp`: Runs a daemon on the host to make DHCP requests on behalf of the container * `dhcp`: Runs a daemon on the host to make DHCP requests on behalf of the container
* `host-local`: Maintains a local database of allocated IPs * `host-local`: Maintains a local database of allocated IPs
* `static`: Allocate a static IPv4/IPv6 addresses to container and it's userful in debugging purpose.
### Meta: other plugins ### Meta: other plugins
* `flannel`: Generates an interface corresponding to a flannel config file * `flannel`: Generates an interface corresponding to a flannel config file

2
plugins/main/host-device/README.md
View File

@@ -1,5 +1,5 @@
# host-device # host-device
Move an already-existing device in to a container. Move an already-existing device into a container.
This simple plugin will move the requested device from the host's network namespace This simple plugin will move the requested device from the host's network namespace
to the container's. Nothing else will be done - no IPAM, no addresses. to the container's. Nothing else will be done - no IPAM, no addresses.

2
plugins/main/macvlan/README.md
View File

@@ -24,7 +24,7 @@ Since each macvlan interface has its own MAC address, it makes it easy to use wi
* `name` (string, required): the name of the network * `name` (string, required): the name of the network
* `type` (string, required): "macvlan" * `type` (string, required): "macvlan"
* `master` (string, required): name of the host interface to enslave * `master` (string, required): name of the host interface to enslave
* `mode` (string, optional): one of "bridge", "private", "vepa", "passthrough". Defaults to "bridge". * `mode` (string, optional): one of "bridge", "private", "vepa", "passthru". Defaults to "bridge".
* `mtu` (integer, optional): explicitly set MTU to the specified value. Defaults to the value chosen by the kernel. * `mtu` (integer, optional): explicitly set MTU to the specified value. Defaults to the value chosen by the kernel.
* `ipam` (dictionary, required): IPAM configuration to be used for this network. * `ipam` (dictionary, required): IPAM configuration to be used for this network.