From 43c2a0d9b0d429e724a60118fa17dd17892d54b5 Mon Sep 17 00:00:00 2001 From: JMoVS Date: Sun, 24 Apr 2022 16:51:22 +0200 Subject: [PATCH] docs: clarity on the section that covers more complex setups closes https://github.com/zrepl/zrepl/pull/596 --- docs/configuration/overview.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/configuration/overview.rst b/docs/configuration/overview.rst index 3c4582a..8d3c050 100644 --- a/docs/configuration/overview.rst +++ b/docs/configuration/overview.rst @@ -243,10 +243,8 @@ Limitations This is temporary and being worked on :issue:`24`. -.. _jobs-multiple-jobs: - -Multiple Jobs & More than 2 Machines ------------------------------------- +Caveats With Complex Setups (More Than 2 Jobs or Machines) +---------------------------------------------------------- Most users are served well with a single sender and a single receiver job. This section documents considerations for more complex setups. @@ -262,7 +260,7 @@ This section documents considerations for more complex setups. If you can't find your desired configuration, have questions or would like to see improvements to multi-job setups, please `open an issue on GitHub `_. -Multiple Jobs on one Machine +Multiple Jobs on One Machine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ As a general rule, multiple jobs configured on one machine **must operate on disjoint sets of filesystems**. Otherwise, concurrently running jobs might interfere when operating on the same filesystem. @@ -281,7 +279,7 @@ On your setup, ensure that This scenario is detailed in one of the :ref:`quick-start guides `. -More Than 2 Machines +Two Or More Machines ^^^^^^^^^^^^^^^^^^^^ This section might be relevant to users who wish to *fan-in* (N machines replicate to 1) or *fan-out* (replicate 1 machine to N machines).