From 5d93d6140abc590c54155c1fc8979d4e49661b08 Mon Sep 17 00:00:00 2001 From: Andrey Khomyakov Date: Wed, 16 Sep 2026 14:32:25 -0700 Subject: [PATCH 1/2] Add TOCs where missing --- acls.rst | 4 ++++ bluefield-3-dpus.rst | 4 ++++ dhcp-and-dhcp-relay.rst | 4 ++++ installation/controller-k3s-air-gap-ha.rst | 4 ++++ installation/ztp.rst | 4 ++++ inventory-profile.rst | 4 ++++ ipam.rst | 4 ++++ lag.rst | 4 ++++ monitoring-observability/visibility.rst | 4 ++++ nat.rst | 4 ++++ netris-ufm-integration.rst | 4 ++++ site.rst | 4 ++++ topology-management.rst | 4 ++++ 13 files changed, 52 insertions(+) diff --git a/acls.rst b/acls.rst index e2b4acd0..51022cba 100644 --- a/acls.rst +++ b/acls.rst @@ -7,6 +7,10 @@ Access Control Lists (ACL) ########################## +.. contents:: Table of Contents + :local: + :depth: 3 + Netris supports ACL-based network access control on managed switch fabrics. Each entry you configure — an ACL entry — matches traffic by source and destination IP address, port or port range, and protocol, and applies a Permit or Deny action. .. image:: images/acl-main-view.png diff --git a/bluefield-3-dpus.rst b/bluefield-3-dpus.rst index d24286e0..9449e8e4 100644 --- a/bluefield-3-dpus.rst +++ b/bluefield-3-dpus.rst @@ -3,6 +3,10 @@ BlueField-3 DPU Support in Netris ================================== +.. contents:: Table of Contents + :local: + :depth: 2 + Overview -------- diff --git a/dhcp-and-dhcp-relay.rst b/dhcp-and-dhcp-relay.rst index 1b3b07dc..86b1b796 100644 --- a/dhcp-and-dhcp-relay.rst +++ b/dhcp-and-dhcp-relay.rst @@ -7,6 +7,10 @@ DHCP and DHCP Relay ==================== +.. contents:: Table of Contents + :local: + :depth: 3 + L2VPN routed V-Nets (where an IP gateway is added) may also be configured with a DHCP service fully managed by Netris and hosted on SoftGate. DHCP Option Sets diff --git a/installation/controller-k3s-air-gap-ha.rst b/installation/controller-k3s-air-gap-ha.rst index 519c1c0d..cf35d42d 100644 --- a/installation/controller-k3s-air-gap-ha.rst +++ b/installation/controller-k3s-air-gap-ha.rst @@ -4,6 +4,10 @@ Installing HA Netris Controller in Air-Gapped Environments =========================================================== +.. contents:: Table of Contents + :local: + :depth: 4 + Why Air-Gapped Installation? ---------------------------- In many production or regulated environments, network connectivity is tightly restricted for security or compliance reasons. An **air-gapped** environment prevents unauthorized external access and ensures no reliance on external artifact repositories. All required components—binaries, container images, and Helm charts—are transferred manually (e.g., via USB, secure copy) and installed entirely offline. This approach: diff --git a/installation/ztp.rst b/installation/ztp.rst index a6a2f569..cd97abca 100644 --- a/installation/ztp.rst +++ b/installation/ztp.rst @@ -5,6 +5,10 @@ Zero Touch Provisioning (ZTP) ############################## +.. contents:: Table of Contents + :local: + :depth: 3 + Overview ======== diff --git a/inventory-profile.rst b/inventory-profile.rst index 25803852..33d5785b 100644 --- a/inventory-profile.rst +++ b/inventory-profile.rst @@ -6,6 +6,10 @@ Inventory Profiles ================== +.. contents:: Table of Contents + :local: + :depth: 2 + Overview ======== diff --git a/ipam.rst b/ipam.rst index c38ea46e..2d38fa8a 100644 --- a/ipam.rst +++ b/ipam.rst @@ -7,6 +7,10 @@ IP Address Management (IPAM) ============================ +.. contents:: Table of Contents + :local: + :depth: 2 + Netris IPAM is the address-space source of truth every address-consuming object in Netris depends on: V-Net gateways and DHCP pools, NAT and L4 Load Balancer address pools, switch and SoftGate loopback and management IPs, and BGP route advertisement all draw from subnets created here first. Allocations and subnets are tracked per VPC in a nested, tree-like structure, and each subnet's purpose and tenant determine which services are allowed to consume it. diff --git a/lag.rst b/lag.rst index e0d85406..226a2517 100644 --- a/lag.rst +++ b/lag.rst @@ -5,6 +5,10 @@ Link Aggregation (LAG) ====================== +.. contents:: Table of Contents + :local: + :depth: 2 + Link Aggregation (LAG), also known as link bundling, Ethernet/network/NIC bonding, or port teaming, is a method of combining (aggregating) multiple network connections in parallel to increase throughput beyond what a single connection could sustain and to provide redundancy in case one of the links fails. .. image:: images/lag_diagram.png diff --git a/monitoring-observability/visibility.rst b/monitoring-observability/visibility.rst index c9b8813e..8462ef7a 100644 --- a/monitoring-observability/visibility.rst +++ b/monitoring-observability/visibility.rst @@ -5,6 +5,10 @@ Graph Boards ********************** +.. contents:: Table of Contents + :local: + :depth: 2 + Graph Boards ============ diff --git a/nat.rst b/nat.rst index 4697ed9a..af64ae63 100644 --- a/nat.rst +++ b/nat.rst @@ -7,6 +7,10 @@ NAT ====================== +.. contents:: Table of Contents + :local: + :depth: 2 + If you utilize private address space for your hosts, you may need a NAT service to enable internet access. Netris SoftGate nodes are required for NAT (Network Address Translation) functionality to work and support SNAT and DNAT features. .. note:: diff --git a/netris-ufm-integration.rst b/netris-ufm-integration.rst index 88c6c0ad..08fe6727 100644 --- a/netris-ufm-integration.rst +++ b/netris-ufm-integration.rst @@ -5,6 +5,10 @@ NVIDIA UFM (InfiniBand) Integration Plugin for Netris Controller ################################################################ +.. contents:: Table of Contents + :local: + :depth: 4 + Overview ======== diff --git a/site.rst b/site.rst index eea7feba..a16f5232 100644 --- a/site.rst +++ b/site.rst @@ -2,6 +2,10 @@ Netris Site ############## +.. contents:: Table of Contents + :local: + :depth: 2 + Overview -------- diff --git a/topology-management.rst b/topology-management.rst index b2767a25..daee1cf4 100644 --- a/topology-management.rst +++ b/topology-management.rst @@ -6,6 +6,10 @@ Inventory ========= +.. contents:: Table of Contents + :local: + :depth: 2 + The Inventory section allows you to add/edit/delete network switches and SoftGates (VPC gateways). Initial setup of a Netris managed network is a three step process: #. Create :doc:`inventory-profile`. From 20878e26cb2e07447cd9bb9a15cf6438f2fdadbd Mon Sep 17 00:00:00 2001 From: Andrey Khomyakov Date: Wed, 16 Sep 2026 14:36:33 -0700 Subject: [PATCH 2/2] Add RHEL 9.8 as supported OS for controller --- installation/controller-k3s-air-gap-ha.rst | 2 +- supported-switch-hardware.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/installation/controller-k3s-air-gap-ha.rst b/installation/controller-k3s-air-gap-ha.rst index cf35d42d..19894d16 100644 --- a/installation/controller-k3s-air-gap-ha.rst +++ b/installation/controller-k3s-air-gap-ha.rst @@ -94,7 +94,7 @@ Steps to Install 1.1 Transfer the File to the Servers """""""""""""""""""""""""""""""""""" -Use a secure copy method (e.g., SCP, USB drive) to move the netris-controller-ha-v4.x.x.tar.gz file to all your **three** targets Ubuntu 24.04 (or supported Linux) nodes. +Use a secure copy method (e.g., SCP, USB drive) to move the netris-controller-ha-v4.x.x.tar.gz file to all your **three** target nodes running Ubuntu 24.04 or RHEL 9.8. 1.2 Extract the Tarball diff --git a/supported-switch-hardware.rst b/supported-switch-hardware.rst index 60359fc4..977e0374 100644 --- a/supported-switch-hardware.rst +++ b/supported-switch-hardware.rst @@ -5,7 +5,7 @@ Hardware Requirements Netris Controller ================= -The Netris Controller requires at least three (for HA) Ubuntu 24.04 bare-metal servers with the specs below. HA Netris Controller can run in both air-gapped and Internet-accessible environments. +The Netris Controller requires at least three (for HA) bare-metal servers running Ubuntu 24.04 or RHEL 9.8 with the specs below. HA Netris Controller can run in both air-gapped and Internet-accessible environments. .. list-table:: :header-rows: 0