Skip to content

Update release notes formatting #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akhomyakov merged 5 commits into from
Mar 11, 2026
Merged

Update release notes formatting #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9b6c24b
added v4.6.1 update waring
pogossian Mar 5, 2026
4806596
Add topology validation aliases
Mar 9, 2026
fdea39f
Fix formatting in topo validation
Mar 9, 2026
62b3667
feat: add version badge functionality to the header
Rustam-Abrahamyan Mar 9, 2026
32b6bad
Update release notes formatting
Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions _templates/netris-header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,53 @@
<img style="height: 1em;" src="{{ pathto('_static/slack.svg', 1) }}" alt="slack_icon">
Join Slack
</a>
<span id="netris-version-badge" style="display: inline-block;margin: 8px; font-size: 1.4em; font-weight: bold; color: #555; white-space: nowrap;"></span>
</span>
</span>
</div>

<script>
(function () {
function currentVersion() {
var parts = location.pathname.split("/").filter(Boolean);
if (parts[0] === "docs" && parts[1] === "en" && parts[2]) return parts[2];
return null;
}

function setVersionBadge(text) {
var badge = document.getElementById("netris-version-badge");
if (badge) badge.textContent = "You are browsing Netris User Documentation version " + text;
}

function run() {
var curr = currentVersion();
if (!curr) return;

if (curr !== "latest" && curr !== "stable") {
setVersionBadge(curr);
return;
}

fetch("/docs/versions.json", { cache: "no-store" })
.then(function (res) { return res.ok ? res.json() : null; })
.then(function (manifest) {
if (!manifest) { setVersionBadge(curr); return; }
var versions = Array.isArray(manifest.versions) ? manifest.versions : [];
var aliasEntry = versions.find(function (v) { return v.id === curr; });
if (aliasEntry && aliasEntry.title && aliasEntry.title !== curr) {
setVersionBadge(aliasEntry.title);
return;
}
var firstReal = versions.reverse().find(function (v) { return v.id !== "latest" && v.id !== "stable"; });
setVersionBadge(firstReal ? (firstReal.title || firstReal.id) : curr);
})
.catch(function () { setVersionBadge(curr); });
}

if (document.readyState === "loading") {
document.addEventListener("DOMContentLoaded", run);
} else {
run();
}
})();
</script>
20 changes: 14 additions & 6 deletions installation/controller-k3s-air-gap-ha.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.


Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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<local-repo-k3s-ha-upgrade>`
*If you're only upgrading the Local Netris Repository, you can skip this section and go directly to* :ref:`Section 3<local-repo-k3s-ha-upgrade>`

2.1 Import Necessary Container Images
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -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:

Expand Down
13 changes: 9 additions & 4 deletions monitoring-observability/topology-validation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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.
Expand Down
7 changes: 2 additions & 5 deletions release-notes/2.8.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/2.9.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.0.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.1.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.2.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.2.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.3.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.4.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.4.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.4.4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/3.5.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/4.0.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/4.1.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/4.2.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/4.3.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/4.5.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
7 changes: 2 additions & 5 deletions release-notes/4.6.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|?
-------------------------------
Expand Down
Loading