Le clients sont des responsables IT de l'EPHEC (École pratique des hautes études commerciales). Ils sont spécialisés en Administration des systèmes et réseaux.
Ce sont des personnes surchargés par leur travail en ce moment, d'où la raison de cette déléguation de commande.
Il est donc clair que les clients ci-présents sont compétants dans le domaine et sauront donc exploiter l'utilitaire accompagnée d'une solide documentation.
Le projet consiste à créer une platefore de monitoring pour pinger (interroger) des noms de domaines comme google.be, ephec.be, etc...
Il est demandé de réaliser l'utilitaire en Python est en ligne de commande (CLI), probablement pour pouvoir facilement implémenter des futures fonctions.
La configuration doit être simple et modifiable avec un fichier, à chaud (fichier JSON contenant les domaines)
La configuration attendue par le script suivant doit répondre à la structure suivante, dans le format normalisé JSON. La clé root est au choix, considerez que c'est un tag, ou une étiquette pour identifier la configuration.
Paramètres attendus:
- enable: [type: bool] > Est-ce que ce nom de domaine doit être ignoré à l'analyse ou pas ?
- dns: [type: str] > nom de domaine ou IP a interroger
- priority: [type: int] > Le chiffre correspond a comment doit se comporter le script en fonction du résultat attendu: voir ici
- period: [type: int] > Tout les combien de secondes doit être analysé le domaine ?
{
"EPHEC": {
"enable": true,
"dns": "www.ephec.be",
"priority": 0,
"period": 15
},
"PLEX - Bad DNS": {
"enable": true,
"dns": "plxe.dosis.eb",
"priority": 1,
"period": 10
},
"PLEX - Good DNS": {
"enable": true,
"dns": "plex.doussis.be",
"priority": 2,
"period": 4
}
}Avoir un suivi en temps réel de l'état des services, d'un simple coup d'oeil avec une intervale personnalisable en secondes.
L'objectif est de pouvoir permettre aux responsables de l'IT d'interagir en conséquence lors d'une éventuelle panne système et de pouvoir éventuellement prévenir leurs utilisateurs sur l'indisponibilité d'un de leurs services.
Et à l'aide de l'API mise en place, il sera possible de développer un script pour executer telle ou telle action en fonction d'un résultat obtenu par DataRing.
Rendre l'outil un minimum lisible et agréable a lire. Il serait désagréable de consulter plus de 100 domaines si tout est mal structuré et en blanc.
Pouvoir éventuellement stocker les données à chaque interval pour avoir une statistique des disponibilités par intervales d'analyse.
Scanner les noms de domaines a une fréquence adaptée de sorte à avoir le temps de lire les informations à l'écran et pouvoir trier les données par:
- fqdn (dns)
- par status (connectés / déconnectés)
- par niveau de priorité
La méthode, peut-être la plus barbare, elle consiste à éditer un fichier JSON et d'y insérer un sous-dictionnaire sans passer par le logiciel en lui-même. Il s'agirait de passer par un éditeur de texte (GUI ou non), et de l'éditer à chaud, le programme, actualise sa liste de noms de domaines a chaque itération de lecture.
La méthode la plus simple pour ajouter un DNS cible serait d'employer l'argument --àdd avec le second script.
Il suffirait d'executer setup.py --add indépendamment du script main.py pour y procèder.
Il est également possible de gérer le script à l'aide de l'API mise en place ! Voici les requêtes possibles:
- /add?tag=AMAZON%20FR&enable=0&dns=www.amazon.fr&period=4&priority=1
- /delete?tag=AMAZON%20FR
- /update?tag=AMAZON%20FR&enable=1&dns=www.amazon.fr&period=20&priority=1
API mise en place avec FastAPI, il est donc nécessaire que votre infrastructure possède Uvicorn.
Le script vient accompagné de sa propre API. Vous aurez plusieur actions possibles comme:
- Ajouter des dns à la config
- Supprimer des dns de la config
- Mettre à jour la config
- Afficher les résultats avec ou sans filtres
- Générer un graphique des résultats
- Ordonner une analyse immédiate
La documentation de l'API a été rédigée à l'aide de FastAPI et accessible via son url:
- /docs
Il n'y a aucun input attendu dans le programme, a part les appels avec arguments. Ce logiciel de base, ne se contente que de traiter des instructions, et toutes entrée (signal, clavier, souris) executant du code ASCII ne devra en rien interferer avec le script. Les seules commandes attendues sont les suivantes:
python3 main.pypython3 setup.py --add --name="GOOGLE BE --dns="google.be" --enable=True --priority=1 --perdiod=15python3 setup.py --delete --name="GOOGLE BE"python3 setup.py --update --name="GOOGLE BE" --enable=FalseLe logiciel devra être capable de mémoriser chaque itération d'analyse, c'est à dire, l'heure du scan et le résultat du domaine scané. Un format proposé serait de la structure suivante:
"scans: {
"GOOGLE BE": {
"2024": {
"mars": {
"13": {
"12:41": {
"reachable": true,
"latence": 15
}
"12:46": {
"reachable": false,
"latence": 999,
"reason": "DNS NOT EXIST"
}
}
}
}
}
}
⚠️ Evitez de stocker les scans toutes les 1 minutes, mais toutes les 5 minutes, sinon le fichier JSON pourrais vite devenir très lourd.⚠️
On pourra ainsi, créer des méthodes ou fonctiones capables de traiter rapidement les données a partir d'une date, un mois, et filtrer sur ceux qui étaient disponible ou non... A partir de ces données, et grace a la structure JSON (dictionnaire), on pourra générer des graphiques sur base des données obtenues.
Ce script incorporera une large gamme de systèmes de notification tels que:
- Notification e-mail (SMTP)
- Notification discord (via bot ou par webhook)
- Notification Telegram
- Optionnel: Notification vers logiciel client (notification OS)
| Numéro de priorité | Description |
|---|---|
| 1 | Niveau absolu, si aucune réponse n'est renvoyé au script, envoyer une notification aux administrateurs |
| 2 | Niveau intermediaire, l'erreur est logguée dans le système de gestion des erreurs internes, mais les admins n'en sont pas notifiés |
| 3 | Niveau minimum, l'erreur est juste ignorée, et aucune notification n'est envoyée |
| 4 | EXCEPTION, le résultat du scan, quel qu'il soit est notifié aux administrateurs |
Certains services externes peuvent réagir si un nombre de pings sont trop récurents sur un temps donné, et peut donc corrompre les données récoltées.
Il faut donc configurer les pings en fonctions des règles du service.
C'est pour cela que l'on propose le paramètre period dans le fichier json,
afin de définir tout les combiens de temps il faudra lancer un scan pour un domain donnée !
🛑 INFO: Si period n'est pas défini dans le JSON, il prendra alors une valeur par défaut définie dans le code principale
Le projet devra être développé dans un délai inférieur à 30 jours, avec des jalons clés à respecter pour chaque phase de développement.
Les réunions avec le client ne sont pas nécessaires mais un suivi est préferé par le client tout les 6 jours.
- Le ping doit fonctionner pour au moins un DNS.
- ROUGE si deconnecté, JAUNE si inconnu.
- Trier par défaut par ordre alphabétique
- La requête API /list_config doit pouvoir renvoyer la configuration au navigateur
Le budget sera défini dans un devis séparé en fonction des coûts de développement et de test
Le travail étant achevé, ce dernier est estimé à 200 € pour une licence entreprise.
| Semaine | Informations |
|---|---|
| S1 | Création du cahier des charges |
| S2 | Initialisation + finalisation du MVP#01 |
| S3 | Création du projet final + couleurs |
| S4 | Fin du projet + Test unitaires |
Ce repository ne contient aucun script avancé comme précisé dans ce cahier de charge. Le but de ce cahier de charge esr de démonter a mes enseignants ma capacité à rédiger un cahier de charge pour mon cursus scolaire. Par Doussis Giorgios