public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 4/5] docs: local-zfs: minor cleanup and adaptation
Date: Wed, 11 May 2022 14:06:34 +0000	[thread overview]
Message-ID: <20220511140635.87279-5-s.ivanov@proxmox.com> (raw)
In-Reply-To: <20220511140635.87279-1-s.ivanov@proxmox.com>

fixes a few small glitches in the markup.

rephrases a few PVEisms (PBS will not swap when starting a backup to
an external storage)

add zstd to available compression algorithms

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
---
 docs/local-zfs.rst | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/docs/local-zfs.rst b/docs/local-zfs.rst
index 32af860f..4c4bd387 100644
--- a/docs/local-zfs.rst
+++ b/docs/local-zfs.rst
@@ -191,12 +191,12 @@ With `systemd-boot`:
 
 .. code-block:: console
 
-  # pve-efiboot-tool format <new disk's ESP>
-  # pve-efiboot-tool init <new disk's ESP>
+  # proxmox-boot-tool format <new ESP>
+  # proxmox-boot-tool init <new ESP>
 
 .. NOTE:: `ESP` stands for EFI System Partition, which is setup as partition #2 on
-  bootable disks setup by the {pve} installer since version 5.4. For details, see
-  xref:sysboot_systemd_boot_setup[Setting up a new partition for use as synced ESP].
+  bootable disks setup by the `Proxmox Backup`_ installer. For details, see
+  :ref:`Setting up a new partition for use as synced ESP <systembooting-proxmox-boot-setup>`.
 
 With `grub`:
 
@@ -254,6 +254,7 @@ The above example limits the usage to 8 GiB ('8 * 2^30^').
    configuration in `/etc/modprobe.d/zfs.conf`, with:
 
 .. code-block:: console
+
   options zfs zfs_arc_min=8589934591
   options zfs zfs_arc_max=8589934592
 
@@ -273,8 +274,7 @@ Swap on ZFS
 ^^^^^^^^^^^
 
 Swap-space created on a zvol may cause some issues, such as blocking the
-server or generating a high IO load, often seen when starting a Backup
-to an external Storage.
+server or generating a high IO load.
 
 We strongly recommend using enough memory, so that you normally do not
 run into low memory situations. Should you need or want to add swap, it is
@@ -311,18 +311,20 @@ ZFS compression
 ^^^^^^^^^^^^^^^
 
 To activate compression:
+
 .. code-block:: console
 
   # zpool set compression=lz4 <pool>
 
 We recommend using the `lz4` algorithm, since it adds very little CPU overhead.
-Other algorithms such as `lzjb` and `gzip-N` (where `N` is an integer from `1-9`
+Other algorithms such as `lzjb`, `zstd` and `gzip-N` (where `N` is an integer from `1-9`
 representing the compression ratio, where 1 is fastest and 9 is best
 compression) are also available. Depending on the algorithm and how
 compressible the data is, having compression enabled can even increase I/O
 performance.
 
 You can disable compression at any time with:
+
 .. code-block:: console
 
   # zfs set compression=off <dataset>
-- 
2.30.2





  parent reply	other threads:[~2022-05-11 14:14 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-11 14:06 [pbs-devel] [PATCH proxmox-backup 0/5] update and improve sysadmin documenation Stoiko Ivanov
2022-05-11 14:06 ` [pbs-devel] [PATCH proxmox-backup 1/5] docs: sysadmin: adapt kernel-specifics for PBS Stoiko Ivanov
2022-05-11 14:06 ` [pbs-devel] [PATCH proxmox-backup 2/5] docs: add system-booting from pve-docs Stoiko Ivanov
2022-05-11 14:06 ` [pbs-devel] [PATCH proxmox-backup 3/5] docs: system-booting: (re)add screenshots Stoiko Ivanov
2022-05-11 14:06 ` Stoiko Ivanov [this message]
2022-05-11 14:06 ` [pbs-devel] [PATCH proxmox-backup 5/5] docs: zfs: update documentation about ZED Stoiko Ivanov
2022-05-12  8:14 ` [pbs-devel] applied-series: [PATCH proxmox-backup 0/5] update and improve sysadmin documenation Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220511140635.87279-5-s.ivanov@proxmox.com \
    --to=s.ivanov@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal