Browse Source

Mention host-gw in README.md

Angus Lees 10 years ago
parent
commit
9d1690d3bf
1 changed files with 6 additions and 1 deletions
  1. 6 1
      README.md

+ 6 - 1
README.md

@@ -1,7 +1,7 @@
 # flannel
 
 flannel (originally [rudder](http://comments.gmane.org/gmane.linux.coreos.devel/1683)) is an overlay network that gives a subnet to each machine for use with
-Kubernetes. 
+Kubernetes.
 
 In Kubernetes every machine in the cluster is assigned a full subnet. The machine A
 and B might have 10.0.1.0/24 and 10.0.2.0/24 respectively. The advantage of
@@ -75,6 +75,11 @@ of available backends and the keys that can be put into the this dictionary are
   * ```Type``` (string): ```vxlan```
   * ```VNI```  (number): VXLAN Identifier (VNI) to be used. Defaults to 1
 
+* host-gw: create IP routes to subnets via remote machine IPs.  Note
+  that this requires direct layer2 connectivity between hosts running
+  flannel.
+  * ```Type``` (string): ```host-gw```
+
 ### Example configuration JSON
 
 The following configuration illustrates the use of most options.