Commit c2d89302 authored by Laurent Lecluse's avatar Laurent Lecluse
Browse files

Cglg & procédures install update mises à jour

parent 7888daf9
Loading
Loading
Loading
Loading
Loading
+1 −0
Changes for CHANGELOG.md: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -30,6 +30,7 @@
* Traducteur de formules de calcul : gestion des SI embarqués dans des paramètres de fonctions
* Nouvelle version de la formule de calcul de Paris Dauphine (#50652)
* Formule de calcul "par défaut" disponible pour tous les établissement qui le souhaitent ou bien en attente de leur formule personnalisée
* Les mises à jour OSE ne pourront plus être bloquées par des modifications locales : elles seront écrasées

## Corrections

+61 −53
Changes for INSTALL.md: 61 added lines, 53 removed lines.
Original line number Diff line number Diff line
@@ -7,12 +7,13 @@ Il faut donc installer :
* Un serveur web Apache + PHP

Le serveur web doit être installé par vos soins.
Le serveur web n'héberge aucune donnée, hormis des fichiers de configuration et de cache. Toutes les données d'explloitation sont donc
stockées en base de données.
Le serveur web n'héberge aucune donnée, hormis des fichiers de configuration et de cache. Toutes les données
d'explloitation sont donc stockées en base de données.

# Serveur de base de donnée

### Spécifications

Les spécifications sont les suivantes :

* 4 CPU virtuels
@@ -23,10 +24,11 @@ Les spécifications sont les suivantes :
* encodage en UTF-8, Oracle 19 minimum, XE ou entreprise

### Paramétrage

Pour information, notre base de données est configurée avec les paramètres suivants :

| Paramètre               | Valeur                       |
| --------------------- | ----------- |
|-------------------------|------------------------------|
| NLS_LANGUAGE            | AMERICAN                     |
| NLS_TERRITORY           | AMERICA                      |
| NLS_CURRENCY            | $                            |
@@ -46,18 +48,22 @@ Pour information, notre base de données est configurée avec les paramètres su
| NLS_LENGTH_SEMANTICS    | BYTE                         |
| NLS_NCHAR_CONV_EXCP     | FALSE                        |
| NLS_NCHAR_CHARACTERSET  | AL16UTF16                    |
|NLS_RDBMS_VERSION | 11.2.0.3.0 |
| NLS_RDBMS_VERSION       | 19.0.0.0.0                   |

La liste de vos paramètres est accessible via la requête suivante :

```sql
SELECT * FROM NLS_DATABASE_PARAMETERS;
SELECT *
FROM NLS_DATABASE_PARAMETERS;
```

### Afficher les messages d'erreur en français dans OSE

Pour afficher les messages d'erreur en français dans OSE, il faut définir une variable d'environnement PHP
spécifique : `NLS_LANG` avec pour valeur `FRENCH`.

Avec Apache, vous devez ajouter la ligne suivante à votre configuration dans le fichier envvars :

```apache
export NLS_LANG="FRENCH"
```
@@ -71,6 +77,7 @@ OSE n'impose pas de version bien spécifique d'Apache.
## Méthode manuelle, à adapter selon vos besoins

### Serveur Web

Installer sur une distribution GNU/Linux - Debian 10 (Buster) de préférence.

Dépendances requises :
@@ -94,10 +101,12 @@ Dépendances requises :
    * soap
    * OCI8 (version 3.3.0 / pilote pour Oracle).

Le mode installation de OSE liste toutes les dépendances nécessaires et teste leur présence sur votre serveur.
Le mode installation d'OSE liste toutes les dépendances nécessaires et teste leur présence sur votre serveur.

### Unoconv

#### Présentation

Unoconv est un utilitaire qui utilise LibreOffice pour convertir des documents depuis le format OpenDocument
vers le format PDF.

@@ -106,13 +115,15 @@ OSE l'utilise par exemple pour générer des contrats de travail ou d'autres ét
**UnoConv** devra donc être installé sur le serveur.

#### Installation

Unoconv est intégré à la plupart des distributions GNU/Linux.

Spécifique à Debian :
Il en existe un paquet intégré à Debian.)
Attention également : sous Debian, unoconv peut s'installer par apt-get, mais il faut aussi installer LibreOffice Writer, la dépendance n'étant pas automatique (`apt-get install unoconv libreoffice-writer`).
Spécifique à Debian (il en existe un paquet intégré à Debian) :
Attention également : sous Debian, unoconv peut s'installer par `apt-get`, mais il faut aussi installer LibreOffice
Writer, la dépendance n'étant pas automatique (`apt-get install unoconv libreoffice-writer`).

