Skip to main content

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 :

  1. teste la connexion SSH vers medulla@<nom du relai>, dès que le relai est choisi ;
  2. sauvegarde les tables SQL et les fichiers config.xml de Syncthing dans un dossier backup/ daté ;
  3. crée le dossier du partage sur le serveur et sur le relai ;
  4. insère le partage dans pkgs.pkgs_shares et sa règle d'accès dans pkgs.pkgs_rules_local ;
  5. 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.xml de 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 syncthing existants.
  • Nom du relai résolvable : la valeur nameserver de xmppmaster.relayserver doit être résolue depuis le serveur principal (DNS ou /etc/hosts).

Relai

  • Compte medulla accessible 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.xml et la même section pulsemaster_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 groupe syncthing.
  • Paquet acl (facultatif) : sans getfacl et setfacl, le dossier est créé sans les ACL (pas de + dans ls -l), avec un avertissement.

Réseau

  • Le serveur principal joint le relai en SSH (port 22 par défaut ; option --relay-ssh-port pour 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 comments ; Les caractères / et \ sont refusés.

Vide : le nom du relai

2

ID du relai à utiliser

L'id affiché dans la liste issue de xmppmaster.relayserver. Le script teste ensuite la connexion SSH vers medulla@<nameserver>.

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

.* pour tout le monde, ou le nom d'un utilisateur.

.*

5

Permission

rw (lecture/écriture) ou r (lecture seule).

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

--dry-run

Simule toutes les actions sans rien écrire.

-y, --yes

Pas de confirmation finale. Si le relai est injoignable, le script s'arrête au lieu de poser la question.

--name

Nom public du partage (question 1).

--relay-id

ID du relai (question 2).

--order

Ordre de la règle (question 3).

--subject

Sujet de la règle (question 4).

--permission

r ou rw (question 5).

--skip-relay

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

--sharing-root

Répertoire parent des partages sur le serveur.

/var/lib/pulse2/packages/sharing

--share-owner USER[:GROUP]

Propriétaire et groupe du dossier créé, sur le serveur et sur le relai.

syncthing:syncthing

--share-mode

Droits du dossier créé, en octal.

755

--acl-from

Dossier dont les ACL sont copiées (même chemin sur le serveur et sur le relai).

<sharing-root>/global

--syncthing-config

config.xml de Syncthing sur le serveur.

/var/lib/syncthing/.config/syncthing/config.xml

--syncthing-template-id

Id du <folder> copié comme modèle, sur le serveur et sur le relai.

pulsemaster_global

Options : relai (SSH) et base de données

Par défaut, ces options ne sont pas à modifier.

Option

Rôle

Défaut

--relay-ssh-user

Compte SSH sur le relai.

medulla

--relay-ssh-port

Port SSH du relai.

Port par défaut de SSH

--relay-ssh-key

Clé privée SSH à utiliser.

Clé par défaut du compte qui lance le script

--ssh-option

Option SSH passée à -o, répétable. Exemple : StrictHostKeyChecking=accept-new.

Aucune

--ssh-timeout

Délai de connexion SSH, en secondes.

10

--relay-syncthing-config

config.xml de Syncthing sur le relai.

/var/lib/syncthing/.config/syncthing/config.xml

--relay-sharing-root

Répertoire parent des partages sur le relai.

/var/lib/pulse2/packages/sharing

--db-host

Hôte SQL.

Fichier ini, sinon localhost

--db-port

Port SQL.

Fichier ini, sinon 3306

--db-user

Utilisateur SQL.

Fichier ini, sinon demandé

--db-password

Mot de passe SQL. Préférez la variable PKGS_DB_PASSWORD : un argument est visible dans ps.

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 pkgs, table pkgs_shares

Une ligne : id = dernier id + 1, name = mon_partage_test, comments = Mon Partage Test, type = local, uri et ars_name = nom du relai, ars_id = id du relai, share_path = /var/lib/pulse2/packages/sharing/mon_partage_test.

2

Base pkgs, table pkgs_rules_local

Une ligne : algorithme 1, ordre, sujet et permission saisis, pkgs_shares_id = id de la ligne ci-dessus.

3

Serveur principal, dossier du partage

Création de /var/lib/pulse2/packages/sharing/mon_partage_test avec les droits drwxr-xr-x+ syncthing syncthing : propriétaire, groupe, mode 755 et ACL copiées depuis global.

4

Serveur principal, config.xml de Syncthing

Ajout d'un bloc <folder> copié depuis pulsemaster_global.

5

Relai, dossier du partage

Même dossier, mêmes droits et mêmes ACL que sur le serveur (via SSH et sudo).

6

Relai, config.xml de Syncthing

Ajout d'un bloc <folder> copié depuis le pulsemaster_global du relai lui-même (et non celui du serveur).