# javnitram/sge-odoo-it-yourself architecture

> Architecture diagram of the GitHub repository javnitram/sge-odoo-it-yourself, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/javnitram/sge-odoo-it-yourself
- Repository: https://github.com/javnitram/sge-odoo-it-yourself

## Overview

##### Identificación del proyecto y propósito
- Este repositorio configura un entorno de desarrollo Dockerizado para Odoo (ERP) junto con PostgreSQL. Su objetivo es facilitar la creación de módulos Odoo sobre un contenedor Odoo, una base de datos Postgres y volúmenes para persistir datos y código, todo orquestado con Docker Compose.

##### Análisis de la estructura de archivos
- docker-compose.yml: definición de servicios (odoo, postgres, posibles volúmenes y redes).
- odoo/config/: configuración de Odoo (odoo.conf y plantilla).
- pgadmin4/servers.json: ajuste local de servidores para la extensión pgAdmin de VS Code (ya no hay contenedor pgAdmin).
- set_permissions.sh: script de host para normalizar permisos en los volúmenes montados (evitar bloqueos de lectura/escritura desde contenedores).
- README.md: explica la puesta en marcha, uso de Git (fork, ramas, commits), extensiones VS Code y comandos odoo scaffold.

##### Cómo estructurar el diagrama de arquitectura
a. Componentes principales
- Estación de trabajo del desarrollador:
– VS Code con extensiones (Docker, Postgres, OdooSnippets, Python).
– Shell local (invoca set_permissions.sh).
- Docker Engine / Docker Compose: orquesta arranque y red interna.
- Contenedores Docker:
– Contenedor “odoo”: ejecuta Odoo, expone puerto 8069. Monta volúmenes: código extra-addons, configuración.
– Contenedor “postgres”: base de datos, expone puerto 5432, persiste datos en volumen.
- Volúmenes host–contenedor:
– /mnt/extra-addons → desarrollo de módulos.
– odoo/config → odoo.conf y otros ajustes.
– pgdata → datos de PostgreSQL.
- Navegador web (usuario/developer) accede al front-end Odoo vía puerto expuesto.
- Repositorio GitHub remoto: flujo de forks, ramas develop/main y pull-requests.

b. Relaciones e interacciones
- VS Code ↔ Docker Engine: inicia/parada de contenedores, inspección.
- set_permissions.sh ↔ volúmenes: corrige permisos post-arranque.
- Contenedor Odoo → Contenedor Postgres: conexión en la red Docker interna (host “db” o similar).
- Host Browser → Odoo: HTTP/JSON en puerto 8069.
- Git CLI / VS Code Git ↔ GitHub: push, pull, merge, scaffold.

c. Patrones y principios arquitectónicos
- Microservicio ligero (Odoo) + base de datos, aislamiento por contenedor.
- Capa de persistencia mediante volúmenes Docker.
- Infraestructura como código (docker-compose.yml).
- Separación clara entre entorno de desarrollo (IDE/host) y runtime (contenedores).

d. Tecnologías y frameworks clave
- Odoo (Python, Postgres ORM)
- PostgreSQL
- Docker, Docker Compose
- Visual Studio Code + extensiones (Docker, Postgres, OdooSnippets, Python)
- Git / GitHub

##### Guía para el diagrama
- Usa rectángulos para representar la estación de trabajo, Docker Engine y GitHub.
- Emplea cilindros para la base de datos Postgres y carpetas/volúmenes para los montajes host–contenedor.
- Dibuja contenedores de Docker como contornos diferenciados (Odoo, Postgres).
- Traza flechas unidireccionales o bidireccionales según flujo de datos (p. ej., Odoo → Postgres, navegador → Odoo).
- Asigna colores distintos: azul para componentes internos, verde para volúmenes, naranja para herramientas de desarrollo, gris para servicios externos (GitHub).

