From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
	by lore.proxmox.com (Postfix) with ESMTPS id B0C2D1FF16E
	for <inbox@lore.proxmox.com>; Mon, 31 Mar 2025 14:25:05 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id 09C2C3245;
	Mon, 31 Mar 2025 14:24:55 +0200 (CEST)
Date: Mon, 31 Mar 2025 14:24:21 +0200
From: Gabriel Goller <g.goller@proxmox.com>
To: Shannon Sterz <s.sterz@proxmox.com>
Message-ID: <mray7o47uv6ndfud5fzsp6rhcvctwdjhwx5tfxul74kmargi7p@3ummcuvb37ab>
Mail-Followup-To: Shannon Sterz <s.sterz@proxmox.com>, 
 Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
 pve-devel <pve-devel-bounces@lists.proxmox.com>
References: <20250328171340.885413-1-g.goller@proxmox.com>
 <20250328171340.885413-53-g.goller@proxmox.com>
 <D8UBHZP29Y1F.3P978YHUL3Q1E@proxmox.com>
MIME-Version: 1.0
Content-Disposition: inline
In-Reply-To: <D8UBHZP29Y1F.3P978YHUL3Q1E@proxmox.com>
User-Agent: NeoMutt/20241002-35-39f9a6
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.024 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
Subject: Re: [pve-devel] [PATCH pve-docs 1/1] fabrics: add initial
 documentation for sdn fabrics
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Cc: pve-devel <pve-devel-bounces@lists.proxmox.com>,
 Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"; Format="flowed"
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>

On 31.03.2025 10:44, Shannon Sterz wrote:
>On Fri Mar 28, 2025 at 6:13 PM CET, Gabriel Goller wrote:
>> [snip]

I agree with everthing above.

>> +
>> +Router-ID Selection
>> +^^^^^^^^^^^^^^^^^^^
>> +
>> +Each node in a fabric needs a unique router ID, which is an IPv4 (or IPv6 in
>> +OpenFabric) address in dotted-decimal notation (e.g., 192.168.1.1).
>
>does this apply to v6 too? i've never seen IPv6 represented in dotted
>decimal notation. imo if you mention IPv6 here, you should specify it's
>representation. maybe:
>
>Each node in a fabric needs a unique router ID, which is an IPv4 address
>in dotted decimal notation (e.g. 192.168.1.1). In OpenFabric this can
>also be an IPv6 address in the typical hexadecimal representation
>separated by colons (e.g., 2001:db8::1428:57ab).

Oops, yeah I forgot this.

>> [snip]
>> +Name:: This is the name of the OpenFabric fabric and can be at most 8 characters long.
>> +
>> +Loopback Prefix:: CIDR (IPv4 or IPv6) network range (e.g., 10.0.0.0/24) used to verify that
>> +all router-IDs in the fabric are contained within this prefix.
>> +
>> +Hello Interval:: Controls how frequently (in seconds) hello packets are sent to
>> +discover and maintain connections with neighboring nodes. Lower values detect
>> +failures faster but increase network traffic. If empty, the default value will
>
>what is the default value? would it make sense to mention that here?

I decided against using default values as I wanted FRR to handle them.
We also don't set default-options in the FRR config, but just delete the
property and let FRR handle it.

Maybe I could write the: "the default FRR value will be used"?

>> +be used. This option is global on the fabric, meaning every interface on every
>> +node in this fabric will inherit this hello-interval property.
>> +
>> +[[pvesdn_openfabric_node]]
>> +On the Node
>> +^^^^^^^^^^^
>> +
>> +Node:: Select the node which will be added to the fabric. Only nodes that
>> +currently are in the cluster will be shown.
>> +
>> +Router-ID:: A unique IPv4 or IPv6 address used to generate the OpenFabric
>> +Network Entity Title (NET). Each node in the same fabric must have a different
>> +Router-ID, while a single node must use the same NET address across all fabrics
>> +(this consistency is automatically managed by {pve}).
>> +
>> +NOTE: When using IPv6 addresses, we use the last 3 segments to generate the
>> +NET. Ensure these segments differ between nodes.
>
>would it make sense to make this a `WARNING` instead of a `NOTE`? sounds
>like this is a bit more important to get right.

yep, I agree.

>> [snip]
>> +[[pvesdn_ospf_fabric]]
>> +On the Fabric
>> +^^^^^^^^^^^^^
>> +
>> +Area:: This specifies the OSPF area identifier, which can be either an integer
>> +(i32) or an IP address. Areas are a way to organize and structure OSPF networks
>
>i32 is super intuitive for Rust programmers but "32-bit signed integer"
>would be clearer to everyone else ;)

Will fix this as well.

Thanks for looking over this! The docs are still quite spare, so I hope
I'll get around adding more stuff for the next version.


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel