Skip to content

docs: point the comments at the modules they mean #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cigamit merged 1 commit into from
Sep 22, 2026
Merged

docs: point the comments at the modules they mean #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions alternative/docker-compose/config/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion alternative/docker-compose/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions alternative/podman/config/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion alternative/services/roles/ascender_config/tasks/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions alternative/services/roles/ascender_config/templates/settings.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down