Merge pull request #259 from gravitl/develop

failover docs (#258)

features.rst

@@ -11,7 +11,7 @@ Allows clients (nodes and ext clients) to reach external networks.
 :ref:`egress`
 
 
-Remoter Access Gateways & Clients
+Remote Access Gateways & Clients
 =================================
 
 A remote access gateway enables "external" clients to connect to the network. External clients refer to clients that are not part of the mesh network, but need to connect to it. This could be a laptop, mobile device, or even a server that is not part of the network.
@@ -35,10 +35,14 @@ Netmaker Professional is our advanced Netmaker offering for business use cases.
 
 - **Metrics:** Nodes collect networking metrics such as latency, transfer, and connectivity status. These are displayed in the Netmaker UI, and also exported to Grafana via Prometheus.  
 
-- **Users:** Community netmaker has rudimentary users, but Professional gives you the ability to create access levels to control network access, and even create groups to organize users. This allows users to log into the dashboard who can only manage ext clients for themselves, or nodes.
+- **Users:** On community you can only create admin users, where as on PRO it gives ability to create non-admin users which you can pair with remote-access gateway to segment users on different networks.
 
 - **Remote Access Client:** Netmaker Professional comes with a remote access client that allows you to connect to your network from anywhere. This is a great way to connect to your network from a laptop or mobile device (soon).
 
+- **FailOvers:** FailOvers are made to help two peers communicate where they cannot talk directly due to their firewall restrictions, in which case their connection falls back through a failover node set by the user in the network.
+
+- **Relays:** All traffic routing to and from in a network for a relayed machine will go through the relay machine.
+
 .. toctree::
    :maxdepth: 1
 

pro/index.rst

@@ -61,3 +61,11 @@ Remote Access Client
    :maxdepth: 2
 
    rac
+
+FailOvers
+-----------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   pro-failovers

pro/pro-failovers.rst

@@ -0,0 +1,34 @@
+=====================================
+FailOver Servers
+=====================================
+
+Introduction
+===============
+
+Sometimes nodes are in hard-to-reach places. Typically this will be due to a CGNAT, Double NAT, or a restrictive firewall. In such scenarios, a direct peer-to-peer connection with all other nodes might be impossible.
+
+For this reason, Netmaker has a FailOver functionality. At any time you may designate a publicly reachable node (such as the Netmaker Server) as a FailOver, and netmaker will identify if any peers in the network are not able to
+communicate directly then their connection will automatically fallback  through the failOver node in the network
+
+Configuring a FailOver node
+==================================
+
+To create a failover, you can use any host in your network, but it should have a public IP address (not behind a NAT).
+
+Navigate to the network tab and click on the hosts tab
+
+.. image:: images/failOvertab.jpg
+   :width: 80%
+   :alt: FailOver
+   :align: center
+
+You can choose any public node in the network to be a failover, Once chosen any peers facing difficulties to communicate directly with each other, will have connection go over the failover node.
+
+To reset the network connections, you can remove the failover node, and network will go back to original state from if any connections are getting failed over.
+
+.. image:: images/failOverselect.jpg
+   :width: 80%
+   :alt: FailOver
+   :align: center
+
+