From: Fabian Grünbichler Date: Fri, 9 Sep 2022 11:18:08 +0000 (+0200) Subject: docs: adapt to pool/mirror changes X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=6f59b35dca145a752bf5a0aa2b14bcbcf000a7c2;p=proxmox-offline-mirror.git docs: adapt to pool/mirror changes Signed-off-by: Fabian Grünbichler --- diff --git a/docs/introduction.rst b/docs/introduction.rst index 00d0334..07bcfbc 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -52,17 +52,21 @@ Technical Overview Behind the scenes, one or more `pools` consisting of - a pool directory containing checksum files (e.g., `sha256/3dc7bc5f82cdcc4ea0f69dd30d5f6bb19e0ccc36f4a79c865eed0e7a370cd5e4`) -- a base directory containing directories and hardlinks to the checksum files inside the pool +- a link directory containing directories and hardlinks to the checksum files inside the pool directory -are used to store the repository contents ("snapshots") in a space-efficient way. +are used to store the repository contents ("snapshots") of repository mirrors in a space-efficient way. When adding a file, the following steps are done: first the ckecksum file(s) are added, then they -are linked under one or more paths. A garbage collect operation will iterate over all files in the -base directory and remove those, which are not (or no longer) a hardlink to any checksum files. It +are linked under one or more paths. A garbage collect operation will iterate over all files in the +link directory and remove those, which are not (or no longer) a hardlink to any checksum files. It will also remove any checksum files which have no hardlinks outside of the pool's checksum file directories. +A pool directory can be shared by multiple mirrors in order to deduplicate stored files across the +mirror boundary. For example, it is recommended to have a single pool directory (mirror base directory) +for all mirrors of Proxmox repositories. + The default config path is ``/etc/proxmox-offline-mirror.cfg``, but it can be overriden on a per command basis (for example, to allow operation as a non-root user). Use the ``--config`` CLI option or the ``PROXMOX_OFFLINE_MIRROR_CONFIG`` environment variable. diff --git a/docs/offline-mirror.rst b/docs/offline-mirror.rst index c5f03c1..ac78e9a 100644 --- a/docs/offline-mirror.rst +++ b/docs/offline-mirror.rst @@ -29,7 +29,11 @@ following command can be used: --key-path /etc/apt/trusted.gpg.d/debian-archive-bullseye-security-automatic.gpg \ --sync true \ --verify true \ - --dir /path/to/mirror/dir/debian-bullseye-security + --base-dir /path/to/mirror/base-dir + +.. note:: The `base-dir` directory can be shared by mirrors for repositories that have common + contents to avoid storing files more than once. For example, having a single base directory + for all mirrors referencing Proxmox repositories is recommended. .. note:: The `all` architecture is meant for architecture independent packages, not for all possible architectures. It is usually always sensible to add it in addition to the host-specific