From 2ad25ee2dbbcbfca62e6b8d0f9b54cd2070662a3 Mon Sep 17 00:00:00 2001 From: Blai Peidro Date: Thu, 17 Sep 2026 02:37:06 +0200 Subject: [PATCH] docs: point the comments at the modules they mean Eight comments across five files send a reader to awx/settings/production.py and awx/settings/defaults.py to see what they are overriding. Neither path exists any more: the package rename moved them to ascender/settings/, and awx/ is a shim of one file. A comment that names a file which is not there is worse than no comment, because the reader assumes they are looking in the wrong place rather than that the note is stale. Both paths checked against the platform's main before being written. Comments only. Nothing here changes what is loaded or when. --- alternative/docker-compose/config/settings.py | 4 ++-- alternative/docker-compose/docker-compose.yml | 2 +- alternative/podman/config/settings.py | 4 ++-- alternative/services/roles/ascender_config/tasks/main.yml | 2 +- .../services/roles/ascender_config/templates/settings.py.j2 | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/alternative/docker-compose/config/settings.py b/alternative/docker-compose/config/settings.py index 2a20073..5a5db8b 100644 --- a/alternative/docker-compose/config/settings.py +++ b/alternative/docker-compose/config/settings.py @@ -1,6 +1,6 @@ # Ascender settings for the Docker Compose deployment. # -# Loaded by awx/settings/production.py after the defaults. Everything +# Loaded by ascender/settings/production.py after the defaults. Everything # deployment-specific comes from environment variables set in # docker-compose.yml (which reads them from .env), so this file is the same for # every install. Any setting that is not read-only can still be changed in the @@ -66,7 +66,7 @@ # valkey listens only on this unix socket (see config/valkey.conf), shared with # the Ascender containers through the valkey_socket volume. The image defaults -# (awx/settings/defaults.py) already point the broker (BROKER_URL), the cache +# (ascender/settings/defaults.py) already point the broker (BROKER_URL), the cache # (awx.main.cache.AWXValkeyCache) and the channel layer (channels_valkey) at # unix:///var/run/valkey/valkey.sock, so nothing is overridden here. Do not copy # upstream AWX's ansible_base / channels_redis backends into this file: the diff --git a/alternative/docker-compose/docker-compose.yml b/alternative/docker-compose/docker-compose.yml index 4835767..deb614f 100644 --- a/alternative/docker-compose/docker-compose.yml +++ b/alternative/docker-compose/docker-compose.yml @@ -34,7 +34,7 @@ x-ascender-env: &ascender-env DATABASE_PASSWORD: ${ASCENDER_PGSQL_PWD:?ASCENDER_PGSQL_PWD is not set; copy .env.example to .env or run ./setup.sh} BROADCAST_WEBSOCKET_SECRET: ${ASCENDER_WEBSOCKET_SECRET:?ASCENDER_WEBSOCKET_SECRET is not set; copy .env.example to .env or run ./setup.sh} -# awx/settings/defaults.py reads /etc/tower/SECRET_KEY and derives the channel +# ascender/settings/defaults.py reads /etc/tower/SECRET_KEY and derives the channel # layer (websocket event) encryption key from it, so every Ascender container # must see the same file. It is delivered as a compose secret from .env. x-ascender-secrets: &ascender-secrets diff --git a/alternative/podman/config/settings.py b/alternative/podman/config/settings.py index 2a20073..5a5db8b 100644 --- a/alternative/podman/config/settings.py +++ b/alternative/podman/config/settings.py @@ -1,6 +1,6 @@ # Ascender settings for the Docker Compose deployment. # -# Loaded by awx/settings/production.py after the defaults. Everything +# Loaded by ascender/settings/production.py after the defaults. Everything # deployment-specific comes from environment variables set in # docker-compose.yml (which reads them from .env), so this file is the same for # every install. Any setting that is not read-only can still be changed in the @@ -66,7 +66,7 @@ # valkey listens only on this unix socket (see config/valkey.conf), shared with # the Ascender containers through the valkey_socket volume. The image defaults -# (awx/settings/defaults.py) already point the broker (BROKER_URL), the cache +# (ascender/settings/defaults.py) already point the broker (BROKER_URL), the cache # (awx.main.cache.AWXValkeyCache) and the channel layer (channels_valkey) at # unix:///var/run/valkey/valkey.sock, so nothing is overridden here. Do not copy # upstream AWX's ansible_base / channels_redis backends into this file: the diff --git a/alternative/services/roles/ascender_config/tasks/main.yml b/alternative/services/roles/ascender_config/tasks/main.yml index e9d8a2d..8c14825 100644 --- a/alternative/services/roles/ascender_config/tasks/main.yml +++ b/alternative/services/roles/ascender_config/tasks/main.yml @@ -44,7 +44,7 @@ ascender_admin_password_effective: "{{ (_secrets.results | selectattr('item', 'equalto', 'admin_password') | first).content | b64decode | trim }}" no_log: true -# awx/settings/defaults.py reads this file and derives the channel layer +# ascender/settings/defaults.py reads this file and derives the channel layer # encryption key from it; settings.py reads it for SECRET_KEY. - name: SECRET_KEY file ansible.builtin.copy: diff --git a/alternative/services/roles/ascender_config/templates/settings.py.j2 b/alternative/services/roles/ascender_config/templates/settings.py.j2 index c4b43d9..616a0ce 100644 --- a/alternative/services/roles/ascender_config/templates/settings.py.j2 +++ b/alternative/services/roles/ascender_config/templates/settings.py.j2 @@ -1,6 +1,6 @@ # {{ ansible_managed }} # Ascender settings for the single-host (services) install. Loaded by -# awx/settings/production.py after the defaults; /etc/tower/conf.d/*.py is +# ascender/settings/production.py after the defaults; /etc/tower/conf.d/*.py is # loaded after this file. Settings defined here are read-only in the UI. import os @@ -31,7 +31,7 @@ USE_X_FORWARDED_PORT = True CLUSTER_HOST_ID = {{ ascender_node_name | to_json }} # valkey listens only on the unix socket /run/valkey/valkey.sock (see the -# ascender_valkey role). Ascender's defaults (awx/settings/defaults.py) already +# ascender_valkey role). Ascender's defaults (ascender/settings/defaults.py) already # point the broker, the cache (awx.main.cache.AWXValkeyCache) and the channel # layer (channels_valkey) at unix:///var/run/valkey/valkey.sock, which is the # same file because /var/run is a symlink to /run on EL9, so nothing is