Aller au contenu

Bienvenue sur Abls-Habitat !

Vous trouverez sur ce site l'ensemble de la documentation technique permettant de prendre en main ce système de gestion d'habitat. Cette documentation s'adresse aux personnes ayant la responsabilité de l'installation et du maintien des systèmes et sous-systèmes composant un domaine complet. Elle présente les guides d'installation, l'architecture, les concepts, les modes d'emploi, ainsi que les bonnes pratiques de mise en oeuvre.

Pré-requis

Les socles minimums sur lesquels les agents ont été testés puis validés:

  • Debian Bookworm ou supérieure, avec les backports installés
  • RaspiOS (basée sur Bookworm)
  • Fedora (Server ou Workstation), à partir de Fedora 38

Note

Vous aurez également besoin des droits d'administration, via sudo par exemple.

Installation d'un agent depuis un container

La solution la plus simple pour installer un agent est d'utiliser le format container.

Depuis votre hote, tapez la commande suivante:

[watchdog@Server ~]$ podman run -d --name abls-agent --restart always --tz local -p 5559:5559 -v /dev/log:/dev/log --env ABLS_API_URL=api.abls-habitat.fr --env ABLS_DOMAIN_UUID=`domain_uuid` --env ABLS_DOMAIN_SECRET=`domain_secret` --group-add keep-groups docker.io/sebaru/abls-agent:latest

Retrouvez aussi ces instructions sur la console, en cliquant sur le menu Ajouter un agent

Installation d'un agent en natif

Si vous souhaitez ajouter manuellement un agent

  1. Suivez la procédure d'installation en ligne de commande
  2. Puis complétez par lier l'agent à l'API.
  3. Si besoin, vous pouvez également positionner les options avancées

Vous pouvez également, dans le cadre d'upgrade par exemple, utiliser la méthode de mise à jour basée sur le repository GIT.

Installation en ligne de commande

Depuis un terminal, lancez la commande suivante:

[watchdog@Server ~]$ sudo bash -c "$(wget https://raw.githubusercontent.com/sebaru/Watchdog/main/INSTALL.sh -q -O -)"

Liez ensuite votre agent à votre domaine.

Lier un agent

La solution la plus simple est de vous connecter à la console, de cliquez sur le menu Ajouter un agent et de suivre les instructions.

Manuellement, vous pouvez également, depuis votre console, récupérer les données suivantes:

  1. Le domain_uuid: Il s'agit de l'identifiant principal de votre domaine, auquel vous pourrez relier tous vos agents
  2. Le domain_secret: Il s'agit du secret protégeant les communications entre vos agents et l'API principale.

Danger

Le domain_secret est une donnée confidentielle qui ne doit jamais être diffusée

Via votre terminal, tapez ensuite la commande suivante:

[watchdog@Server ~]$ sudo Watchdogd --save --domain-uuid `domain_uuid` --domain-secret `domain-secret`

Votre agent est désormais lié à l'API.

Options avancées

Si besoin de configuration plus fine, vous pouvez positionner explicitement l'UUID de votre agent ainsi que l'URL de l'API maitresse via les options de démarrage suivantes:

  1. Agent UUID: Utilisez cette options en cas de restauration d'un agent par exemple.
  2. API URL: Utile en cas d'utilisation d'une API OnPremise.

Danger

Les options avancées sont réservées aux personnes maitrisant ces options et en ayant le réel besoin.

Via votre terminal, tapez ensuite la commande suivante:

[watchdog@Server ~]$ sudo Watchdogd --save --domain-uuid `domain_uuid` --domain-secret `domain-secret` --api-url `api_url` --agent-uuid `agent_uuid`

Votre agent est désormais lié à l'API.

Arrêt/Relance et suivi de votre agent natif

Commandes de lancement et d'arret

Les commandes suivantes permettent alors de demarrer, stopper, redémarrer l'agent sur votre Système:

[watchdog@Server ~]$ sudo systemctl start Watchdogd.service
[watchdog@Server ~]$ sudo systemctl stop Watchdogd.service
[watchdog@Server ~]$ sudo systemctl restart Watchdogd.service

Attention, l'arrêt d'un agent nécessite de sauvegarder beaucoup d'éléments vers l'API, cela peut prendre 2 à 5 minutes.

Commandes d'affichage des logs

Les commandes suivantes permettent d'afficher les logs de l'agent:

[watchdog@Server ~]$ sudo journalctl -f -u Watchdogd.service

Upgrader un agent natif deja installé

Un agent peut etre automatiquement upgradé depuis la console, via la page de gestion des agents.

Vous pouvez également le mettre à niveau via l'utilisation du repository Github.

Pour cela, tapez les commandes suivantes dans un terminal:

[watchdog@Server ~]$ git clone https://github.com/sebaru/Watchdog.git abls-habitat-agent
[watchdog@Server ~]$ cd abls-habitat-agent
[watchdog@Server ~]$ ./autogen.sh
[watchdog@Server ~]$ sudo make install
[watchdog@Server ~]$ cd ..
[watchdog@Server ~]$ rm -rf abls-habitat-agent
[watchdog@Server ~]$ sudo systemctl restart Watchdogd

Reinstaller un agent natif

Pour relancer la phase d'installation, supprimez le fichier de configuration puis relancez l'agent:

$ sudo rm /etc/abls-habitat-agent.conf
$ sudo systemctl restart Watchdogd

Et enfin recommencer la procédure.