#### Configuration

Unoconv doit être lancé en tant que démon.
Il tournera donc en tâche de fond et OSE fera appel à lui pour effectuer les conversions en PDF souhaitées.
Pour cela, la commande `unoconv --listener` doit être lancée.
@@ -142,22 +153,24 @@ systemctl enable unoconv.service
systemctl start unoconv.service
```


### Fichiers de l'application

L'installation se fait en récupérant les sources directement depuis le dépôt GitLab de l'Université de Caen.
Un script a été conçu pour automatiser cette opération.

Pour installer OSE, exécutez la commande suivante sur votre serveur :

```bash
wget https://ose.unicaen.fr/install && php install
```


### Configuration d'Apache

#### Exemple avec un VirtualHost

Exemple pris avec /var/www/ose en répertoire d'installation et ose.unicaen.fr en nom d'hôte.
A adapter à vos besoins.
À adapter à vos besoins.

```apache
<VirtualHost *:80>
	ServerName ose.unicaen.fr
@@ -166,13 +179,6 @@ A adapter à vos besoins.
	RewriteEngine On
	RewriteBase /

	RewriteCond %{REQUEST_FILENAME} -s [OR]
	RewriteCond %{REQUEST_FILENAME} -l [OR]
	RewriteCond %{REQUEST_FILENAME} -d
	RewriteRule ^.*$ - [NC,L]
	RewriteCond %{REQUEST_URI}::$1 ^(/.+)(.+)::\2$
	RewriteRule ^(.*) - [E=BASE:%1]
	RewriteRule ^(.*)$ %{ENV:BASE}index.php [NC,L]

	# Usage de l'application. 
	# Plusieurs valeurs possibles : dev (pour le développement), test (pour du test), prod (à utiliser en production)
@@ -181,38 +187,32 @@ A adapter à vos besoins.
	php_value post_max_size 100M
	php_value max_execution_time 300
	php_value max_input_time 60
	php_value memory_limit 1024M
	php_value memory_limit 2048M

	<Directory /var/www/ose/public>
		Options Indexes MultiViews
		AllowOverride All
		AllowOverride All # Un fichier .htaccess est placé dans le répertoire public de OSE : il doit être parcouru
	</Directory>
</VirtualHost>
```

#### Exemple avec un alias

Exemple pris avec /var/www/ose en répertoire d'installation et /ose en Alias.
A adapter à vos besoins.
À adapter à vos besoins.

```apache
Alias /ose			                /var/www/ose/public

<Directory /var/www/ose/public>
	Options Indexes MultiViews
	AllowOverride All
	AllowOverride All # Un fichier .htaccess est placé dans le répertoire public de OSE : il doit être parcouru
	Order allow,deny
	allow from all

	RewriteEngine On
	RewriteBase /ose

	RewriteCond %{REQUEST_FILENAME} -s [OR]
	RewriteCond %{REQUEST_FILENAME} -l [OR]
	RewriteCond %{REQUEST_FILENAME} -d
	RewriteRule ^.*$ - [NC,L]
	RewriteCond %{REQUEST_URI}::$1 ^(/.+)(.+)::\2$
	RewriteRule ^(.*) - [E=BASE:%1]
	RewriteRule ^(.*)$ %{ENV:BASE}index.php [NC,L]

	# Usage de l'application. 
	# Plusieurs valeurs possibles : dev (pour le développement), test (pour du test), prod (à utiliser en production)
	SetEnv APPLICATION_ENV "test"
@@ -221,18 +221,20 @@ Alias /ose /var/www/ose/public
	php_value post_max_size 100M
	php_value max_execution_time 300
	php_value max_input_time 60
	php_value memory_limit 1024M
	php_value memory_limit 2048M
</Directory>
```
N'oubliez pas de recharger la configuration d'Apache (systemctl reload apache2)!

N'oubliez pas de recharger la configuration d'Apache (systemctl reload apache2)!

# Configuration technique

Personnalisez le fichier `config.local.php` pour adapter OSE à votre établissement.
Une attention toute particulière doit être prise pour configurer les paramètres de base de données, car ces derniers
seront utiles pour terminer la procédure d'installation.

# Création de la base de données

Créez une base de données avec un utilisateur pour OSE, un schéma, puis un tablespace vides.

Les droits de l'utilisateur Ose doivent être les suivants :
@@ -263,30 +265,32 @@ GRANT EXECUTE ON "SYS"."DBMS_ALERT" TO "OSE";
```

