Merge pull request #435 from xcp-ng/ohu/config-file/000

scripts/tools - add an inventory-like file for update command

Author: olivierh-pro

README.md

@@ -569,7 +569,7 @@ uv run scripts/tools.py -h
 This command performs an update operation on remote targets.
 
 ```bash
-uv run scripts/tools.py update primary1 primary2
+uv run scripts/tools.py update -H primary1 primary2
 ```
 
 For each primary target :
@@ -578,3 +578,41 @@ For each primary target :
 2. Update with repository manager (yum): Optionally enables repositories
 3. Reboot
 4. Get attached secondary hosts and repeats three previous steps for each secondary
+
+**Inventory file**
+
+`update` command can read an inventory file in [TOML v1.0.0](https://toml.io/en/v1.0.0) format:
+
+```bash
+uv run scripts/tools.py update -i my_inventory.toml
+```
+
+> [!NOTE]
+> You can use either `-i/--inventory` or `-H/--hosts`.
+>
+> **Above flags can't be used together**
+
+Take a look at an example inventory file:
+
+```toml
+# my_inventory.toml
+
+[all]
+enablerepos = ["xcp-ng-base"]
+
+[servers]
+
+[servers."ip_or_hostname-1"]
+
+[servers."ip_or_hostname-2"]
+
+enablerepos = ["xcp-ng-updates"]
+```
+
+> [!IMPORTANT]
+> Config values under `servers` override values under `all`. For instance, the above inventory would produce
+> the following python dict:
+>
+> `{'ip_or_hostname-1': {'enablerepos': ['xcp-ng-base']}, 'ip_or_hostname-2': {'enablerepos': ['xcp-ng-updates']}}`
+>
+> Using *enablerepo flag* `-e` with inventory is still possible, it won't be used though.

lib/tools/cli.py

@@ -4,13 +4,20 @@
 """
 import argparse
 import logging
+from pathlib import Path
 
 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
 
 def _command_update(args):
-    update_all(args.hosts, args.repos)
+    if args.inventory:
+        inventory = load_inventory(args.inventory)
+    else:
+        inventory = into_inventory(args.hosts, args.repos)
+
+    update_all(inventory)
 
 
 def cli():
@@ -27,11 +34,13 @@ def cli():
         description="Run update tasks on target(s)",
         help="Run update tasks on target(s)",
     )
-    subparser_cmd_update.add_argument(
-        "hosts", type=HostAddress, metavar="HOST", nargs="+", help="Hostname(s) or ip address(es) of target(s)"
+    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)"
     )
+    cmd_update_excl_grp.add_argument("-i", "--inventory", type=Path, help="Use an hosts inventory file")
     subparser_cmd_update.add_argument(
-        "--enablerepo",
+        "-e", "--enablerepo",
         metavar="REPO",
         action="append",
         dest="repos",

lib/tools/inventory.py

@@ -0,0 +1,40 @@
+"""Inventory for tools scripts.
+"""
+import tomllib
+from pathlib import Path
+
+from lib.common import HostAddress
+
+def load_inventory(inventory_path: Path) -> dict:
+    """Create an inventory object from loaded inventory file."""
+    inventory = {}
+
+    with open(inventory_path, "rb") as f:
+        data = tomllib.load(f)
+
+    all = data.get("all", {})
+    servers = data.get("servers", [])
+
+    for server, config in servers.items():
+        repos = config.get("enablerepos", [])
+        host = {
+            "enablerepos": repos or all.get("enablerepos", [])
+        }
+        inventory[server] = host
+
+    return inventory
+
+def into_inventory(hosts: list[HostAddress], enablerepos: list[str]) -> dict:
+    """Create an inventory object from arguments.
+
+    Basically, it is used as compatibility when we don't want inventory from file.
+    """
+    inventory = {}
+
+    for h in hosts:
+        host = {
+            "enablerepos": enablerepos or [],
+        }
+        inventory[h] = host
+
+    return inventory

lib/tools/tasks/update.py

@@ -4,31 +4,28 @@
 """
 from concurrent.futures import ThreadPoolExecutor
 
-from lib.common import HostAddress
 from lib.host import Host
 from lib.pool import Pool
 
 from .. import logger
 
-def update_all(master_hosts: list[HostAddress], enablerepos: list[str]) -> None:
+def update_all(inventory: dict) -> None:
     """Updates all master (primary) hosts.
 
     .. note:: Host must be a master
 
         Throws error if hosts are not master (primary).
 
-    :param :py:class:`list[lib.common.HostAddress]` master_hosts:
-        A list of hosts to update.
-    :param list[str] enablerepos:
-        Repositories to enable when updating.
+    :param dict inventory:
+        Each host (key) holds its own config data (values).
     """
-    logger.debug(f"[{master_hosts}] enablerepos: {enablerepos}")
+    logger.debug(f"Inventory: {inventory}")
     # init related pools
-    pools = [Pool(h) for h in master_hosts]
+    pools = [Pool(h) for h in inventory]
 
     with ThreadPoolExecutor() as executor:
         for p in pools:
-            executor.submit(update_host, p.master, enablerepos)
+            executor.submit(update_host, p.master, inventory[p.master.hostname_or_ip]["enablerepos"])
 
 
 def update_host(host: Host, enablerepos: list[str] = []):