Crear un recurso compartido de paquetes para un relay
Objetivo
El script create_pkgs_share.py crea, con un solo comando, un recurso compartido de paquetes vinculado a un relay: una entrada en la base de datos, una carpeta en el servidor y en el relay, y una carpeta de Syncthing configurada en ambos lados.
Se ejecuta en el servidor Medulla principal, con privilegios de root. Plantea cinco preguntas (nombre del recurso compartido, relay, orden, sujeto, permiso) y lleva a cabo los siguientes pasos:
- comprueba la conexión SSH con
medulla@<nombre del relay>tan pronto como se elige el relay; - realiza una copia de seguridad de las tablas SQL y de los archivos
config.xmlde Syncthing en una carpetabackup/con fecha; - crea la carpeta del recurso compartido en el servidor y en el relay;
- inserta el recurso compartido en
pkgs.pkgs_sharesy su regla de acceso enpkgs.pkgs_rules_local; - añade una configuración de Syncthing en el servidor principal y en el relay.
Si un paso falla antes de que finalice el proceso, se anula todo lo que ya se haya realizado. La opción --dry-run simula todo el proceso sin escribir nada: utilícela antes de la primera ejecución real.
Requisitos previos
Se requiere acceso de root en el servidor principal, una cuenta medulla accesible por SSH mediante clave en el servidor de relay, y Syncthing instalado en ambos sistemas.
Descarga del script
Directamente desde este enlace:
https://dl.medulla-tech.io/ma/create_pkgs_share.py
O ejecutando el siguiente comando:
wget https://dl.medulla-tech.io/ma/create_pkgs_share.py
Servidor principal (donde se ejecuta el script)
- Acceso de root. El script cambia el propietario de la carpeta creada y escribe en el archivo
config.xmlde Syncthing. - Syncthing instalado, con un archivo
/var/lib/syncthing/.config/syncthing/config.xml. - Directorio: Creación del directorio en
/var/lib/pulse2/packages/sharing/, que ya existe. - Cuenta y grupo
syncthingexistentes. - Nombre del relay resoluble: el valor
nameserverdexmppmaster.relayserverdebe poder resolverse desde el servidor principal (DNS o/etc/hosts).
Relay
- Cuenta
medullaaccesible por SSH mediante clave (véase la sección siguiente). - root, o sudo sin contraseña para
medulla. - Syncthing instalado, con el mismo archivo
config.xmly la misma secciónpulsemaster_global. La plantilla copiada en el relay es la del relay, no la del servidor. - Debe existir el directorio
/var/lib/pulse2/packages/sharing/, así como la cuenta y el gruposyncthing. - Paquete
acl(opcional): singetfaclnisetfacl, la carpeta se crea sin ACL (no aparece el símbolo+enls -l), con una advertencia.
Red
- El servidor principal se conecta al relay mediante SSH (puerto 22 por defecto; opción
--relay-ssh-portpara otro puerto). - No se solicita ninguna contraseña durante la ejecución: la conexión SSH se realiza únicamente mediante clave.
Si la conexión mediante contraseña está desactivada en el relay, añada manualmente la clave pública en ~medulla/.ssh/authorized_keys (carpeta .ssh con permisos 700, archivo con permisos 600, propietario medulla).
1. Realizar la prueba en las mismas condiciones que el script
Desde el servidor principal, como usuario root:
ssh -o BatchMode=yes medulla@<nombre del relay> 'sudo -n sh -c true && echo "SSH + sudo OK"'
Debe aparecer el mensaje SSH + sudo OK sin que se le plantee ninguna pregunta. Si SSH le plantea una pregunta o le solicita una contraseña, el script fallará de la misma manera.
Para otra cuenta, otro puerto u otra clave, utilice las opciones --relay-ssh-user, --relay-ssh-port y --relay-ssh-key del script.
Instalación del script
El script consta de un único archivo: instale los paquetes, cópielo en el servidor principal y, a continuación, compruebe que se inicia.
1. Copiar el script
En una carpeta reservada para el usuario root, por ejemplo, /root/scripts/:
mkdir -p /root/scripts
cp create_pkgs_share.py /root/scripts/
chmod +x /root/scripts/create_pkgs_share.py
La carpeta backup/ se crea junto al script durante la primera ejecución efectiva. Las copias de config.xml que contiene incluyen la clave API de Syncthing: la carpeta del script no debe ser legible para otras cuentas que no sean root.
2. Comprobar
/root/scripts/create_pkgs_share.py --help
Debería aparecer la ayuda. Si aparece el mensaje Module manquant : pymysql, instale el paquete python3-pymysql.
Uso
Ejecute el script en el servidor principal, como usuario root: sin argumentos, le planteará las preguntas una a una, mostrará un resumen y, a continuación, le pedirá confirmación antes de escribir nada. Comience siempre con una simulación.
/root/scripts/create_pkgs_share.py --dry-run # simulation, rien n'est écrit
/root/scripts/create_pkgs_share.py # lancement réel
Antes de las cinco preguntas, el script solicita el nombre de usuario o la contraseña de SQL que falte tras leer las opciones, la variable PKGS_DB_PASSWORD (solo la contraseña) y, a continuación, el archivo xmppmaster.ini.
Las cinco preguntas
|
N.º |
Pregunta |
Respuesta esperada |
Valor por defecto |
|---|---|---|---|
|
1 |
Nombre público del recurso compartido |
Texto libre; se permiten espacios y mayúsculas. Se conserva tal cual en |
Vacío: el nombre del relay |
|
2 |
ID del relay que se va a utilizar |
El ID que aparece en la lista procedente de |
Ninguno |
|
3 |
Orden de la nueva regla |
Un número entero. Las reglas existentes (ID, orden, recurso compartido, sujeto, permiso) se muestran antes de la pregunta. |
Último orden + 10 |
|
4 |
Sujeto |
|
|
|
5 |
Permiso |
|
Ninguno: respuesta obligatoria |
Ejemplo: la respuesta Mon Partage Test da como resultado comments = Mon Partage Test, name = mon_partage_test, una carpeta y un share_path /var/lib/pulse2/packages/sharing/mon_partage_test, y una carpeta Syncthing con el ID pulsemaster_mon_partage_test.
El resumen finaliza con Confirmer la création ? [o/N]: la respuesta por defecto es no.
Si el relay es inaccesible, el script muestra el error y, a continuación, pregunta: Continuer sans configurer le relai ? [o/N] (no por defecto). Si responde sí, se crea el recurso compartido únicamente en el servidor; el relay debe configurarse manualmente. Con la opción --yes, el script se detiene sin escribir nada.
Simulación (--dry-run)
El script plantea las mismas preguntas y se conecta a la base de datos y al relay, pero solo en modo de lectura: ni copia de seguridad, ni carpeta, ni INSERT, ni modificación de config.xml. Muestra las dos consultas INSERT con sus valores, la carpeta que se crearía y los bloques XML que se añadirían en Syncthing, tanto en el lado del servidor como en el del relay. El ID real del recurso compartido se vuelve a calcular en el momento de la escritura. Si el relay es inaccesible, la simulación muestra una advertencia y continúa.
Modo no interactivo
No se vuelve a solicitar un valor proporcionado como argumento. Si se especifican todos los valores y se utiliza la opción --yes, el script no plantea ninguna pregunta:
/root/scripts/create_pkgs_share.py \
--name "Partage Relai 01" --relay-id 3 \
--order 5 --subject '.*' --permission rw --yes
Opciones: respuestas y comportamiento
|
Opción |
Función |
|---|---|
|
|
Simula todas las acciones sin escribir nada. |
|
|
No hay confirmación final. Si el relay es inaccesible, el script se detiene en lugar de plantear la pregunta. |
|
|
Nombre público del recurso compartido (pregunta 1). |
|
|
ID del relay (pregunta 2). |
|
|
Orden de la regla (pregunta 3). |
|
|
Sujeto de la regla (pregunta 4). |
|
|
|
|
|
No configura el relay: no se intenta ninguna conexión SSH. |
Opciones: rutas y permisos
Por defecto, no es necesario modificar estas opciones.
|
Opción |
Función |
Valor por defecto |
|---|---|---|
|
|
Directorio padre de los recursos compartidos en el servidor. |
|
|
|
Propietario y grupo de la carpeta creada, tanto en el servidor como en el relay. |
|
|
|
Permisos de la carpeta creada, en formato octal. |
|
|
|
Carpeta cuyas ACL se copian (misma ruta en el servidor y en el relay). |
|
|
|
Archivo |
|
|
|
ID de la carpeta |
|
Opciones: relay (SSH) y base de datos
Por defecto, no es necesario modificar estas opciones.
|
Opción |
Función |
Valor por defecto |
|---|---|---|
|
|
Cuenta SSH en el relay. |
|
|
|
Puerto SSH del relay. |
Puerto predeterminado de SSH |
|
|
Clave privada de SSH que se va a utilizar. |
Clave predeterminada de la cuenta que ejecuta el script |
|
|
Opción SSH pasada a |
Ninguna |
|
|
Tiempo de espera de conexión SSH, en segundos. |
|
|
|
Archivo |
|
|
|
Directorio padre de los recursos compartidos en el relay. |
|
|
|
Servidor SQL. |
Archivo ini; en su defecto, |
|
|
Puerto SQL. |
Archivo ini; de lo contrario, |
|
|
Usuario de SQL. |
Archivo ini; de lo contrario, se solicitará |
|
|
Contraseña de SQL. Se recomienda utilizar la variable |
Archivo ini (mismo usuario); de lo contrario, se solicitará |
Lo que modifica el script
Para un recurso compartido denominado Mon Partage Test en el relay relai01 (ID 3), el script escribe los seis elementos siguientes. No se modifica nada más.
|
N.º |
Dónde |
Qué |
|---|---|---|
|
1 |
Base de datos |
Una línea: |
|
2 |
Base de datos |
Una línea: algoritmo |
|
3 |
Servidor principal, carpeta del recurso compartido |
Creación de |
|
4 |
Servidor principal, archivo |
Se añade un bloque |
|
5 |
Relay, carpeta del recurso compartido |
La misma carpeta, los mismos permisos y las mismas ACL que en el servidor (a través de SSH y |
|
6 |
Relay, archivo |
Se añade un bloque |