Simon Bärlocher 3236ca332f

docs(collection): document all roles and fix metadata drift

Replace ansible-galaxy init placeholders across the collection and
correct documentation that drifted from the code, after a multi-agent
review of every role README against its defaults, tasks and templates.

Collection level:
- README: role table for all 16 roles, requirements and role-ordering
- galaxy.yml: declare community.docker and community.general deps,
  real description/tags/urls; normalize license to MIT-0
- meta/runtime.yml: requires_ansible '>=2.15.0'
- plugins/README: document the homarr_layout filter and
  garage_credentials lookup instead of scaffold boilerplate

Per-role meta/main.yml and README for the placeholder roles
(389ds, authentik, authentik_outpost_ldap, base, collabora, drawio,
garage, homarr, httpbin, keycloak, nextcloud, opencloud, traefik).

Correctness fixes found during review:
- keycloak: wrong domain default, drop invented keycloak_cert_resolver,
  document the provisioning feature
- garage: root_domain is .s3.<first-entry>, not the bare domain
- opnform: jwt/front_api secrets use `openssl rand -hex 32`; align the
  validation fail_msg in tasks/main.yml accordingly
- send: S3 example references garage_s3_domains[0] (was singular)
- opencloud: document required opencloud_wopi_domain

License normalized to MIT-0 across galaxy.yml, role meta and READMEs to
match the SPDX headers.

2026-05-27 23:12:24 +02:00

1.5 KiB

Raw Blame History

base

Host baseline for the Digitalboard platform. Installs Docker (engine, CLI, containerd, buildx, compose plugin) and a small set of apt and convenience packages on Debian/Ubuntu, and sets the shared directory layout every other role builds on.

This role is intended to run first on every host, before any service role.

What it does

Installs Docker prerequisites (apt-transport-https, ca-certificates, curl, gnupg, lsb-release, apache2-utils for htpasswd) plus convenience packages (htop, ncdu, vim) and Docker itself (docker-ce, docker-ce-cli, containerd.io, docker-buildx-plugin, docker-compose-plugin).
Optionally configures Docker registry mirrors via /etc/docker/daemon.json.
Starts and enables the Docker service and writes a custom /etc/motd.

This role defines the shared directory-layout variables (docker_compose_base_dir, docker_volume_base_dir) that every service role consumes, but the per-service subdirectories are created by the respective service roles, not here.

Role variables

Variable	Default	Description
`docker_compose_base_dir`	`/etc/docker/compose`	Root directory for per-service Compose projects.
`docker_volume_base_dir`	`/srv/data`	Root directory for per-service persistent volumes.
`docker_registry_mirrors`	`[]`	Optional list of registry mirror URLs; empty disables mirrors.

Example

- hosts: all
  become: true
  roles:
    - digitalboard.core.base

License

MIT-0

1.5 KiB Raw Blame History