Browse Source

Merge pull request #611 from gravitl/feature_v0.9.4_docs

minor docs fixes
Alex 3 years ago
parent
commit
44688fe32c

BIN
docs/_build/doctrees/architecture.doctree


BIN
docs/_build/doctrees/environment.pickle


BIN
docs/_build/doctrees/server-installation.doctree


BIN
docs/_build/doctrees/ui-reference.doctree


+ 1 - 1
docs/_build/html/_sources/architecture.rst.txt

@@ -107,7 +107,7 @@ The check in process is what allows Netmaker to create dynamic mesh networks. As
 Database (sqlite, rqlite, postgres)
 Database (sqlite, rqlite, postgres)
 -------------------------------------
 -------------------------------------
 
 
-As of v0.8, Netmaker uses sqlite by default as a database. It can also use PostgreSQL, or rqlite, a distributed (RAFT consensus) databaseand. Netmaker interacts with this database to store and retrieve information about nodes, networks, and users. 
+As of v0.8, Netmaker uses sqlite by default as a database. It can also use PostgreSQL, or rqlite, a distributed (RAFT consensus) database. Netmaker interacts with this database to store and retrieve information about nodes, networks, and users. 
 
 
 Additional database support (besides sqlite and rqlite) is very easy to implement for special use cases. Netmaker uses simple key value lookups to run the networks, and the database was designed to be extensible, so support for key-value stores and other SQL-based databases can be achieved by changing a single file.
 Additional database support (besides sqlite and rqlite) is very easy to implement for special use cases. Netmaker uses simple key value lookups to run the networks, and the database was designed to be extensible, so support for key-value stores and other SQL-based databases can be achieved by changing a single file.
 
 

+ 2 - 2
docs/_build/html/_sources/ui-reference.rst.txt

@@ -42,8 +42,8 @@ Edit
 
 
 **NOTE:** With the exception of Address Ranges (1-2) any setting that affects nodes will not take effect on existing nodes. It will only set the settings on any **new** node, after the setting has been changed.
 **NOTE:** With the exception of Address Ranges (1-2) any setting that affects nodes will not take effect on existing nodes. It will only set the settings on any **new** node, after the setting has been changed.
 
 
-(1) **Address Range (ipv4): The ipv4 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.** 
-(2) **Address Range (ipv6): The ipv6 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.**
+(1) **Address Range (ipv4):** The ipv4 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.** 
+(2) **Address Range (ipv6):** The ipv6 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.**
 (3) **Local Range:** Only relevant if "Is Local" was switched on during creation. Specifies the local range that nodes will base their Endpoint off of (note: if a node cannot find an enpoint within the range it will fallback to public ip).
 (3) **Local Range:** Only relevant if "Is Local" was switched on during creation. Specifies the local range that nodes will base their Endpoint off of (note: if a node cannot find an enpoint within the range it will fallback to public ip).
 (4) **Display Name:** The display name of the network. Network Name cannot be changed (acts as a unique ID) but display name can be changed. Only effects appearance in UI.
 (4) **Display Name:** The display name of the network. Network Name cannot be changed (acts as a unique ID) but display name can be changed. Only effects appearance in UI.
 (5) **Default Interface:** The default network interface name configured on each node. This defaults to "nm-<network name>".
 (5) **Default Interface:** The default network interface name configured on each node. This defaults to "nm-<network name>".

+ 14 - 7
docs/_build/html/about.html

@@ -285,49 +285,56 @@
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
+      <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
+      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="client-installation.html" class="md-nav__link">Client Installation</a>
+      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
+      <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
+      <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
+      <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+      <a href="usage.html" class="md-nav__link">External Guides</a>
       
       
     
     
     </li>
     </li>

+ 19 - 12
docs/_build/html/architecture.html

@@ -57,7 +57,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Install" href="install.html" />
     <link rel="next" title="Install" href="install.html" />
-    <link rel="prev" title="1. About" href="about.html" />
+    <link rel="prev" title="About" href="about.html" />
   
   
    
    
 
 
@@ -209,7 +209,7 @@
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="about.html" class="md-nav__link">1. About</a>
+      <a href="about.html" class="md-nav__link">About</a>
       
       
     
     
     </li>
     </li>
@@ -329,49 +329,56 @@
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
+      <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
+      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="client-installation.html" class="md-nav__link">Client Installation</a>
+      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="external-clients.html" class="md-nav__link">Ingress GW + External Clients</a>
+      <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
+      <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
+      <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+      <a href="usage.html" class="md-nav__link">External Guides</a>
       
       
     
     
     </li>
     </li>
