Différences

Ci-dessous, les différences entre deux révisions de la page.

--- admin:services:faq_services [2020/01/11 10:23] – créée admin
+++ admin:services:faq_services [2023/02/05 22:51] (Version actuelle) – [template de réponse mail] correxion d'une typo pilou
@@ Ligne 1: / Ligne 1: @@
 ======= FAQ Services =======
-Variés sont possiblement les choix d'organisations techniques.
+L'administration système et de services en ligne implique des choix d'organisation, de nommage, de rangement… Ceux-ci peuvent être très variés d'une équipe à l'autre.
 Afin d'avoir une forme d'homogénéité dans le Chapril, voici sous forme de FAQ, quelques conventions techniques à suivre, dans la mesure du possible.
@@ Ligne 10: / Ligne 10: @@
 Le dossier ''/etc/'' est « gité » via EtcKeeper. Penser à commiter dès que vous y faites une modification.
-===== Tâches CRON ? =====
-La sagesse unixienne recommande aux utilisateurs de passer par ''crontab -u user -e'' pour déclarer une tâche cron sans perturber le système. C'est vraiment une bonne idée. Sauf que sur nos vm, nous ne sommes pas des utilisateurs mais des **adminsys**. Et même si certains services tournent sous un compte Unix dédié, il s'agit d'un compte système et non d'un compte utilisateur classique.
-En conséquence, les recommandations sont les suivantes :
-  * les tâches cron sont à déclarer dans ''/etc/cron.d/'' ;
-  * les tâches cron sont à mettre dans un ou plusieurs fichiers dédiés au service ;
-  * le nommage doit reprendre le nom du service (''foochaprilorg'', ''foochaprilorg-bare'') ;
-  * penser à commiter en cas de modification (avoir bien configuré son SSH pour transférer les variables GIT nécessaires) ;
-  * logger la tâche cron (exemple : ''…/task.sh >> /var/log/foochaprilorg-bar.log 2>&1'').
-Exemples de nommage :
-<code>
-=(^-^)=root@lamp:/etc/cron.d# ll
-total 16
--rw-r--r-- 1 root root  63 juil. 18 16:30 backup
--rw-r--r-- 1 root root 375 janv.  6 23:10 datechaprilorg
--rw-r--r-- 1 root root 134 déc.   7 10:48 pastechaprilorg
--rw-r--r-- 1 root root 712 janv.  1  2017 php
-</code>
-Avantages :
-  * facilité d'accès pour les adminsys quand ils cherchent le cron d'un service ;
-  * historisation et traçabilité de la configuration ;
-  * alertes Icinga2 si oublie de commit ;
-  * sauvegarde automatique ;
-  * …
 ===== Les fichiers de conf HTTP ? =====
@@ Ligne 58: / Ligne 29: @@
 -rw-r--r-- 1 root root 1917 nov.  29 23:40 www.chapril.org.conf
 </code>
+===== Les fichiers web  ? =====
+L'emplacement par défaut pour les fichiers web d'un service, c'est ''/var/www/foo.chapril.org''.
 ===== Les fichiers de logs HTTP ? =====
@@ Ligne 85: / Ligne 61: @@
 -rw-r----- 1 root adm  23273 janv.  9 08:13 www.chapril.org/www.chapril.org-error.log
 </code>
+===== Format des logs HTTP ? =====
+Pour profiter des IP proxifiées, activer le ''combined'' :
+<code>
+ CustomLog ${APACHE_LOG_DIR}/foo.chapril.org/foo.chapril.org-access.log combined-proxy
+</code>
+===== Les autres fichiers de logs ? =====
+Pour le projet foo.chapril.org, les mettre dans le dossier ''/var/log/foo.chapril.org/''.
 ===== Home Directory du service ? =====
@@ Ligne 120: / Ligne 107: @@
 ===== Base de données du service ? =====
-Nommages :
+L'idéal serait un nommage parlant :
   * la base : ''foochaprilorg_redmine''_db ou ''foochaprilorg_bare_db'' ;
   * le compte Mariadb : foochaprilorg_dbadmin.
+Mais dans la pratique, on peut se simplifier la vie :
+  * la base : ''nomduproduit_db'' (exemples : ''kanboard_db'', ''framadate_db'') ;
+  * le compte : ''nomduproduit'' (exemples : ''kanboard'', ''framadate'').
 ===== Partition dédiée du service ? =====
@@ Ligne 129: / Ligne 119: @@
 Dans le cas d'un service nécessitant beaucoup d'espace disque, alors créer une partition dédiée. Cette partition ''data'' ne devra contenir que des données, pas de code de l'application du service.
-Exemple : https://admin.chapril.org/doku.php?id=admin:chatons:drop.chapril.org#preparation
+Exemple : https://admin.chapril.org/doku.php?id=admin:services:drop.chapril.org#preparation
+===== Quelle configuration SMTP ? =====
+L'équipe infra gère le flux mail. Configuration à faire : localhost sur le port 25.
 ===== Courriel du service ? =====
