SOLR implementation via Docker

Ajit_Londhe · July 9, 2021, 6:43pm

Hello all,

I’ve added instructions for how to set up SOLR using Docker here:

Comment by alondhe - updates for solr based search

OHDSI:master ← OHDSI:vocabulary-performance

# Updated to use SOLR 8.11.1 due to log4j vulnerability # Install SOLR using …Docker ## On Windows/Mac: Download Docker desktop app (https://www.docker.com/products/docker-desktop). ## On Debian/Ubuntu Linux: ``` sudo apt-get install docker ``` ## On RHEL: ``` sudo yum install docker ``` ### Solr core creation 1. Create a directory to store the Dockerfile and configuration files, this directory is known as the docker build context folder. Navigate to it in your command line interface. 2. Create a file named "Dockerfile" in this build context folder and use this as the content: ``` FROM solr:8.11.1 # argument variables to define ARG vocabulary_version ARG jdbc_file_name # copy the solr configset from WebAPI COPY --chown=solr /WebAPI/src/main/resources/solr /var/solr/data/$vocabulary_version # copy your JDBC file COPY --chown=solr $jdbc_file_name /opt/solr-8.11.1/server/lib/$jdbc_file_name ``` 3. Clone the WebAPI Git repo (using your desired commit or release) into the docker build context folder: ``` git clone https://github.com/OHDSI/WebAPI.git ``` 4. Copy your JDBC jar file (for connecting to your vocabulary's database platform) into the build context folder. 5. Next make the following edits to the files in /WebAPI/src/main/resources/solr: - data-config.xml: Edit the data source & references in the query to match the database holding your vocabulary - core.properties: Edit the name to match the vocabulary version (e.g. v5.0_20-MAY-21), remove the "conf\\\\" prefix from config and schema values. - conf\\solrconfig.xml: Edit the connection information in the <requestHandler name="/dataimport" class="solr.DataImportHandler"> block to provide it the details to connect the database holding your vocabulary. - if using Spark, add this to this /dataimport block: ```<str name="autoCommit">true</str>``` ### Build/create/start the docker container 5. Run the container build step, specifying the vocabulary version and the name of the JDBC file needed for connecting to your database platform: ``` docker build --build-arg vocabulary_version=v5.0_20-MAY-21 --build-arg jdbc_file_name=SparkJDBC41.jar --no-cache -t solr . ``` 6. Run the create step, which will then create the container: ``` docker create --restart=always --name=solr -p 8983:8983 -t solr ``` 7. Start the container: ``` docker start solr ``` 8. Test the container has started by going to http://localhost:8983/solr/#/ (substitute the server name for localhost) ### Building the Solr core - From the SOLR Admin screen (http://localhost:8983/solr/#/), build the core by using the 'Core Selector' dropdown in the left-hand menu. Select the vocabulary core from the drop down, and then in the sub-menu that appears, select Dataimport and then used the 'Execute' button. The service will build the core from the concepts per the query in the data-config.xml - Once the execution of the core indexing is complete, you can use the Solr "Query" tool under the core sub-menu to make sure the core is working properly before moving to WebAPI. A sample query you can use is to enter this in the q field: query:metformin **Then, follow the rest of the WebAPI configuration instructions in the Windows instructions above.**

This is useful for sites looking to Dockerize their OHDSI stack.

Thanks,
Ajit