@@ -549,7 +556,7 @@
 
 
 
 
 <h3 id="database-sqlite-rqlite-postgres">Database (sqlite, rqlite, postgres)<a class="headerlink" href="#database-sqlite-rqlite-postgres" title="Permalink to this headline">¶</a></h3>
 <h3 id="database-sqlite-rqlite-postgres">Database (sqlite, rqlite, postgres)<a class="headerlink" href="#database-sqlite-rqlite-postgres" title="Permalink to this headline">¶</a></h3>
-<p>As of v0.8, Netmaker uses sqlite by default as a database. It can also use PostgreSQL, or rqlite, a distributed (RAFT consensus) databaseand. Netmaker interacts with this database to store and retrieve information about nodes, networks, and users.</p>
+<p>As of v0.8, Netmaker uses sqlite by default as a database. It can also use PostgreSQL, or rqlite, a distributed (RAFT consensus) database. Netmaker interacts with this database to store and retrieve information about nodes, networks, and users.</p>
 <p>Additional database support (besides sqlite and rqlite) is very easy to implement for special use cases. Netmaker uses simple key value lookups to run the networks, and the database was designed to be extensible, so support for key-value stores and other SQL-based databases can be achieved by changing a single file.</p>
 <p>Additional database support (besides sqlite and rqlite) is very easy to implement for special use cases. Netmaker uses simple key value lookups to run the networks, and the database was designed to be extensible, so support for key-value stores and other SQL-based databases can be achieved by changing a single file.</p>
 
 
 
 
@@ -640,7 +647,7 @@
     <div class="md-footer-nav">
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
       <nav class="md-footer-nav__inner md-grid">
           
           
-            <a href="about.html" title="1. About"
+            <a href="about.html" title="About"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                rel="prev">
                rel="prev">
               <div class="md-flex__cell md-flex__cell--shrink">
               <div class="md-flex__cell md-flex__cell--shrink">
@@ -649,7 +656,7 @@
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
                 <span class="md-flex__ellipsis">
                 <span class="md-flex__ellipsis">
                   <span
                   <span
-                      class="md-footer-nav__direction"> Previous </span> <span class="section-number">1. </span>About </span>
+                      class="md-footer-nav__direction"> Previous </span> About </span>
               </div>
               </div>
             </a>
             </a>
           
           

+ 32 - 25
docs/_build/html/external-clients.html

@@ -57,7 +57,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Egress Gateway" href="egress-gateway.html" />
     <link rel="next" title="Egress Gateway" href="egress-gateway.html" />
-    <link rel="prev" title="Client Installation" href="client-installation.html" />
+    <link rel="prev" title="Getting Started" href="getting-started.html" />
   
   
    
    
 
 
@@ -240,27 +240,6 @@
       <a href="getting-started.html" class="md-nav__link">Getting Started</a>
       <a href="getting-started.html" class="md-nav__link">Getting Started</a>
       
       
     
     
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="client-installation.html" class="md-nav__link">Client Installation</a>
-      
-    
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
@@ -336,7 +315,35 @@
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+      <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="usage.html" class="md-nav__link">External Guides</a>
       
       
     
     
     </li>
     </li>
@@ -489,7 +496,7 @@ If you do not want DNS on your ext client conf files, simply leave it blank.</p>
     <div class="md-footer-nav">
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
       <nav class="md-footer-nav__inner md-grid">
           
           
-            <a href="client-installation.html" title="Client Installation"
+            <a href="getting-started.html" title="Getting Started"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                rel="prev">
                rel="prev">
               <div class="md-flex__cell md-flex__cell--shrink">
               <div class="md-flex__cell md-flex__cell--shrink">
@@ -498,7 +505,7 @@ If you do not want DNS on your ext client conf files, simply leave it blank.</p>
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
                 <span class="md-flex__ellipsis">
                 <span class="md-flex__ellipsis">
                   <span
                   <span
-                      class="md-footer-nav__direction"> Previous </span> Client Installation </span>
+                      class="md-footer-nav__direction"> Previous </span> Getting Started </span>
               </div>
               </div>
             </a>
             </a>
           
           

+ 42 - 35
docs/_build/html/oauth.html

@@ -56,8 +56,8 @@
     <link rel="author" title="About these documents" href="about.html" />
     <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Client Installation" href="client-installation.html" />
