Skip to content

Latest commit

 

History

History
94 lines (55 loc) · 5.02 KB

README.md

File metadata and controls

94 lines (55 loc) · 5.02 KB
Raw

Nictiz-Snowstorm

Modified docker-compose for deploying snowstorm and elasticsearch containers. This has been tested on OSX and Linux - Docker on Windows requires small adjustments.

Running snowstorm and elasticsearch from scratch

This will automatically pull the snowstorm container from the IHTSDO GitHub repository.

*[IMPORTANT] Requirements: 
docker machine with >=4GB memory
this docker-compose file will create a folder ./elastic containing the indices for elasticsearch. This folder contains the entire elasticsearch database and can be backed up or reused.

In the project root, run docker-compose

docker-compose up snowstorm

Snowstorm ingest

The snowstorm ingest image will take several command line options to quickly add or update codesystems in snowstorm. For testing purposes and example only! This script has not been thoroughly tested, and does not contain any error handling or safety measures. Remember to start your snowstorm service with read only disabled! [edit in ./docker-compose.yml]

*[IMPORTANT] Requirements: 
docker machine with >=4GB memory

  1. Download all release files you want to use in this folder (./ingest).

  2. cd into the ingest folder ./ingest

  3. You can either use the prebuilt docker image available on the docker repository, or build your own if you want to modify it in any way.

    A) Use the prebuilt image nictiz/snowstorm-ingest:latest Continue to step 4.

    B) Build your own from source:

    In ./ingest, execute:

     docker build -f Dockerfile-ingest -t nictiz/snowstorm-ingest .

    Continue to step 4.

  4. Run the docker container in one of two ways:

    A) Specify the specific release filename and codebase, or;

    B) Import all release files in the ./ingest folder

    For A, continue to step 5. For B, continue to step 6.

  5. Import a single specific release

    docker run --rm -it --network snowstorm_network --mount src=$(pwd),target=/releases/,type=bind nictiz/snowstorm-ingest http://snow:8080 [IMPORT-TYPE] "[FILENAME]" [CODEBASE] [SHORTNAME]

    This will import the specified .zip release file in the ./ingest folder to snowstorm/elasticsearch in the specified codebase. This tool has been developed to provide a way to quickly launch an up-to-date snowstorm server. If you wish to use the versioning options of snowstorm, feel free to use this script as an example for your usecase.

    Replace:
[http://snow:8080] -> your server, ONLY if not running local from the provided docker-compose
[IMPORT-TYPE] -> SNAPSHOT / DELTA / FULL
[FILENAME] -> Release filename .zip
[CODEBASE] -> CODEBASE for your import, ie. MAIN
[SHORTNAME] -> SHORTNAME for your codebase, ie. SNOMEDCT
* For more in-depth explanation of each option, we would like to refer you to the IHTSDO snowstorm GitHub documentation.

  6. Import all files in the folder

    *[IMPORTANT] As extensions should be loaded after the full (inter)national edition, it is recommended to first import the edition using the method described in step 5, after which all remaining extensions can be imported using this method.

    .

    docker run --rm -it --network snowstorm_network --mount src=$(pwd),target=/releases/,type=bind nictiz/snowstorm-ingest http://snow:8080 [IMPORT-TYPE]

    This will import all .zip release files in the ./ingest folder to snowstorm/elasticsearch in the same codebase. This tool has been developed to provide a way to quickly launch an up-to-date snowstorm server, if you wish to use the codebase and versioning options of snowstorm, feel free to use this script as an example for your usecase.

    Replace:
[http://snow:8080] -> your server, ONLY if not running local from the provided docker-compose
[IMPORT-TYPE] -> SNAPSHOT / DELTA / FULL
* For a more in-depth explanation of each option, we would like to refer you to the IHTSDO snowstorm GitHub documentation.

  7. After completing the import process

    Do not forget to restart the server using a read-only configuration. [edit in ./docker-compose.yml]

Appendix A)

To import the Dutch Edition and GMDN/Patient Friendly releases to a fresh database when running from the provided docker-compose file, download the releases to the ./ingest folder, after which the following commands should be sufficient: (as of 7-2019)

From ./ingest, run:

docker run --rm -it --network snowstorm_network --mount src=$(pwd),target=/releases/,type=bind nictiz/snowstorm-ingest http://snow:8080 SNAPSHOT "SnomedCT_Netherlands_EditionRelease_PRODUCTION_20190331T120000Z.zip" MAIN SNOMEDCT

docker run --rm -it --network snowstorm_network --mount src=$(pwd),target=/releases/,type=bind nictiz/snowstorm-ingest http://snow:8080 SNAPSHOT "SnomedCT_GMDNMapRelease_Production_20190331T120000Z.zip" MAIN SNOMEDCT

docker run --rm -it --network snowstorm_network --mount src=$(pwd),target=/releases/,type=bind nictiz/snowstorm-ingest http://snow:8080 SNAPSHOT "SnomedCT_Netherlands_PatientFriendlyExtensionRelease_PRODUCTION_20190331T120000Z.zip" MAIN SNOMEDCT