# danielpg25/fct-openshift architecture

> Architecture diagram of the GitHub repository danielpg25/fct-openshift, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/danielpg25/fct-openshift
- Repository: https://github.com/danielpg25/fct-openshift

## Overview

Para dibujar un diagrama de arquitectura claro y detallado de este proyecto (Despliegue Continuo de Aplicaciones Web usando OpenShift), sigue estos pasos:

##### Identificar el tipo y propósito del proyecto
- Es un proyecto de **introducción y práctica** para desplegar aplicaciones web en un entorno PaaS (OpenShift) con despliegue continuo (CI/CD).
- No es una aplicación tradicional con frontend/backend propio, sino un **entorno y flujo de despliegue** que integra: máquina local (VM), cluster OpenShift (CRC), repositorios GitHub, Webhooks y herramientas de construcción (Source2Image, Dockerfile, Templates).

##### Analizar la estructura de componentes
- **Entorno anfitrión**: tu máquina (o VM CentOS 8), con CRC instalado.
- **Cluster OpenShift**: nodo único, gestiona Pods, DeploymentConfigs, Services, Routes, PersistentVolumes.
- **Registro interno de imágenes**: OpenShift ImageStream y registro integrado.
- **Repositorios GitHub**: alojan el código de las aplicaciones (Flask, PHP, WordPress template).
- **Herramienta Ngrok**: expone la API de OpenShift local a Internet para recibir Webhooks de GitHub.
- **Canal de CI/CD**:
a. Push en GitHub → Webhook (vía Ngrok) → BuildConfig/OpenShift → (S2I o Docker Build o Template) → ImageStream → DeploymentConfig → Pods → Service → Route.

##### Componentes principales a incluir en el diagrama
A. Desarrollador
- VSCode / línea de comandos → hace `git push`
B. GitHub
- Repositorio remoto
- Webhook configurado apuntando a la URL pública de Ngrok + ruta de buildconfig
C. Ngrok
- Túnel HTTP(s) que redirige solicitudes externas al API server de OpenShift (localhost:6443)
D. OpenShift Cluster (CRC)
1. API Server
2. Auth/Zones (namespaces/proyectos)
3. BuildConfigs (S2I, Dockerfile, Template)
4. ImageStreams
5. DeploymentConfigs / ReplicaSets
6. Pods
7. Services
8. Routes
9. PersistentVolumes / Claims
E. Contenedores de ejemplo
- Aplicación Flask (Python) mediante S2I
- Aplicación PHP (`bookmedik`) mediante Dockerfile
- WordPress + MySQL mediante plantilla YAML

##### Relaciones e interacciones
- Flechas direccionales que muestren:
1. `git push` → GitHub
2. GitHub Webhook (via Ngrok) → OpenShift API (BuildConfig trigger)
3. OpenShift BuildConfig → Source2Image / Docker Build / Template → construye imagen → almacena en ImageStream
4. ImageStream → despliegue (DeploymentConfig) → crea Pods
5. Pods → Service interno → Route → acceso externo
6. Template → crea a la vez recursos de base de datos y aplicación, con PersistentVolumeClaims

##### Patrones y principios presentes
- **CI/CD pipeline**: build automático tras push
- **Container-as-a-Service**: abstraer infraestructura con OpenShift
- **Inmutabilidad y reproducibilidad**: construcción de contenedores vía S2I/Dockerfile/Templates
- **Separación de responsabilidades**:
· Fuente de verdad (Git)
· Orquestación (OpenShift)
· Exposición pública (Routes, Ngrok)
· Almacenamiento persistente (PVC)

##### Guía para adaptar el diagrama a este caso
- Usa **formas distintas** (rectángulos, cilindros, nube) para:
· Componentes locales vs. remotos vs. cluster
· Tipos de build (S2I, Dockerfile, Template)
· Azul: desarrollo/git
· Verde: OpenShift core (API, Builds, Pods)
· Naranja: network/exposición (Ngrok, Routes)
· Marrón: almacenamiento persistente

##### Elementos obligatorios en el diagrama
- Etiquetas claras de cada elemento (ej. “BuildConfig: flask-temperaturas-s2i”)
- Flechas dirigidas con anotaciones de protocolo/evento (HTTP POST Webhook, oc start, etc.)
- Leyenda de colores y formas para distinguir capas:
· Capa de CI/CD
· Capa de orquestación de contenedores
· Capa de red (exposición externa)
· Capa de almacenamiento

