Créer un partage de packages pour un relai
Objectif
Le script create_pkgs_share.py crée en une seule commande un partage de packages rattaché à un relai : une ligne en base, un dossier sur le serveur et sur le relai, et un dossier Syncthing déclaré des deux côtés.
Il se lance sur le serveur principal Medulla, en root. Il pose cinq questions (nom du partage, relai, ordre, sujet, permission) et enchaîne les étapes suivantes :
- teste la connexion SSH vers
medulla@<nom du relai>, dès que le relai est choisi ; - sauvegarde les tables SQL et les fichiers
config.xmlde Syncthing dans un dossierbackup/daté ; - crée le dossier du partage sur le serveur et sur le relai ;
- insère le partage dans
pkgs.pkgs_shareset sa règle d'accès danspkgs.pkgs_rules_local; - ajoute une configuration Syncthing sur le serveur principal et le relai.
Si une étape échoue avant la fin, tout ce qui a déjà été fait est annulé. L'option --dry-run simule l'ensemble sans rien écrire : à utiliser avant le premier vrai lancement.
Pré-requis
Il faut un accès root sur le serveur principal, un compte medulla joignable en SSH par clé sur le relai, et Syncthing installé des deux côtés.
Téléchargement du script
Directement depuis ce lien :
https://dl.medulla-tech.io/ma/create_pkgs_share.py
Ou en faisant la commande suivante :
wget https://dl.medulla-tech.io/ma/create_pkgs_share.py
Serveur principal (où l'on lance le script)
- Accès root. Le script change le propriétaire du dossier créé et écrit dans le
config.xmlde Syncthing. - Syncthing installé, avec un fichier
/var/lib/syncthing/.config/syncthing/config.xml. - Répertoire Création du répertoire dans
/var/lib/pulse2/packages/sharing/existant. - Compte et groupe
syncthingexistants. - Nom du relai résolvable : la valeur
nameserverdexmppmaster.relayserverdoit être résolue depuis le serveur principal (DNS ou/etc/hosts).
Relai
- Compte
medullaaccessible en SSH par clé (voir la section suivante). - root, ou sudo sans mot de passe pour
medulla. - Syncthing installé, avec le même fichier
config.xmlet la même sectionpulsemaster_global. Le modèle copié sur le relai est celui du relai, pas celui du serveur. - Répertoire
/var/lib/pulse2/packages/sharing/existant, et compte et groupesyncthing. - Paquet
acl(facultatif) : sansgetfacletsetfacl, le dossier est créé sans les ACL (pas de+dansls -l), avec un avertissement.
Réseau
- Le serveur principal joint le relai en SSH (port 22 par défaut ; option
--relay-ssh-portpour un autre port). - Aucun mot de passe n'est demandé pendant l'exécution : la connexion SSH se fait par clé uniquement.
Si la connexion par mot de passe est désactivée sur le relai, ajoutez la clé publique à la main dans ~medulla/.ssh/authorized_keys (dossier .ssh en 700, fichier en 600, propriétaire medulla).
1. Tester dans les mêmes conditions que le script
Depuis le serveur principal, en root :
ssh -o BatchMode=yes medulla@<nom du relai> 'sudo -n sh -c true && echo "SSH + sudo OK"'
Le message SSH + sudo OK doit s'afficher sans aucune question. Si SSH pose une question ou demande un mot de passe, le script échouera de la même façon.
Pour un autre compte, un autre port ou une autre clé, utilisez les options --relay-ssh-user, --relay-ssh-port et --relay-ssh-key du script.
Installation du script
Le script tient en un seul fichier : installez les paquets, copiez-le sur le serveur principal, puis vérifiez qu'il démarre.
1. Copier le script
Dans un dossier réservé à root, par exemple /root/scripts/ :
mkdir -p /root/scripts
cp create_pkgs_share.py /root/scripts/
chmod +x /root/scripts/create_pkgs_share.py
Le dossier backup/ est créé à côté du script lors du premier vrai lancement. Les copies de config.xml qu'il contient incluent la clé API de Syncthing : le dossier du script ne doit pas être lisible par d'autres comptes que root.
2. Vérifier
/root/scripts/create_pkgs_share.py --help
L'aide doit s'afficher. Si le message Module manquant : pymysql apparaît, installez le paquet python3-pymysql.
Utilisation
Lancez le script sur le serveur principal, en root : sans argument, il pose ses questions une par une, affiche un récapitulatif, puis demande confirmation avant d'écrire quoi que ce soit. Commencez toujours par une simulation.
/root/scripts/create_pkgs_share.py --dry-run # simulation, rien n'est écrit
/root/scripts/create_pkgs_share.py # lancement réel
Avant les cinq questions, le script demande l'utilisateur ou le mot de passe SQL qui manque après lecture des options, de la variable PKGS_DB_PASSWORD (mot de passe seulement), puis du fichier xmppmaster.ini.
Les cinq questions
|
N° |
Question |
Réponse attendue |
Défaut |
|---|---|---|---|
|
1 |
Nom public du partage |
Texte libre, espaces et majuscules permis. Conservé tel quel dans |
Vide : le nom du relai |
|
2 |
ID du relai à utiliser |
L'id affiché dans la liste issue de |
Aucun |
|
3 |
Ordre de la nouvelle règle |
Un entier. Les règles existantes (id, ordre, partage, sujet, permission) sont affichées avant la question. |
Dernier ordre + 10 |
|
4 |
Sujet |
|
|
|
5 |
Permission |
|
Aucun : réponse obligatoire |
Exemple : la réponse Mon Partage Test donne comments = Mon Partage Test, name = mon_partage_test, un dossier et un share_path /var/lib/pulse2/packages/sharing/mon_partage_test, et un dossier Syncthing d'id pulsemaster_mon_partage_test.
Le récapitulatif se termine par Confirmer la création ? [o/N] : la réponse par défaut est non.
Si le relai est injoignable, le script affiche l'erreur puis demande Continuer sans configurer le relai ? [o/N] (non par défaut). Répondre oui crée le partage côté serveur uniquement ; le relai reste à configurer à la main. Avec --yes, le script s'arrête sans rien écrire.
Simulation (--dry-run)
Le script pose les mêmes questions et se connecte à la base et au relai, mais seulement en lecture : ni sauvegarde, ni dossier, ni INSERT, ni modification de config.xml. Il affiche les deux requêtes INSERT avec leurs valeurs, le dossier qui serait créé et les blocs XML qui seraient ajoutés dans Syncthing, côté serveur et côté relai. L'id réel du partage est recalculé au moment de l'écriture. Si le relai est injoignable, la simulation affiche un avertissement et continue.
Mode non interactif
Une valeur donnée en argument n'est pas redemandée. Avec toutes les valeurs et --yes, le script ne pose aucune question :
/root/scripts/create_pkgs_share.py \
--name "Partage Relai 01" --relay-id 3 \
--order 5 --subject '.*' --permission rw --yes
Options : réponses et comportement
|
Option |
Rôle |
|---|---|
|
|
Simule toutes les actions sans rien écrire. |
|
|
Pas de confirmation finale. Si le relai est injoignable, le script s'arrête au lieu de poser la question. |
|
|
Nom public du partage (question 1). |
|
|
ID du relai (question 2). |
|
|
Ordre de la règle (question 3). |
|
|
Sujet de la règle (question 4). |
|
|
|
|
|
Ne configure pas le relai : aucune connexion SSH n'est tentée. |
Options : chemins et droits
Par défaut, ces options ne sont pas à modifier.
|
Option |
Rôle |
Défaut |
|---|---|---|
|
|
Répertoire parent des partages sur le serveur. |
|
|
|
Propriétaire et groupe du dossier créé, sur le serveur et sur le relai. |
|
|
|
Droits du dossier créé, en octal. |
|
|
|
Dossier dont les ACL sont copiées (même chemin sur le serveur et sur le relai). |
|
|
|
|
|
|
|
Id du |
|
Options : relai (SSH) et base de données
Par défaut, ces options ne sont pas à modifier.
|
Option |
Rôle |
Défaut |
|---|---|---|
|
|
Compte SSH sur le relai. |
|
|
|
Port SSH du relai. |
Port par défaut de SSH |
|
|
Clé privée SSH à utiliser. |
Clé par défaut du compte qui lance le script |
|
|
Option SSH passée à |
Aucune |
|
|
Délai de connexion SSH, en secondes. |
|
|
|
|
|
|
|
Répertoire parent des partages sur le relai. |
|
|
|
Hôte SQL. |
Fichier ini, sinon |
|
|
Port SQL. |
Fichier ini, sinon |
|
|
Utilisateur SQL. |
Fichier ini, sinon demandé |
|
|
Mot de passe SQL. Préférez la variable |
Fichier ini (même utilisateur), sinon demandé |
Ce que le script modifie
Pour un partage nommé Mon Partage Test sur le relai relai01 (id 3), le script écrit les six éléments suivants. Rien d'autre n'est touché.
|
N° |
Où |
Quoi |
|---|---|---|
|
1 |
Base |
Une ligne : |
|
2 |
Base |
Une ligne : algorithme |
|
3 |
Serveur principal, dossier du partage |
Création de |
|
4 |
Serveur principal, |
Ajout d'un bloc |
|
5 |
Relai, dossier du partage |
Même dossier, mêmes droits et mêmes ACL que sur le serveur (via SSH et |
|
6 |
Relai, |
Ajout d'un bloc |