Skip to content

Commit

Permalink
Merge pull request #218 from hwchiu/fix-readme
Browse files Browse the repository at this point in the history
fix the typo of macvlan and also modify documents to meet the current plugins.
  • Loading branch information
dcbw committed Nov 7, 2018
2 parents 534bfaf + f006155 commit 5fc8209
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* `ptp`: Creates a veth pair.
* `vlan`: Allocates a vlan device.
* `host-device`: Move an already-existing device into a container.
#### Windows: windows specific
* `win-bridge`: Creates a bridge, adds the host and the container to it.
* `win-overlay`: Creates an overlay interface to the container.
### IPAM: IP address allocation
* `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
* `static`: Allocate a static IPv4/IPv6 addresses to container and it's userful in debugging purpose.

### Meta: other plugins
* `flannel`: Generates an interface corresponding to a flannel config file
Expand Down
2 changes: 1 addition & 1 deletion plugins/main/host-device/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 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
to the container's. Nothing else will be done - no IPAM, no addresses.
Expand Down
2 changes: 1 addition & 1 deletion plugins/main/macvlan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
* `type` (string, required): "macvlan"
* `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.
* `ipam` (dictionary, required): IPAM configuration to be used for this network.

Expand Down

0 comments on commit 5fc8209

Please sign in to comment.