Merge pull request #5 from khaledk2/add_readme

Add readme

Author: khaledk2

README.rst

@@ -0,0 +1,77 @@
+OMERO Searchengine
+==================
+
+[![Actions Status](https://github.com/ome/ansible-role-omero-ms-image-region/workflows/Molecule/badge.svg)](https://github.com/ome/ansible-role-omero-ms-image-region/actions)
+[![Ansible Role](https://img.shields.io/badge/ansible--galaxy-omero_ms_image_region-blue.svg)](https://galaxy.ansible.com/ui/standalone/roles/ome/omero_ms_image_region/)
+
+Installs and configures the OMERO Searchengine.
+
+Dependencies
+------------
+
+OMERO.docker.web is required.
+
+
+Role Variables
+--------------
+
+- `apps_folder'`: The application data folder
+- `database_server_url`: The database URL
+- `database_port`: The database port
+- `database_name`: The database name (e.g., omero)
+- `database_username`: The database username
+- `database_user_password`: The database user password
+- `default_datasource`: The default datasource
+- `search_engineelasticsearch_docker_image`: The Elasticsearch image (default: `docker.elastic.co/elasticsearch/elasticsearch:9.2.1`)
+- `searchengine_docker_image`: The search engine Docker image
+- `automatic_refresh`: Whether the searchengine  should reload configuration when modified (true/false)
+- `searchengine_secret_key`: The search engine secret key
+- `searchengineurlprefix`: The URL prefix for the searchengine (default: searchengine)
+- `elasticsearch_no_nodes`: The number of nodes in the Elasticsearch cluster
+- `elasticsearch_backup_folder`: The Elasticsearch data backup folder
+- `ca_password`:  The CA password for the Elasticsearch certificate
+- `keystore_password`: The keystore password for the Elasticsearch cluster
+- `elastic_password`: The password for the Elasticsearch user
+- `data_dump_folder`:The data dump folder (used for asynchronous search and container BFFs)
+- `nginx_port`: The port Nginx should use
+- `cache_rows`: The number of rows the indexing process can handle at one time
+- `no_index_processes`: The number of parallel processes available for the indexing process
+
+Example Playbook
+----------------
+::
+
+    - name: Deploying search engine
+      connection: local
+      hosts: localhost
+      become: true
+      roles:
+      - role:  omero_searchengine
+        vars:
+         - elastic_password: Jlsp2cZirz6G56&^hdlhkf7
+         - apps_folder: /data
+         - asynchronous_search: true
+         - automatic_refresh: true
+         - cache_rows: 50000
+         - database_name: idr
+         - database_user_password: GDj2PSoCYYwt2BvWvsT3xePW42TocQ8ZaIpfFWIBjCJX
+         - database_port: '5432'
+         - database_server_url: 192.168.10.38
+         - database_username: omeroreadonly
+         - elasticsearch_backup_folder: /searchengine_backup
+         - searchengine_secret_key  : searchengine_secret_key
+         - verify_certs: false
+         - quires_folder: quires/
+         - data_dump_folder: /data/data_dump/
+         - default_datasource: omero
+         - searchengineurlprefix: "searchengine"
+         - ca_password: "ca_password_1234"
+         - keystore_password: "keystore_password_1234"
+         - no_index_processes: 6
+         - elasticsearch_no_nodes: 3
+         - nginx_port: 8080
+
+Author Information
+------------------
+
+ome-devel@lists.openmicroscopy.org.uk

defaults/main.yml

@@ -9,7 +9,6 @@ database_user_password: database_password
 searchenginecache_folder: /data/searchengine/searchengine/cacheddata/
 search_engineelasticsearch_docker_image: docker.elastic.co/elasticsearch/elasticsearch:9.2.1
 searchengine_docker_image: khaledk2/searchengine:new_packages
-# ansible_python_interpreter: path/to/bin/python
 searchengine_index: searchengine_index
 automatic_refresh: true
 cache_rows: 1000