Files
computer-playbook/plugins/lookup/shared_network_key.py
T
kevinveenbirkenbachandClaude Opus 5 a05071fe78 refactor(roles): let a role declare its entity name and drop the get_ prefix
The entity name keys a role's instance directory, its compose project and its container name, and was derived only by stripping the longest matching category prefix. Two roles under different categories whose names share a suffix therefore collapse onto one entity and overwrite each other's rendered stack, which no provides: can repair.

A literal entity_name in vars/main.yml now wins over the derivation. web-app-seaweedfs-console takes its shorter name back and declares the entity seaweedfs-console, which frees the seaweedfs key in its own services map for the engine consumer and removes the provides:, covers: and alias entries that stood in for it. A new lint pairs the declaration with the primary key it has to match, because a drift between them would drop the role from the provider set in silence.

Compared across all 288 roles, exactly one entity changes, and it restores what main already keeps on disk, so no instance directory moves.

The function and the filter lose their get_ prefix. Two lints read that prefix as the discriminator between the variable and the filter that fills it; both discriminate on the pipe now. Ansible's templar resolves a filter and a same-named variable independently, verified against ansible-core 2.20.2.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-10-03 19:40:53 +02:00

61 lines
1.9 KiB
Python

"""Lookup `shared_network_key`: the compose networks key of the pre-created
``<entity>`` network of a role.
Docker compose stores that key in the ``com.docker.compose.network`` label of
every network it owns, so a caller pre-creating the network out of band has to
stamp the same value or compose will resolve the project's networks against a
claim the rendered file does not make. The key is derived from
``utils.networks.render``, which renders the file itself, so the two cannot
drift.
Examples::
- name: create the shared network
ansible.builtin.command:
argv:
- container
- network
- create
- --label
- "com.docker.compose.network={{ lookup('shared_network_key', role_id) }}"
"""
from __future__ import annotations
from typing import Any
from ansible.errors import AnsibleError
from ansible.plugins.lookup import LookupBase
from utils.networks.lookup_context import build_context, resolve_var
from utils.networks.render import shared_network_compose_key
from utils.roles.entity.name import entity_name
class LookupModule(LookupBase):
def run(
self,
terms: list[Any] | None,
variables: dict[str, Any] | None = None,
**kwargs: Any,
) -> list[str]:
if not terms or len(terms) != 1:
raise AnsibleError(
"shared_network_key lookup requires exactly one term: application_id"
)
ctx = build_context(self, variables)
application_id = str(resolve_var(ctx.templar, terms[0]))
return [
shared_network_compose_key(
application_id=application_id,
deployment_mode=ctx.deployment_mode,
registry=ctx.registry,
entity_name=entity_name,
lookup_config=ctx.lookup_config,
lookup_database=ctx.lookup_database,
node_local=bool(kwargs.get("node_local", False)),
)
]