Merge pull request #459 from xcp-ng/ohu/update-tools/snapshot-2

tools/update - add a new arg to handle hosting pool (physical)

Author: olivierh-pro

README.md

@@ -641,17 +641,17 @@ uv run scripts/tools.py -h
 This command performs an update operation on remote targets.
 
 ```bash
-uv run scripts/tools.py update -H primary1 primary2
+uv run scripts/tools.py update -H master1 master2
 ```
 
 For each pool target :
 
-1. Update master (primary) host of the pool:
+1. Update master 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
+2. Get other hosts of the pool
+  * Repeat step `1.` for each host
 
 **Inventory file**
 
@@ -671,8 +671,9 @@ Take a look at an example inventory file:
 ```toml
 # my_inventory.toml
 
-[all]
+[default]
 repositories = ["xcp-ng-base"]
+hosting_pool = "A"
 
 [hosts]
 
@@ -681,12 +682,14 @@ repositories = ["xcp-ng-base"]
 [hosts."ip_or_hostname-2"]
 
 repositories = ["xcp-ng-updates"]
+hosting_pool = "B"
 ```
 
 > [!IMPORTANT]
-> Config values under `servers` override values under `all`. For instance, the above inventory would produce
+> * `default` is applied to all hosts
+> * Config values under `hosts` override values under `default`. For instance, the above inventory would produce
 > the following python dict:
 >
-> `{'ip_or_hostname-1': {'repositories': ['xcp-ng-base']}, 'ip_or_hostname-2': {'repositories': ['xcp-ng-updates']}}`
+> `{'ip_or_hostname-1': {'repositories': ['xcp-ng-base'], 'hosting_pool': 'A'}, 'ip_or_hostname-2': {'repositories': ['xcp-ng-updates'], 'hosting_pool': 'B'}}`
 >
-> Using *enablerepo flag* `-e` with inventory is still possible, it won't be used though.
+> * When `--inventory` flag is present, repos passed to `-e` flag won't be considered.

lib/pool.py

@@ -17,7 +17,7 @@
 class Pool:
     """Pool
 
-    :raises NotAMasterHostError: if initial host is not a master (primary)
+    :raises NotAMasterHostError: if initial host is not a master
     """
     xe_prefix = "pool"
 
@@ -300,4 +300,4 @@ def network_named(self, network_name: str) -> str:
         return self.master.xe('network-list', {'name-label': network_name}, minimal=True)
 
 class NotAMasterHostError(Exception):
-    """Host must be a master (primary)."""
+    """Host must be a master."""

lib/tools/cli.py

@@ -17,7 +17,7 @@ def _command_update(args: argparse.Namespace) -> None:
     if args.inventory:
         inventory = load_inventory(args.inventory)
     else:
-        inventory = into_inventory(args.hosts, args.repos)
+        inventory = into_inventory(args.hosts, args.repos, args.hosting_pool)
 
     update_pools(inventory)
 
@@ -53,6 +53,12 @@ def cli() -> None:
         dest="repos",
         help="repositories to enable when updating",
     )
+    subparser_cmd_update.add_argument(
+        "-P",
+        "--hosting-pool",
+        type=HostAddress,
+        help="Address (hostname|ip) of hosting pool's master host (nested context)",
+    )
     subparser_cmd_update.set_defaults(func=_command_update)
 
     args = parser.parse_args()

lib/tools/inventory.py

@@ -11,38 +11,52 @@
 
 class HostConfig(TypedDict):
     repositories: list[str]
+    hosting_pool: HostAddress | None
 
 
-Inventory: TypeAlias = dict[HostAddress, HostConfig]
+HostConfigs: TypeAlias = dict[HostAddress, HostConfig]
 
+class Inventory(TypedDict):
+    hosts: HostConfigs
 
 def load_inventory(inventory_path: Path) -> Inventory:
     """Create an inventory object from loaded inventory file."""
