Features
Cette application exploite les services REST exposés (cf. Actuator) pour fournir un ensemble de fonctionnalités facilitant la supervision de FlowerDocs.
Parmi la liste des fonctionnalités proposées, vous pourrez trouver entre autres :
- Vision d’ensemble des différentes instances de la stack FlowerDocs
- Changement des niveaux de log à la volée
- Consultation des logs applicatifs
- Purge de cache
- Consultation des métriques à disposition
- Visualisation des dernières traces HTTP
- Notifications
- ….
Pour plus d’informations sur les fonctionnalités et leur paramétrage, consultez la documentation.
Lancement
java -jar flower-docs-management-2.7.6.jar --system.admin.password=<password>
L’application est accessible à l’URL : http://localhost:2111/admin
Découverte via Eureka
Les différentes instances pouvant être gérées dans cette application sont découvertes via Eureka. La découverte des applications passe par l’enregistrement de chacune auprès du serveur Eureka (embarqué dans l’application Management).
Pour cela, il est nécessaire de définir, pour FlowerDocs GUI et FlowerDocs Core, la propriété eureka.client.serviceUrl.defaultZone
(par défaut : http://localhost:2111/eureka).
FlowerDocs Core et FlowerDocs GUI s’enregistrent auprès d’Eureka avec les informations à leur disposition afin d’indiquer comment les contacter. Si leur contexte (path) ou leur port ont été personnalisés, il est nécessaire de l’indiquer dans leur fichier de configuration core.properties
et gui.properties
.
FlowerDocs Core
Information | Propriété | Valeur par défaut |
---|---|---|
Contexte | core.context |
/core |
Port | core.port |
8081 |
FlowerDocs GUI
Information | Propriété | Valeur par défaut |
---|---|---|
Contexte | gui.context |
/gui |
Port | gui.port |
8080 |
Configuration
Sécurité
Accès à l’application
Un compte utilisateur est nécessaire pour pouvoir accéder à cette application. Par défaut, le mot de passe de l’utilisateur user
est indiqué dans le fichier de logs. Ce compte peut être personnalisé avec les paramètres spring.security.user.name
et spring.security.user.password
.
Accès à FlowerDocs
L’application nécessite l’utilisation d’un compte ayant le rôle SYSTEM_ADMIN
afin d’exécuter des requêtes sur les endpoints décrits précédemment (cf. Actuator). Ce compte peut être défini grâce aux paramètres system.admin.username
et system.admin.password
.
Sans configuration, seul l’utilisateur système de FlowerDocs Core et de FlowerDocs GUI peut être utilisé. Il est possible de définir un utilisateur additionnel tel que :
internal.realm.users[0].id=metric-admin
internal.realm.users[0].password=<password>
internal.realm.users[0].profiles=SYSTEM_ADMIN
Cette configuration est à effectuer côté FlowerDocs Core et FlowerDocs GUI.
Notifications Email
Il est possible de configurer les notifications de changement de statut des applications FlowerDocs Core et FlowerDocs GUI.
Serveur SMTP
Pour cela, il est nécessaire de configurer le serveur SMTP à utiliser pour l’envoi d’email :
spring.mail.host=<host>
spring.mail.username=<user>
spring.mail.password=<password>
spring.mail.properties.mail.smtp.starttls.enable=true
Selon la configuration, il peut être nécessaire de forcer la confiance en l’hôte SMTP :
spring.mail.properties.mail.smtp.ssl.trust=<host>
Diffusion
Pour définir à quelles adresses seront envoyés les emails de notification, ajoutez le paramètre suivant :
spring.boot.admin.notify.mail.to=<recipient>