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 [212.224.123.68])
by lore.proxmox.com (Postfix) with ESMTPS id 6DD881FF17C
for <inbox@lore.proxmox.com>; Wed, 2 Apr 2025 11:10:11 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id B9597D0E7;
Wed, 2 Apr 2025 11:09:59 +0200 (CEST)
Date: Wed, 2 Apr 2025 11:09:57 +0200
From: Gabriel Goller <g.goller@proxmox.com>
To: Christoph Heiss <c.heiss@proxmox.com>
Message-ID: <mqlwud75ugovnx3j67bhhkej53kp7boun7g26gyb7j42iuf2jx@x7miazl2j3hg>
Mail-Followup-To: Christoph Heiss <c.heiss@proxmox.com>,
Proxmox VE development discussion <pve-devel@lists.proxmox.com>
References: <20250328171340.885413-1-g.goller@proxmox.com>
<20250328171340.885413-53-g.goller@proxmox.com>
<D8W0V7A166IQ.12UUD63VWDJAA@proxmox.com>
MIME-Version: 1.0
Content-Disposition: inline
In-Reply-To: <D8W0V7A166IQ.12UUD63VWDJAA@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: 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 02.04.2025 10:49, Christoph Heiss wrote:
>On Fri Mar 28, 2025 at 6:13 PM CET, Gabriel Goller wrote:
>[..]
>> +
>> +Installation
>> +~~~~~~~~~~~~
>> +
>> +We use the FRR implementations of OpenFabric and OSPF, so first you need to
>> +install `frr` and the `frr-pythontools` package:
>
>Rather try to avoid first-person, as per our style guide [0].
>
>Could be rephrased as e.g.
>
> The FRR implementations of OpenFabric and OSPF are used, so first the
> `frr` and `frr-pythontools` packages must be installed:
>
>[0] https://pve.proxmox.com/wiki/Technical_Writing_Style_Guide#Avoid_first_person
Oops, yeah my oversight.
>> +
>> +----
>> +apt update
>> +apt install frr frr-pythontools
>> +----
>> +
>[..]
>> +
>> +[[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.
>
>Same here w.r.t. first person ("we use").
Fixed this as well.
>> +
>> +Interfaces:: Specify the interfaces used to establish peering connections with
>> +other OpenFabric nodes. Preferably select interfaces without pre-assigned IP
>> +addresses, then configure addresses in the IPv4/IPv6 column if needed. A dummy
>> +"loopback" interface with the router-id is automatically created.
>> +Interface-specific settings override the global fabric settings.
>> +
>> +The following optional parameters can be configured per interface when enabling
>> +the additional columns:
>
>Perhaps this sentence should be made a bit more prominent, e.g. as
>sub-heading? It's easy to read over it and miss it, but it's quite
>important piece of information. Especially if your not *that* familiar
>with the UI and enablable columns.
>
>There are advanced options, so hiding them by default is good IMO - just
>a bit confusing to have big headings with the option names but nowhere
>to enable them (directly).
I thought about adding section (even though this is not exactly a
different panel in the UI), e.g.,
On The Interface
^^^^^^^^^^^^^^^^
So we'd have:
OpenFabric
- On the Node
- On the Interface
- On the Fabric
and obviously the same with OSPF.
What do you think?
Thanks for looking through this!
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel