Browse Source

Fix/improve docs

Fixes #274, #291, #316
Eugene Yakubovich 9 years ago
parent
commit
2c52a98c23

+ 8 - 8
Documentation/aws-vpc-backend.md

@@ -13,8 +13,8 @@ From the VPC dashboard start out by running the "VPC Wizard":
 <br/>
 <div class="row">
   <div class="col-lg-10 col-lg-offset-1 col-md-10 col-md-offset-1 col-sm-12 col-xs-12 co-m-screenshot">
-    <a href="{{site.baseurl}}/assets/images/media/aws-vpc.png">
-      <img src="{{site.baseurl}}/assets/images/media/aws-vpc.png" alt="New Amazon VPC" />
+    <a href="img/aws-vpc.png">
+      <img src="img/aws-vpc.png" alt="New Amazon VPC" />
     </a>
   </div>
 </div>
@@ -80,8 +80,8 @@ In the launch wizard, choose the `CoreOS-stable-681.2.0` image and under "Config
 <br/>
 <div class="row">
   <div class="col-lg-10 col-lg-offset-1 col-md-10 col-md-offset-1 col-sm-12 col-xs-12 co-m-screenshot">
-    <a href="{{site.baseurl}}/assets/images/media/aws-instance-configuration.png" class="co-m-screenshot">
-      <img src="{{site.baseurl}}/assets/images/media/aws-instance-configuration.png" alt="AWS EC2 Instance Details" />
+    <a href="img/aws-instance-configuration.png" class="co-m-screenshot">
+      <img src="img/aws-instance-configuration.png" alt="AWS EC2 Instance Details" />
     </a>
   </div>
 </div>
@@ -96,8 +96,8 @@ Since our instance will be sending and receiving traffic for IPs other than the
 <br/>
 <div class="row">
   <div class="col-lg-10 col-lg-offset-1 col-md-10 col-md-offset-1 col-sm-12 col-xs-12 co-m-screenshot">
-    <a href="{{site.baseurl}}/assets/images/media/aws-src-dst-check.png" class="co-m-screenshot">
-      <img src="{{site.baseurl}}/assets/images/media/aws-src-dst-check.png" alt="Disable AWS Source/Dest Check" />
+    <a href="img/aws-src-dst-check.png" class="co-m-screenshot">
+      <img src="img/aws-src-dst-check.png" alt="Disable AWS Source/Dest Check" />
     </a>
   </div>
 </div>
@@ -131,8 +131,8 @@ Confirm that the subnet route table has entries for the lease acquired by each o
 <br/>
 <div class="row">
   <div class="col-lg-10 col-lg-offset-1 col-md-10 col-md-offset-1 col-sm-12 col-xs-12 co-m-screenshot">
-    <a href="{{site.baseurl}}/assets/images/media/aws-routes.png" class="co-m-screenshot">
-      <img src="{{site.baseurl}}/assets/images/media/aws-routes.png" alt="AWS Routes" />
+    <a href="img/aws-routes.png" class="co-m-screenshot">
+      <img src="img/aws-routes.png" alt="AWS Routes" />
     </a>
   </div>
 </div>

+ 6 - 6
Documentation/gce-backend.md

@@ -17,14 +17,14 @@ Under the "Management, disk, networking, access & security options" make the fol
 <br/>
 <div class="row">
   <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 co-m-screenshot">
-    <a href="{{site.baseurl}}/assets/images/media/gce-instance.png">
-      <img src="{{site.baseurl}}/assets/images/media/gce-instance.png" alt="New GCE Instance">
+    <a href="img/gce-instance.png">
+      <img src="img/gce-instance.png" alt="New GCE Instance">
     </a>
     <div class="co-m-screenshot-caption">Booting a new GCE instance</div>
   </div>
   <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 co-m-screenshot">
-    <a href="{{site.baseurl}}/assets/images/media/gce-instance-and-security.png">
-      <img src="{{site.baseurl}}/assets/images/media/gce-instance-and-security.png" alt="Security settings for a new instance">
+    <a href="img/gce-instance-and-security.png">
+      <img src="img/gce-instance-and-security.png" alt="Security settings for a new instance">
     </a>
     <div class="co-m-screenshot-caption">Security settings for a new instance</div>
   </div>
@@ -64,8 +64,8 @@ Check that the subnet lease acquired by each of the hosts has been added!
 <br/>
 <div class="row">
   <div class="col-lg-10 col-lg-offset-1 col-md-10 col-md-offset-1 col-sm-12 col-xs-12 co-m-screenshot">
-    <a href="{{site.baseurl}}/assets/images/media/gce-routes.png" class="co-m-screenshot">
-      <img src="{{site.baseurl}}/assets/images/media/gce-routes.png" alt="GCE Routes" />
+    <a href="img/gce-routes.png" class="co-m-screenshot">
+      <img src="img/gce-routes.png" alt="GCE Routes" />
     </a>
   </div>
 </div>

BIN
Documentation/img/aws-instance-configuration.png


BIN
Documentation/img/aws-routes.png


BIN
Documentation/img/aws-src-dst-check.png


BIN
Documentation/img/aws-vpc.png


BIN
Documentation/img/gce-instance-and-security.png


BIN
Documentation/img/gce-instance.png


BIN
Documentation/img/gce-routes.png


+ 8 - 0
README.md

@@ -69,6 +69,7 @@ This is the only mandatory key.
 * vxlan: use in-kernel VXLAN to encapsulate the packets.
   * `Type` (string): `vxlan`
   * `VNI`  (number): VXLAN Identifier (VNI) to be used. Defaults to 1.
+  * `Port` (number): UDP port to use for sending encapsulated packets. Defaults to kernel default, currently 8472.
 
 * host-gw: create IP routes to subnets via remote machine IPs.
   Note that this requires direct layer2 connectivity between hosts running flannel.
@@ -225,3 +226,10 @@ Systemd users can use `EnvironmentFile` directive in the .service file to pull i
 
 CoreOS ships with flannel integrated into the distribution.
 See https://coreos.com/docs/cluster-management/setup/flannel-config/ for more information.
+
+## Running on Vagrant
+
+Vagrant has a tendency to give the default interface (one with the default route) a non-unique IP (often 10.0.2.15).
+This causes flannel to register multiple nodes with the same IP.
+To work around this issue, use `--iface` option to specify the interface that has a unique IP.
+If you're running on CoreOS, use cloud-config to set `coreos.flannel.interface` to `$public_ipv4`.