@@ Ligne 138: / Ligne 132: @@
 En cas de demande d'information sur ce courriel, ouvrir un ticket de traçage en prenant garde soit de masquer les informations sensibles, soit en cochant « privé » à la création du ticket.
+===== Tâches CRON ? =====
+La sagesse unixienne recommande aux utilisateurs de passer par ''crontab -u user -e'' pour déclarer une tâche cron sans perturber le système. C'est vraiment une bonne idée. Sauf que sur nos vm, nous ne sommes pas des utilisateurs mais des **adminsys**. Et même si certains services tournent sous un compte Unix dédié, il s'agit d'un compte système et non d'un compte utilisateur classique.
+En conséquence, les recommandations sont les suivantes :
+  * les tâches cron sont à déclarer dans ''/etc/cron.d/'' ;
+  * les tâches cron sont à mettre dans un ou plusieurs fichiers dédiés au service ;
+  * le nommage doit reprendre le nom du service (''foochaprilorg'', ''foochaprilorg-bare'') ;
+  * penser à commiter en cas de modification (avoir bien configuré son SSH pour transférer les variables GIT nécessaires) ;
+  * logger la tâche cron (exemple : ''…/task.sh >> /var/log/foo.chapril.org/bar.log 2>&1'').
+Exemples de nommage :
+<code>
+=(^-^)=root@lamp:/etc/cron.d# ll
+total 16
+-rw-r--r-- 1 root root  63 juil. 18 16:30 backup
+-rw-r--r-- 1 root root 375 janv.  6 23:10 datechaprilorg
+-rw-r--r-- 1 root root 134 déc.   7 10:48 pastechaprilorg
+-rw-r--r-- 1 root root 712 janv.  1  2017 php
+</code>
+Avantages :
+  * facilité d'accès pour les adminsys quand ils cherchent le cron d'un service ;
+  * historisation et traçabilité de la configuration ;
+  * alertes Icinga2 si oublie de commit ;
+  * sauvegarde automatique ;
+  * …
+===== Nommage branche Chapril =====
+Pour certains services, la personnalisation passe par la modification du code du service. Afin de suivre et pouvoir propager les modifications dans les futures versions, la mise sous Git du code est nécessaire (si ce n'est pas déjà fait).
+À ce moment là, il faut créer une branche dédiée au Chapril nommée chapril-x.y.z en reprenant le numéro de la version du projet officielle.
 ===== Puis-je assigner un ticket ? =====
@@ Ligne 152: / Ligne 180: @@
   * ne pas laisser trop longtemps les tickets en statut « Résolu » ;
   * …
+===== Besoin d'une action infra ? ======
+L'organisation du Chapril est faite pour faciliter la vie des animateurs de services. Besoin d'une action en dehors de la vm du service ? Alors interpeler un membre de l'équipe infra :D
+===== Module FPM vs open_basedir ? ======
+Par simplicité, si possible, privilégier la directive ''php_admin_value open_basedir''.
+===== Réception d'un courriel sur l'adresse de support ? ======
+Chaque service du Chapril a son courriel de support : foo-support@chapril.org.
+Et parfois, des utilisateurs écrivent à cette adresse. Voici un plan de traitement :
+  * 1) répondre en privé :
+    * expéditeur :
+      * utiliser son courriel @april.org, c'est l'idéal,
+      * éviter **absolument** d'utiliser une adresse GAFAM ou FAI,
+    * en copie :
+      * foo-support@chapril.org
+    * contenu :
+      * dire qui l'on est.
+Modèle de courriel de réponse :
+<code>
+  Bonjour Ada,
+  Je suis Christian Momon, l'animateur bénévole du service foo.chapril.org. Nous sommes
+heureux que nos services numériques libres, éthiques et loyaux puissent vous être utiles.
+ [réponse à la demande]
+ En vous souhaitant, au nom de toute l'équipe du Chapril, un agréable
+usage de nos services libres, éthiques et loyaux.
+ Librement,
+ Christian (Cpm).
+</code>
+  * 2) créer un ticket :
+    * sujet : copiercollerlesujetducourrielavecescrochets
+    * description : copier/coller le courriel en anonymisant un peu :
+<code>
+  Le 20/01/2010, Laurence R. a écrit sur foo-support@chapril.org :
+    Bonjour,
+    […]
+ </code>
+    * ajouter en commentaire le copier/coller de votre réponse
+  * 3) partager
+    * sur chapril@ : si le sujet est pertinent : par exemple, en cas de remerciements, ça fera toujours plaisir à l'équipe :-)
+    * …
+===== Charset des bases de donneés ? ======
+Privilégier l'UTF8. Par exemple, avec Mysql/MariaDB, systématiquement faire du **utf8mb4**.
+Ça permet de gérer les émoticons dans la base. Ça permettra surtout d'éviter des migrations de bases…
+Exemple :
+<code>
+CREATE DATABASE IF NOT EXISTS gitea_db DEFAULT CHARACTER SET utf8mb4 COLLATE 'utf8mb4_unicode_ci';
+</code>