Funkwhale ArchitectureΒΆ

Compose 🐳¢

flowchart LR
    subgraph role [web-app-funkwhale]
        svc_celeryworker["celeryworker<br>built here"]
        svc_celerybeat["celerybeat<br>built here"]
        svc_api["api<br>funkwhale/api:2.0.13<br>http 5000"]
        svc_front["front<br>built here"]
        svc_typesense["typesense<br>typesense/typesense:30.2"]
        svc_migrate["migrate<br>built here"]
    end

Swarm 🐝¢

flowchart LR
    svc_celeryworker["celeryworker"]
    svc_celeryworker --> rep_celeryworker["replicas: from the host group"]
    svc_celeryworker --> plc_celeryworker["node.role == manager"]:::pinned
    svc_celerybeat["celerybeat"]
    svc_celerybeat --> rep_celerybeat["replicas: from the host group"]
    svc_celerybeat --> plc_celerybeat["node.role == manager"]:::pinned
    svc_api["api"]
    svc_api --> rep_api["replicas: from the host group"]
    svc_api --> plc_api["node.role == manager"]:::pinned
    svc_front["front"]
    svc_front --> rep_front["replicas: from the host group"]
    svc_front --> plc_front["node.role == manager"]:::pinned
    svc_typesense["typesense"]
    svc_typesense --> rep_typesense["replicas: from the host group"]
    svc_typesense --> plc_typesense["node.role == manager"]:::pinned
    svc_migrate["migrate"]
    svc_migrate --> rep_migrate["replicas: 1"]
    svc_migrate --> plc_migrate["node.role == manager"]:::pinned
    classDef pinned fill:#fef7e0,stroke:#b06000,color:#3d2600;

VolumesΒΆ

flowchart LR
    vol_media["funkwhale_media"]
    vol_media -->|"role is manager-pinned"| local_media["node-local on the manager"]:::local
    vol_music["funkwhale_music"]
    vol_music -->|"role is manager-pinned"| local_music["node-local on the manager"]:::local
    vol_static["funkwhale_static"]
    vol_static -->|"role is manager-pinned"| local_static["node-local on the manager"]:::local
    vol_typesense_data["funkwhale_typesense_data"]
    vol_typesense_data -->|"role is manager-pinned"| local_typesense_data["node-local on the manager"]:::local
    classDef shared fill:#e6f4ea,stroke:#137333,color:#0b2e13;
    classDef local fill:#fef7e0,stroke:#b06000,color:#3d2600;

Condition

Effect

swarm, storage.backend: nfs, no nfs: false, role not pinned

shared over NFS

any one of those missing

node-local

All four conditions must hold, so pinning a role takes every one of its volumes node-local. Only the role’s primary entry counts as pinned here: a placement on any other service pins that service alone and leaves the backing of every volume unchanged. The chain is drawn rather than its result, because that coupling is what makes a placement change move data without saying so.

DependenciesΒΆ

flowchart LR
    subgraph deps [Dependencies]
        dep_svc_bkp_volume_2_local["svc-bkp-volume-2-local πŸ’»"]
        dep_svc_db_openldap["svc-db-openldap 🐳🐝"]
        dep_svc_db_postgres["svc-db-postgres 🐳🐝"]
        dep_svc_db_redis["svc-db-redis 🐳🐝"]
        dep_svc_db_typesense["svc-db-typesense 🐳🐝"]
        dep_svc_net_tor["svc-net-tor 🐳🐝"]
        dep_web_app_dashboard["web-app-dashboard 🐳🐝"]
        dep_web_app_docs["web-app-docs 🐳🐝"]
        dep_web_app_keycloak["web-app-keycloak 🐳🐝"]
        dep_web_app_matomo["web-app-matomo 🐳🐝"]
        dep_web_app_prometheus["web-app-prometheus 🐳🐝"]
        dep_web_app_stalwart["web-app-stalwart 🐳🐝"]
        dep_web_svc_design["web-svc-design πŸ’»"]
        dep_web_svc_logout["web-svc-logout 🐳🐝"]
        dep_web_svc_seaweedfs["web-svc-seaweedfs 🐳🐝"]
    end
    subgraph role [web-app-funkwhale 🐳🐝]
        svc_funkwhale["funkwhale"]
        svc_api["api"]
        svc_migrate["migrate"]
        svc_typesense["typesense"]
        svc_logout["logout"]
        svc_ldap["ldap"]
        svc_dashboard["dashboard"]
        svc_matomo["matomo"]
        svc_email["email"]
        svc_redis["redis"]
        svc_postgres["postgres"]
        svc_minio["minio ❌"]
        svc_seaweedfs["seaweedfs"]
        svc_sso["sso"]
        svc_design["design"]
        svc_prometheus["prometheus"]
        svc_tor["tor"]
        svc_container_backup["container_backup"]
        svc_docs["docs"]
    end
    dep_svc_bkp_volume_2_local -. "0..1" .-> svc_container_backup
    dep_svc_db_openldap -. "0..1" .-> svc_ldap
    dep_svc_db_postgres -. "0..1" .-> svc_postgres
    dep_svc_db_redis -. "0..1" .-> svc_redis
    dep_svc_db_typesense -. "0..1" .-> svc_typesense
    dep_svc_net_tor -. "0..1" .-> svc_tor
    dep_web_app_dashboard -. "0..1" .-> svc_dashboard
    dep_web_app_docs -. "0..1" .-> svc_docs
    dep_web_app_keycloak -. "0..1" .-> svc_sso
    dep_web_app_matomo -. "0..1" .-> svc_matomo
    dep_web_app_prometheus -. "0..1" .-> svc_prometheus
    dep_web_app_stalwart -. "0..1" .-> svc_email
    dep_web_svc_design -. "0..1" .-> svc_design
    dep_web_svc_logout -. "0..1" .-> svc_logout
    dep_web_svc_seaweedfs -. "0..1" .-> svc_seaweedfs

Symbol

Meaning

1:1 solid

fixed relationship

0..1 dashed

conditional, enabled only in matching deployments

0..0 red

declared but turned off in this role

πŸ’»

deploys to the host

🐳

deploys under compose

🐝

deploys under swarm

❌

service explicitly turned off

βš™οΈ

Ansible role dependency from meta/main.yml

Every dependency and dependent is listed; the graph is not truncated.