Files
computer-playbook/plugins/lookup/prometheus_integration_active.py
T
kevinveenbirkenbachandClaude Opus 4.8 238bc285c7 refactor(lookups): reach merged config via the lookup-loader SPOT
Consumer lookup plugins now reach the merged config through the Ansible
lookup loader instead of importing get_merged_applications /
get_merged_domains from utils.cache. The merge stays one cached
implementation surfaced via the applications/config/domains/users lookups;
consumers call lookup_loader.get(...).run() (the compose_networks idiom).

- get_merged_applications walks the whole meta/ tree recursively
  (meta/**/*.yml to applications.<app>.<path>, addons and any depth) and
  folds the raw meta/volumes.yml subtree onto applications.<app>.volumes
  after the templar render so the Jinja source: strings stay unrendered.
- 31 consumer lookups rerouted; providers (applications/config/
  applications_current_play/users/domains) and the raw-volume accessors
  (volume/nginx) keep the cache import behind # nocheck: lookup-cache-import.
- New lint test_no_cache_imports_in_lookups enforces the contract.
- nfs_flavor is now the flavor SPOT (svc-storage-nfs-server + nfs_client_src
  resolve via lookup('nfs_flavor')); removed the unused STORAGE_NFS_FLAVOR
  group_var. Extracted extract_default_credentials to
  utils/cache/schema_credentials.py to keep applications.py under the cap.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-28 18:35:06 +02:00

69 lines
2.2 KiB
Python

from __future__ import annotations
from typing import Any
from ansible.plugins.loader import lookup_loader
from ansible.plugins.lookup import LookupBase
class LookupModule(LookupBase):
"""
Return True when the prometheus monitoring block should be emitted for the
current application on the current host; False otherwise.
The condition satisfied:
1. 'web-app-prometheus' is in group_names (prometheus is deployed on this host), AND
2. Either the current application IS web-app-prometheus, OR it declares prometheus
as an enabled compose service dependency (services.prometheus.enabled: true).
Usage in a template:
{% if lookup('prometheus_integration_active', application_id) %}
...prometheus monitoring block...
{% endif %}
Pass 'application_id' as term 0 (string). 'applications' is obtained via
lookup('applications'), the merged-config SPOT.
"""
def run(
self,
terms: list[Any],
variables: dict[str, Any] | None = None,
**kwargs: Any,
) -> list[bool]:
vars_ = variables or getattr(self._templar, "available_variables", {}) or {}
applications = lookup_loader.get(
"applications",
loader=self._loader,
templar=getattr(self, "_templar", None),
).run([], variables=vars_)[0]
# application_id may be passed explicitly (term 0) or read from available_variables.
if terms and isinstance(terms[0], str):
application_id: str = terms[0]
else:
application_id = vars_.get("application_id", "")
group_names: list[str] = vars_.get("group_names", [])
if "web-app-prometheus" not in group_names:
return [False]
if application_id == "web-app-prometheus":
return [True]
try:
# Per services live at applications.<app>.services
# (no `compose.services` wrapper).
enabled = bool(
applications.get(application_id, {})
.get("services", {})
.get("prometheus", {})
.get("enabled", False)
)
except Exception:
enabled = False
return [enabled]