CLOS-4056: Tighten CLN-related actor comments and clarifications

Author: prilr

repos/system_upgrade/cloudlinux/actors/checkrhnversionoverride/actor.py

@@ -20,11 +20,9 @@ class CheckRhnVersionOverride(Actor):
     @run_on_cloudlinux
     def process(self):
         if not is_cln_package_channel_active():
-            # CLOS-4056: versionOverride only matters when CLN is delivering
-            # packages - the upgrade rewrites it to drive channel selection.
-            # On no-auth (SWNG) systems the package channel is cl-channel,
-            # not CLN, so there is nothing to inspect or warn about even if
-            # /etc/sysconfig/rhn/up2date is still present from registration.
+            # CLOS-4056: versionOverride only matters when CLN is delivering packages,
+            # since the upgrade rewrites it to drive channel selection.
+            # On no-auth systems this does not apply.
             return
 
         up2date_config = '/etc/sysconfig/rhn/up2date'

repos/system_upgrade/cloudlinux/actors/enableyumspacewalkplugin/libraries/enableyumspacewalkplugin.py

@@ -10,10 +10,11 @@
     ParserClass = configparser.ConfigParser
 
 
-# DNF plugin config path on the target system (CL8). FirstBoot runs after the
-# target OS is already in place; on CL8 the plugin package is
-# dnf-plugin-spacewalk (PES replacement for CL7's yum-rhn-plugin,
-# pes-events id=1586) and its config ships with enabled=0.
+# DNF plugin config path on the target system (CL8).
+# FirstBoot runs after the target OS is already in place;
+# on CL8 the plugin package is dnf-plugin-spacewalk
+# (PES replacement for CL7's yum-rhn-plugin, pes-events id=1586)
+# and its config ships with enabled=0.
 DEFAULT_CONFIG_PATH = '/etc/dnf/plugins/spacewalk.conf'
 
 
@@ -24,8 +25,8 @@ def _enable_plugin(config_path, parser_cls=ParserClass, log=None):
     when the plugin is not installed, and otherwise a human-readable
     problem description suitable for a Leapp report.
 
-    Absence of `config_path` is treated as a silent skip: on no-auth /
-    SWNG systems (CLOS-4056) `rhn-client-tools >= 3.0.1` Obsoletes the
+    Absence of `config_path` is treated as a silent skip: on no-auth
+    systems (CLOS-4056) `rhn-client-tools >= 3.0.1` Obsoletes the
     `dnf-plugin-spacewalk` package, so the config file is either gone by
     then, or doesn't do anything.
     """

repos/system_upgrade/cloudlinux/actors/enableyumspacewalkplugin/tests/test_enableyumspacewalkplugin.py

@@ -17,10 +17,9 @@ def _write(tmp_path, body):
 def test_missing_config_is_silent_skip(tmp_path):
     """Config file absent -> silent skip: no change, no title, no report.
 
