From 493a67ea81d13f9f5df7004a2c872c69c275de62 Mon Sep 17 00:00:00 2001 From: khaledk2 Date: Thu, 15 Aug 2024 14:18:47 +0100 Subject: [PATCH] Update installation --- .../configuration_installation.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/configuration/configuration_installation.rst b/docs/configuration/configuration_installation.rst index 53c8e63a..b6f6bd7e 100644 --- a/docs/configuration/configuration_installation.rst +++ b/docs/configuration/configuration_installation.rst @@ -44,7 +44,7 @@ The application should have the access attributes (e.g, URL, username, password, Application installation using Docker ===================================== -Ubuntu, CentOS 7 and Rocky Linux 9 images are provided. +Ubuntu and Rocky Linux 9 images are provided. * The user may build the Docker image using the following command:: @@ -61,7 +61,7 @@ Ubuntu, CentOS 7 and Rocky Linux 9 images are provided. * It will be used to save the configuration file so the user can configure his instance * Additionally, it will be used to save the logs files and other cached data. -* An example of running the docker run command for a CentOS image which maps the ``etc/searchengine`` folder to the user home folder in order to save the log files as well as mapping the application configuration file :: +* An example of running the docker run command for a Rocky Linux image which maps the ``etc/searchengine`` folder to the user home folder in order to save the log files as well as mapping the application configuration file :: $ docker run --rm -p 5577:5577 -d -v $HOME/:/etc/searchengine/ searchengine @@ -76,24 +76,24 @@ Ubuntu, CentOS 7 and Rocky Linux 9 images are provided. Searchengine installation and configuration using Ansible ========================================================= -The ansible playbook :omero_search_engine:`management-searchengine.yml ` has been developed to deploy the apps: +Idr team has developed installation playbooks that can be downloaded, customized and used to install the searchengine. -* It contains two groups of tasks each saved in a separate file -* The first file (`deploy_elasticsearch_cluster.yml `) will create the required folders and configure and run the Elasticsearch cluster -* the second one, (`deploy_searchengine.yml `) will configure and run the searchengine app -* There is a variables file :omero_search_engine:`searchengine_vars.yml ` that the user needs to edit before running the playbook. +* The first playbook [deploy_elasticsearch_cluster.yml](https://github.com/IDR/deployment/blob/master/ansible/idr-elasticsearch.yml) will create the required folders and configure and run the Elasticsearch cluster +* The second one, [deploy_searchengine.yml](https://github.com/IDR/deployment/blob/master/ansible/idr-searchengine.yml) will configure and run the searchengine app +* There is a variables file [searchengine_vars.yml](https://https://github.com/IDR/deployment/blob/master/ansible/group_vars/searchengine-hosts.yml) that the user needs to edit before running the playbook. The variable names are self-explanatory and should be customized to the host machine * To check that the apps have been installed and run, the user can use ``wget`` or ``curl`` to call: * for searchengine, http://127.0.0.1:5577/api/v1/resources/ * for Elasticsearch, http://127.0.0.1:9201 -* After deploying the apps, the user needs to run the :omero_search_engine:`run_searchengine_index_services.yml ` playbook for indexing: +* After deploying the apps, the user needs to run the [run_searchengine_index_services.yml](https://github.com/IDR/deployment/blob/master/ansible/run_searchengine_index_service.yml) playbook for indexing: * If the PostgreSQL database server is located on the same machine which hosts the searchengine, the user needs to: * Edit ``pg_hba.conf`` file (one of the postgresql configuration files) and add the client IP (i.e. 10.11.0.11) * Reload the configuration, so the PostgreSQL accepts the connection from indexing and caching services. + * As the caching and indexing processes take a long time, there are another two playbooks that enable the user to check if they have finished or not: - * :omero_search_engine:`check_indexing_service.yml ` + * [check_indexing_service.yml](https://github.com/IDR/deployment/blob/master/ansible/check_indexing_service.yml)