Wikibase/Maintenance

Maintenir une instance Wikibase

Vous trouverez sur cette page quelques ressources pour vous documenter sur votre instance de Wikibase et la garder fonctionnelle et à jour.

Aperçu de l'architecture

Veuillez d'abord prendre connaissance du tableau et du diagramme :

Service name	Access	Notes
wikibase	localhost	MediaWiki avec l'extension Wikibase
mysql	conteneur interne port 3306	base de données MySQL (MariaDB)
elasticsearch	conteneur interne ports 9200, 9300	Elasticsearch
quickstatements	localhost:8840	QuickStatements
wdqs	conteneur interne port 9999	Service des requêtes Wikidata
wdqs-proxy	conteneur interne port 80	Proxy du service des requêtes
wdqs-frontend	localhost:8834	Interface utilisateur du service des requêtes

Outillage Docker

Les meilleurs outils pour gérer votre installation Docker sont ceux que vous avez utilisés pour l'obtenir et qui se trouve à la première place : docker et docker compose. Ce manuel ne peut pas remplacer les fondamentaux de Docker; pour cela veuillez regarder le document de référence des commandes propres à Docker pour docker-compose et le moteur docker.

Ceci dit, plusieurs commandes de démarrage s'avèrent pratiques.

Avant de commencer

• Les noms des conteneurs créés avec docker compose commencent par le nom de base du répertoire dans lequel ils ont été créés lors du premier appel à docker compose up. Les exemples des noms de conteneurs ci-dessous commencent par wbdocker_ car les exemples ont été exécutés dans un répertoire nommé wbdocker.
• Depuis 2023, docker-compose (avec tiret) en tant que commande séparée est devenue obsolète en faveur de docker compose (sans tiret), un argument pour la commande principale docker.
• Les commandes ci-après omettent la mention explicite de docker-compose.yml et supposent que vous avez utilisé la méthode d'installation minimale. Si vous avez utilisé la méthode d'installation étendue, vous devez spécifier tous les fichiers de configuration à inclure, en ajoutant -f docker-compose.yml -f docker-compose.extra.yml à chaque appel de docker compose.

Obtenir un shell de commande sur un conteneur

Il ne vous sera pas utile pour les activités typiques de Wikibase, mais pour ceux qui débutent avec Docker voici une commande très utile pour vous connecter à un conteneur actif :

docker exec -it <container name> bash

Copier un fichier dans votre répertoire local

docker cp wbdocker_wikibase_1:/var/www/html/LocalSettings.php LocalSettings.php

Ceci fonctionne également dans l'autre sens et la combinaison est utile pour disons, récupérer votre LocalSettings.php, le modifier et le sauvegarder à nouveau.

docker cp LocalSettings.php wbdocker_wikibase_1:/var/www/html/LocalSettings.php 

Lire l'excellent billet posté par Adam Shorland pour d'autres détails sur la modification des fichiers de conteneurs.

Arrêter les conteneurs Docker

Cette commande arrête les conteneurs Docker en laissant les machines intactes (avec bien sûr toutes les données) :

docker compose stop

Comme on peut l'imaginer, vous pouvez utiliser docker compose start pour les redémarrer.

Supprimer les conteneurs en préservant les données

Cette commande supprime les conteneurs en préservant toutes les données dans MySQL, MediaWiki et le service de requête dans les volumes Docker.

docker compose down --remove-orphans

Tout supprimer

Avertissement :

Cette commande supprime TOUTES les données que vous avez ajoutées à votre installation Docker ce qui inclut MediaWiki, Wikibase, Elasticsearch et la base de données MySQL. Il est impossible de revenir en arrière dorénavant !

docker compose down --volumes

Journaux

Chaque application de la grappe Wikibase génère ses propres traces dans le journal. Consultez la documentation propre à chaque service pour savoir comment lire les journaux.

Dans le répertoire où vous avez placé votre fichier docker-compose.yml, exécutez la commande docker compose logs et le nom du service (voir la table ci-dessus) pour voir les traces correspondantes dans le journal. Par exemple :

user@host:~/docker$ docker compose logs  -f --tail=100 mysql
mysql_1 | 2019-12-31 10:00:00+00:00 [Note] [Entrypoint]: Entrypoint script for MySQL Server started.
mysql_1 | 2019-12-31 10:00:00+00:00 [Note] [Entrypoint]: Switching to dedicated user 'mysql'
...

Sauvegarde et restauration

Les données de votre instance Wikibase sont précieuses. Que se passerait-il si votre centre de données venait à brûler ? Combien de temps faut-il pour une reconstruction ? Les sauvegardes et le test des données restaurées régulièrement sont des actions primordiales.

En général, il existe deux ensembles de données que vous devrez sauvegarder : le système de fichiers MediaWiki / Wikibase et plus important : la base de données MySQL. D'abord et avant tout nous vous recommandons de lire le document d'installation de Wikibase Docker pour avoir un aperçu du paysage.

Au niveau Docker

Puisqu'il s'agit d'une installation Docker, il est recommandé d'utiliser les outils Docker pour les sauvegardes.

La sauvegarde au niveau Docker est expliquée en détails ici. Elle comprend la sauvegarde des volumes Docker et le vidage de la base de données avec mysqldump.

Pour un aperçu utile de la sauvegarde et de la restauration des données Docker, y compris l'utilisation des commandes docker save et docker load, lire cet excellent billet de StackOverflow. Il a été réactualisé à plusieurs reprises depuis sa version initiale en 2014 et constitue une visite complète et un point d'accès piur les références des commandes Docker en ligne évoquées ci-dessus.

Au niveau conteneur

La sauvegarde au niveau conteneur n'est pas une proposition facile; nous l'évoquons ici principalement pour présenter un image plus complète de MediaWiki et de Wikibase.

Pour cela veuillez lire Manuel:Faire la sauvegarde d'un wiki , en gardant à l'esprit que le travail doit être fait à partir des conteneurs (voir les outils Docker ci-dessus) et que les données doivent être extraites et placées à un endroit sécurisé en dehors de Docker.

Outils Wiki

Wikibase est une extension de MediaWiki. La plus grande fonction avec laquelle vous allez travailler est actuellement celle de MediaWiki, veuillez-donc consulter le Manuel:Contenu et le Pôle des administrateurs système . Voir principalement :

• Aide:Sommaire - guide utilisateur
• Manuel:Droits utilisateurs - gestion des droits utilisateurs
• Manuel:Administrateurs - guide de l'administrateur Wiki

Mise à jour

En gardant à jour le logiciel vous êtes assuré d'avoir les dernières fonctionnalités, la correction des bogues et les correctifs de sécurité,ce qui est important.

Pour mettre à jour Wikibase sous Docker, veuillez lire notre documentation de mise à jour.

La mise à jour d'une installation manuelle de la suite Wikibase n'est pas aussi directe : elle implique la mise à jour de MediaWiki lui-même (voir la documentation de mise à jour de MediaWiki) puis celle des composants logiciels individuels.