-    <link rel="prev" title="Advanced Server Installation" href="server-installation.html" />
+    <link rel="next" title="External Guides" href="usage.html" />
+    <link rel="prev" title="Advanced Client Installation" href="client-installation.html" />
   
   
    
    
 
 
@@ -240,6 +240,34 @@
       <a href="getting-started.html" class="md-nav__link">Getting Started</a>
       <a href="getting-started.html" class="md-nav__link">Getting Started</a>
       
       
     
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
+      
+    
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
@@ -247,6 +275,13 @@
       <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
       <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
       
       
     
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
+      
+    
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
@@ -308,35 +343,7 @@
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="client-installation.html" class="md-nav__link">Client Installation</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+      <a href="usage.html" class="md-nav__link">External Guides</a>
       
       
     
     
     </li>
     </li>
@@ -487,7 +494,7 @@ Instructions for Microsoft Azure AD: <a class="reference external" href="https:/
     <div class="md-footer-nav">
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
       <nav class="md-footer-nav__inner md-grid">
           
           
-            <a href="server-installation.html" title="Advanced Server Installation"
+            <a href="client-installation.html" title="Advanced Client Installation"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                rel="prev">
                rel="prev">
               <div class="md-flex__cell md-flex__cell--shrink">
               <div class="md-flex__cell md-flex__cell--shrink">
@@ -496,17 +503,17 @@ Instructions for Microsoft Azure AD: <a class="reference external" href="https:/
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
                 <span class="md-flex__ellipsis">
                 <span class="md-flex__ellipsis">
                   <span
                   <span
-                      class="md-footer-nav__direction"> Previous </span> Advanced Server Installation </span>
+                      class="md-footer-nav__direction"> Previous </span> Advanced Client Installation </span>
               </div>
               </div>
             </a>
             </a>
           
           
           
           
-            <a href="client-installation.html" title="Client Installation"
+            <a href="usage.html" title="External Guides"
                class="md-flex md-footer-nav__link md-footer-nav__link--next"
                class="md-flex md-footer-nav__link md-footer-nav__link--next"
                rel="next">
                rel="next">
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span
                 class="md-flex__ellipsis"> <span
                 class="md-flex__ellipsis"> <span
-                class="md-footer-nav__direction"> Next </span> Client Installation </span>
+                class="md-footer-nav__direction"> Next </span> External Guides </span>
             </div>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink"><i
             <div class="md-flex__cell md-flex__cell--shrink"><i
                 class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
                 class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>

File diff suppressed because it is too large
+ 0 - 0
docs/_build/html/searchindex.js


+ 39 - 32
docs/_build/html/server-installation.html

@@ -56,8 +56,8 @@
     <link rel="author" title="About these documents" href="about.html" />
     <link rel="author" title="About these documents" href="about.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Integrating OAuth" href="oauth.html" />
-    <link rel="prev" title="Getting Started" href="getting-started.html" />
+    <link rel="next" title="Advanced Client Installation" href="client-installation.html" />
+    <link rel="prev" title="Relay Servers" href="relay-server.html" />
   
   
    
    
 
 
@@ -209,7 +209,7 @@
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="about.html" class="md-nav__link">1. About</a>
+      <a href="about.html" class="md-nav__link">About</a>
       
       
     
     
     </li>
     </li>
@@ -240,6 +240,34 @@
       <a href="getting-started.html" class="md-nav__link">Getting Started</a>
       <a href="getting-started.html" class="md-nav__link">Getting Started</a>
       
       
     
     
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
+      
+    
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
@@ -404,42 +432,21 @@
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="client-installation.html" class="md-nav__link">Client Installation</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="external-clients.html" class="md-nav__link">Ingress GW + External Clients</a>
-      
-    
-    </li>
-    <li class="md-nav__item">
-    
-    
-      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
+      <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
+      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+      <a href="usage.html" class="md-nav__link">External Guides</a>
       
       
     
     
     </li>
     </li>
@@ -720,7 +727,7 @@
     <span class="nt">container_name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">netmaker</span>
     <span class="nt">container_name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">netmaker</span>
     <span class="nt">depends_on</span><span class="p">:</span>
     <span class="nt">depends_on</span><span class="p">:</span>
       <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rqlite</span>
       <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rqlite</span>