-    On no-auth / SWNG systems (CLOS-4056) the dnf-plugin-spacewalk
-    package is Obsoleted by rhn-client-tools >= 3.0.1 and the config
-    file is absent by design. Emitting a 'not found' report there
-    would be noise.
+    On no-auth systems (CLOS-4056) the dnf-plugin-spacewalk
+    package is Obsoleted by rhn-client-tools >= 3.0.1.
+    Emitting a 'not found' report there would be noise.
     """
     changed, title = _enable_plugin(str(tmp_path / "absent.conf"), ParserClass)
     assert changed is False

repos/system_upgrade/cloudlinux/actors/pinclnmirror/actor.py

@@ -27,10 +27,8 @@ class PinClnMirror(Actor):
     def process(self):
         """Pin CLN mirror"""
         if not is_cln_package_channel_active():
-            # CLOS-4056: pinning the CLN mirror is only meaningful when CLN
-            # is delivering packages. On no-auth (SWNG) systems packages come
-            # from cl-channel via mirrorlist, so there is nothing to pin -
-            # registration may still be in place but is irrelevant here.
+            # CLOS-4056: pinning the CLN mirror is only meaningful when CLN is delivering packages.
+            # With the no-auth repo scheme active, there's no point in doing so.
             api.current_logger().info(
                 "CLN is not the active package channel; skipping mirror pinning"
             )

repos/system_upgrade/cloudlinux/actors/resetrhnversionoverride/actor.py

@@ -18,10 +18,9 @@ class ResetRhnVersionOverride(Actor):
     @run_on_cloudlinux
     def process(self):
         if not is_cln_package_channel_active():
-            # CLOS-4056: versionOverride is only set/used by the CLN package
-            # channel flow. If the system isn't on CLN for packages, leave
-            # /etc/sysconfig/rhn/up2date alone - registration metadata there
-            # is not ours to touch.
+            # CLOS-4056: versionOverride only matters when CLN is delivering packages,
+            # since the upgrade rewrites it to drive channel selection.
+            # On no-auth systems this does not apply.
             return
 
         up2date_config = '/etc/sysconfig/rhn/up2date'

repos/system_upgrade/cloudlinux/actors/switchclnchannel/actor.py

@@ -24,11 +24,9 @@ class SwitchClnChannel(Actor):
     @run_on_cloudlinux
     def process(self):
         if not is_cln_package_channel_active():
-            # CLOS-4056: CLN is no longer the package channel here (no-auth /
-            # SWNG mode). Skipping the channel switch is correct - packages
-            # come from cl-channel / cloudlinux9-baseos instead. The system
-            # may still be CLN-registered for licensing; that is a separate
-            # concern this actor does not need to manage.
+            # CLOS-4056: CLN package channel is inactive, so skipping the channel switch
+            # is correct - packages come from standard repositories instead.
+            # Leapp manages those without custom actions through repomaps.
             api.current_logger().info(
                 "CLN is not the active package channel; skipping channel switch"
             )
@@ -37,10 +35,9 @@ def process(self):
         try:
             cln_switch(target=int(get_target_major_version()))
         except CalledProcessError as e:
-            # CLOS-4056: Do not inhibit. Even on systems that ARE using CLN
-            # as the package channel, a transient CLN-server reachability
-            # problem at FirstBoot (DNS/network not up yet) shouldn't block
-            # the upgrade - the no-auth fallback repos still serve packages.
+            # Do not inhibit. Even on systems that ARE using CLN as the package channel,
+            # a transient CLN-server reachability problem at FirstBoot
+            # shouldn't block the upgrade.
             reporting.create_report(
                 [
                     reporting.Title(

repos/system_upgrade/cloudlinux/actors/unpinclnmirror/actor.py

@@ -22,8 +22,7 @@ class UnpinClnMirror(Actor):
     def process(self):
         if not is_cln_package_channel_active():
             # CLOS-4056: pinclnmirror skipped its work for the same reason
-            # (CLN is not the package channel here), so there is nothing
-            # for us to unpin.
+            # (CLN package channel inactive), so there is nothing for us to unpin.
             return
 
         target_userspace = get_target_userspace_path()

repos/system_upgrade/cloudlinux/libraries/cln_detect.py

@@ -2,24 +2,24 @@
 
 CLN has historically combined two concerns:
 
-  1. **Registration / identity** - the system is registered with the CLN
-     server (`/etc/sysconfig/rhn/systemid`, JWT token), used for licensing
-     and inventory regardless of how packages are delivered.
+1. *Registration / identity* - the system is registered with the CLN
+server (`/etc/sysconfig/rhn/systemid`, JWT token), used for licensing
+regardless of how packages are delivered.
 
-  2. **Package delivery** - the system pulls CloudLinux packages through
-     the spacewalk DNF/YUM plugin against the CLN-side channel
-     (`cloudlinux-x86_64-server-N`).
+2. *Package delivery* - the system pulls CloudLinux packages
+through the spacewalk DNF/YUM plugin against the
+CLN-side channel (`cloudlinux-x86_64-server-N`).
 
-The no-auth (SWNG) transition decouples these. New CL8 and CL9 systems
-keep CLN **registration** but no longer use CLN as the **package
-channel** - packages come from the SWNG mirrorlist via
-`/etc/yum.repos.d/cl.repo` (`cl-channel`) instead. `rhn-client-tools
->= 3.0.1` disables the spacewalk plugin to enforce this.
+The no-auth repository transition decouples these.
+New CL8 and CL9 systems keep CLN *registration*,
+but no longer use CLN as the *package channel* - packages come from the SWNG mirrorlist
+via `/etc/yum.repos.d/cl.repo` (`cl-channel`) instead.
+`rhn-client-tools >= 3.0.1` disables the spacewalk plugin to enforce this.
 
 The CLN-touching actors in this repo only care about the second concern:
-they exist to make the CLN package channel work during ELevate. On
-systems where the channel has been switched off they should stand down
-even though registration may still be present and valid.
+they exist to make the CLN package channel work during ELevate.
+On systems where the channel has been switched off they should stand down,
+regardless of registration state.
 
 CLOS-4056: gate those actors on `is_cln_package_channel_active()`.
 """