Conclusión
El diagrama debe reflejar el **flujo completo** desde el `git push` hasta la entrega del contenedor en producción simulada sobre CRC, destacando las tres alternativas de build (S2I, Dockerfile, Template) y mostrando cómo se integra Ngrok para CI/CD local. Con estos elementos claros, el principal software engineer tendrá una visión precisa de la arquitectura end-to-end del proyecto.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Local Environment
    subgraph "Local Environment" 
        direction TB
        Dev["Developer (VSCode/git)"]:::dev
        Dev -->|"git push"| GitHub["GitHub Repo"]:::git
    end

    %% Network Exposure
    subgraph "Network Exposure" 
        direction TB
        Ngrok["Ngrok Tunnel"]:::net
        GitHub -->|"HTTP POST Webhook"| Ngrok
        Ngrok -->|"HTTPS"| API["OpenShift API Server"]:::oss
    end

    %% OpenShift Cluster
    subgraph "OpenShift Cluster (CRC)" 
        direction TB
        API["API Server"]:::oss
        Auth["Auth/Namespaces"]:::oss
        Builds["BuildConfigs"]:::oss
        ImageStream["ImageStreams"]:::oss
        DeployConf["DeploymentConfigs/ReplicaSets"]:::oss
        Pods["Pods"]:::oss
        Service["Services"]:::oss
        Route["Routes"]:::net
        Storage["PersistentVolumes/Claims"]:::storage

        API --> Auth
        Auth --> Builds
        Builds --> S2I["Build: S2I (Flask)"]:::oss
        Builds --> Docker["Build: Dockerfile (PHP)"]:::oss
        Builds --> Template["Build: Template (WordPress/MySQL)"]:::oss
        S2I --> ImageStream
        Docker --> ImageStream
        Template --> ImageStream
        ImageStream --> DeployConf
        DeployConf --> Pods
        Pods --> Service
        Service --> Route
        Template --> Storage
    end

    %% Documentation
    subgraph "Documentation" 
        direction TB
        DOC1["README.md"]:::doc
        DOC2["Practica.md (CI/CD Pipeline)"]:::doc
        DOC3["Introduccion.md"]:::doc
        DOC4["teoria.md"]:::doc
        DOC5["Escenario.md"]:::doc
        DOC6["Objetivos.md"]:::doc
        DOC7["Bibliografia.md"]:::doc
        DOC8["Conclusiones.md"]:::doc
    end

    %% Legend (Color Coding)
    subgraph "Legend"
        direction TB
        L1["Development/Git"]:::dev
        L2["Network/Exposure"]:::net
        L3["OpenShift Core"]:::oss
        L4["Storage"]:::storage
        L5["Documentation"]:::doc
    end

    %% Click Events
    click DOC1 "https://github.com/danielpg25/fct-openshift/blob/main/README.md"
    click DOC2 "https://github.com/danielpg25/fct-openshift/blob/main/Practica/Practica.md"
    click DOC3 "https://github.com/danielpg25/fct-openshift/blob/main/Introduccion/Introduccion.md"
    click DOC4 "https://github.com/danielpg25/fct-openshift/blob/main/Fundamentos_Teoricos/teoria.md"
    click DOC5 "https://github.com/danielpg25/fct-openshift/blob/main/Escenario/Escenario.md"
    click DOC6 "https://github.com/danielpg25/fct-openshift/blob/main/Objetivos/Objetivos.md"
    click DOC7 "https://github.com/danielpg25/fct-openshift/blob/main/Bibliografia/Bibliografia.md"
    click DOC8 "https://github.com/danielpg25/fct-openshift/blob/main/Conclusiones/Conclusiones.md"
    click Template "https://github.com/danielpg25/fct-openshift/blob/main/Practica/wordpress-template.yaml"

    %% Styles
    classDef dev fill:#D0E6FF,stroke:#0057D9,color:#000;
    classDef git fill:#D0E6FF,stroke:#0057D9,color:#000;
    classDef net fill:#FFE4B5,stroke:#FF8C00,color:#000;
    classDef oss fill:#DFFFE0,stroke:#008000,color:#000;
    classDef storage fill:#F5E6DA,stroke:#A0522D,color:#000;
    classDef doc fill:#F0F0F0,stroke:#888,color:#000;
```
