feat: sincronizar scaffold completo del shape web-backend/python
Sincroniza el scaffold canónico desde templates/web-backend-python/ del repo IDP. Reemplaza el placeholder mínimo previo (.gitea/workflows/ci.yaml, README.md, .gitignore, catalog-info.yaml) por el scaffold completo documentado en ADR-053 §3: - code/ — FastAPI app con /health (db check), /metrics, /demo estático, middleware correlation_id, settings Pydantic, db.py con SQLAlchemy - code/alembic/ — migración inicial vacía + env.py usando MIGRATION_DATABASE_URL - code/tests/ — pytest + httpx TestClient (test_health, test_demo) - helm/APP_NAME/ — chart con Deployment, Service, IngressRoute Traefik, NetworkPolicy, ServiceMonitor, Job alembic-upgrade como hook pre-upgrade,pre-install (backoffLimit: 0) - coralware-shape.yaml — manifiesto v1alpha1 del contrato del shape - claim-mariadb.yaml — AddonClaim declarativo (uso futuro ADR-052) - catalog-info.yaml — entidad Backstage actualizada - .gitea/workflows/APP_NAME-build.yaml — invoca reusable workflow ADR-038 + job helm-deploy con KUBECONFIG_TENANT_B64 Placeholders __APP_NAME__, __TIER__, __TENANT_ID__, __TENANT_ID_NODASHES__ serán sustituidos server-side por repo-provisioner cuando materialice el template para un tenant (pendiente — ADR-053 §11.5). El openspec/ del golden path NO se sincroniza al repo Gitea (gobernanza interna de Coralware). Refs: ADR-052, ADR-053, poc-nexobms.md (PoC NexoBMS Demetrio).
This commit is contained in:
83
.gitea/workflows/APP_NAME-build.yaml
Normal file
83
.gitea/workflows/APP_NAME-build.yaml
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
name: __APP_NAME__ — build & deploy
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
paths:
|
||||||
|
- 'code/**'
|
||||||
|
- 'helm/**'
|
||||||
|
- '.gitea/workflows/__APP_NAME__-build.yaml'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
# Tests + build + push a Harbor — patrón ADR-038 reusable workflow.
|
||||||
|
build:
|
||||||
|
uses: coralware/IDP/.gitea/workflows/_python-microservice.yaml@main
|
||||||
|
with:
|
||||||
|
service_name: __APP_NAME__
|
||||||
|
service_dir: code
|
||||||
|
uses_metrics: false
|
||||||
|
coverage_threshold: 80 # menor que el IDP interno (90); el dev sube cuando madure
|
||||||
|
trivy_exit_code: 0 # informacional en MVP; subir a 1 antes de producción
|
||||||
|
enforce_rollback: false # rollout lo gestiona el job helm-deploy abajo
|
||||||
|
|
||||||
|
# Deploy al cluster del tenant — Helm upgrade --install con hook Alembic.
|
||||||
|
helm-deploy:
|
||||||
|
needs: build
|
||||||
|
runs-on: [self-hosted, linux/amd64]
|
||||||
|
container: alpine/helm:3.14.4
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Install kubectl
|
||||||
|
run: apk add --no-cache kubectl
|
||||||
|
|
||||||
|
- name: Decodificar kubeconfig del tenant
|
||||||
|
env:
|
||||||
|
KUBECONFIG_B64: ${{ secrets.KUBECONFIG_TENANT_B64 }}
|
||||||
|
run: |
|
||||||
|
if [ -z "$KUBECONFIG_B64" ]; then
|
||||||
|
echo "ERROR: secret KUBECONFIG_TENANT_B64 no configurado en el proyecto Gitea."
|
||||||
|
echo "tenant-manager debe provisionarlo al crear el repo."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
mkdir -p /root/.kube
|
||||||
|
echo "$KUBECONFIG_B64" | base64 -d > /root/.kube/config
|
||||||
|
chmod 600 /root/.kube/config
|
||||||
|
|
||||||
|
- name: Helm upgrade --install
|
||||||
|
env:
|
||||||
|
TENANT_ID: ${{ vars.TENANT_ID }}
|
||||||
|
TENANT_ID_NODASHES: ${{ vars.TENANT_ID_NODASHES }}
|
||||||
|
TENANT_TIER: ${{ vars.TENANT_TIER }}
|
||||||
|
IMAGE_TAG: ${{ needs.build.outputs.image_tag }}
|
||||||
|
run: |
|
||||||
|
helm upgrade --install __APP_NAME__ ./helm/__APP_NAME__ \
|
||||||
|
--namespace tenant-${TENANT_ID_NODASHES}-apps \
|
||||||
|
--create-namespace \
|
||||||
|
--set image.tag=${IMAGE_TAG} \
|
||||||
|
--set tenantId=${TENANT_ID} \
|
||||||
|
--set tenantIdNodashes=${TENANT_ID_NODASHES} \
|
||||||
|
--set tier=${TENANT_TIER} \
|
||||||
|
--wait --timeout 5m
|
||||||
|
|
||||||
|
- name: Verificar rollout
|
||||||
|
env:
|
||||||
|
TENANT_ID_NODASHES: ${{ vars.TENANT_ID_NODASHES }}
|
||||||
|
run: |
|
||||||
|
kubectl -n tenant-${TENANT_ID_NODASHES}-apps \
|
||||||
|
rollout status deploy/__APP_NAME__ --timeout=3m
|
||||||
|
|
||||||
|
- name: Smoke check post-deploy
|
||||||
|
env:
|
||||||
|
INGRESS_HOST: __APP_NAME__-${{ vars.TENANT_ID_NODASHES }}.apps.coralware.cloud
|
||||||
|
run: |
|
||||||
|
for i in $(seq 1 12); do
|
||||||
|
if wget -q -O - --timeout=10 "https://${INGRESS_HOST}/health" | grep -q '"status":"ok"'; then
|
||||||
|
echo "Smoke OK: /health responde 200 con db:up"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
echo "Intento ${i}/12 — /health aún no responde, esperando 5s…"
|
||||||
|
sleep 5
|
||||||
|
done
|
||||||
|
echo "ERROR: /health no respondió 200 dentro del timeout"
|
||||||
|
exit 1
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
name: ci
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
pull_request:
|
|
||||||
branches: [main]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: [self-hosted]
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- name: Build
|
|
||||||
run: echo "Configurar pasos de build para tu proyecto"
|
|
||||||
24
.gitignore
vendored
24
.gitignore
vendored
@@ -1,20 +1,14 @@
|
|||||||
# Python
|
|
||||||
__pycache__/
|
__pycache__/
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
.env
|
*.egg-info/
|
||||||
venv/
|
.pytest_cache/
|
||||||
|
.ruff_cache/
|
||||||
|
.coverage
|
||||||
|
htmlcov/
|
||||||
.venv/
|
.venv/
|
||||||
|
venv/
|
||||||
# Node.js
|
|
||||||
node_modules/
|
|
||||||
dist/
|
|
||||||
.env
|
.env
|
||||||
|
.idea/
|
||||||
# Go
|
.vscode/
|
||||||
*.exe
|
*.swp
|
||||||
*.out
|
|
||||||
vendor/
|
|
||||||
|
|
||||||
# General
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
*.log
|
|
||||||
|
|||||||
144
README.md
144
README.md
@@ -1,3 +1,143 @@
|
|||||||
# template-web-backend-python
|
# __APP_NAME__ — Web Backend Python (FastAPI + Alembic)
|
||||||
|
|
||||||
Template Golden Path — Web Backend con Python
|
App generada desde el Golden Path **`web-backend/python`** de Coralware Cove IDP.
|
||||||
|
|
||||||
|
Este repositorio contiene el scaffold completo: aplicación FastAPI, migraciones
|
||||||
|
Alembic, frontend estático en `/demo`, Helm chart, workflow de CI y manifiesto
|
||||||
|
de contrato con la plataforma. Cuando se materializa este template para tu
|
||||||
|
tenant, los placeholders en mayúsculas se sustituyen automáticamente.
|
||||||
|
|
||||||
|
> **Contrato del shape:** ver `coralware-shape.yaml` en la raíz. Define los
|
||||||
|
> endpoints obligatorios, la BD esperada y la versión del shape. No elimines
|
||||||
|
> ese archivo — la plataforma lo lee.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Estructura
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── coralware-shape.yaml ← contrato con la plataforma
|
||||||
|
├── catalog-info.yaml ← entidad Backstage
|
||||||
|
├── code/
|
||||||
|
│ ├── app/ ← FastAPI app
|
||||||
|
│ ├── alembic/ ← migraciones DB
|
||||||
|
│ ├── tests/ ← pytest + cobertura
|
||||||
|
│ ├── pyproject.toml
|
||||||
|
│ ├── requirements.txt
|
||||||
|
│ └── Dockerfile
|
||||||
|
├── helm/__APP_NAME__/ ← Helm chart con hook Alembic pre-upgrade
|
||||||
|
├── claim-mariadb.yaml ← AddonClaim de la BD (ver §Base de datos)
|
||||||
|
└── .gitea/workflows/ ← CI: tests + build + deploy
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Ciclo de vida
|
||||||
|
|
||||||
|
1. **Tú escribes código** — endpoints en `code/app/routers/`, modelos en
|
||||||
|
`code/app/models/`, migraciones con `alembic revision --autogenerate`.
|
||||||
|
2. **`git push`** a `main` dispara el workflow Gitea Actions.
|
||||||
|
3. El CI corre `black`, `ruff`, `bandit`, `pytest --cov`. Si algo falla, el
|
||||||
|
pipeline aborta.
|
||||||
|
4. Si pasa, builda imagen multi-arch con BuildKit y la publica en Harbor.
|
||||||
|
5. `helm upgrade --install` aplica el chart al cluster de tu tenant.
|
||||||
|
Antes del rollout, un Job pre-upgrade corre `alembic upgrade head`.
|
||||||
|
Si Alembic falla, Helm aborta y la app vieja queda intacta.
|
||||||
|
6. Tras rollout exitoso, smoke check valida `/health` 200.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Endpoints obligatorios
|
||||||
|
|
||||||
|
| Path | Auth | Propósito |
|
||||||
|
|------|------|-----------|
|
||||||
|
| `/health` | none | Liveness + readiness; devuelve `{status: ok, db: up\|down}` |
|
||||||
|
| `/docs` | configurable (`OPENAPI_REQUIRE_AUTH`) | Swagger UI |
|
||||||
|
| `/openapi.json` | igual que `/docs` | Schema OpenAPI |
|
||||||
|
| `/demo` | none | Frontend estático servido desde `code/app/static/demo/` |
|
||||||
|
| `/metrics` | restringido vía NetworkPolicy | Métricas Prometheus |
|
||||||
|
|
||||||
|
`/health`, `/docs`, `/demo` son contrato del shape — NO renombres.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Base de datos
|
||||||
|
|
||||||
|
Tu app espera un Secret `__APP_NAME__-db-creds` en su namespace con las
|
||||||
|
claves `DATABASE_URL` y `MIGRATION_DATABASE_URL`. El Secret lo provisiona la
|
||||||
|
plataforma:
|
||||||
|
|
||||||
|
- **PoC / MVP** — Coralware lo crea manualmente siguiendo el runbook
|
||||||
|
`docs/runbook-mariadb-poc.md` en el repo IDP. Tú no haces nada.
|
||||||
|
- **Producción (Fase 5.5+)** — `claim-mariadb.yaml` lo materializa
|
||||||
|
automáticamente cuando esté disponible el controller `addon-provisioner`
|
||||||
|
(ver ADR-052).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Variables de entorno
|
||||||
|
|
||||||
|
| Variable | Origen | Default | Descripción |
|
||||||
|
|----------|--------|---------|-------------|
|
||||||
|
| `DATABASE_URL` | Secret | — | Connection string runtime |
|
||||||
|
| `MIGRATION_DATABASE_URL` | Secret | = `DATABASE_URL` | Connection para Alembic |
|
||||||
|
| `LOG_LEVEL` | ConfigMap | `INFO` | `DEBUG` para troubleshooting |
|
||||||
|
| `CORRELATION_ID_HEADER` | ConfigMap | `X-Correlation-ID` | Header de trazabilidad |
|
||||||
|
| `OPENAPI_REQUIRE_AUTH` | ConfigMap | `false` | Activar JWT en `/docs` |
|
||||||
|
| `KEYCLOAK_ISSUER` | ConfigMap | — | URL del realm cuando auth activado |
|
||||||
|
| `STATIC_DEMO_PATH` | ConfigMap | `/app/static/demo` | Path al frontend estático |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Migraciones Alembic
|
||||||
|
|
||||||
|
Migración base vacía en `code/alembic/versions/0001_initial.py`. Para crear
|
||||||
|
una nueva tras agregar modelos:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd code
|
||||||
|
alembic revision --autogenerate -m "agregar tabla users"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Desarrollo local
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd code
|
||||||
|
pip install -r requirements-dev.txt
|
||||||
|
|
||||||
|
docker run --rm -d --name mariadb-dev \
|
||||||
|
-e MARIADB_ROOT_PASSWORD=dev -e MARIADB_DATABASE=app \
|
||||||
|
-p 3306:3306 mariadb:11
|
||||||
|
|
||||||
|
export DATABASE_URL="mysql+pymysql://root:dev@127.0.0.1:3306/app"
|
||||||
|
export MIGRATION_DATABASE_URL="$DATABASE_URL"
|
||||||
|
|
||||||
|
alembic upgrade head
|
||||||
|
uvicorn app.main:app --reload --port 8000
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Plan de salida
|
||||||
|
|
||||||
|
Si decides migrar fuera de Cove, todo lo que necesitas vive en formato estándar:
|
||||||
|
|
||||||
|
| Componente | Cómo lo exportas |
|
||||||
|
|-----------|------------------|
|
||||||
|
| Código | `git remote add github && git push github main` |
|
||||||
|
| Imagen | `docker pull` desde Harbor + push a tu registry |
|
||||||
|
| Manifests | Ya están en `helm/` — `helm template` genera YAML aplicable |
|
||||||
|
| Datos | Coralware ejecuta `mariadb-dump` y entrega `.sql.gz` |
|
||||||
|
|
||||||
|
Sin lock-in técnico.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Referencias
|
||||||
|
|
||||||
|
- `docs/adr-053-shape-web-backend-python.md` — anatomía del shape
|
||||||
|
- `docs/adr-052-tenant-addon-claim-model.md` — modelo de add-ons (BD)
|
||||||
|
- `docs/adr-038-ci-estandar-reusable-workflow.md` — pipeline Python
|
||||||
|
|||||||
@@ -9,3 +9,5 @@ spec:
|
|||||||
type: __TYPE__
|
type: __TYPE__
|
||||||
lifecycle: experimental
|
lifecycle: experimental
|
||||||
owner: __OWNER__
|
owner: __OWNER__
|
||||||
|
dependsOn:
|
||||||
|
- resource:__APP_NAME__-db
|
||||||
|
|||||||
25
claim-mariadb.yaml
Normal file
25
claim-mariadb.yaml
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# AddonClaim — referencia futura para cuando ADR-052 esté implementado.
|
||||||
|
#
|
||||||
|
# DURANTE LA POC NEXOBMS Y HASTA QUE addon-provisioner ESTÉ DISPONIBLE:
|
||||||
|
# este archivo NO se aplica. Coralware materializa el Secret
|
||||||
|
# __APP_NAME__-db-creds manualmente siguiendo docs/runbook-mariadb-poc.md.
|
||||||
|
#
|
||||||
|
# CUANDO ADR-052 ESTÉ EN FASE 5.5+:
|
||||||
|
# - el dev/CI hace `kubectl apply -f claim-mariadb.yaml` al ns de la app
|
||||||
|
# - addon-provisioner crea BD lógica + user + Secret automáticamente
|
||||||
|
# - el campo .spec.secretName debe coincidir con .Values.database.secretName
|
||||||
|
# del Helm chart (por convención: "<APP_NAME>-db-creds")
|
||||||
|
apiVersion: idp.coralware.cloud/v1alpha1
|
||||||
|
kind: AddonClaim
|
||||||
|
metadata:
|
||||||
|
name: __APP_NAME__-db
|
||||||
|
labels:
|
||||||
|
idp.coralware.cloud/tenant-id: __TENANT_ID__
|
||||||
|
idp.coralware.cloud/app: __APP_NAME__
|
||||||
|
spec:
|
||||||
|
addonType: mariadb
|
||||||
|
databaseName: __APP_NAME___db # nombre de la BD lógica
|
||||||
|
user:
|
||||||
|
permissions: rw # rw | ro — default rw
|
||||||
|
secretName: __APP_NAME__-db-creds
|
||||||
|
deletionPolicy: Retain # Retain (default) | Delete
|
||||||
28
code/Dockerfile
Normal file
28
code/Dockerfile
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Multi-stage para imagen final lean.
|
||||||
|
# Stage 1: deps — instala dependencias Python en una venv aislada.
|
||||||
|
# Stage 2: runtime — copia código y venv, corre como user no-root con FS read-only.
|
||||||
|
|
||||||
|
FROM python:3.12-slim AS deps
|
||||||
|
WORKDIR /build
|
||||||
|
COPY requirements.txt .
|
||||||
|
RUN python -m venv /venv \
|
||||||
|
&& /venv/bin/pip install --no-cache-dir --upgrade pip \
|
||||||
|
&& /venv/bin/pip install --no-cache-dir -r requirements.txt
|
||||||
|
|
||||||
|
FROM python:3.12-slim AS runtime
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY --from=deps /venv /venv
|
||||||
|
ENV PATH="/venv/bin:$PATH"
|
||||||
|
|
||||||
|
COPY app /app/app
|
||||||
|
COPY alembic /app/alembic
|
||||||
|
COPY alembic.ini /app/alembic.ini
|
||||||
|
|
||||||
|
RUN useradd -u 1001 -r appuser \
|
||||||
|
&& chown -R appuser:appuser /app
|
||||||
|
USER appuser
|
||||||
|
|
||||||
|
EXPOSE 8000
|
||||||
|
|
||||||
|
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000", "--no-access-log"]
|
||||||
44
code/alembic.ini
Normal file
44
code/alembic.ini
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
[alembic]
|
||||||
|
script_location = alembic
|
||||||
|
prepend_sys_path = .
|
||||||
|
file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
|
||||||
|
|
||||||
|
# La URL real la lee env.py de la variable MIGRATION_DATABASE_URL (o DATABASE_URL).
|
||||||
|
# NO hardcodear aquí.
|
||||||
|
sqlalchemy.url =
|
||||||
|
|
||||||
|
[post_write_hooks]
|
||||||
|
|
||||||
|
[loggers]
|
||||||
|
keys = root,sqlalchemy,alembic
|
||||||
|
|
||||||
|
[handlers]
|
||||||
|
keys = console
|
||||||
|
|
||||||
|
[formatters]
|
||||||
|
keys = generic
|
||||||
|
|
||||||
|
[logger_root]
|
||||||
|
level = WARN
|
||||||
|
handlers = console
|
||||||
|
qualname =
|
||||||
|
|
||||||
|
[logger_sqlalchemy]
|
||||||
|
level = WARN
|
||||||
|
handlers =
|
||||||
|
qualname = sqlalchemy.engine
|
||||||
|
|
||||||
|
[logger_alembic]
|
||||||
|
level = INFO
|
||||||
|
handlers =
|
||||||
|
qualname = alembic
|
||||||
|
|
||||||
|
[handler_console]
|
||||||
|
class = StreamHandler
|
||||||
|
args = (sys.stderr,)
|
||||||
|
level = NOTSET
|
||||||
|
formatter = generic
|
||||||
|
|
||||||
|
[formatter_generic]
|
||||||
|
format = %(levelname)-5.5s [%(name)s] %(message)s
|
||||||
|
datefmt = %H:%M:%S
|
||||||
57
code/alembic/env.py
Normal file
57
code/alembic/env.py
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
"""
|
||||||
|
Alembic env.py — punto de entrada de las migraciones.
|
||||||
|
|
||||||
|
Lee la URL de conexión de MIGRATION_DATABASE_URL (recomendado: user con DDL
|
||||||
|
separado), o de DATABASE_URL como fallback.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from logging.config import fileConfig
|
||||||
|
|
||||||
|
from sqlalchemy import engine_from_config, pool
|
||||||
|
|
||||||
|
from alembic import context
|
||||||
|
from app.settings import settings
|
||||||
|
|
||||||
|
config = context.config
|
||||||
|
|
||||||
|
if config.config_file_name is not None:
|
||||||
|
fileConfig(config.config_file_name)
|
||||||
|
|
||||||
|
config.set_main_option("sqlalchemy.url", settings.migration_url)
|
||||||
|
|
||||||
|
# Importar Base y modelos para que --autogenerate los detecte:
|
||||||
|
# from app.models import Base
|
||||||
|
# target_metadata = Base.metadata
|
||||||
|
target_metadata = None
|
||||||
|
|
||||||
|
|
||||||
|
def run_migrations_offline() -> None:
|
||||||
|
"""Genera SQL sin conectar — útil para revisar antes de aplicar."""
|
||||||
|
url = config.get_main_option("sqlalchemy.url")
|
||||||
|
context.configure(
|
||||||
|
url=url,
|
||||||
|
target_metadata=target_metadata,
|
||||||
|
literal_binds=True,
|
||||||
|
dialect_opts={"paramstyle": "named"},
|
||||||
|
)
|
||||||
|
with context.begin_transaction():
|
||||||
|
context.run_migrations()
|
||||||
|
|
||||||
|
|
||||||
|
def run_migrations_online() -> None:
|
||||||
|
"""Aplica migraciones contra la BD real."""
|
||||||
|
connectable = engine_from_config(
|
||||||
|
config.get_section(config.config_ini_section, {}),
|
||||||
|
prefix="sqlalchemy.",
|
||||||
|
poolclass=pool.NullPool,
|
||||||
|
)
|
||||||
|
with connectable.connect() as connection:
|
||||||
|
context.configure(connection=connection, target_metadata=target_metadata)
|
||||||
|
with context.begin_transaction():
|
||||||
|
context.run_migrations()
|
||||||
|
|
||||||
|
|
||||||
|
if context.is_offline_mode():
|
||||||
|
run_migrations_offline()
|
||||||
|
else:
|
||||||
|
run_migrations_online()
|
||||||
25
code/alembic/versions/0001_initial.py
Normal file
25
code/alembic/versions/0001_initial.py
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
"""migración inicial — esquema vacío
|
||||||
|
|
||||||
|
Revision ID: 0001_initial
|
||||||
|
Revises:
|
||||||
|
Create Date: 2026-05-04
|
||||||
|
"""
|
||||||
|
|
||||||
|
import sqlalchemy as sa # noqa: F401
|
||||||
|
|
||||||
|
from alembic import op # noqa: F401
|
||||||
|
|
||||||
|
revision = "0001_initial"
|
||||||
|
down_revision = None
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
# Esquema base vacío. Cuando agregues modelos en app/models/, regenera con:
|
||||||
|
# alembic revision --autogenerate -m "agregar tabla X"
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
pass
|
||||||
0
code/app/__init__.py
Normal file
0
code/app/__init__.py
Normal file
40
code/app/db.py
Normal file
40
code/app/db.py
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
"""
|
||||||
|
Capa de conexión SQLAlchemy.
|
||||||
|
- engine único por proceso, configurado al startup
|
||||||
|
- sesiones por request (dependency injection FastAPI)
|
||||||
|
- ping ligero para /health
|
||||||
|
"""
|
||||||
|
|
||||||
|
from collections.abc import Iterator
|
||||||
|
|
||||||
|
from sqlalchemy import create_engine, text
|
||||||
|
from sqlalchemy.orm import Session, sessionmaker
|
||||||
|
|
||||||
|
from app.settings import settings
|
||||||
|
|
||||||
|
engine = create_engine(
|
||||||
|
settings.DATABASE_URL,
|
||||||
|
pool_pre_ping=True,
|
||||||
|
pool_recycle=3600,
|
||||||
|
)
|
||||||
|
|
||||||
|
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
|
||||||
|
|
||||||
|
|
||||||
|
def get_session() -> Iterator[Session]:
|
||||||
|
"""Dependency FastAPI: una sesión por request, cierre garantizado."""
|
||||||
|
db = SessionLocal()
|
||||||
|
try:
|
||||||
|
yield db
|
||||||
|
finally:
|
||||||
|
db.close()
|
||||||
|
|
||||||
|
|
||||||
|
def db_alive() -> bool:
|
||||||
|
"""Ping de conexión usado por /health. Retorna False ante cualquier excepción."""
|
||||||
|
try:
|
||||||
|
with engine.connect() as conn:
|
||||||
|
conn.execute(text("SELECT 1"))
|
||||||
|
return True
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
115
code/app/main.py
Normal file
115
code/app/main.py
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
"""
|
||||||
|
Aplicación FastAPI — entry point.
|
||||||
|
|
||||||
|
Endpoints obligatorios del shape web-backend/python (ver coralware-shape.yaml):
|
||||||
|
- /health → liveness + readiness
|
||||||
|
- /docs → Swagger UI (auth opcional)
|
||||||
|
- /demo → frontend estático servido desde STATIC_DEMO_PATH
|
||||||
|
- /metrics → Prometheus
|
||||||
|
|
||||||
|
Endpoints de dominio: agregar en app/routers/ y registrar en _register_routers().
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
from fastapi import Depends, FastAPI, HTTPException, Request, status
|
||||||
|
from fastapi.responses import JSONResponse, Response
|
||||||
|
from fastapi.staticfiles import StaticFiles
|
||||||
|
from prometheus_client import CONTENT_TYPE_LATEST, generate_latest
|
||||||
|
|
||||||
|
from app.db import db_alive
|
||||||
|
from app.settings import settings
|
||||||
|
|
||||||
|
logging.basicConfig(
|
||||||
|
level=getattr(logging, settings.LOG_LEVEL, logging.INFO),
|
||||||
|
format="%(asctime)s [%(levelname)s] [cid=%(correlation_id)s] %(message)s",
|
||||||
|
datefmt="%Y-%m-%dT%H:%M:%SZ",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class CorrelationIdFilter(logging.Filter):
|
||||||
|
def filter(self, record: logging.LogRecord) -> bool:
|
||||||
|
if not hasattr(record, "correlation_id"):
|
||||||
|
record.correlation_id = "-"
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
logging.getLogger().addFilter(CorrelationIdFilter())
|
||||||
|
log = logging.getLogger("__APP_NAME__")
|
||||||
|
|
||||||
|
|
||||||
|
def _require_auth_dep() -> None:
|
||||||
|
"""
|
||||||
|
Dependency placeholder para /docs cuando OPENAPI_REQUIRE_AUTH=true.
|
||||||
|
Implementación real: validar JWT contra KEYCLOAK_ISSUER (ADR-029 R-004).
|
||||||
|
"""
|
||||||
|
if not settings.OPENAPI_REQUIRE_AUTH:
|
||||||
|
return
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=status.HTTP_401_UNAUTHORIZED,
|
||||||
|
detail="Auth requerido — implementar validación JWT contra Keycloak",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def create_app() -> FastAPI:
|
||||||
|
app = FastAPI(
|
||||||
|
title="__APP_NAME__",
|
||||||
|
version="0.1.0",
|
||||||
|
dependencies=[Depends(_require_auth_dep)] if settings.OPENAPI_REQUIRE_AUTH else [],
|
||||||
|
)
|
||||||
|
|
||||||
|
@app.middleware("http")
|
||||||
|
async def correlation_id_middleware(request: Request, call_next):
|
||||||
|
cid = request.headers.get(settings.CORRELATION_ID_HEADER) or _generate_cid()
|
||||||
|
request.state.correlation_id = cid
|
||||||
|
response = await call_next(request)
|
||||||
|
response.headers[settings.CORRELATION_ID_HEADER] = cid
|
||||||
|
return response
|
||||||
|
|
||||||
|
@app.get("/health", tags=["platform"])
|
||||||
|
async def health() -> JSONResponse:
|
||||||
|
db_status = "up" if db_alive() else "down"
|
||||||
|
code = 200 if db_status == "up" else 503
|
||||||
|
return JSONResponse(
|
||||||
|
status_code=code,
|
||||||
|
content={"status": "ok" if code == 200 else "degraded", "db": db_status},
|
||||||
|
)
|
||||||
|
|
||||||
|
@app.get("/metrics", tags=["platform"])
|
||||||
|
async def metrics() -> Response:
|
||||||
|
return Response(content=generate_latest(), media_type=CONTENT_TYPE_LATEST)
|
||||||
|
|
||||||
|
if os.path.isdir(settings.STATIC_DEMO_PATH):
|
||||||
|
app.mount(
|
||||||
|
"/demo",
|
||||||
|
StaticFiles(directory=settings.STATIC_DEMO_PATH, html=True),
|
||||||
|
name="demo",
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
log.warning(
|
||||||
|
"STATIC_DEMO_PATH=%s no existe — endpoint /demo no será servido",
|
||||||
|
settings.STATIC_DEMO_PATH,
|
||||||
|
)
|
||||||
|
|
||||||
|
_register_routers(app)
|
||||||
|
return app
|
||||||
|
|
||||||
|
|
||||||
|
def _generate_cid() -> str:
|
||||||
|
"""Genera correlation_id si el cliente no envió uno."""
|
||||||
|
import time
|
||||||
|
import uuid
|
||||||
|
|
||||||
|
return f"__APP_NAME__-{int(time.time() * 1000)}-{uuid.uuid4().hex[:8]}"
|
||||||
|
|
||||||
|
|
||||||
|
def _register_routers(app: FastAPI) -> None:
|
||||||
|
"""
|
||||||
|
Registra los routers de dominio.
|
||||||
|
Agrega aquí los include_router(...) conforme tu app crezca.
|
||||||
|
"""
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
app = create_app()
|
||||||
8
code/app/models/__init__.py
Normal file
8
code/app/models/__init__.py
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Modelos SQLAlchemy. Define tu Base aquí y heredala en cada modelo:
|
||||||
|
#
|
||||||
|
# from sqlalchemy.orm import DeclarativeBase
|
||||||
|
# class Base(DeclarativeBase):
|
||||||
|
# pass
|
||||||
|
#
|
||||||
|
# Tras crear modelos, genera la migración con:
|
||||||
|
# alembic revision --autogenerate -m "descripción del cambio"
|
||||||
2
code/app/routers/__init__.py
Normal file
2
code/app/routers/__init__.py
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# Routers de dominio. Crea un módulo por agregado (users.py, orders.py, etc.)
|
||||||
|
# y regístralos en app/main.py:_register_routers().
|
||||||
32
code/app/settings.py
Normal file
32
code/app/settings.py
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
"""
|
||||||
|
Configuración runtime via variables de entorno.
|
||||||
|
Toda la configuración pasa por aquí — no leas env vars dispersos en otros módulos.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from pydantic import Field
|
||||||
|
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||||
|
|
||||||
|
|
||||||
|
class Settings(BaseSettings):
|
||||||
|
model_config = SettingsConfigDict(env_file=None, case_sensitive=True)
|
||||||
|
|
||||||
|
DATABASE_URL: str = Field(..., description="Connection string runtime de la app")
|
||||||
|
MIGRATION_DATABASE_URL: str = Field(
|
||||||
|
default="",
|
||||||
|
description="Connection string para Alembic; si vacío, usa DATABASE_URL",
|
||||||
|
)
|
||||||
|
|
||||||
|
LOG_LEVEL: str = "INFO"
|
||||||
|
CORRELATION_ID_HEADER: str = "X-Correlation-ID"
|
||||||
|
|
||||||
|
OPENAPI_REQUIRE_AUTH: bool = False
|
||||||
|
KEYCLOAK_ISSUER: str = ""
|
||||||
|
|
||||||
|
STATIC_DEMO_PATH: str = "/app/static/demo"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def migration_url(self) -> str:
|
||||||
|
return self.MIGRATION_DATABASE_URL or self.DATABASE_URL
|
||||||
|
|
||||||
|
|
||||||
|
settings = Settings()
|
||||||
41
code/app/static/demo/index.html
Normal file
41
code/app/static/demo/index.html
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="es">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>__APP_NAME__ — demo</title>
|
||||||
|
<style>
|
||||||
|
body { font-family: system-ui, sans-serif; max-width: 720px; margin: 4rem auto; padding: 0 1rem; }
|
||||||
|
code { background: #f4f4f4; padding: 0.15rem 0.4rem; border-radius: 3px; }
|
||||||
|
.status { padding: 0.5rem 1rem; border-radius: 4px; margin-top: 1rem; }
|
||||||
|
.ok { background: #d4edda; color: #155724; }
|
||||||
|
.err { background: #f8d7da; color: #721c24; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>__APP_NAME__</h1>
|
||||||
|
<p>App generada desde el Golden Path <code>web-backend/python</code>.</p>
|
||||||
|
<p>
|
||||||
|
Este es el frontend estático servido en <code>/demo</code>. Modifica
|
||||||
|
<code>code/app/static/demo/</code> para reemplazarlo con tu UI.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<div id="health-status" class="status">cargando…</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
fetch('/health')
|
||||||
|
.then(r => r.json())
|
||||||
|
.then(data => {
|
||||||
|
const el = document.getElementById('health-status');
|
||||||
|
const ok = data.status === 'ok';
|
||||||
|
el.className = 'status ' + (ok ? 'ok' : 'err');
|
||||||
|
el.textContent = `Estado: ${data.status} · DB: ${data.db}`;
|
||||||
|
})
|
||||||
|
.catch(err => {
|
||||||
|
const el = document.getElementById('health-status');
|
||||||
|
el.className = 'status err';
|
||||||
|
el.textContent = 'No se pudo contactar a /health';
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
37
code/pyproject.toml
Normal file
37
code/pyproject.toml
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
[project]
|
||||||
|
name = "__APP_NAME__"
|
||||||
|
version = "0.1.0"
|
||||||
|
description = "Web backend Python (FastAPI + Alembic) — Golden Path web-backend/python"
|
||||||
|
requires-python = ">=3.12"
|
||||||
|
|
||||||
|
[tool.black]
|
||||||
|
line-length = 100
|
||||||
|
target-version = ["py312"]
|
||||||
|
|
||||||
|
[tool.ruff]
|
||||||
|
line-length = 100
|
||||||
|
target-version = "py312"
|
||||||
|
|
||||||
|
[tool.ruff.lint]
|
||||||
|
select = ["E", "F", "W", "I", "B", "UP", "S"]
|
||||||
|
ignore = ["S101"]
|
||||||
|
|
||||||
|
[tool.ruff.lint.per-file-ignores]
|
||||||
|
"tests/*" = ["S105", "S106"]
|
||||||
|
|
||||||
|
[tool.bandit]
|
||||||
|
exclude_dirs = ["tests", ".venv"]
|
||||||
|
|
||||||
|
[tool.pytest.ini_options]
|
||||||
|
pythonpath = ["."]
|
||||||
|
testpaths = ["tests"]
|
||||||
|
addopts = "-v --strict-markers"
|
||||||
|
asyncio_mode = "auto"
|
||||||
|
|
||||||
|
[tool.coverage.run]
|
||||||
|
source = ["app"]
|
||||||
|
omit = ["app/__init__.py", "tests/*"]
|
||||||
|
|
||||||
|
[tool.coverage.report]
|
||||||
|
fail_under = 80
|
||||||
|
show_missing = true
|
||||||
6
code/requirements-dev.txt
Normal file
6
code/requirements-dev.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
-r requirements.txt
|
||||||
|
-r ../../code/requirements-dev-base.txt
|
||||||
|
|
||||||
|
httpx==0.27.2
|
||||||
|
pytest-asyncio==0.24.0
|
||||||
|
testcontainers[mariadb]==4.8.2
|
||||||
10
code/requirements.txt
Normal file
10
code/requirements.txt
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
fastapi==0.115.0
|
||||||
|
uvicorn[standard]==0.32.0
|
||||||
|
pydantic==2.9.2
|
||||||
|
pydantic-settings==2.6.0
|
||||||
|
sqlalchemy==2.0.36
|
||||||
|
alembic==1.13.3
|
||||||
|
pymysql==1.1.1
|
||||||
|
cryptography==43.0.3
|
||||||
|
prometheus-client==0.21.0
|
||||||
|
python-jose[cryptography]==3.3.0
|
||||||
0
code/tests/__init__.py
Normal file
0
code/tests/__init__.py
Normal file
34
code/tests/conftest.py
Normal file
34
code/tests/conftest.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
"""
|
||||||
|
Fixtures para los tests del shape.
|
||||||
|
|
||||||
|
Levanta una MariaDB efímera con testcontainers para que los tests corran
|
||||||
|
contra una BD real (no mocks). El reusable workflow ADR-038 garantiza que
|
||||||
|
Docker está disponible en el runner.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
from collections.abc import Iterator
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
from testcontainers.mariadb import MariaDbContainer
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="session")
|
||||||
|
def mariadb_url() -> Iterator[str]:
|
||||||
|
"""MariaDB efímera por sesión de tests; URL exportada como DATABASE_URL."""
|
||||||
|
with MariaDbContainer("mariadb:11") as mdb:
|
||||||
|
url = mdb.get_connection_url().replace("mysql://", "mysql+pymysql://", 1)
|
||||||
|
os.environ["DATABASE_URL"] = url
|
||||||
|
os.environ["MIGRATION_DATABASE_URL"] = url
|
||||||
|
yield url
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def client(mariadb_url: str) -> Iterator[TestClient]:
|
||||||
|
"""TestClient con la app cargada contra la BD efímera."""
|
||||||
|
from app.main import create_app
|
||||||
|
|
||||||
|
app = create_app()
|
||||||
|
with TestClient(app) as c:
|
||||||
|
yield c
|
||||||
22
code/tests/test_demo.py
Normal file
22
code/tests/test_demo.py
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
"""Cubre el endpoint /demo: sirve el index estático."""
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
|
||||||
|
def test_demo_serves_index_html(client: TestClient) -> None:
|
||||||
|
response = client.get("/demo/")
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert "text/html" in response.headers.get("content-type", "")
|
||||||
|
assert "__APP_NAME__" in response.text or "demo" in response.text.lower()
|
||||||
|
|
||||||
|
|
||||||
|
def test_metrics_endpoint_responds(client: TestClient) -> None:
|
||||||
|
response = client.get("/metrics")
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert "text/plain" in response.headers.get("content-type", "")
|
||||||
|
|
||||||
|
|
||||||
|
def test_openapi_accessible_when_auth_disabled(client: TestClient) -> None:
|
||||||
|
response = client.get("/openapi.json")
|
||||||
|
assert response.status_code == 200
|
||||||
|
spec = response.json()
|
||||||
|
assert spec["info"]["title"] == "__APP_NAME__"
|
||||||
30
code/tests/test_health.py
Normal file
30
code/tests/test_health.py
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
"""Cubre el endpoint /health: respuesta 200 con la BD viva, 503 cuando cae."""
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
|
||||||
|
def test_health_db_up_returns_200(client: TestClient) -> None:
|
||||||
|
response = client.get("/health")
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert response.json() == {"status": "ok", "db": "up"}
|
||||||
|
|
||||||
|
|
||||||
|
def test_health_db_down_returns_503(client: TestClient) -> None:
|
||||||
|
with patch("app.main.db_alive", return_value=False):
|
||||||
|
response = client.get("/health")
|
||||||
|
assert response.status_code == 503
|
||||||
|
body = response.json()
|
||||||
|
assert body["status"] == "degraded"
|
||||||
|
assert body["db"] == "down"
|
||||||
|
|
||||||
|
|
||||||
|
def test_health_propagates_correlation_id(client: TestClient) -> None:
|
||||||
|
cid = "test-cid-12345"
|
||||||
|
response = client.get("/health", headers={"X-Correlation-ID": cid})
|
||||||
|
assert response.headers.get("X-Correlation-ID") == cid
|
||||||
|
|
||||||
|
|
||||||
|
def test_health_generates_correlation_id_when_absent(client: TestClient) -> None:
|
||||||
|
response = client.get("/health")
|
||||||
|
assert response.headers.get("X-Correlation-ID")
|
||||||
38
coralware-shape.yaml
Normal file
38
coralware-shape.yaml
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# Manifiesto de contrato del shape — leído por la plataforma Coralware
|
||||||
|
# para entender qué endpoints expone tu app y qué dependencias necesita.
|
||||||
|
# NO eliminar este archivo. Sí puedes ajustar valores conforme tu app evolucione.
|
||||||
|
apiVersion: coralware.cloud/v1alpha1
|
||||||
|
kind: Shape
|
||||||
|
metadata:
|
||||||
|
name: web-backend-python
|
||||||
|
spec:
|
||||||
|
goldenPath: web-backend
|
||||||
|
goldenPathLang: python
|
||||||
|
shapeVersion: "1.0.0"
|
||||||
|
|
||||||
|
app:
|
||||||
|
name: __APP_NAME__
|
||||||
|
framework: fastapi
|
||||||
|
pythonVersion: "3.12"
|
||||||
|
|
||||||
|
endpoints:
|
||||||
|
health: /health
|
||||||
|
docs: /docs
|
||||||
|
demo: /demo
|
||||||
|
metrics: /metrics
|
||||||
|
|
||||||
|
database:
|
||||||
|
required: true
|
||||||
|
type: mariadb
|
||||||
|
secretName: __APP_NAME__-db-creds
|
||||||
|
keys:
|
||||||
|
- DATABASE_URL
|
||||||
|
- MIGRATION_DATABASE_URL
|
||||||
|
|
||||||
|
migrations:
|
||||||
|
tool: alembic
|
||||||
|
hook: pre-upgrade
|
||||||
|
|
||||||
|
observability:
|
||||||
|
metricsPort: 9090
|
||||||
|
prometheusScrape: true
|
||||||
11
helm/APP_NAME/.helmignore
Normal file
11
helm/APP_NAME/.helmignore
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
.DS_Store
|
||||||
|
.git/
|
||||||
|
.gitignore
|
||||||
|
.idea/
|
||||||
|
.vscode/
|
||||||
|
*.tmproj
|
||||||
|
.project
|
||||||
|
*.tgz
|
||||||
|
.helmignore
|
||||||
|
README.md
|
||||||
|
LICENSE
|
||||||
12
helm/APP_NAME/Chart.yaml
Normal file
12
helm/APP_NAME/Chart.yaml
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
apiVersion: v2
|
||||||
|
name: __APP_NAME__
|
||||||
|
description: Helm chart del Golden Path web-backend/python
|
||||||
|
type: application
|
||||||
|
version: 0.1.0
|
||||||
|
appVersion: "0.1.0"
|
||||||
|
keywords:
|
||||||
|
- fastapi
|
||||||
|
- web-backend
|
||||||
|
- coralware-cove
|
||||||
|
maintainers:
|
||||||
|
- name: __OWNER__
|
||||||
32
helm/APP_NAME/templates/_helpers.tpl
Normal file
32
helm/APP_NAME/templates/_helpers.tpl
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
{{/*
|
||||||
|
Labels comunes a todos los recursos del chart.
|
||||||
|
Sigue convenciones CLAUDE.md global + IDP (idp.coralware.cloud/*).
|
||||||
|
*/}}
|
||||||
|
{{- define "app.labels" -}}
|
||||||
|
app.kubernetes.io/name: {{ .Chart.Name }}
|
||||||
|
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||||
|
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||||
|
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||||
|
app.kubernetes.io/part-of: {{ .Chart.Name }}
|
||||||
|
idp.coralware.cloud/tier: {{ .Values.tier | quote }}
|
||||||
|
idp.coralware.cloud/tenant-id: {{ .Values.tenantId | quote }}
|
||||||
|
idp.coralware.cloud/golden-path: {{ .Values.goldenPath }}
|
||||||
|
idp.coralware.cloud/golden-path-lang: {{ .Values.goldenPathLang }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
{{/*
|
||||||
|
Selector labels — subset estable de app.labels usado en Deployment.spec.selector
|
||||||
|
y Service.spec.selector. NO debe incluir labels que cambien (version, tier).
|
||||||
|
*/}}
|
||||||
|
{{- define "app.selectorLabels" -}}
|
||||||
|
app.kubernetes.io/name: {{ .Chart.Name }}
|
||||||
|
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
{{/*
|
||||||
|
Checksum del Secret de la BD — fuerza rollout cuando rota el secret.
|
||||||
|
*/}}
|
||||||
|
{{- define "app.dbSecretChecksum" -}}
|
||||||
|
{{- $secret := lookup "v1" "Secret" .Release.Namespace .Values.database.secretName }}
|
||||||
|
{{- if $secret }}{{ toYaml $secret.data | sha256sum }}{{ else }}absent{{ end }}
|
||||||
|
{{- end }}
|
||||||
87
helm/APP_NAME/templates/deployment.yaml
Normal file
87
helm/APP_NAME/templates/deployment.yaml
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: {{ .Release.Name }}
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 4 }}
|
||||||
|
spec:
|
||||||
|
replicas: {{ .Values.replicaCount }}
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
{{- include "app.selectorLabels" . | nindent 6 }}
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 8 }}
|
||||||
|
annotations:
|
||||||
|
checksum/db-secret: {{ include "app.dbSecretChecksum" . }}
|
||||||
|
spec:
|
||||||
|
serviceAccountName: {{ .Release.Name }}
|
||||||
|
imagePullSecrets:
|
||||||
|
- name: {{ .Values.image.pullSecret }}
|
||||||
|
securityContext:
|
||||||
|
runAsNonRoot: true
|
||||||
|
runAsUser: 1001
|
||||||
|
seccompProfile:
|
||||||
|
type: RuntimeDefault
|
||||||
|
containers:
|
||||||
|
- name: app
|
||||||
|
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
|
||||||
|
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||||
|
ports:
|
||||||
|
- name: http
|
||||||
|
containerPort: 8000
|
||||||
|
protocol: TCP
|
||||||
|
envFrom:
|
||||||
|
- secretRef:
|
||||||
|
name: {{ .Values.database.secretName }}
|
||||||
|
- configMapRef:
|
||||||
|
name: {{ .Release.Name }}-config
|
||||||
|
env:
|
||||||
|
- name: STATIC_DEMO_PATH
|
||||||
|
value: {{ .Values.config.staticDemoPath | quote }}
|
||||||
|
livenessProbe:
|
||||||
|
httpGet:
|
||||||
|
path: /health
|
||||||
|
port: http
|
||||||
|
initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }}
|
||||||
|
periodSeconds: {{ .Values.probes.liveness.periodSeconds }}
|
||||||
|
readinessProbe:
|
||||||
|
httpGet:
|
||||||
|
path: /health
|
||||||
|
port: http
|
||||||
|
initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }}
|
||||||
|
periodSeconds: {{ .Values.probes.readiness.periodSeconds }}
|
||||||
|
failureThreshold: {{ .Values.probes.readiness.failureThreshold }}
|
||||||
|
resources:
|
||||||
|
{{- toYaml .Values.resources | nindent 12 }}
|
||||||
|
securityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
readOnlyRootFilesystem: true
|
||||||
|
capabilities:
|
||||||
|
drop: ["ALL"]
|
||||||
|
volumeMounts:
|
||||||
|
- name: tmp
|
||||||
|
mountPath: /tmp
|
||||||
|
volumes:
|
||||||
|
- name: tmp
|
||||||
|
emptyDir: {}
|
||||||
|
---
|
||||||
|
apiVersion: v1
|
||||||
|
kind: ServiceAccount
|
||||||
|
metadata:
|
||||||
|
name: {{ .Release.Name }}
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 4 }}
|
||||||
|
---
|
||||||
|
apiVersion: v1
|
||||||
|
kind: ConfigMap
|
||||||
|
metadata:
|
||||||
|
name: {{ .Release.Name }}-config
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 4 }}
|
||||||
|
data:
|
||||||
|
LOG_LEVEL: {{ .Values.config.logLevel | quote }}
|
||||||
|
CORRELATION_ID_HEADER: {{ .Values.config.correlationIdHeader | quote }}
|
||||||
|
OPENAPI_REQUIRE_AUTH: {{ .Values.config.openapiRequireAuth | quote }}
|
||||||
|
KEYCLOAK_ISSUER: {{ .Values.config.keycloakIssuer | quote }}
|
||||||
19
helm/APP_NAME/templates/ingressroute.yaml
Normal file
19
helm/APP_NAME/templates/ingressroute.yaml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{{- if .Values.ingress.enabled }}
|
||||||
|
apiVersion: traefik.io/v1alpha1
|
||||||
|
kind: IngressRoute
|
||||||
|
metadata:
|
||||||
|
name: {{ .Release.Name }}
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 4 }}
|
||||||
|
spec:
|
||||||
|
entryPoints:
|
||||||
|
- websecure
|
||||||
|
routes:
|
||||||
|
- match: Host(`{{ .Values.ingress.host }}`)
|
||||||
|
kind: Rule
|
||||||
|
services:
|
||||||
|
- name: {{ .Release.Name }}
|
||||||
|
port: {{ .Values.service.port }}
|
||||||
|
tls:
|
||||||
|
secretName: {{ .Values.ingress.tlsSecretName }}
|
||||||
|
{{- end }}
|
||||||
59
helm/APP_NAME/templates/job-alembic-upgrade.yaml
Normal file
59
helm/APP_NAME/templates/job-alembic-upgrade.yaml
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
{{- if .Values.alembic.enabled }}
|
||||||
|
# Job pre-upgrade que corre Alembic antes de rolar el Deployment.
|
||||||
|
# - backoffLimit: 0 → si falla, NO reintenta; Helm aborta el upgrade.
|
||||||
|
# - hook-delete-policy hook-succeeded → solo se borra al éxito; en fallo queda
|
||||||
|
# visible para `kubectl logs job/...` y diagnóstico.
|
||||||
|
apiVersion: batch/v1
|
||||||
|
kind: Job
|
||||||
|
metadata:
|
||||||
|
name: {{ .Release.Name }}-alembic-{{ .Release.Revision }}
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 4 }}
|
||||||
|
annotations:
|
||||||
|
"helm.sh/hook": pre-upgrade,pre-install
|
||||||
|
"helm.sh/hook-weight": "0"
|
||||||
|
"helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
|
||||||
|
spec:
|
||||||
|
backoffLimit: 0
|
||||||
|
ttlSecondsAfterFinished: 600
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 8 }}
|
||||||
|
spec:
|
||||||
|
restartPolicy: Never
|
||||||
|
serviceAccountName: {{ .Release.Name }}
|
||||||
|
imagePullSecrets:
|
||||||
|
- name: {{ .Values.image.pullSecret }}
|
||||||
|
securityContext:
|
||||||
|
runAsNonRoot: true
|
||||||
|
runAsUser: 1001
|
||||||
|
containers:
|
||||||
|
- name: alembic
|
||||||
|
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
|
||||||
|
command: {{ .Values.alembic.command | toJson }}
|
||||||
|
envFrom:
|
||||||
|
- secretRef:
|
||||||
|
name: {{ .Values.database.secretName }}
|
||||||
|
env:
|
||||||
|
# Si el Secret expone MIGRATION_DATABASE_URL, lo usa; si no, env.py
|
||||||
|
# cae a DATABASE_URL automáticamente (ver settings.migration_url).
|
||||||
|
- name: DATABASE_URL
|
||||||
|
valueFrom:
|
||||||
|
secretKeyRef:
|
||||||
|
name: {{ .Values.database.secretName }}
|
||||||
|
key: DATABASE_URL
|
||||||
|
- name: MIGRATION_DATABASE_URL
|
||||||
|
valueFrom:
|
||||||
|
secretKeyRef:
|
||||||
|
name: {{ .Values.database.secretName }}
|
||||||
|
key: MIGRATION_DATABASE_URL
|
||||||
|
optional: true
|
||||||
|
resources:
|
||||||
|
{{- toYaml .Values.alembic.resources | nindent 12 }}
|
||||||
|
securityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
readOnlyRootFilesystem: true
|
||||||
|
capabilities:
|
||||||
|
drop: ["ALL"]
|
||||||
|
{{- end }}
|
||||||
66
helm/APP_NAME/templates/networkpolicy.yaml
Normal file
66
helm/APP_NAME/templates/networkpolicy.yaml
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
{{- if .Values.networkPolicy.enabled }}
|
||||||
|
# NetworkPolicy mínima del shape: bajo deny-all-default del namespace, permite:
|
||||||
|
# - Ingress: Traefik (web-backend público) + Prometheus (scrape de /metrics).
|
||||||
|
# - Egress: DNS, Harbor (pull en startup), ns-addons del tenant (BD).
|
||||||
|
apiVersion: networking.k8s.io/v1
|
||||||
|
kind: NetworkPolicy
|
||||||
|
metadata:
|
||||||
|
name: {{ .Release.Name }}
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 4 }}
|
||||||
|
spec:
|
||||||
|
podSelector:
|
||||||
|
matchLabels:
|
||||||
|
{{- include "app.selectorLabels" . | nindent 6 }}
|
||||||
|
policyTypes: [Ingress, Egress]
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
# Tráfico HTTP desde Traefik (IngressRoute)
|
||||||
|
- from:
|
||||||
|
- namespaceSelector:
|
||||||
|
matchLabels:
|
||||||
|
kubernetes.io/metadata.name: traefik-system
|
||||||
|
ports:
|
||||||
|
- protocol: TCP
|
||||||
|
port: 8000
|
||||||
|
# Scrape de métricas Prometheus
|
||||||
|
- from:
|
||||||
|
- namespaceSelector:
|
||||||
|
matchLabels:
|
||||||
|
kubernetes.io/metadata.name: cattle-monitoring-system
|
||||||
|
podSelector:
|
||||||
|
matchLabels:
|
||||||
|
app.kubernetes.io/name: prometheus
|
||||||
|
ports:
|
||||||
|
- protocol: TCP
|
||||||
|
port: 8000
|
||||||
|
|
||||||
|
egress:
|
||||||
|
# DNS
|
||||||
|
- to:
|
||||||
|
- namespaceSelector:
|
||||||
|
matchLabels:
|
||||||
|
kubernetes.io/metadata.name: kube-system
|
||||||
|
ports:
|
||||||
|
- protocol: UDP
|
||||||
|
port: 53
|
||||||
|
- protocol: TCP
|
||||||
|
port: 53
|
||||||
|
# ns-addons del tenant: MariaDB primary + pool
|
||||||
|
- to:
|
||||||
|
- namespaceSelector:
|
||||||
|
matchLabels:
|
||||||
|
kubernetes.io/metadata.name: {{ .Values.networkPolicy.addonsNamespace }}
|
||||||
|
ports:
|
||||||
|
- protocol: TCP
|
||||||
|
port: 3306
|
||||||
|
- protocol: TCP
|
||||||
|
port: 6033
|
||||||
|
# Harbor pull (registro de imágenes)
|
||||||
|
- to:
|
||||||
|
- ipBlock:
|
||||||
|
cidr: 0.0.0.0/0
|
||||||
|
ports:
|
||||||
|
- protocol: TCP
|
||||||
|
port: 443
|
||||||
|
{{- end }}
|
||||||
15
helm/APP_NAME/templates/service.yaml
Normal file
15
helm/APP_NAME/templates/service.yaml
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
apiVersion: v1
|
||||||
|
kind: Service
|
||||||
|
metadata:
|
||||||
|
name: {{ .Release.Name }}
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 4 }}
|
||||||
|
spec:
|
||||||
|
type: {{ .Values.service.type }}
|
||||||
|
selector:
|
||||||
|
{{- include "app.selectorLabels" . | nindent 4 }}
|
||||||
|
ports:
|
||||||
|
- name: http
|
||||||
|
port: {{ .Values.service.port }}
|
||||||
|
targetPort: http
|
||||||
|
protocol: TCP
|
||||||
16
helm/APP_NAME/templates/servicemonitor.yaml
Normal file
16
helm/APP_NAME/templates/servicemonitor.yaml
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
{{- if .Values.serviceMonitor.enabled }}
|
||||||
|
apiVersion: monitoring.coreos.com/v1
|
||||||
|
kind: ServiceMonitor
|
||||||
|
metadata:
|
||||||
|
name: {{ .Release.Name }}
|
||||||
|
labels:
|
||||||
|
{{- include "app.labels" . | nindent 4 }}
|
||||||
|
spec:
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
{{- include "app.selectorLabels" . | nindent 6 }}
|
||||||
|
endpoints:
|
||||||
|
- port: {{ .Values.serviceMonitor.port }}
|
||||||
|
interval: {{ .Values.serviceMonitor.interval }}
|
||||||
|
path: /metrics
|
||||||
|
{{- end }}
|
||||||
69
helm/APP_NAME/values.yaml
Normal file
69
helm/APP_NAME/values.yaml
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
# Defaults sensatos para tier startup. El CI inyecta tier/tenantId via --set
|
||||||
|
# leyendo valores del TenantProfile correspondiente.
|
||||||
|
|
||||||
|
replicaCount: 1
|
||||||
|
|
||||||
|
image:
|
||||||
|
repository: registry.coralsafety.com/__TENANT_ID_NODASHES__/__APP_NAME__
|
||||||
|
tag: latest
|
||||||
|
pullPolicy: Always
|
||||||
|
pullSecret: harbor-tenant-pull
|
||||||
|
|
||||||
|
# Identidad del tenant — populated por --set desde el CI
|
||||||
|
tenantId: ""
|
||||||
|
tenantIdNodashes: ""
|
||||||
|
tier: startup
|
||||||
|
goldenPath: web-backend
|
||||||
|
goldenPathLang: python
|
||||||
|
|
||||||
|
database:
|
||||||
|
secretName: __APP_NAME__-db-creds
|
||||||
|
|
||||||
|
config:
|
||||||
|
logLevel: INFO
|
||||||
|
correlationIdHeader: X-Correlation-ID
|
||||||
|
openapiRequireAuth: false
|
||||||
|
keycloakIssuer: ""
|
||||||
|
staticDemoPath: /app/static/demo
|
||||||
|
|
||||||
|
resources:
|
||||||
|
requests:
|
||||||
|
cpu: 50m
|
||||||
|
memory: 128Mi
|
||||||
|
limits:
|
||||||
|
cpu: 500m
|
||||||
|
memory: 512Mi
|
||||||
|
|
||||||
|
probes:
|
||||||
|
liveness:
|
||||||
|
initialDelaySeconds: 20
|
||||||
|
periodSeconds: 10
|
||||||
|
readiness:
|
||||||
|
initialDelaySeconds: 5
|
||||||
|
periodSeconds: 5
|
||||||
|
failureThreshold: 3
|
||||||
|
|
||||||
|
service:
|
||||||
|
type: ClusterIP
|
||||||
|
port: 8000
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: true
|
||||||
|
host: __APP_NAME__-__TENANT_ID_NODASHES__.apps.coralware.cloud
|
||||||
|
tlsSecretName: __APP_NAME__-tls
|
||||||
|
|
||||||
|
alembic:
|
||||||
|
enabled: true
|
||||||
|
command: ["alembic", "upgrade", "head"]
|
||||||
|
resources:
|
||||||
|
requests: {cpu: 50m, memory: 128Mi}
|
||||||
|
limits: {cpu: 200m, memory: 256Mi}
|
||||||
|
|
||||||
|
serviceMonitor:
|
||||||
|
enabled: true
|
||||||
|
interval: 30s
|
||||||
|
port: http
|
||||||
|
|
||||||
|
networkPolicy:
|
||||||
|
enabled: true
|
||||||
|
addonsNamespace: __TENANT_ID_NODASHES__-addons
|
||||||
Reference in New Issue
Block a user