-    <span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gravitl/netmaker:v0.9.3</span>
+    <span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gravitl/netmaker:v0.9.4</span>
     <span class="nt">volumes</span><span class="p">:</span> <span class="c1"># Volume mounts necessary for CLIENT_MODE to control wireguard networking on host (except dnsconfig, which is where dns config files are stored for use by CoreDNS)</span>
     <span class="nt">volumes</span><span class="p">:</span> <span class="c1"># Volume mounts necessary for CLIENT_MODE to control wireguard networking on host (except dnsconfig, which is where dns config files are stored for use by CoreDNS)</span>
       <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">dnsconfig:/root/config/dnsconfig</span> <span class="c1"># Netmaker writes Corefile to this location, which gets mounted by CoreDNS for DNS configuration.</span>
       <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">dnsconfig:/root/config/dnsconfig</span> <span class="c1"># Netmaker writes Corefile to this location, which gets mounted by CoreDNS for DNS configuration.</span>
       <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">/usr/bin/wg:/usr/bin/wg</span>
       <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">/usr/bin/wg:/usr/bin/wg</span>
@@ -1133,7 +1140,7 @@ This install has some notable exceptions:
     <div class="md-footer-nav">
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
       <nav class="md-footer-nav__inner md-grid">
           
           
-            <a href="getting-started.html" title="Getting Started"
+            <a href="relay-server.html" title="Relay Servers"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                rel="prev">
                rel="prev">
               <div class="md-flex__cell md-flex__cell--shrink">
               <div class="md-flex__cell md-flex__cell--shrink">
@@ -1142,17 +1149,17 @@ This install has some notable exceptions:
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
                 <span class="md-flex__ellipsis">
                 <span class="md-flex__ellipsis">
                   <span
                   <span
-                      class="md-footer-nav__direction"> Previous </span> Getting Started </span>
+                      class="md-footer-nav__direction"> Previous </span> Relay Servers </span>
               </div>
               </div>
             </a>
             </a>
           
           
           
           
-            <a href="oauth.html" title="Integrating OAuth"
+            <a href="client-installation.html" title="Advanced Client Installation"
                class="md-flex md-footer-nav__link md-footer-nav__link--next"
                class="md-flex md-footer-nav__link md-footer-nav__link--next"
                rel="next">
                rel="next">
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span
                 class="md-flex__ellipsis"> <span
                 class="md-flex__ellipsis"> <span
-                class="md-footer-nav__direction"> Next </span> Integrating OAuth </span>
+                class="md-footer-nav__direction"> Next </span> Advanced Client Installation </span>
             </div>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink"><i
             <div class="md-flex__cell md-flex__cell--shrink"><i
                 class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
                 class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>

+ 19 - 12
docs/_build/html/ui-reference.html

@@ -57,7 +57,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="API Reference" href="api.html" />
     <link rel="next" title="API Reference" href="api.html" />
-    <link rel="prev" title="Using Netmaker" href="usage.html" />
+    <link rel="prev" title="External Guides" href="usage.html" />
   
   
    
    
 
 
@@ -244,49 +244,56 @@
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
+      <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
+      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="client-installation.html" class="md-nav__link">Client Installation</a>
+      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="external-clients.html" class="md-nav__link">Ingress + External Clients</a>
+      <a href="https://nm-k8s.readthedocs.io" class="md-nav__link">Kubernetes</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="egress-gateway.html" class="md-nav__link">Egress Gateway</a>
+      <a href="server-installation.html" class="md-nav__link">Advanced Server Installation</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="relay-server.html" class="md-nav__link">Relay Servers</a>
+      <a href="client-installation.html" class="md-nav__link">Advanced Client Installation</a>
+      
+    
+    </li>
+    <li class="md-nav__item">
+    
+    
+      <a href="oauth.html" class="md-nav__link">Integrating OAuth</a>
       
       
     
     
     </li>
     </li>
     <li class="md-nav__item">
     <li class="md-nav__item">
     
     
     
     
-      <a href="usage.html" class="md-nav__link">Using Netmaker</a>
+      <a href="usage.html" class="md-nav__link">External Guides</a>
       
       
     
     
     </li>
     </li>
@@ -507,8 +514,8 @@
 <a class="reference internal image-reference" href="_images/ui-3.jpg"><img alt="edit network" class="align-center" src="_images/ui-3.jpg" style="width: 80%;"/></a>
 <a class="reference internal image-reference" href="_images/ui-3.jpg"><img alt="edit network" class="align-center" src="_images/ui-3.jpg" style="width: 80%;"/></a>
 <p><strong>NOTE:</strong> With the exception of Address Ranges (1-2) any setting that affects nodes will not take effect on existing nodes. It will only set the settings on any <strong>new</strong> node, after the setting has been changed.</p>
 <p><strong>NOTE:</strong> With the exception of Address Ranges (1-2) any setting that affects nodes will not take effect on existing nodes. It will only set the settings on any <strong>new</strong> node, after the setting has been changed.</p>
 <ol class="arabic simple">
 <ol class="arabic simple">
-<li><p><strong>Address Range (ipv4): The ipv4 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.</strong></p></li>
-<li><p><strong>Address Range (ipv6): The ipv6 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.</strong></p></li>
+<li><p><strong>Address Range (ipv4):</strong> The ipv4 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.**</p></li>
+<li><p><strong>Address Range (ipv6):</strong> The ipv6 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.**</p></li>
 <li><p><strong>Local Range:</strong> Only relevant if “Is Local” was switched on during creation. Specifies the local range that nodes will base their Endpoint off of (note: if a node cannot find an enpoint within the range it will fallback to public ip).</p></li>
 <li><p><strong>Local Range:</strong> Only relevant if “Is Local” was switched on during creation. Specifies the local range that nodes will base their Endpoint off of (note: if a node cannot find an enpoint within the range it will fallback to public ip).</p></li>
 <li><p><strong>Display Name:</strong> The display name of the network. Network Name cannot be changed (acts as a unique ID) but display name can be changed. Only effects appearance in UI.</p></li>
 <li><p><strong>Display Name:</strong> The display name of the network. Network Name cannot be changed (acts as a unique ID) but display name can be changed. Only effects appearance in UI.</p></li>
 <li><p><strong>Default Interface:</strong> The default network interface name configured on each node. This defaults to “nm-&lt;network name&gt;”.</p></li>
 <li><p><strong>Default Interface:</strong> The default network interface name configured on each node. This defaults to “nm-&lt;network name&gt;”.</p></li>
@@ -640,7 +647,7 @@
     <div class="md-footer-nav">
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
       <nav class="md-footer-nav__inner md-grid">
           
           
-            <a href="usage.html" title="Using Netmaker"
+            <a href="usage.html" title="External Guides"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                class="md-flex md-footer-nav__link md-footer-nav__link--prev"
                rel="prev">
                rel="prev">
               <div class="md-flex__cell md-flex__cell--shrink">
               <div class="md-flex__cell md-flex__cell--shrink">
@@ -649,7 +656,7 @@
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
                 <span class="md-flex__ellipsis">
                 <span class="md-flex__ellipsis">
                   <span
                   <span
-                      class="md-footer-nav__direction"> Previous </span> Using Netmaker </span>
+                      class="md-footer-nav__direction"> Previous </span> External Guides </span>
               </div>
               </div>
             </a>
             </a>
           
           

BIN
docs/images/egress1.png


+ 2 - 2
docs/ui-reference.rst

@@ -42,8 +42,8 @@ Edit
 
 
 **NOTE:** With the exception of Address Ranges (1-2) any setting that affects nodes will not take effect on existing nodes. It will only set the settings on any **new** node, after the setting has been changed.
 **NOTE:** With the exception of Address Ranges (1-2) any setting that affects nodes will not take effect on existing nodes. It will only set the settings on any **new** node, after the setting has been changed.
 
 
-(1) **Address Range (ipv4): The ipv4 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.** 
-(2) **Address Range (ipv6): The ipv6 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.**
+(1) **Address Range (ipv4):** The ipv4 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.** 
+(2) **Address Range (ipv6):** The ipv6 private network CIDR. If edited, Netmaker will go through all nodes and update private addresses based on the new range.**
 (3) **Local Range:** Only relevant if "Is Local" was switched on during creation. Specifies the local range that nodes will base their Endpoint off of (note: if a node cannot find an enpoint within the range it will fallback to public ip).
 (3) **Local Range:** Only relevant if "Is Local" was switched on during creation. Specifies the local range that nodes will base their Endpoint off of (note: if a node cannot find an enpoint within the range it will fallback to public ip).
 (4) **Display Name:** The display name of the network. Network Name cannot be changed (acts as a unique ID) but display name can be changed. Only effects appearance in UI.
 (4) **Display Name:** The display name of the network. Network Name cannot be changed (acts as a unique ID) but display name can be changed. Only effects appearance in UI.
 (5) **Default Interface:** The default network interface name configured on each node. This defaults to "nm-<network name>".
 (5) **Default Interface:** The default network interface name configured on each node. This defaults to "nm-<network name>".

Some files were not shown because too many files changed in this diff