ShFlow - Automatización con Shell

Logo ShFlow Logo ShFlow

📚 Documentación de ShFlow

Bienvenido a la documentación oficial de ShFlow, el sistema de automatización declarativa en Shell. Aquí encontrarás toda la información técnica, organizativa y comunitaria para trabajar, extender y contribuir al proyecto.


🧭 Introducción

⚙️ Inventario

  • hosts.yaml — definición de hosts y grupos
  • groups.yaml — metadatos y etiquetas
  • vars/ — variables globales, por grupo y por host

📦 Módulos disponibles

Consulte la lista de modulos autogenerada

  • facts — inventario del sistema
  • setup — configuración base
  • ntp — sincronización horaria
  • vault — gestión de secretos
  • users — gestión de usuarios
  • packages — instalación de paquetes
  • (más módulos en desarrollo)

📜 Ejecución

  • shflow.sh — motor principal
  • Argumentos y flags (-h, -g, --debug)
  • Playbooks YAML
  • Salida y trazabilidad

🧪 Depuración y validación

  • Modo debug
  • Validación de inventario
  • Limpieza de claves y valores

🧠 Changelogs

📁 Ejemplos y casos de uso

  • Auditoría de hardware
  • Configuración de red
  • Inventario distribuido

🤝 Contribuir al proyecto

Consulta la sección CONTRIBUTING para aprender cómo colaborar:

  • Flujo de trabajo con Git
  • Estilo de código y documentación
  • Creación de nuevos módulos
  • Propuestas de mejora y revisión

🥚 Huevo de Pascua

Un pequeño regalo para quienes miran más allá de la superficie.