Une fois la base de données créée, il faut mettre en place les tables, les vues, etc.
Cela se fait au moyen de la commande suivante (depuis le répertoire de OSE) :
Cela se fait au moyen de la commande suivante (depuis le répertoire d'OSE) :

```bash
./bin/ose install-bdd
``` 

# Mise en place des tâches CRON

Des tâches CRON doivent être lancée sur votre serveur régulièrement pour mettre à jour certaines données
ou réaliser des actions.

Ceci est utile en production. Il n'est pas conseillé d'activer ces tâches CRON en développement ou
en test, mais plutôt de lancer manuellement ces tâches.

Dans tous les cas, c'est le script de OSE qui sera appelé.
Le script est situé dans le répertoire de OSE, `bin/ose`.
Dans tous les cas, c'est le script bash d'OSE qui sera appelé.
Le script est situé dans le répertoire d'OSE, `bin/ose`.
Il est suivi de l'action à exécuter, puis éventuellement de paramètres à préciser.

Exemple d'utilisation pour lancer une tâche de synchronisation appelée `synchro`:

```bash
/usr/bin/php [votre dossier ose]/bin/ose synchronisation synchro
/[votre chemin ose]/bin/ose synchronisation synchro
```

| Usage                                                                                                            | Fréquence                                                 | Action de script               |
| --------------------- | --------------------- | --------------------- |
|------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|--------------------------------|
| Indicateurs : envoi des notifications par mail                                                                   | Les jours de semaine entre 5h et 17h                      | notifier-indicateurs           |
| Synchronisation : Mise en place d'un job pour l'import des données. Plusieurs jobs pourront être créés au besoin | Tous les quarts d'heures entre 7h et 21h sauf le dimanche | synchronisation `<Nom du job>` |  
| Calcul des effectifs du module Charges                                                                           | Une fois par jour, à 20h tous les jours sauf le dimanche. | chargens-calcul-effectifs      |
@@ -296,19 +300,19 @@ Exemple d'utilisation pour lancer une tâche de synchronisation appelée `synchr
| MAJ des vues matérialisées dédiées aux exports (BO, SID, etc.)                                                   | Une fois par jour, à 4h tous les jours sauf le dimanche   | maj-exports                    |

Après la commande, on ajoute `> /tmp/oselog 2>&1` pour loguer le résultat dans le fichier`/tmp/oselog`.
A adapter le cas échéant.
À adapter le cas échéant.

Voici un exemple de crontab :

```cron
# m  h    dom mon dow command
0    5-17 *   *   1-5 /usr/bin/php /var/www/ose/bin/ose notifier-indicateurs      > /tmp/oselog 2>&1
*/15 7-21 *   *   1-6 /usr/bin/php /var/www/ose/bin/ose synchronisation synchro   > /tmp/oselog 2>&1
0      20 *   *   1-6 /usr/bin/php /var/www/ose/bin/ose chargens-calcul-effectifs > /tmp/oselog 2>&1
0    6,14 *   *   1-6 /usr/bin/php /var/www/ose/bin/ose calcul-tableaux-bord      > /tmp/oselog 2>&1
0       3 *   *   1,4 /usr/bin/php /var/www/ose/bin/ose formule-calcul            > /tmp/oselog 2>&1
0      7 15  12     * /usr/bin/php /var/www/ose/bin/ose maj-taux-mixite           > /tmp/oselog 2>&1
0       4 *   *   1-6 /usr/bin/php /var/www/ose/bin/ose maj-exports               > /tmp/oselog 2>&1
0    5-17 *   *   1-5 /[votre chemin ose]/ose/bin/ose notifier-indicateurs  > /tmp/oselog 2>&1
0    7-21 *   *   1-6 /[votre chemin ose]/bin/ose synchronisation synchro   > /tmp/oselog 2>&1
0      20 *   *   1-6 /[votre chemin ose]/bin/ose chargens-calcul-effectifs > /tmp/oselog 2>&1
0    6,14 *   *   1-6 /[votre chemin ose]/bin/ose calcul-tableaux-bord      > /tmp/oselog 2>&1
0       3 *   *   1,4 /[votre chemin ose]/bin/ose formule-calcul            > /tmp/oselog 2>&1
0       7 15  12    * /[votre chemin ose]/bin/ose maj-taux-mixite           > /tmp/oselog 2>&1
0       4 *   *   1-6 /[votre chemin ose]/bin/ose maj-exports               > /tmp/oselog 2>&1
```

OSE est maintenant installé.
@@ -317,18 +321,21 @@ OSE est maintenant installé.

Il n'est pas recommandé d'activer les notifications pour les indicateurs en pré-production.
De même, il est déconseillé de lancer la tâche de synchronisation tous les quarts d'heure en pré-prod.
Le mieux est, dans ce contexte, de réaliser ces synchronisations manuellement, table par table, depuis l'interface de OSE.
cela vous permettra de
Le mieux est, dans ce contexte, de réaliser ces synchronisations manuellement, table par table, depuis
l'interface d'OSE.
Cela vous permettra de :

* mieux maitriser les flux de données entre votre SI et OSE ;
*  mieux identifier des problèmes éventuels au niveau des connecteurs puisque OSE affiche les erreurs rencontrées à l'écran ;
*  d'avoir une offre de formation de test "stable", c'est-à-dire qui ne se met pas à jour toute seule, ce qui simplifiera vos tests.
* mieux identifier des problèmes éventuels au niveau des connecteurs puisque OSE affiche les erreurs rencontrées à
  l'écran ;
* d'avoir une offre de formation de test "stable", c'est-à-dire qui ne se met pas à jour toute seule, ce qui simplifiera
  vos tests.

En revanche, il est vivement recommandé de bien paramétrer en préproduction les autres tâches
(calcul des effectifs Chargens, calcul des tableau de bord, formule de calcul).

(calcul des effectifs Chargens, calcul des tableaux de bord, formule de calcul).

# Connecteurs

Afin de pouvoir intégrer OSE à votre système d'information,
des [connecteurs Import](doc/Connecteurs-Import/Connecteurs-IMPORT.md)
vous sont fournis à titre d'exemple.
@@ -337,4 +344,5 @@ Vous devrez en effet les adapter à vos besoins.
# Paramétrage de l'application

Reste enfin à paramétrer l'application en fonction de vos besoins.
[Le guide administratif](https://redmine.unicaen.fr/Etablissement/projects/deploiement_ose/dmsf?folder_id=3204) vous aidera en cela.
[Le guide administratif](https://redmine.unicaen.fr/Etablissement/projects/deploiement_ose/dmsf?folder_id=3204) vous
aidera en cela.
+10 −6
Changes for UPDATE.md: 10 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -6,10 +6,18 @@
Vous êtes invités à consulter cette page, car y sont mentionnées des "notes de mise à jour" par version qu'il
convient de lire attentivement avant de démarrer toute opération.

Si vous "sautez" plusieurs versions, attention à bien lire également les notes de mises à jour de chaque version intermédiaire, car des opérations
Si vous "sautez" plusieurs versions, attention à bien lire également les notes de mises à jour de **toutes les versions intermédiaires**, car des opérations
manuelles à effectuer peuvent y être consignées. Opérations sans lesquelles pourrait ne plus fonctionner.

## Mode maintenance

Le mode maintenance est utilisé pour couper l'accès à l'application durant les opérations de mise à jour.

Si la mise à jour concerne une ou plusieurs versions mineures, par exemple passage de la version 23.12 à la 23.14, alors il convient d'abord de tester
si l'opération fonctionne d'abord sur votre serveur de pré-production. Si cela se passe bien, vous pourrez mettre à jour votre instance de production 
sans la mettre en mode maintenance, donc sans avoir de coupure de service. Dans tous les autres cas ou bien si vous avez des doutes, le mode maintenance doit être
activé.

Placez OSE en mode maintenance. Dans le fichier `config.local.php` :

* `maintenance/modeMaintenance` doit passer à `true`.
@@ -17,15 +25,11 @@ Placez OSE en mode maintenance. Dans le fichier `config.local.php` :

## Mise à jour

* Si les fichiers sources de OSE ont été modifiés manuellement (hors fichier de configuration local), veillez à remettre la copie
de travail dans son état originel au moyen de la commande suivante :
`git reset --hard` (dans le répertoire de l'application).

* Dans le répertoire de l'application, exécutez `./bin/ose update`, puis suivez les instructions.

La base de données sera également mise à jour (structures et données).

Si au niveau base de données vous rencontrez des erreurs, une nouvelle mise à jour de la base de données pourra être lancée
Si au niveau base de données, vous rencontrez des erreurs, une nouvelle mise à jour de la base de données pourra être lancée
au moyen de la commande `./bin/ose update-bdd`. 

## Passage en production