-    inventory: Inventory = {}
-
     with open(inventory_path, "rb") as f:
         data = tomllib.load(f)
 
-    all = data.get("all", {})
+    default = data.get("default", {})
     hosts = data.get("hosts", [])
 
-    for server, config in hosts.items():
+    inventory_hosts: HostConfigs = {}
+    for h, config in hosts.items():
         repos = config.get("repositories", [])
-        host: HostConfig = {"repositories": repos or all.get("repositories", [])}
-        inventory[server] = host
+        hosting_pool = config.get("hosting_pool", None)
+        if hosting_pool is None:
+            hosting_pool = default.get("hosting_pool", None)
+        host: HostConfig = {
+            "repositories": repos or default.get("repositories", []),
+            "hosting_pool": hosting_pool,
+        }
+        inventory_hosts[h] = host
 
-    return inventory
+    return {
+        "hosts": inventory_hosts,
+    }
 
 
-def into_inventory(hosts: list[HostAddress], repositories: list[str]) -> Inventory:
+def into_inventory(hosts: list[HostAddress], repositories: list[str], hosting_pool: HostAddress) -> Inventory:
     """Create an inventory object from arguments.
 
     Basically, it is used as compatibility when we don't want inventory from file.
     """
-    inventory: Inventory = {}
-
+    inventory_hosts: HostConfigs = {}
     for h in hosts:
-        host: HostConfig = {"repositories": repositories or []}
-        inventory[h] = host
-
-    return inventory
+        host: HostConfig = {
+            "repositories": repositories or [],
+            "hosting_pool": hosting_pool or None,
+        }
+        inventory_hosts[h] = host
+
+    return {
+        "hosts": inventory_hosts,
+    }

lib/tools/tasks/update.py

@@ -7,40 +7,43 @@
 from concurrent.futures import ThreadPoolExecutor
 
 from lib.pool import NotAMasterHostError, Pool
+from lib.tools.inventory import Inventory
 
 from .. import logger
 
-def update_pools(inventory: dict) -> None:
+def update_pools(inventory: Inventory) -> None:
     """Updates hosts in pool(s).
 
     .. note::
 
         Every non-master hosts in inventory will be ignored
 
-    *Update master hosts declared in inventory first, then, update secondary hosts attached to each master.*
+    *Update each pool's master host declared in inventory first, then, update other hosts for each pool.*
 
     :param dict inventory:
         Each host (key) holds its own config data (values, eg: `enablerepos`).
     """
     logger.debug(f"Inventory: {inventory}")
+    inventory_hosts = inventory["hosts"]
     # init related pools
-    pools = []
-    for h in inventory:
+    pools: list[Pool] = []
+    for host in inventory_hosts:
         try:
-            p = Pool(h)
+            p = Pool(host)
             pools.append(p)
         except NotAMasterHostError:
-            logger.warning(f"[{h}] Skipping: not a master host")
+            logger.warning(f"[{host}] Skipping: not a master host")
 
+    # update master hosts
     with ThreadPoolExecutor() as executor:
         for p in pools:
-            executor.submit(p.master.update, inventory[p.master.hostname_or_ip]["enablerepos"])
+            executor.submit(p.master.update, inventory_hosts[p.master.hostname_or_ip]["repositories"])
 
-    # secondary hosts
+    # update other hosts
     with ThreadPoolExecutor() as executor:
         for p in pools:
-            # omit first item because it is a primary (master)
-            for h in p.hosts[1:]:
-                # repos are the same as the primary (master)
-                repos = inventory[p.master.hostname_or_ip]["enablerepos"]
-                executor.submit(h.update, repos)
+            # omit first item because it is the pool's master
+            for other_host in p.hosts[1:]:
+                # repos are the same as for the master host
+                repos = inventory_hosts[p.master.hostname_or_ip]["repositories"]
+                executor.submit(other_host.update, repos)