##### Elementos imprescindibles
- Etiquetas claras con nombre de cada componente y puerto.
- Indicación de la red Docker interna (subred o etiqueta “docker-net”).
- Volúmenes host ↔ contenedor con ruta en host y en contenedor.
- Flechas de control (iniciar/parar contenedores) y de datos (peticiones HTTP, consultas SQL).
- Leyenda de colores y formas.

Con esta base, el diagrama mostrará de forma fiel la plataforma de desarrollo Odoo sobre Docker, sus componentes aislados, los puntos de integración (IDE, navegador, repositorio) y el flujo de datos entre contenedores y hacia el exterior.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Workstation
    subgraph "Developer Workstation"
        direction TB
        VSCode["VS Code\n(Docker, Postgres,\nOdooSnippets, Python)"]:::devTools
        Shell["Shell"]:::devTools
        GitCLI["Git CLI\n/ VS Code Git"]:::devTools
    end

    %% Docker Environment
    subgraph "Docker Environment"
        direction TB
        DockerEngine["Docker Engine"]:::internal
        DockerCompose["Docker Compose\n(docker-compose.yml)"]:::internal
    end

    %% Docker Network and Containers
    subgraph "Docker Network: docker-net"
        direction TB
        OdooContainer["Container: Odoo\nPort 8069"]:::internal
        PostgresContainer["Container: PostgreSQL\nPort 5432"]:::internal
    end

    %% Volumes
    subgraph "Volumes (Host ↔ Container)"
        direction TB
        VolumeAddons["Folder: extra-addons\n(host ↔ /mnt/extra-addons)"]:::vol
        VolumeConfig["Folder: odoo/config\n(host ↔ /etc/odoo)"]:::vol
        VolumePgData["Folder: pgdata\n(host ↔ /var/lib/postgresql/data)"]:::vol
    end

    %% External Entities
    Browser["Browser\n(HTTP 8069)"]:::external
    GitHub["GitHub Remote"]:::external

    %% Permission Script
    PermScript["set_permissions.sh"]:::devTools

    %% pgAdmin config
    PgAdmin["pgadmin4/servers.json"]:::devTools

    %% README
    Readme["README.md"]:::devTools

    %% Relationships
    VSCode -->|"control"| DockerEngine
    GitCLI -->|"push/pull/merge/scaffold"| GitHub
    Shell -->|invokes| PermScript
    PermScript -->|normalizes permissions| VolumeAddons
    PermScript -->|normalizes permissions| VolumeConfig
    PermScript -->|normalizes permissions| VolumePgData

    DockerCompose -->|orchestrates| DockerEngine
    DockerCompose -->|starts| OdooContainer
    DockerCompose -->|starts| PostgresContainer

    OdooContainer -->|"connect db:5432"| PostgresContainer
    OdooContainer -->|mount| VolumeAddons
    OdooContainer -->|mount| VolumeConfig
    PostgresContainer -->|mount| VolumePgData

    Browser -->|"HTTP/JSON"| OdooContainer

    %% Click Events
    click DockerCompose "https://github.com/javnitram/sge-odoo-it-yourself/blob/main/docker-compose.yml"
    click Config "https://github.com/javnitram/sge-odoo-it-yourself/blob/main/odoo/config/odoo.conf"
    click ConfigTemplate "https://github.com/javnitram/sge-odoo-it-yourself/blob/main/odoo/config/odoo.conf.template"
    click PermScript "https://github.com/javnitram/sge-odoo-it-yourself/blob/main/set_permissions.sh"
    click PgAdmin "https://github.com/javnitram/sge-odoo-it-yourself/blob/main/pgadmin4/servers.json"
    click Readme "https://github.com/javnitram/sge-odoo-it-yourself/blob/main/README.md"
    click Addons "https://github.com/javnitram/sge-odoo-it-yourself/tree/main/odoo/"

    %% Styles
    classDef devTools fill:#FFA500,stroke:#333,stroke-width:1px
    classDef internal fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef vol fill:#90EE90,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px
```
