mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-12 05:36:40 +00:00
kevinveenbirkenbachandClaude Fable 5
da598a2d67
Add cli.build.readme.overview (make readme-index / make docs) rendering a roles overview in the root README: Name, Lifecycle, Homepage, Video, Description, Integrated with, Install. New info-media lint requires homepage + video in every invokable role's meta/info.yml (opt out via '# nocheck: info-media' in meta/main.yml); backfilled 147 roles with researched, adversarially-verified homepages and official videos. Retire the 'unsupported' lifecycle value: fold it into 'eol' as a valid live end-of-life status (shipped but untested/unmaintained) across the stage lists, symbol glossary, allow-list lint and docs. Retag confluence, jira, minio, phpldapadmin to eol and magento to pre-alpha. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Shared Utilities (utils/)
This directory contains shared Python helpers used by custom modules and plugins.
Purpose
Use utils/ for reusable code that should not be duplicated across:
library/modules,plugins/action/,plugins/filter/,plugins/lookup/.
Typical shared utilities:
- API clients,
- validation/conversion helpers,
- path and configuration helpers,
- cross-plugin/module domain logic.
- Shared HTTP(S) connection handler for multiple modules.
- Common validation or transformation functions for user input.
- Utility functions for interacting with Docker, LDAP, etc.
- Grouped helper packages such as
utils/domains/for related domain logic.
Design Guidelines
- Keep helpers focused and composable.
- Avoid side effects during import.
- Prefer explicit function/class APIs over implicit globals.
- Keep dependencies minimal so modules/plugins stay lightweight.
Example Import
from utils.domains.primary_domain import get_primary_domain
What Does Not Belong Here
- Standalone executable modules (put in
library/). - Ansible plugin entrypoints (put in
plugins/*).
References
- Module utilities: https://docs.ansible.com/ansible/latest/dev_guide/developing_module_utilities.html
- Plugin development: https://docs.ansible.com/ansible/latest/dev_guide/developing_plugins.html