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 31EF61FF15E
	for <inbox@lore.proxmox.com>; Tue, 20 May 2025 13:56:44 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id 97FD71B9E7;
	Tue, 20 May 2025 13:56:43 +0200 (CEST)
Message-ID: <2860b3bd-63de-43bd-bec0-ecf7569a3ba7@proxmox.com>
Date: Tue, 20 May 2025 13:56:05 +0200
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
 Alexander Abraham <a.abraham@proxmox.com>
References: <14c0c179-6ea7-439c-a9ef-77cdaf944d9e@proxmox.com>
 <20250514164920.15675-1-a.abraham@proxmox.com>
Content-Language: en-US
From: Fiona Ebner <f.ebner@proxmox.com>
In-Reply-To: <20250514164920.15675-1-a.abraham@proxmox.com>
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.435 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_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible
 spam tricks
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
 http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
 information. [openzfs.github.io]
Subject: Re: [pve-devel] [PATCH pve-docs] fix #5644: Moved the section on ZFS
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>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>

The commit title seems to be cut off/incomplete and is missing the "v4".

Sending patches to existing threads is usually done only in exceptional
cases and almost always just for follow-ups. Please send a stand-alone
v5 next time.

Am 14.05.25 um 18:49 schrieb Alexander Abraham:
> I moved the section on creating swap partitions on ZFS between

Please avoid using "I" to describe changes in commit messages.

> the "Disk Health Monitoring" section and the "Logical Volume
> Manager" section.

> I also incorporated all suggestions Fiona
> made, except one: No comma was put before "because" because
> the subordinate clause is introduced by "because". One only
> puts commas after suboridnate clauses if these introduce a
> sentence.

This should not be part of the commit message, because this is
irrelevant for git history, which is only concerned about the final
version that actually gets applied. This is relevant to ease patch
review, so it should be put below the three dashes...

> 
> Signed-off-by: Alexander Abraham <a.abraham@proxmox.com>
> ---

...here. This will not end up in the final commit message and there's no
issue with using "I" here either.

>  local-zfs.adoc       | 42 +---------------------------------------
>  pve-swap-on-zfs.adoc | 46 ++++++++++++++++++++++++++++++++++++++++++++
>  sysadmin.adoc        |  2 ++
>  3 files changed, 49 insertions(+), 41 deletions(-)
>  create mode 100644 pve-swap-on-zfs.adoc
> 
> diff --git a/local-zfs.adoc b/local-zfs.adoc
> index c64fb27..3c9564f 100644
> --- a/local-zfs.adoc
> +++ b/local-zfs.adoc
> @@ -1,6 +1,7 @@
>  [[chapter_zfs]]
>  ZFS on Linux
>  ------------
> +
>  ifdef::wiki[]
>  :pve-toplevel:
>  endif::wiki[]

This hunk seems unrelated. If there is a reason for it, please send it
as a separate patch.

> @@ -622,47 +623,6 @@ time this value changes:
>  You *must reboot* to activate these changes.
>  ====
>  
> -
> -[[zfs_swap]]
> -SWAP on ZFS
> -~~~~~~~~~~~
> -
> -Swap-space created on a zvol may generate some troubles, like blocking the
> -server or generating a high IO load, often seen when starting a Backup
> -to an external Storage.
> -
> -We strongly recommend to use enough memory, so that you normally do not
> -run into low memory situations. Should you need or want to add swap, it is
> -preferred to create a partition on a physical disk and use it as a swap device.
> -You can leave some space free for this purpose in the advanced options of the
> -installer. Additionally, you can lower the
> -``swappiness'' value. A good value for servers is 10:
> -
> -----
> -# sysctl -w vm.swappiness=10
> -----
> -
> -To make the swappiness persistent, open `/etc/sysctl.conf` with
> -an editor of your choice and add the following line:
> -
> ---------
> -vm.swappiness = 10
> ---------
> -
> -.Linux kernel `swappiness` parameter values
> -[width="100%",cols="<m,2d",options="header"]
> -|===========================================================
> -| Value               | Strategy
> -| vm.swappiness = 0   | The kernel will swap only to avoid
> -an 'out of memory' condition
> -| vm.swappiness = 1   | Minimum amount of swapping without
> -disabling it entirely.
> -| vm.swappiness = 10  | This value is sometimes recommended to
> -improve performance when sufficient memory exists in a system.
> -| vm.swappiness = 60  | The default value.
> -| vm.swappiness = 100 | The kernel will swap aggressively.
> -|===========================================================
> -
>  [[zfs_encryption]]
>  Encrypted ZFS Datasets
>  ~~~~~~~~~~~~~~~~~~~~~~
> diff --git a/pve-swap-on-zfs.adoc b/pve-swap-on-zfs.adoc
> new file mode 100644
> index 0000000..aec3a70
> --- /dev/null
> +++ b/pve-swap-on-zfs.adoc
> @@ -0,0 +1,46 @@
> +[[zfs_swap]]
> +SWAP on ZFS
> +-----------

This section should still be part of the ZFS documentation. Only the
"Creating SWAP Partitions" part should be moved out. And the new file
should then not include "zfs" in its name.

> +
> +It is strongly recommended to not use a ZFS volume for creating a swap 

Nit: could be more direct with "Do not use a ZFS volume"

> +partition because this could lead to deadlocks. These deadlocks could 
> +cause the affected system to freeze. The OpenZFS documentation 

The three lines above all have trailing spaces.

> +footnote:[https://openzfs.github.io/openzfs-docs/Project%20and%20Community/FAQ.html#using-a-zvol-for-a-swap-device-on-linux]
> +warns about using a ZFS volume for creating a swap partition.
> +
> +[[creating_swap_partitions]]
> +Creating SWAP Partitions
> +------------------------
> +
> +We strongly recommend to use enough memory, so that you normally do not
> +run into low memory situations. Should you need or want to add swap, it is
> +preferred to create a partition on a physical disk and use it as a swap device.
> +You can leave some space free for this purpose in the advanced options of the
> +installer. Additionally, you can lower the
> +``swappiness'' value. A good value for servers is 10: 

There's a trailing space here as well. Make sure to configure your
editor so that you notice those.

> +
> +----
> +# sysctl -w vm.swappiness=10
> +----
> +
> +To make the swappiness persistent, open `/etc/sysctl.conf` with
> +an editor of your choice and add the following line:
> +
> +--------
> +vm.swappiness = 10
> +--------
> +
> +.Linux kernel `swappiness` parameter values
> +[width="100%",cols="<m,2d",options="header"]
> +|===========================================================
> +| Value               | Strategy
> +| vm.swappiness = 0   | The kernel will swap only to avoid
> +an 'out of memory' condition
> +| vm.swappiness = 1   | Minimum amount of swapping without
> +disabling it entirely.
> +| vm.swappiness = 10  | This value is sometimes recommended to
> +improve performance when sufficient memory exists in a system.
> +| vm.swappiness = 60  | The default value.
> +| vm.swappiness = 100 | The kernel will swap aggressively.
> +|===========================================================
> +
> diff --git a/sysadmin.adoc b/sysadmin.adoc
> index dd43f73..9b2db52 100644
> --- a/sysadmin.adoc
> +++ b/sysadmin.adoc
> @@ -71,6 +71,8 @@ include::pve-external-metric-server.adoc[]
>  
>  include::pve-disk-health-monitoring.adoc[]
>  
> +include::pve-swap-on-zfs.adoc[]
> +
>  include::local-lvm.adoc[]
>  
>  include::local-zfs.adoc[]



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