Add CNI system requirements ports per enabled (#907)

* Add CNI system requirements ports per enabled * list all ports
replicatedhq · Nov 4, 2022 · f91cb9d · f91cb9d · github-actions · Nov 4, 2022
1 parent aedbd83
commit f91cb9d
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 10 deletions.
diff --git a/src/components/App.js b/src/components/App.js
@@ -211,17 +211,41 @@ cat install.sh | sudo bash -s airgap
                       4 CPUs or equivalent per machine
                     </li>
                     <li className="u-fontSize--small u-color--dustyGray u-fontWeight--medium u-lineHeight--normal">
-                      30 GB of Disk Space per machine
+                      8 GB of RAM per machine
                     </li>
                     <li className="u-fontSize--small u-color--dustyGray u-fontWeight--medium u-lineHeight--normal">
-                      UDP ports 6783 and 6784 open
+                      30 GB of Disk Space per machine
                     </li>
+                    {installerData && installerData.spec.flannel && installerData.spec.flannel.version &&
                     <li className="u-fontSize--small u-color--dustyGray u-fontWeight--medium u-lineHeight--normal">
-                      8 GB of RAM per machine
-                    </li>
+                      TCP ports 2379, 2380, 6443, 10250, 10251 and 10252 open between cluster nodes
+                    </li>}
+                    {installerData && installerData.spec.flannel && installerData.spec.flannel.version &&
                     <li className="u-fontSize--small u-color--dustyGray u-fontWeight--medium u-lineHeight--normal">
-                      TCP ports 6443 and 6783 open
-                    </li>
+                      UDP port 8472 open between cluster nodes
+                    </li>}
+                    {installerData && installerData.spec.weave && installerData.spec.weave.version &&
+                    <li className="u-fontSize--small u-color--dustyGray u-fontWeight--medium u-lineHeight--normal">
+                      TCP ports 2379, 2380, 6443, 6783, 10250, 10251 and 10252 open between cluster nodes
+                    </li>}
+                    {installerData && installerData.spec.weave && installerData.spec.weave.version &&
+                    <li className="u-fontSize--small u-color--dustyGray u-fontWeight--medium u-lineHeight--normal">
+                      UDP ports 6783 and 6784 open between cluster nodes
+                    </li>}
+                    {installerData && installerData.spec.antrea && installerData.spec.antrea.version &&
+                    <li className="u-fontSize--small u-color--dustyGray u-fontWeight--medium u-lineHeight--normal">
+                      {installerData.spec.antrea.isEncryptionDisabled ?
+                      <span>
+                        TCP ports 2379, 2380, 6443, 8091, 10250, 10251 and 10252 open between cluster nodes
+                      </span> :
+                      <span>
+                        TCP ports 2379, 2380, 6443, 8091, 10250, 10251, 10252 and 51820 open between cluster nodes
+                      </span>}
+                    </li>}
+                    {installerData && installerData.spec.antrea && installerData.spec.antrea.version &&
+                    <li className="u-fontSize--small u-color--dustyGray u-fontWeight--medium u-lineHeight--normal">
+                      UDP port 6081 open between cluster nodes
+                    </li>}
                   </div>
                 </div>
               </div>

diff --git a/src/markdown-pages/add-ons/flannel.md b/src/markdown-pages/add-ons/flannel.md
@@ -25,6 +25,22 @@ spec:
 
 flags-table
 
+## System Requirements
+
+The following additional ports must be open between nodes for multi-node clusters:
+
+#### Primary Nodes:
+
+| Protocol | Direction | Port Range | Purpose                 | Used By |
+| -------  | --------- | ---------- | ----------------------- | ------- |
+| UDP      | Inbound   | 8472       | Flannel VXLAN           | All     |
+
+#### Secondary Nodes:
+
+| Protocol | Direction | Port Range | Purpose                 | Used By |
+| -------  | --------- | ---------- | ----------------------- | ------- |
+| UDP      | Inbound   | 8472       | Flannel VXLAN           | All     |
+
 ## Custom Pod Subnet
 
 The Pod subnet will default to `10.32.0.0/20` if available.

diff --git a/src/markdown-pages/add-ons/weave.md b/src/markdown-pages/add-ons/weave.md
@@ -22,3 +22,21 @@ spec:
 ```
 
 flags-table
+
+## System Requirements
+
+The following additional ports must be open between nodes for multi-node clusters:
+
+#### Primary Nodes:
+
+| Protocol | Direction | Port Range | Purpose                 | Used By |
+| -------  | --------- | ---------- | ----------------------- | ------- |
+| TCP      | Inbound   | 6783       | Weave Net control       | All     |
+| UDP      | Inbound   | 6783-6784  | Weave Net data          | All     |
+
+#### Secondary Nodes:
+
+| Protocol | Direction | Port Range | Purpose                 | Used By |
+| -------  | --------- | ---------- | ----------------------- | ------- |
+| TCP      | Inbound   | 6783       | Weave Net control       | All     |
+| UDP      | Inbound   | 6783-6784  | Weave Net data          | All     |
diff --git a/src/markdown-pages/install-with-kurl/system-requirements.md b/src/markdown-pages/install-with-kurl/system-requirements.md
@@ -23,9 +23,10 @@ title: "System Requirements"
 * 4 AMD64 CPUs or equivalent per machine
 * 8 GB of RAM per machine
 * 40 GB of Disk Space per machine. 
-    * **Note**: 10GB of the total 40GB should be available to `/var/lib/rook`. For more information see [Rook](/docs/add-ons/rook)
-* TCP ports 2379, 2380, 6443, 6783, 10250, 10251 and 10252 open between cluster nodes
-* UDP ports 6783 and 6784 open between cluster nodes
+    * **Note**: When [Rook](/docs/add-ons/rook) is enabled, 10GB of the total 40GB should be available to `/var/lib/rook`
+* TCP ports 2379, 2380, 6443, 10250, 10251 and 10252 open between cluster nodes
+    * **Note**: When [Flannel](/docs/add-ons/flannel) is enabled, UDP port 8472 open between cluster nodes
+    * **Note**: When [Weave](/docs/add-ons/weave) is enabled, TCP port 6783 and UDP port 6783 and 6784 open between cluster nodes
 
 ## kURL Dependencies Directory
 
@@ -64,6 +65,7 @@ The following ports must be open between nodes for multi-node clusters:
 | TCP      | Inbound   | 6443       | Kubernetes API server   | All     |
 | TCP      | Inbound   | 2379-2380  | etcd server client API  | Primary |
 | TCP      | Inbound   | 10250      | kubelet API             | Primary |
+| UDP      | Inbound   | 8472       | Flannel VXLAN           | All     |
 | TCP      | Inbound   | 6783       | Weave Net control       | All     |
 | UDP      | Inbound   | 6783-6784  | Weave Net data          | All     |
 
@@ -72,6 +74,7 @@ The following ports must be open between nodes for multi-node clusters:
 | Protocol | Direction | Port Range | Purpose                 | Used By |
 | -------  | --------- | ---------- | ----------------------- | ------- |
 | TCP      | Inbound   | 10250      | kubelet API             | Primary |
+| UDP      | Inbound   | 8472       | Flannel VXLAN           | All     |
 | TCP      | Inbound   | 6783       | Weave Net control       | All     |
 | UDP      | Inbound   | 6783-6784  | Weave Net data          | All     |
 

diff --git a/src/templates/DocsTemplate.js b/src/templates/DocsTemplate.js
@@ -43,7 +43,7 @@ export default function Template({
           <h1>{frontmatter.title} {frontmatter.isAlpha && <span className="prerelease-tag alpha">alpha</span>} {frontmatter.isBeta && <span className="prerelease-tag beta">beta</span>}</h1>
           <div
             className="docs-content"
-            dangerouslySetInnerHTML={{ __html: html.replace("flags-table", buildHtmlTableFromJson(frontmatter.addOn)) }}
+            dangerouslySetInnerHTML={{ __html: html && html.replace("flags-table", buildHtmlTableFromJson(frontmatter.addOn)) }}
           />
         </div>
       </div>