# regardsoss/regards-docker architecture

> Architecture diagram of the GitHub repository regardsoss/regards-docker, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/regardsoss/regards-docker
- Repository: https://github.com/regardsoss/regards-docker

## Overview

This repository is an Ansible deployment for the REGARDS stack on Linux servers. The intended workflow is an operator running deployment playbooks to provision Docker Swarm and configure and start REGARDS and its supporting services; separate playbooks and roles also cover shutdown and removal. The tree identifies these capability areas, but no source excerpts were provided, so their invocation order and inter-module calls cannot be verified; dashed edges indicate only this unverified workflow.

Main entry points: [`roles/regards-stack`](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack) (Stack orchestration), [`regards.yml`](https://github.com/regardsoss/regards-docker/blob/master/regards.yml) (REGARDS deployment), [`regards-config.yml`](https://github.com/regardsoss/regards-docker/blob/master/regards-config.yml) (Configuration deployment), [`regards-stack.yml`](https://github.com/regardsoss/regards-docker/blob/master/regards-stack.yml) (Stack deployment)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Deployment entrypoints"]
  node_deploy["REGARDS deployment<br/>[regards.yml]"]
  node_stack_playbook["Stack deployment<br/>[regards-stack.yml]"]
  node_config_playbook["Configuration deployment<br/>[regards-config.yml]"]
  node_plugins_playbook["Plugin deployment"]
end

subgraph group_swarm["Host and Swarm"]
  node_host_setup["Docker host setup"]
  node_swarm_init["Swarm initialization"]
  node_swarm_members["Swarm membership"]
  node_swarm_workers["Worker membership"]
  node_swarm_labels["Node labels"]
end

subgraph group_regards["REGARDS services"]
  node_stack_runtime["Stack orchestration"]
  node_microservices["REGARDS services"]
  node_plugins["Plugin workspace"]
  node_data_services["Data services"]
  node_object_storage["Object storage"]
  node_front_proxy["Front proxy"]
end

subgraph group_operations["Operations and observability"]
  node_monitoring["Monitoring"]
  node_logs["Log pipeline"]
  node_shutdown["Shutdown"]
  node_remove["Removal<br/>[regards-delete.yml]"]
end

node_operator(("Operator"))

node_operator -.->|"runs playbook"| node_deploy
node_deploy -.->|"provisions hosts"| node_host_setup
node_deploy -.->|"sets up Swarm"| node_swarm_init
node_deploy -.->|"deploys stack"| node_stack_playbook
node_stack_playbook -.->|"orchestrates stack"| node_stack_runtime
node_stack_runtime -.->|"deploys services"| node_microservices
node_stack_runtime -.->|"uses plugins"| node_plugins
node_stack_runtime -.->|"deploys services"| node_data_services
node_stack_runtime -.->|"deploys storage"| node_object_storage
node_stack_runtime -.->|"configures access"| node_front_proxy
node_config_playbook -.->|"configures monitoring"| node_monitoring
node_config_playbook -.->|"configures logging"| node_logs
node_plugins_playbook -.->|"deploys plugins"| node_plugins
node_operator -.->|"runs shutdown"| node_shutdown
node_operator -.->|"runs removal"| node_remove

click node_deploy "https://github.com/regardsoss/regards-docker/blob/master/regards.yml"
click node_stack_playbook "https://github.com/regardsoss/regards-docker/blob/master/regards-stack.yml"
click node_config_playbook "https://github.com/regardsoss/regards-docker/blob/master/regards-config.yml"
click node_plugins_playbook "https://github.com/regardsoss/regards-docker/blob/master/regards-plugins.yml"
click node_host_setup "https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-installation"
click node_swarm_init "https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-swarm-init"
click node_swarm_members "https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-manager"
click node_swarm_workers "https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-worker"
click node_swarm_labels "https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-nodes-label"
click node_stack_runtime "https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack"
click node_microservices "https://github.com/regardsoss/regards-docker/tree/master/roles/regards-microservices-workspace-local"
click node_plugins "https://github.com/regardsoss/regards-docker/tree/master/roles/regards-plugins-workspace-local"
click node_data_services "https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack-elasticsearch"
click node_object_storage "https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack-minio"
click node_front_proxy "https://github.com/regardsoss/regards-docker/tree/master/roles/regards-front"
click node_monitoring "https://github.com/regardsoss/regards-docker/tree/master/roles/regards-prometheus-config"
click node_logs "https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack-logs"
click node_shutdown "https://github.com/regardsoss/regards-docker/blob/master/regards-shutdown.yml"
click node_remove "https://github.com/regardsoss/regards-docker/blob/master/regards-delete.yml"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_deploy,node_stack_playbook,node_config_playbook,node_plugins_playbook toneBlue
class node_host_setup,node_swarm_init,node_swarm_members,node_swarm_workers,node_swarm_labels toneAmber
class node_stack_runtime,node_microservices,node_plugins,node_data_services,node_object_storage,node_front_proxy toneMint
class node_monitoring,node_logs,node_shutdown,node_remove toneRose
class node_operator toneIndigo
```

## Components

### Deployment entrypoints

- [REGARDS deployment](https://github.com/regardsoss/regards-docker/blob/master/regards.yml): `regards.yml`
- [Stack deployment](https://github.com/regardsoss/regards-docker/blob/master/regards-stack.yml): `regards-stack.yml`
- [Configuration deployment](https://github.com/regardsoss/regards-docker/blob/master/regards-config.yml): `regards-config.yml`
- [Plugin deployment](https://github.com/regardsoss/regards-docker/blob/master/regards-plugins.yml): `regards-plugins.yml`

### Host and Swarm

- [Docker host setup](https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-installation): `dependencies/roles/ansible-docker-swarm/roles/docker-installation`
- [Swarm initialization](https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-swarm-init): `dependencies/roles/ansible-docker-swarm/roles/docker-swarm-init`
- [Swarm membership](https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-manager): `dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-manager`
- [Worker membership](https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-worker): `dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-worker`
- [Node labels](https://github.com/regardsoss/regards-docker/tree/master/dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-nodes-label): `dependencies/roles/ansible-docker-swarm/roles/docker-swarm-add-nodes-label`

### REGARDS services

- [Stack orchestration](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack): `roles/regards-stack`
- [REGARDS services](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-microservices-workspace-local): `roles/regards-microservices-workspace-local`
- [Plugin workspace](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-plugins-workspace-local): `roles/regards-plugins-workspace-local`
- [Data services](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack-elasticsearch): `roles/regards-stack-elasticsearch`
- [Object storage](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack-minio): `roles/regards-stack-minio`
- [Front proxy](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-front): `roles/regards-front`

### Operations and observability

- [Monitoring](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-prometheus-config): `roles/regards-prometheus-config`
- [Log pipeline](https://github.com/regardsoss/regards-docker/tree/master/roles/regards-stack-logs): `roles/regards-stack-logs`
- [Shutdown](https://github.com/regardsoss/regards-docker/blob/master/regards-shutdown.yml): `regards-shutdown.yml`
- [Removal](https://github.com/regardsoss/regards-docker/blob/master/regards-delete.yml): `regards-delete.yml`

### Other components

- **Operator**

## Connections

- Operator → REGARDS deployment: runs playbook
- REGARDS deployment → Docker host setup: provisions hosts
- REGARDS deployment → Swarm initialization: sets up Swarm
- REGARDS deployment → Stack deployment: deploys stack
- Stack deployment → Stack orchestration: orchestrates stack
- Stack orchestration → REGARDS services: deploys services
- Stack orchestration → Plugin workspace: uses plugins
- Stack orchestration → Data services: deploys services
- Stack orchestration → Object storage: deploys storage
- Stack orchestration → Front proxy: configures access
- Configuration deployment → Monitoring: configures monitoring
- Configuration deployment → Log pipeline: configures logging
- Plugin deployment → Plugin workspace: deploys plugins
- Operator → Shutdown: runs shutdown
- Operator → Removal: runs removal
