README-fr.md

English documentation

UTDON (UpToDateOrNot??)

Vos applications FOSS (Free and open-source software) en production, sont-elles à jour ?

Présentation

UTDON est né d'un shell qui compare :

• la version d'une application en cours d'exécution (production)
• à la dernière version disponible (dépôt GITHUB ou compatible Gitea).

N'ayant que des applications dont le dépôt des sources est situé sur "GitHub" ou "CodeBerg", UTDON ne fonctionne pour l'instant qu'avec GitHub et des dépôts compatibles "Gitea".

Cas d'utilisation

• Surveillance par UI.
• Surveillance par appel API.
• Surveillance par appel API et mise à jour d'un service de monitoring (type ping).
• Appel API de la chaîne CI/CD pour déclencher le processus de mise à jour de l'application.
• Surveillance d'applications qui ne proposent pas de point d'entrée API permettant d'obtenir la version.
• Authentification possible pour Github, dépôts compatibles Gitea, et applications (parfois nécessaire pour obtenir la version).

Versioning UTDON

UDON suit le protocole "semver" (https://semver.org/), accessible par l'entrypoint "/api/v1/version" qui renvoit une valeur au format JSON : {"version":"[\d+].[\d+].[\d+]} (3 groupes de nombres séparés par un point).

Les "tags" GitHub, ainsi que les "tags" des containers resteront similaires à cette réponse.

Les versions "Release Candidats" seront définies comme suit : "[\d+].[\d+].[\d+]-rc-[\d+]".

Comment çà marche ?

• Installer le service & le démarrer
• Utilisez votre navigateur web pour vous connecter au service :
  • http://[Addresse IP]:[port]/
  • login/mot de passe par défaut: admin/admin
• Vous changez le mot de passe.
• Creation des utilisateurs & groupes
• Création du premier "contrôle" (qui peut être votre nouveau service UTDON... pour vérifier que tout fonctionne)
• Vous exécuter la comparaison.
• Chaque contrôle indique son dernier état de "comparaison".
• Pour automatiser l'ensemble, créez une tâche d'ordonnancement (cron) avec "curl" qui appelle l'entrypoint de votre choix :
  • uniquement la comparaison, l'état est mis à jour au niveau de l'application
  • la comparaison avec la mise à jour du service monitoring et vous serez averti des écarts constatés.

Flux

graph TD
ag(api tags github)

s(server)
ps(production server)
pr(production release)
lr(last release)
cp(compare)
res(result as JSON)
mps(monitoring ping service)
cicd(CI/CD)
s-->|call|ag
ag-->|apply expression and get|lr
s-->|call|ps
ps-->|apply expression and get|pr
cp-->lr
cp-->pr
s-->cp
cp-->|give|res
res-->|update internal state|s
s-->|update|mps
s-->|call|cicd

Loading

Stack

• Nodejs
• React/Redux
• Bases de données JSON : Situées en RAM, si vous remplacer les fichiers en cours d'exécution, ceci n'aura aucun effet. Le contenu des bases est enregistré après chaque modification et lorsque le service reçoit le signal SGINT | SIGTERM | SIGUSR2.
• Filtres RegExp et Jmespath pour Json.
• Swagger.

Securité

Ne jamais exposer UTDON directement sur internet (utilisez un VPN si nécessaire). UTDON est un outil interne, auto-hébergé, qui exécute des actions sur vos ressources privées (Monitoring/CI-CD).

Refuser tout hébergement SAAS: Ce produit n'a pas été dessiné pour être "multi-tenant" et n'est pas protégé par une solution "E2E". Les données d'authentification sont chiffrées au moyen d'une chaîne qui serait fournie pas le potentiel hébergeur et donc déchifrable par lui. Comprenez que les "contrôles" UTDON contiennent l'url du service à surveiller, et potentiellement les accès à votre chaîne CI/CD et/ou service de monitoring.

Chiffrement

Le contenu des deux bases de données est chiffré partiellement :

• user.json: Le mot de passe (non réversible) et le jeton d'authentification (réversible) des utilisateurs
• database.json:
  • Les chaînes d'authentification pour les "urls" de monitoring et de la chaine CI/CD (réversibles).
  • les "HTTP header" (production et dépôt git) associés au processus de "production scrap".
• globalGithubToken: jeton d'authentification Github global (réversible)

Si vous avez perdu le mot de passe admin

Arréter le service, supprimer le fichier "user.json", puis redémarrer. Connectez-vous ensuite avec le compte/mot de passe par défaut : admin/admin, puis changer le immédiatement.

Session

Les sessions sont gérées en RAM, un simple redémarrage du service réinitialise l'intégralité des sessions.

Logs

Les logs sont limités au strict nécessaire pour éviter le stockage inutile:

• Connexion utilisateur
• Déconnexion utilisateur
• Ajout d'un contrôle
• suppression d'un contrôle
• Modification d'un contrôle
• Exécution d'une comparaison
• Appel dernière comparaison
• Exécution d'un appel externe du service ping (monitoring externe)
• Exécution d'un appel externe de la chaîne CI/CD

Roadmap

• Ajout d'un token "readonly" par utilisateur pour utilisation à partir d'une chaîne CI/CD
• Stockage S3.
• Entrypoint API metrics.
• Authentification LDAP.

Crédits

• image de la page de connexion: générée par l'AI https://www.artguru.ai/fr/

• Icons: https://tabler.io/icons

• Radioactive button : https://zurb.com/playground/radioactive-buttons

• Multiselect component https://github.com/hc-oss/react-multi-select-component?tab=readme-ov-file

• LoaderShip: https://www.loadership.com/

• Logo: https://www.instagram.com/henry_redbeard/

Si vous appréciez cette application

Donnez lui une étoile...

CHANGELOG