Installation Elasticsearch
Cette partie décrit comment installer Elasticsearch afin de l’utiliser comme backend FlowerDocs.
Afin d’installer Elasticsearch, il est nécessaire de :
Télécharger Elasticsearch à partir du site officiel
Extraire l’archive
elasticsearch-5.2.1.zip
dans un répertoire${ES_HOME}
Ensuite, pour configurer Elasticsearch, éditez le fichier ${ES_HOME}/config/elasticsearch.yml
tel que :
- Pour définir le nom du cluster Elasticsearch, dé-commentez la propriété
cluster.name
et modifiez sa valeur parflower-es-dev
- Dans le cas d’un cluster Elasticsearch, dé-commentez la propriété
node.name
et modifiez sa valeur par celle de votre choix (ex:node-1
) - Si plusieurs noeuds Elasticsearch sont déployés sur la même machine, il est nécessaire de modifier la valeur de la propriété
http.port
- Ajoutez la propriété
action.auto_create_index: false
- Pour accéder à Elasticsearch depuis un serveur distant, il est nécessaire de dé-commenter la propriété
network.host
et de définir une des valeurs suivantes :0.0.0.0
- nom DNS
- adresse IP
Pour terminer, démarrez Elasticsearch en allant dans le dossier ${ES_HOME}/bin
puis en exécutant le script elasticsearch
ou elasticsearch.bat
(selon le système d’exploitation)
Installation Kibana
Cette partie décrit comment installer Kibana afin de faire du reporting dans FlowerDocs.
Afin d’installer Kibana, il est nécessaire de :
Télécharger Kibana à partir du site officiel
Extraire l’archive dans un répertoire
${KIBANA_HOME}
Ensuite, pour configurer Kibana, éditez le fichier ${KIBANA_HOME}/config/kibana.yml
tel que :
- Dans le cas d’un Kibana sur un serveur différent d’Elasticsearch, dé-commentez la propriété
elasticsearch.url
et renseignez pour valeur l’url d’accès à Elasticsearch (par défauthttp://localhost:9200
) - Dé-commentez la propriété
server.basePath
et modifiez sa valeur par/flower-docs-gui/plugins/reporting
.
Pour terminer, démarrez Kibana en allant dans le dossier ${KIBANA_HOME}/bin
puis en exécutant le script kibana
ou kibana.bat
(selon le système d’exploitation)
Configuration
Afin de configurer l’accès de FlowerDocs à Elasticsearch et Kibana, modifiez le fichier gui.properties
en fonction des paramètres renseignés lors de l’installation :
Propriété | Valeur par défaut | Description |
---|---|---|
es.nodes | localhost:9300 |
Adresses des différents noeuds Elasticsearch séparées par une , |
es.cluster | flower-es-dev |
Le nom du cluster Elasticsearch |
es.username | Le nom de l’utilisateur (optionnel) | |
es.password | Le mot de passe de l’utilisateur (optionnel) | |
es.conflict.version | true |
Utilise la notion de version pour gérer les modifications concurrentes |
es.aggregation.max.size | 100 |
Nombre de buckets maximum remonté par agrégation |
kibana.url | http://localhost:5601 |
URL d’accès à Kibana à partir du FlowerDocs Core |