Aller au contenu

Common Library

Statut

HISTORICAL / COMPATIBILITY GUIDE

Cette page conserve la trace de l’ancienne bibliothèque shell commune utilisée par certaines commandes d’exploitation historiques.

Elle ne doit pas être interprétée comme la preuve qu’un fichier /usr/local/lib/ccx/common.sh est encore installé ou requis sur le Runtime actuel.

Pour les opérations courantes, la référence vérifiable dans le dépôt est aujourd’hui le Makefile et les scripts sous scripts/.

Pourquoi cette page existe encore

Une partie de l’outillage d’exploitation historique reposait sur une bibliothèque shell commune destinée à éviter la duplication de :

  • chemins ;
  • répertoires de sauvegarde ;
  • paramètres WordPress ;
  • paramètres MariaDB ;
  • fonctions de journalisation ;
  • helpers partagés.

Le chemin documenté historiquement était :

/usr/local/lib/ccx/common.sh

Cette information est utile pour comprendre d’anciens scripts ou incidents, mais elle ne constitue pas un contrat CURRENT.

Ce qu’il faut vérifier avant de l’utiliser

Ne jamais exécuter :

source /usr/local/lib/ccx/common.sh

uniquement parce que cette page le mentionne.

Vérifier d’abord sur l’environnement concerné :

ls -l /usr/local/lib/ccx/common.sh

Puis vérifier quels scripts du dépôt y font encore réellement référence.

Une absence du fichier n’est pas automatiquement une anomalie si l’outillage actuel passe désormais par make, Docker Compose ou les scripts versionnés dans le dépôt.

Variables historiques

Les variables ci-dessous appartiennent au contrat historique de cette bibliothèque :

Variable Rôle historique
CCX_BASE racine du projet
CCX_BACKUPS répertoire des sauvegardes
CCX_REPORTS répertoire des rapports
CCX_LOGS répertoire des logs
CCX_TMP espace temporaire
CCX_WP chemin WordPress
CCX_DB_NAME nom de base MariaDB
CCX_DB_USER utilisateur MariaDB
CCX_DB_HOST hôte MariaDB
CCX_DB_PASS secret de connexion récupéré dynamiquement

Ne pas recopier ces variables dans un nouveau script sans vérifier le mécanisme actuel de configuration.

Règle actuelle à retenir

Le principe architectural reste valide même si common.sh disparaît :

une information technique partagée ne doit pas être dupliquée dans plusieurs scripts.

La centralisation doit vivre dans une source versionnée et vérifiable :

  • Makefile ;
  • script commun sous scripts/ ;
  • configuration Docker Compose ;
  • variable d’environnement explicitement documentée.

Sécurité

Les secrets ne doivent jamais être copiés en dur dans les scripts ou dans la documentation.

Pour diagnostiquer un problème de connexion :

  1. identifier d’abord la source de configuration réellement utilisée ;
  2. vérifier le contexte Docker concerné ;
  3. ne jamais afficher un secret dans un log ou un rapport ;
  4. corriger la source de configuration, pas une copie locale divergente.

Anciennes commandes

Des documents historiques associaient cette Common Library à des commandes comme :

  • ccx-health ;
  • ccx-backup ;
  • ccx-ops.

Leur présence actuelle ne doit pas être déduite de cette page. Utiliser les entrées vérifiables du dépôt, notamment :

make doctor
make backup
make backup-verify BUNDLE=...
make restore-check BUNDLE=...

Voir ccx-ops pour la correspondance entre l’ancien vocabulaire d’exploitation et les commandes actuelles.

Diagnostic sûr

Si un ancien runbook échoue avec une erreur du type :

/usr/local/lib/ccx/common.sh: No such file or directory

ne recréez pas immédiatement le fichier manquant.

Procédure recommandée :

  1. identifier le script ou la commande qui le source ;
  2. vérifier si ce script appartient encore au chemin d’exploitation CURRENT ;
  3. chercher l’équivalent versionné dans Makefile ou scripts/ ;
  4. ne restaurer une dépendance historique qu’après preuve qu’elle reste nécessaire.

À retenir

common.sh est une trace d’architecture d’exploitation historique, pas une dépendance à réintroduire par réflexe.

Le principe durable est la centralisation de la configuration et des helpers communs dans des composants versionnés, auditables et sans secrets en dur.

Voir aussi