Code source wiki de Guide de mise à jour

Modifié par mperroud le 2021/11/10 10:19
Afficher les derniers auteurs
1 {{ddtoc/}}
2
3 ----
4
5 Ce document explique les différentes étapes à suivre pour mettre à jour votre déploiement DigDash Enterprise vers une nouvelle version.
6
7 (% class="box errormessage" %)
8 (((
9 **Attention : Avant toute migration, faire une sauvegarde intégrale de l’application depuis la page d’accueil => Configuration => Gestion des sauvegardes.**
10 )))
11
12 (% class="box warningmessage" %)
13 (((
14 **Important : Migration des développements spécifiques (toutes versions)**
15 Cette procédure ne prend pas en compte la migration de développements spécifiques (modification de logos, adjonction de JSP,...) qui peut être décrite dans vos procédures internes.
16 Si des développements spécifiques ont été faits, procédez à une copie de sauvegarde de votre installation actuelle afin de pouvoir récupérer et migrer tous ces développements.
17 )))
18
19 Les archives d’installation de DigDash Enterprise sont nommées sous le modèle **digdash_enterprise_2021R1_numpatch_64.zip.**
20 Après extraction, le dossier s’appellera **digdash_enterprise_2021R1_numpatch**.
21
22 Pour expliciter la procédure, le dossier d’installation de la plus ancienne des versions sera nommé **install_dd_OLD** et le dossier d’installation de la plus récente des versions **install_dd_NEW.**
23 Le numéro de version est visible dans le fichier version.txt de l'archive ou depuis la page « **Configuration **/ **État du serveur** » (« Version DigDash Enterprise » en haut à gauche dans la rubrique « **État général** »).
24
25 **Prérequis minimum :**
26
27 * Serveur : Tomcat 8
28 * Serveur : Java 8
29 * Desktop Studio : Java 8 minimum ([[Java 7 n'est plus mis à jour depuis Juillet 2015>>https://www.java.com/en/download/help/java_7.html]])
30 * Web Studio : aucun prérequis (accessible dans le navigateur web comme le tableau de bord)
31
32 **Recommendations :**
33
34 * Serveur : **Tomcat 9** (Windows et Linux)
35 * Serveur : **Java 11** (Windows)
36 * Desktop Studio : Java 8 à la dernière mise à jour (sécurité)
37 * Web Studio : aucun prérequis (accessible dans le navigateur web comme le tableau de bord)
38
39 Sous linux vous devrez au minimum installer Java en suivant les recommendations.
40
41 = Premier déploiement de la 2021 R1 =
42
43 Ce paragraphe vous concerne si vous déployez pour la 1ère fois la version 2021 R1.
44 Dans le cas du déploiement d'un patch pour la 2021 R1, voir le chapitre [[Déploiement d'un patch sur une 2021 R1>>doc:||anchor="HDE9ploiementd27unpatchsurune2021R1"]].
45
46 (% class="box successmessage" %)
47 (((
48 Cette version permet de simplifier les processus d'installation, de configuration et de maintenance (installation d'un patch ou intervention du support).
49 Il est intéressant et vivement recommandé de reprendre de zéro l'installation pour cette mise à jour.
50 Le nouveau système de configuration vous fera gagner du temps par la suite.
51 )))
52
53 Le principe général est de n'avoir à modifier qu'un seul fichier : **digdash.properties**, qui sera préservé automatiquement lors d'une prochaine mise à jour.
54 Ce fichier est fourni dans l'archive d'installation et comporte déjà tous les paramètres succeptibles d'être personnalisés lors de l'installation.
55
56 On distinguera deux cas principaux : utilisation du serveur Tomcat fourni (windows ou linux) ou utilisation de votre propre Tomcat.
57
58 == Utilisation du Tomcat fourni ==
59
60 === Étape 1 : Sauvegarde ===
61
62 Effectuez une sauvegarde complète de votre configuration : entrées LDAP (utilisateurs, rôles, groupes d'autorisations), modèles de données, tableaux de bord, etc.
63 Si vous aviez ajouté des fichiers à votre installation (modification de logos, imags, css, adjonction de JSP, ...) il faudra les reporter dans la nouvelle installation.
64
65 Voir documentation [[Sauvegarde et restauration>>doc:Digdash.deployment.configuration.backup_restore.WebHome]].
66
67 === Étape 2 : Arrêt du serveur ===
68
69 Arrêtez le serveur DigDash à l'aide de : **<install_dd_OLD>/stop_tomcat.bat**.
70 Ou sous Linux **<install_dd_OLD>/apache-tomcat/bin/shutdown.sh.**
71 Ou arrêtez le service correspondant.
72
73 === Étape 3 : Extraction ===
74
75 * Dézippez **digdash_enterprise_2021R1_numpatch_64.zip** à l'emplacement de votre choix grâce à un outils comme [[7Zip>>https://www.7-zip.org||rel="noopener noreferrer" target="_blank"]].
76 * Renommez le dossier contenant l'installation. L'idéal est un nom sans version, pour ne pas induire en erreur sur le contenu de l'installation lors des mises à jour à venir.
77 * Vérifiez que votre dossier d'installation contient le fichier **version.txt**. C'est lui qui indiquera de manière certaine la version du produit (sans avoir à démarrer le serveur).
78
79 === Étape 4 : Paramétrage ===
80
81 (% class="box infomessage" %)
82 (((
83 Si vous êtes sous Linux, copiez le fichier **<install_dd_NEW>/digdash.properties** dans le dossier **/etc/digdash.**
84 Il sera trouvé automatiquement par le serveur.
85 Veillez à ce que dossiers et fichiers aient les mêmes droits que l'utilisateur exécutant le service Tomcat.
86 )))
87
88 Editez le fichier **<install_dd_NEW>/digdash.properties**.
89
90 (% class="box infomessage" %)
91 (((
92 Les lignes commençant par un seul caractère **#** sont celles à modifier.
93 En supprimant le caractère **#** en début de ligne vous activez le paramètre.
94 )))
95
96 ==== Emplacement des données ====
97
98 (% class="box successmessage" %)
99 (((
100 Lors de la configuration portez une attention particulière aux paramètres **digdash.appdata** ou **<application>.AppDataPath**.
101 L'idéal est d'utiliser le paramètre global **digdash.appdata** : toutes les applications utiliserons alors le même dossier racine.
102 )))
103
104 Pour spécifier un emplacement commun à toutes les applications DigDash (ldap, serveur, studio, ...) il faut modifier le paramètre **digdash.appdata** :
105
106 (% class="box" %)
107 (((
108 #digdash.appdata=C:/appdata
109 )))
110
111 devient :
112
113 (% class="box" %)
114 (((
115 digdash.appdata=C:/appdata
116 )))
117
118 (% class="box warningmessage" %)
119 (((
120 Attention à n'utiliser que des slash "/", ou deux anti-slash "~\~\".
121 )))
122
123 Attention au dossier des données de l'annuaire LDAP. Il s'agit du dossier **ldapdigdash** (si vous ne l'aviez pas modifié).
124
125 * Si vous utilisez le paramètre global **digdash.appdata** alors il faudra déplacer votre ancien dossier **ldapdigdash **dans le dossier spécifié dans ce paramètre.
126 * Si vous voulez continuer à placer le dossier **ldapdigdash **dans un autre emplacement, utilisez le paramètre **adswrapper.ads.instance.name**.
127
128 (% class="box warningmessage" %)
129 (((
130 Toutes les applications dans le même dossier (même LDAP) :
131
132 * digdash.appdata=C:/data
133 )))
134
135 (% class="box warningmessage" %)
136 (((
137 Pour un dossier LDAP séparé :
138
139 * (((
140 adswrapper.ads.instance.name=D:/data/ldapdigdash
141 )))
142 )))
143
144 ==== Les autres paramètres ====
145
146 Tous les autres paramètres présents dans ce fichier sont préfixés du nom de l'application concernée :
147
148 (% class="box infomessage" %)
149 (((
150 <nom de l'application>.<nom du paramètre>=<valeur>
151 )))
152
153 Vous devez ainsi reporter tous les paramètres que vous aviez modifiés dans les fichiers **web.xml** de votre ancienne installation.
154
155 Par exemple, pour modifier la méthode d'authentification (**authMethod**) au Tableau de bord (**digdash_dashboard**.war) il faut modifier le paramètre **digdash_dashboard.authMethod**.
156
157 (% class="box" %)
158 (((
159 #digdash_dashboard.authMethod=default/NTUser/NTUserOrLDAP/NTUserOrLDAP,loginForm/Custom
160 )))
161
162 devient :
163
164 (% class="box" %)
165 (((
166 digdash_dashboard.authMethod=default/NTUser/NTUserOrLDAP/NTUserOrLDAP,loginForm/Custom
167 )))
168
169 === Etape 5 : Démarrage ===
170
171 Une fois que vous avez reporté tous les paramètres de votre ancienne installation dans le fichier **digdash.properties**, démarrez TOMCAT à l'aide de **<install_dd_NEW>/start_tomcat.bat** et laissez Tomcat redéployer les nouvelles applications.
172 Ou sous Linux **<install_dd_OLD>/apache-tomcat/bin/startup.sh.**
173
174 Pour une installation en tant que service sous Windows, utilisez le script **<install_dd_NEW>/configure/servers_install_service.bat** (attention au nom du service si vous l'aviez modifié lors de la précédente installation, référez vous au** **[[Guide d'installation Windows>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||target="_blank"]] pour plus de détails).
175
176 Sous linux reportez vous au [[Guide d'installation Linux>>doc:Digdash.deployment.installation.install_guide_linux.WebHome||target="_blank"]].
177 Plus d'informations sur l'installation en tant que service dans le [[Guide d'installation Windows>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||target="_blank"]].
178
179
180 === Étape 6 : Restauration ===
181
182 Si vous avez configuré votre nouvelle installation pour pointer sur votre ancien dossier des données (voir [[Etape 5>>doc:||anchor="HC9tape5A0:DossierdesdonnE9es"]]) la restauration n'est pas nécessaire.
183
184 Sinon (nouveau dossier des données) utilisez la sauvegarde de l’étape 1 pour restaurer les entrées LDAP (utilisateurs, rôles, groupes d'autorisations).
185
186 __**Important**__** :** si vous aviez fait des modifications dans les dossiers **ddenterpriseapi** et **digdash_dashboard** sur des fichiers de configuration (web.xml, ...), des images ou des fichiers css, vous devrez les reporter.
187
188 //__Note__ : Si vous venez d’une version 2017 R1 et si vous avez customisé les styles du tableau de bord, veuillez vous référer à la documentation [[Personnalisation>>doc:Digdash.customization.customization_DDE.WebHome]] pour mettre à jour vos styles CSS.//
189
190
191 === Étape 7 : Nettoyage du cache du navigateur ===
192
193 Supprimez le cache du navigateur (raccourcis sur la pluspart des navigateurs : Ctrl + Shift + Suppr)
194
195 == Utilisation de votre Tomcat ==
196
197 Si vous utilisez votre propre serveur Tomcat (Windows ou linux), la procédure à suivre est la même que pour le[[ déploiement d'un patch>>doc:||anchor="HDE9ploiementd27unpatchsurune2021R1"]],
198 vous pouvez donc suivre la procédure du [[chapitre suivant>>doc:||anchor="HDE9ploiementd27unpatchsurune2021R1"]].
199
200 Seule l'**étape 6 : Récupération des add-ons** sera à adapter.
201 Vous n'aurez qu'à copier le dossier add-ons où cela vous convient (vous l'avez peut être déjà sur votre machine, mais il peut contenir des mises à jour).
202
203 = Déploiement d'un patch sur une 2021 R1 =
204
205 Ce paragraphe concerne la mise à jour d'une version 2021 R1 vers une autre 2021 R1 plus récente.
206
207 (% class="box infomessage" %)
208 (((
209 La procédure qui suit part du principe que votre configuration suit la recommandation d'utiliser le fichier **digdash.properties**. Si cela n'est pas fait, référez vous au [[premier chapitre>>doc:||anchor="HPremierdE9ploiementdela2021R1"]].
210 )))
211
212 (% class="box warningmessage" %)
213 (((
214 Si votre installation contient des développements spécifiques, qui se trouvent dans les dossiers des applications :
215 **<install_dd>/apache-tomcat/webapps/ddenterpriseapi** ou **<install_dd>/apache-tomcat/webapps/digdash_dashboard**
216 ils seront perdus lors de la mise à jour. Sauvegardez les avant toute autre opération, afin de pouvoir les reporter après mise à jour.
217 )))
218
219 == Étape 1 : Sauvegarde ==
220
221 Effectuez une sauvegarde complète de votre configuration : entrées LDAP (utilisateurs, rôles, groupes d'autorisations), modèles de données, tableaux de bord, etc.
222
223 N'oubliez pas les éventuels développements spécifiques pouvant se trouver dans les applications (voir l'encadré jaune précédent).
224
225 Voir documentation [[Sauvegarde et restauration>>doc:Digdash.deployment.configuration.backup_restore.WebHome]].
226
227 == Étape 2 : Arrêt du serveur ==
228
229 Arrêtez le serveur DigDash à l'aide de : **<install_dd>/stop_tomcat.bat**
230 Ou arrêtez le service correspondant.
231
232 == Étape 3 : Suppression des anciennes applications ==
233
234 Sauvegardez puis effacez les fichiers et dossiers de **<install_dd>/apache-tomcat/webapps :**
235
236 (% border="0" %)
237 |(((
238 Dossiers :
239
240 * adminconsole
241 * ddenterpriseapi
242 * digdash_dashboard
243 * studio
244 * adswrapper
245 )))|(((
246 Fichiers :
247
248 * adminconsole.war
249 * ddenterpriseapi.war
250 * digdash_dashboard.war
251 * studio.war
252 * adswrapper.war
253 )))
254
255 (% class="box warningmessage" %)
256 (((
257 Ne pas effacer le dossier **ROOT**.
258 )))
259
260 (% class="box warningmessage" %)
261 (((
262 Ne pas effacer le dossier **ldapdigdash**.
263 )))
264
265 == Étape 4 : Copie des nouvelles applications ==
266
267 Dézippez la nouvelle version du produit dans un emplacement temporaire.
268
269 Naviguez dans ce dossier temporaire jusque dans le dossier **apache-tomcat/webapps.**
270 Copiez les 5 fichiers suivants dans le même dossier de votre installation :
271
272 * adminconsole.war
273 * ddenterpriseapi.war
274 * digdash_dashboard.war
275 * studio.war
276 * adswrapper.war
277
278 Le dossier **webapps **doit maintenant contenir 5 fichiers .war et le dossier **ROOT**.
279
280 == Étape 5 : Fichier version.txt ==
281
282 Copiez le fichier **version.txt** dans votre dossier d'installation. Il remplacera celui de la précédente installation.
283
284 (% class="box infomessage" %)
285 (((
286 Ce fichier permet de connaître la version du produit sans démarrer le serveur ou si la page "Etat du serveur" n'est pas disponible.
287 )))
288
289 == Étape 6 : Récuparation des add-ons ==
290
291 Copiez le contenu du répertoire **add-ons** vers le même endroit dans votre installation.
292 Si vous aviez modifiés certains fichiers (**importtools**, **backtuptools**, ...) sauvegardés les avant la copie.
293
294 == Étape 7 : Démarrage ==
295
296 Démarrez Tomcat à l'aide de **start_tomcat.bat /startup.sh** et laissez Tomcat redéployer les nouvelles applications.
297
298 Si vous êtes en mode service relancez le manuellement.
299
300 == Étape 8 : Nettoyage du cache du navigateur ==
301
302 Supprimez le cache du navigateur (raccourcis sur la pluspart des navigateurs : Ctrl + Shift + Suppr)
303
304 = Version 2018 R2 ou inférieure vers 2021 R1 =
305
306 (% class="wikigeneratedid" %)
307 Contactez DigDash à l’adresse [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__contact@digdash.com__>>path:mailto:contact@digdash.com]](%%).