tools/update: change docs to be more consistent

Function `update_all` denoted the wrong intention
because we update pools through their master host.

Signed-off-by: Olivier Hoareau <olivier.hoareau@vates.tech>

Author: olivierh-pro

README.md

@@ -572,12 +572,14 @@ This command performs an update operation on remote targets.
 uv run scripts/tools.py update -H primary1 primary2
 ```
 
-For each primary target :
-
-1. Clean cached metadata
-2. Update with repository manager (yum): Optionally enables repositories
-3. Reboot
-4. Get attached secondary hosts and repeats three previous steps for each secondary
+For each pool target :
+
+1. Update primary host of the pool:
+  * Clean cached metadata
+  * Update with repository manager (yum): Optionally enables repositories
+  * Reboot
+2. Get attached secondary hosts of the pool
+  * Repeat step `1.` for each secondary
 
 **Inventory file**
 

lib/tools/cli.py

@@ -9,15 +9,15 @@
 from lib.common import HostAddress
 from lib.tools import logger
 from lib.tools.inventory import into_inventory, load_inventory
-from lib.tools.tasks.update import update_all
+from lib.tools.tasks.update import update_pools
 
 def _command_update(args):
     if args.inventory:
         inventory = load_inventory(args.inventory)
     else:
         inventory = into_inventory(args.hosts, args.repos)
 
-    update_all(inventory)
+    update_pools(inventory)
 
 
 def cli():
@@ -31,12 +31,17 @@ def cli():
     # subparser - command: update
     subparser_cmd_update = subparsers.add_parser(
         name="update",
-        description="Run update tasks on target(s)",
-        help="Run update tasks on target(s)",
+        description="Run update tasks on target pools",
+        help="Run update tasks on target pools",
     )
     cmd_update_excl_grp = subparser_cmd_update.add_mutually_exclusive_group(required=True)
     cmd_update_excl_grp.add_argument(
-        "-H", "--hosts", type=HostAddress, metavar="HOST", nargs="+", help="Hostname(s) or ip address(es) of target(s)"
+        "-H",
+        "--hosts",
+        type=HostAddress,
+        metavar="HOST",
+        nargs="+",
+        help="Address (hostname|ip) of the master host in pool",
     )
     cmd_update_excl_grp.add_argument("-i", "--inventory", type=Path, help="Use an hosts inventory file")
     subparser_cmd_update.add_argument(

lib/tools/tasks/update.py

@@ -8,15 +8,15 @@
 
 from .. import logger
 
-def update_all(inventory: dict) -> None:
-    """Updates all master (primary) hosts.
+def update_pools(inventory: dict) -> None:
+    """Updates hosts in pool(s).
 
     .. note:: Host must be a master
 
         Throws error if hosts are not master (primary).
 
     :param dict inventory:
-        Each host (key) holds its own config data (values).
+        Each host (key) holds its own config data (values, eg: `enablerepos`).
     """
     logger.debug(f"Inventory: {inventory}")
     # init related pools