refactor: convertir este repositorio en instancia de clusterlog
Retira el código del motor (cmd/, internal/, go.mod, templates/, examples/, scripts de desarrollo Go) — vive ahora en https://github.com/fenandosr/clusterlog (release v0.1.0). Este repositorio conserva únicamente content/, data/, config/ y zola.toml: los datos reales de esta instancia (MCPS). Se agrega .clusterlog-version (fija v0.1.0) y scripts/fetch-engine.sh, que descarga el binario y las plantillas del motor por versión fijada verificando su checksum contra el release. Makefile y .gitea/workflows/ci.yml se adaptan para descargar en vez de compilar. RUNBOOK.md y runbooks/ se recortan a las celdas que sí operan sobre datos reales de esta instancia (sync-check, validate-local, site-build, review-mine, verify-head); el ciclo de desarrollo del motor mismo (build/test/vet) vive en su propio repositorio. Se preserva toda la historia existente: éste es un commit nuevo, no una reescritura. Ver docs/adr/0005-motor-instancia.md en el repositorio del motor para el contexto completo de la separación. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,6 +1,16 @@
|
||||
# Bitácora Operativa del Clúster
|
||||
# Bitácora Operativa del Clúster (MCPS)
|
||||
|
||||
Sitio interno y CLI auditable para conservar en un solo lugar la documentación, los manuales, las memorias de cambio, los proyectos, las tareas y la agenda de revisión semanal del equipo que administra un clúster.
|
||||
Instancia de [`clusterlog`](https://github.com/fenandosr/clusterlog): sitio
|
||||
interno y CLI auditable para conservar en un solo lugar la documentación,
|
||||
los manuales, las memorias de cambio, los proyectos, las tareas y la agenda
|
||||
de revisión semanal del equipo que administra el clúster MCPS.
|
||||
|
||||
Este repositorio contiene únicamente **datos de este deployment**
|
||||
(`content/`, `data/`, `config/`, `zola.toml`, `.clusterlog-version`). El
|
||||
código de la CLI, las plantillas y el mecanismo de tema viven en el motor:
|
||||
[fenandosr/clusterlog](https://github.com/fenandosr/clusterlog) — ver
|
||||
`docs/adr/0005-motor-instancia.md` de ese repositorio para el porqué de la
|
||||
separación.
|
||||
|
||||
La solución separa responsabilidades:
|
||||
|
||||
@@ -13,7 +23,7 @@ administrador o agente IA
|
||||
| ---- escribe Markdown/eventos JSON
|
||||
| ---- opcionalmente crea commit SSH firmado
|
||||
v
|
||||
repositorio Git ---- fuente de verdad y auditoría
|
||||
repositorio Git ---- fuente de verdad y auditoría (esta instancia)
|
||||
|
|
||||
v
|
||||
clusterlog sync ---- genera data/generated/site_state.json
|
||||
@@ -22,7 +32,7 @@ administrador o agente IA
|
||||
Zola ---- lectura, navegación, taxonomías y búsqueda
|
||||
```
|
||||
|
||||
## Qué incluye el MVP
|
||||
## Qué incluye
|
||||
|
||||
- Secciones de **Documentación**, **Manuales**, **Memorias**, **Proyectos**, **Tareas** y **Revisión**.
|
||||
- Memorias operativas con autor, huella SSH, riesgo, sistemas, etiquetas, ticket, duración, validación y reversión.
|
||||
@@ -30,79 +40,45 @@ administrador o agente IA
|
||||
- Invalidación automática de revisiones cuando cambia el contenido de una memoria.
|
||||
- Tareas con estimación, fecha objetivo, responsables, estado y tiempo real mediante eventos `start`, `stop` y `adjust`.
|
||||
- Proyectos con objetivo, responsables, alcance, hitos, criterio de éxito y estado.
|
||||
- CLI no interactiva, salida JSON, entrada JSON por archivo o `stdin`, modo `--dry-run` y códigos de salida estables.
|
||||
- Identidad por huella de llave pública SSH y commits Git firmados por SSH con `--commit`.
|
||||
- Detección heurística de secretos antes de escribir contenido.
|
||||
- Estado derivado y reproducible para que Zola siga siendo un sitio estático.
|
||||
|
||||
## Requisitos
|
||||
|
||||
- Go 1.23 o posterior.
|
||||
- Git con soporte de firmas SSH.
|
||||
- OpenSSH/`ssh-keygen` para firmar y verificar commits.
|
||||
- Zola 0.23.3 para construir el sitio.
|
||||
- Acceso al repositorio del tema durante `make theme`, o una copia local indicada con `ZOLA386_SOURCE`.
|
||||
- **No requiere Go ni un checkout del motor**: `make build`/`make templates` descargan el binario y las plantillas fijadas en [`.clusterlog-version`](.clusterlog-version) desde `fenandosr/clusterlog`, verificando su checksum.
|
||||
|
||||
## Inicio rápido
|
||||
|
||||
```bash
|
||||
make theme
|
||||
make build
|
||||
make theme # tema zola.386 (repositorio externo, pinneado)
|
||||
make templates # plantillas del motor, versión fijada
|
||||
make build # binario clusterlog, versión fijada
|
||||
./bin/clusterlog --root . sync
|
||||
./bin/clusterlog --root . validate --skip-zola
|
||||
zola serve
|
||||
```
|
||||
|
||||
El sitio queda disponible en la dirección que muestre Zola. Antes de publicarlo, cambie `base_url` en `zola.toml` y manténgalo detrás de VPN, red privada o autenticación corporativa.
|
||||
El sitio queda disponible en la dirección que muestre Zola. Antes de publicar un cambio a `base_url`/`zola.toml`, manténgalo detrás de VPN, red privada o autenticación corporativa.
|
||||
|
||||
## Crear una instancia nueva
|
||||
## Registrar un administrador nuevo
|
||||
|
||||
Este repositorio hoy mezcla la herramienta con el contenido de un deployment. Para empezar un deployment **distinto** sin partir de este contenido, use:
|
||||
|
||||
```bash
|
||||
clusterlog bootstrap-instance --output ./mi-deploy --product-name "Mi Bitácora"
|
||||
```
|
||||
|
||||
Genera `zola.toml`, las seis secciones de `content/` vacías, `data/admins.json`/`config/allowed_signers` vacíos y `.clusterlog-version`. Ver la sección 17 de [`CLI.md`](CLI.md) para el detalle completo; sigue siendo un primer paso — todavía no incluye plantillas/tema empaquetados ni CI de instancia (el motor no publica releases binarios todavía).
|
||||
|
||||
## Registrar al primer administrador
|
||||
|
||||
La llave pública identifica el registro del administrador. Para una auditoría fuerte, las operaciones posteriores deben usar `--commit` y la rama protegida debe rechazar commits sin firma válida.
|
||||
Sólo un `owner` activo puede hacerlo (ver `content/manuales/primer-administrador.md` para el procedimiento completo, incluido el alta del segundo administrador).
|
||||
|
||||
```bash
|
||||
./bin/clusterlog \
|
||||
--root . \
|
||||
--ssh-key ~/.ssh/id_ed25519.pub \
|
||||
--commit \
|
||||
admin add \
|
||||
--id ana \
|
||||
--name "Ana Torres" \
|
||||
--email ana@example.org \
|
||||
--key ~/.ssh/id_ed25519.pub \
|
||||
--roles owner,admin
|
||||
--roles admin
|
||||
```
|
||||
|
||||
Configure Git para firmar el primer commit completo:
|
||||
|
||||
```bash
|
||||
git init
|
||||
git config user.name "Ana Torres"
|
||||
git config user.email ana@example.org
|
||||
git config gpg.format ssh
|
||||
git config user.signingkey ~/.ssh/id_ed25519
|
||||
git config commit.gpgsign true
|
||||
git add .
|
||||
git commit -S -m "bootstrap: iniciar bitácora operativa"
|
||||
```
|
||||
|
||||
A partir de ahí:
|
||||
|
||||
```bash
|
||||
./bin/clusterlog --root . --ssh-key ~/.ssh/id_ed25519.pub --commit identity
|
||||
./bin/clusterlog --root . --ssh-key ~/.ssh/id_ed25519.pub --commit memory create --from-json examples/memory.json
|
||||
```
|
||||
|
||||
`identity` no modifica el repositorio; `--commit` sólo tiene efecto en comandos que escriben archivos.
|
||||
|
||||
## Flujo para Claude Code u otro agente
|
||||
|
||||
1. El agente recopila y redacta los hechos de la sesión, sin incluir credenciales ni valores sensibles.
|
||||
@@ -136,6 +112,8 @@ Las instrucciones completas para agentes están en [`AGENTS.md`](AGENTS.md) y [`
|
||||
|
||||
## Flujo de revisión semanal
|
||||
|
||||
Versión ejecutable (Runme) en [`runbooks/weekly-review.md`](runbooks/weekly-review.md); agenda y criterio en [`docs/WEEKLY_REVIEW.md`](docs/WEEKLY_REVIEW.md):
|
||||
|
||||
```bash
|
||||
# Ver sólo las memorias que le faltan al administrador actual
|
||||
./bin/clusterlog --root . --json --ssh-key ~/.ssh/id_ed25519.pub review list --mine
|
||||
@@ -153,12 +131,10 @@ La página `/revision/` contiene la cola pendiente y, como apoyo a la reunión,
|
||||
## Comandos de calidad
|
||||
|
||||
```bash
|
||||
make test # pruebas unitarias e integración de la CLI
|
||||
make vet # análisis estático de Go
|
||||
make e2e # flujo completo en una copia temporal
|
||||
make sync-check # comprueba que la proyección está actualizada
|
||||
make validate-local # valida sin requerir Zola
|
||||
make site # tema + plantillas + estado + validación completa + sitio
|
||||
make smoke # contratos, sincronización y validación local
|
||||
make validate-local # sin requerir Zola
|
||||
make site # tema + estado + validación completa + sitio
|
||||
make ci # equivalente local de la canalización
|
||||
```
|
||||
|
||||
@@ -168,39 +144,36 @@ Los procedimientos frecuentes también existen como notebooks ejecutables,
|
||||
sin reemplazar ningún comando canónico: [`RUNBOOK.md`](RUNBOOK.md) es el
|
||||
punto de entrada. Requiere Runme `v3.17.4` (`make runme-install`) sólo si se
|
||||
quiere abrir como notebook o correr por CLI; cada celda es, además, un
|
||||
bloque de shell normal que sigue funcionando copiado a mano. Detalles,
|
||||
modelo de identidad y limitaciones conocidas en
|
||||
[`docs/RUNME.md`](docs/RUNME.md) y la decisión en
|
||||
[`docs/adr/0004-runme-sidecar.md`](docs/adr/0004-runme-sidecar.md).
|
||||
bloque de shell normal que sigue funcionando copiado a mano. Modelo de
|
||||
identidad, limitaciones y la decisión completa viven en el motor:
|
||||
[`docs/RUNME.md`](https://github.com/fenandosr/clusterlog/blob/main/docs/RUNME.md)
|
||||
y
|
||||
[ADR-0004](https://github.com/fenandosr/clusterlog/blob/main/docs/adr/0004-runme-sidecar.md).
|
||||
|
||||
## Estructura
|
||||
|
||||
```text
|
||||
cmd/clusterlog/ punto de entrada de la CLI
|
||||
internal/clusterlog/ modelo, comandos, validación y proyección
|
||||
content/ Markdown fuente por sección
|
||||
content/ Markdown fuente por sección (memorias, manuales, ...)
|
||||
data/admins.json registro de administradores y política
|
||||
data/review-events/ un archivo por revisión
|
||||
data/task-events/ un archivo por evento de tiempo/estado
|
||||
data/generated/ proyección regenerable para Zola
|
||||
templates/ plantillas locales compatibles con Zola actual
|
||||
static/ ajustes visuales y búsqueda
|
||||
scripts/ preparación del tema y smoke tests
|
||||
docs/ decisiones arquitectónicas y operación
|
||||
config/allowed_signers firmantes SSH autorizados (generado junto a admins.json)
|
||||
templates/, themes/ descargados por make templates/make theme — no versionados
|
||||
static/ ajustes visuales y búsqueda propios de esta instancia
|
||||
scripts/ fetch del motor, tema, smoke test, verificación de firmas
|
||||
runbooks/, RUNBOOK.md documentación ejecutable de esta instancia
|
||||
docs/ guion de la reunión semanal
|
||||
.clusterlog-version versión fijada del motor que usa esta instancia
|
||||
```
|
||||
|
||||
## Documentación clave
|
||||
|
||||
- [`HOJA_DE_PROYECTO.md`](HOJA_DE_PROYECTO.md): alcance, requisitos, fases y criterios de aceptación.
|
||||
- [`CLI.md`](CLI.md): contrato de comandos, JSON y códigos de salida.
|
||||
- [`SECURITY.md`](SECURITY.md): modelo de confianza y despliegue recomendado.
|
||||
- [`THEME_COMPATIBILITY.md`](THEME_COMPATIBILITY.md): estrategia para `zola.386`.
|
||||
- [`docs/WEEKLY_REVIEW.md`](docs/WEEKLY_REVIEW.md): guion de la reunión semanal.
|
||||
- [`docs/ADR.md`](docs/ADR.md): decisiones de diseño de **clusterlog** (la herramienta), no del clúster que administra; formato, campos y ejemplo. Registros en [`docs/adr/`](docs/adr/), sin equivalente en la UI del sitio ni en la CLI.
|
||||
- [`docs/RUNME.md`](docs/RUNME.md): documentación ejecutable con Runme — instalación, modelo de identidad y limitaciones. Punto de entrada: [`RUNBOOK.md`](RUNBOOK.md).
|
||||
- [`VALIDATION_REPORT.md`](VALIDATION_REPORT.md): pruebas ejecutadas, límites y controles pendientes.
|
||||
- [`RELEASE_NOTES.md`](RELEASE_NOTES.md): alcance de la entrega 0.1.0.
|
||||
- [`content/manuales/`](content/manuales/): procedimientos operativos de esta instancia (acceso SSH, correo, Caddy, alta de administradores...).
|
||||
- Documentación del motor (CLI, esquemas, ADRs, `bootstrap-instance`, Runme): [fenandosr/clusterlog](https://github.com/fenandosr/clusterlog).
|
||||
|
||||
## Estado del prototipo
|
||||
## Estado
|
||||
|
||||
La CLI compila con Go 1.23 y sus pruebas cubren creación por JSON, resolución de identidad, revisión por hash, proyección de tareas y eventos independientes. La construcción de Zola está configurada en la CI incluida. Cuando el registro ya contiene administradores activos, la CI también verifica cada commit del pull request contra `config/allowed_signers`; el scaffold vacío omite esa comprobación durante el bootstrap inicial.
|
||||
Instancia activa del clúster MCPS. La CI (`.gitea/workflows/ci.yml`) descarga el binario y las plantillas del motor por versión fijada, sincroniza y valida el contenido, construye con Zola y publica en `clusterlog.mcps-epcm.org` al hacer push a `main`. También verifica cada commit del pull request contra `config/allowed_signers`.
|
||||
|
||||
Reference in New Issue
Block a user