diff --git a/_templates/netris-header.html b/_templates/netris-header.html index 9260eeb7..6660450b 100644 --- a/_templates/netris-header.html +++ b/_templates/netris-header.html @@ -9,6 +9,53 @@ slack_icon Join Slack + + + diff --git a/installation/controller-k3s-air-gap-ha.rst b/installation/controller-k3s-air-gap-ha.rst index 076cdd48..bfc44989 100644 --- a/installation/controller-k3s-air-gap-ha.rst +++ b/installation/controller-k3s-air-gap-ha.rst @@ -114,7 +114,7 @@ On **all three nodes** change the directory to the extracted folder. For example cd netris-controller-ha-v4.x.x -All subsequent steps in this guide assume you’re working from within this netris-controller-ha-v4.x.x/ directory. +All subsequent steps in this guide assume you're working from within this netris-controller-ha-v4.x.x/ directory. 2. Install K3s on All Nodes @@ -186,7 +186,7 @@ On the **second** and **third nodes**, update the IPs to match your environment: ./install-k3s.sh -- Replace 192.168.0.1:6443 with the first node’s IP and port. +- Replace 192.168.0.1:6443 with the first node's IP and port. - Keep 192.168.0.40 as your KubeAPI VIP. @@ -425,7 +425,7 @@ Wait until all pods are ready and in a running or completed state. kubectl get pods -n netris-controller -Look for multiple pods in Running and Completed states (e.g., mariadb, mongodb, redis, web-service, “initdb” jobs, etc.). +Look for multiple pods in Running and Completed states (e.g., mariadb, mongodb, redis, web-service, "initdb" jobs, etc.). Expected output: @@ -500,7 +500,7 @@ Expected output: 10. (Optional) Enable SSL with cert-manager ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you intend to secure the Controller via an FQDN and Let’s Encrypt (or another ACME issuer) please also install cert-manager: +If you intend to secure the Controller via an FQDN and Let's Encrypt (or another ACME issuer) please also install cert-manager: 1. Install cert-manager: @@ -651,14 +651,14 @@ On **all three nodes** change the directory to the extracted folder. For example cd netris-controller-ha-v4.x.x -All subsequent steps in this guide assume you’re working from within this netris-controller-ha-v4.x.x/ directory. +All subsequent steps in this guide assume you're working from within this netris-controller-ha-v4.x.x/ directory. 2. Steps to Upgrade Controller ------------------------------- -*If you’re only upgrading the Local Netris Repository, you can skip this section and go directly to* :ref:`Section 3` +*If you're only upgrading the Local Netris Repository, you can skip this section and go directly to* :ref:`Section 3` 2.1 Import Necessary Container Images ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -704,6 +704,14 @@ To take database snapshot run the following command on the **first node**: On the **first node** only: +.. warning:: + **Upgrading to v4.6.1?** Do not follow the manual steps below. Instead, use the automated upgrade script included in the package, which handles MariaDB cluster re-creation, database backup/restore, and MongoDB data migration automatically: + + .. code-block:: shell + + ./update-v4.6.1.sh + + The script will verify versions, prompt for confirmation, and guide you through the full upgrade. Once it completes successfully, proceed to step 3 to verify the result. 1. Upgrade the **HelmChart** manifest: diff --git a/monitoring-observability/topology-validation.rst b/monitoring-observability/topology-validation.rst index fa370ff2..5fab84d2 100644 --- a/monitoring-observability/topology-validation.rst +++ b/monitoring-observability/topology-validation.rst @@ -34,8 +34,10 @@ The JSON snippet below should be included in every server's custom field. Common { "topology-validation": { "hostname": "hgx-pod00-su0-h00", + "hostname-alias": ["abc", "system-default"], + "ignore-check-if-hostname": ["xyz", "ignore-me-hostname"], "eth1": "enp10s0", - "eth2": "enp7s0", + "eth2": [“enp456”, “enp567”, “enp212”], "eth3": "enp47s0", "eth4": "enp1s0", "eth5": "enp17s0", @@ -48,9 +50,12 @@ The JSON snippet below should be included in every server's custom field. Common } } -``topology-validation`` tells Netris to enable server-to-switch wiring validation for the given server -``"hostname": "hgx-pod00-su0-h00"`` tells Netris that the expected hostname of the server should be ``"hgx-pod00-su0-h00"`` -- so Netris will LLDP lookup for the hostname and compare to this value. -``"eth1": "enp10s0",`` lines tell Netris what should be the expected (normal) interface name (enp10s0 in this example) for the logical "eth1" in the Netris Topology. Typically, most users standardize groups of servers for interface order and names; that way, the mapping is the same for all servers in a given group (vendor/type). Typically this data is inserted through Terraform for convenience, or through the web console, one-by-one. +* ``topology-validation`` tells Netris to enable server-to-switch wiring validation for the given server +* ``"hostname": "hgx-pod00-su0-h00"`` tells Netris that the expected hostname of the server should be +* ``"hgx-pod00-su0-h00"`` -- so Netris will LLDP lookup for the hostname and compare to this value. +* ``"hostname-alias": (array of strings)`` If the server's current hostname matches any value in this list, treat it as equivalent to the main hostname for validation purposes. +* ``"ignore-check-if-hostname": (array of strings)`` If the server's current hostname matches any value in this list, skip topology validation entirely for that server. If both keys are present: ``"ignore-check-if-hostname"`` take precedence over ``"hostname-alias"``. +* ``"eth1": "enp10s0",`` lines tell Netris what should be the expected (normal) interface name (enp10s0 in this example) for the logical "eth1" in the Netris Topology. Typically, most users standardize groups of servers for interface order and names; that way, the mapping is the same for all servers in a given group (vendor/type). Typically this data is inserted through Terraform for convenience, or through the web console, one-by-one. The below screenshot demonstrates a case, from two leaf switches perspective, when two cables between two leaf switches and server NICs are miswired. diff --git a/release-notes/2.8.0.rst b/release-notes/2.8.0.rst index 8d41c7f0..fd41e003 100644 --- a/release-notes/2.8.0.rst +++ b/release-notes/2.8.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 2.8.0 .. _release_2.8.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (May/13/2020) -================================== +Netris |version| Release Notes (May/13/2020) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/2.9.0.rst b/release-notes/2.9.0.rst index 49ec8c0e..227ae4b2 100644 --- a/release-notes/2.9.0.rst +++ b/release-notes/2.9.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 2.9.0 .. _release_2.9.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Mar/5/2021) -================================== +Netris |version| Release Notes (Mar/5/2021) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/3.0.0.rst b/release-notes/3.0.0.rst index aebce053..038f83bf 100644 --- a/release-notes/3.0.0.rst +++ b/release-notes/3.0.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.0.0 .. _release_3.0.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Oct/6/2021) -================================== +Netris |version| Release Notes (Oct/6/2021) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/3.1.0.rst b/release-notes/3.1.0.rst index 168bed3b..99f3544e 100644 --- a/release-notes/3.1.0.rst +++ b/release-notes/3.1.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.1.0 .. _release_3.1.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Aug/1/2022) -================================== +Netris |version| Release Notes (Aug/1/2022) +============================================= Kubernetes was born in the public cloud, and made its way everywhere. S3 storage was born in the public cloud and made its way everywhere. The 3rd thing that is missing beyond the public cloud is the self-service VPC Networking of the public cloud. diff --git a/release-notes/3.2.0.rst b/release-notes/3.2.0.rst index c7f0cd6e..6e613afb 100644 --- a/release-notes/3.2.0.rst +++ b/release-notes/3.2.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.2.0 .. _release_3.2.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Sep/22/2022) -================================== +Netris |version| Release Notes (Sep/22/2022) +============================================= One thing missing beyond the public cloud is the self-service VPC Networking of the public cloud. Your Elastic load balancers, self-service network firewall, self-service NAT and DHCP, and self-service site-to-site VPN. diff --git a/release-notes/3.2.1.rst b/release-notes/3.2.1.rst index 26e3d7f6..62919e7a 100644 --- a/release-notes/3.2.1.rst +++ b/release-notes/3.2.1.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.2.1 .. _release_3.2.1: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Oct/05/2022) -================================== +Netris |version| Release Notes (Oct/05/2022) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/3.3.0.rst b/release-notes/3.3.0.rst index 107963ed..eebc44ed 100644 --- a/release-notes/3.3.0.rst +++ b/release-notes/3.3.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.3.0 .. _release_3.3.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Dec/05/2022) -================================== +Netris |version| Release Notes (Dec/05/2022) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/3.4.0.rst b/release-notes/3.4.0.rst index dd177c22..dd24e52b 100644 --- a/release-notes/3.4.0.rst +++ b/release-notes/3.4.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.4.0 .. _release_3.4.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Mar/06/2023) -================================== +Netris |version| Release Notes (Mar/06/2023) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/3.4.3.rst b/release-notes/3.4.3.rst index 0d1b9e26..64b3d4f8 100644 --- a/release-notes/3.4.3.rst +++ b/release-notes/3.4.3.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.4.3 .. _release_3.4.3: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Nov/09/2023) -================================== +Netris |version| Release Notes (Nov/09/2023) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/3.4.4.rst b/release-notes/3.4.4.rst index 978ea12b..6c7ce161 100644 --- a/release-notes/3.4.4.rst +++ b/release-notes/3.4.4.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.4.4 .. _release_3.4.4: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Sep/29/2023) -================================== +Netris |version| Release Notes (Sep/29/2023) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/3.5.0.rst b/release-notes/3.5.0.rst index 4ea779dd..01ac649e 100644 --- a/release-notes/3.5.0.rst +++ b/release-notes/3.5.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 3.5.0 .. _release_3.5.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Oct/24/2023) -================================== +Netris |version| Release Notes (Oct/24/2023) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/4.0.0.rst b/release-notes/4.0.0.rst index bf3e3ace..aa07ed0a 100644 --- a/release-notes/4.0.0.rst +++ b/release-notes/4.0.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 4.0.0 .. _release_4.0.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Jul/25/2023) -================================== +Netris |version| Release Notes (Jul/25/2023) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/4.1.1.rst b/release-notes/4.1.1.rst index 2f744be9..ae2409fa 100644 --- a/release-notes/4.1.1.rst +++ b/release-notes/4.1.1.rst @@ -3,11 +3,8 @@ .. |version| replace:: 4.1.1 .. _release_4.1.1: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Jan/31/2024) -================================== +Netris |version| Release Notes (Jan/31/2024) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/4.2.0.rst b/release-notes/4.2.0.rst index c95c22f4..affcce8e 100644 --- a/release-notes/4.2.0.rst +++ b/release-notes/4.2.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 4.2.0 .. _release_4.2.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (May/1/2024) -================================== +Netris |version| Release Notes (May/1/2024) +============================================ What's new in Netris |version|? ------------------------------- diff --git a/release-notes/4.3.0.rst b/release-notes/4.3.0.rst index e8a6f5ac..a7038299 100644 --- a/release-notes/4.3.0.rst +++ b/release-notes/4.3.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 4.3.0 .. _release_4.3.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (July/31/2024) -================================== +Netris |version| Release Notes (July/31/2024) +============================================= What's new in Netris |version|? ------------------------------- diff --git a/release-notes/4.5.3.rst b/release-notes/4.5.3.rst index abf9f49c..9167cf30 100644 --- a/release-notes/4.5.3.rst +++ b/release-notes/4.5.3.rst @@ -3,11 +3,8 @@ .. |version| replace:: 4.5.3 .. _release_4.5.3: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (August/27/2025) -================================== +Netris |version| Release Notes (August/27/2025) +=============================================== What's new in Netris |version|? ------------------------------- diff --git a/release-notes/4.6.0.rst b/release-notes/4.6.0.rst index 9efce783..8d81ed52 100644 --- a/release-notes/4.6.0.rst +++ b/release-notes/4.6.0.rst @@ -3,11 +3,8 @@ .. |version| replace:: 4.6.0 .. _release_4.6.0: -.. meta:: - :description: Netris Release Notes |version| - -Netris |version| (Feb/10/2026) -================================== +Netris |version| Release Notes (Feb/10/2026) +============================================ What's new in Netris |version|? -------------------------------