openhie/instant repository overview

⁠Instant OpenHIE

View the user documentation⁠ for more information.

⁠Getting Started

The services can be deployed using docker-compose or kubernetes.

⁠Docker-compose

Navigate to the main folder to execute the commands.

To set the Instant OpenHIE services run the following command:

yarn
yarn docker:build
yarn docker:instant init -t docker

To tear down the deployments use the opposing command:

yarn docker:instant down -t docker

To start up the services after a tear down, use the following command:

yarn docker:instant up -t docker

To completely remove all project components use the following option:

yarn docker:instant destroy -t docker

Each command also takes a list of package IDs to operate on. If this is left out then all packages are run by default.

E.g only run core package: yarn docker:instant init -t docker core

⁠Kubernetes

A kubernetes deployment can either be to AWS using eksctl⁠ and kubectl⁠ or locally using minikube⁠ and kubectl.

For a quick setup of these environments navigate to the Kubernetes development readme⁠

Navigate to the main folder to execute the commands.

To set the Instant OpenHIE services run the following command:

yarn
yarn docker:build
yarn docker:instant init -t k8s

To tear down the deployments, use the following command:

yarn docker:instant down -t k8s

To start up the services after a tear down, use the following command:

yarn docker:instant up -t k8s

To completely remove all project components, use the following option:

yarn docker:instant destroy -t k8s

Each command also takes a list of package IDs to operate on. If this is left out then all packages are run by default.

E.g only run core package: yarn docker:instant init -t k8s core

⁠Custom packages

To add a custom package to your instant instance use the following flag

-c="/path/to/package"

For example, if you had downloaded the who-covid19-surveillance-package⁠ repository onto your machine you could reference it as follows:

yarn docker:instant init core covid19surveillance -c="../who-covid19-surveillance-package"

⁠Docker or Kubernetes without the Instant OpenHIE repo

The Instant OpenHIE project is available as a Docker image therefore we do not need the whole GitHub repository to run the containers.

For a minimum Instant OpenHIE set up, download this deploy script from GitHub⁠. Once downloaded make sure it's executable: sudo chmod +x deploy.sh

Then, run the following command to add your custom package and initialise the system in docker.

./deploy init -t docker core <your_package_ids> -c="../path/to/your/package"

To remove the instant project, run the following:

./deploy destroy -t docker core covid19surveillance

To initialise kubernetes, run the following:

./deploy init -t k8s core <your_package_ids> -c="../path/to/your/package"

Multiple custom packages can be chained together as follows:

./deploy init test1 test2 test3 -c="../test1" -c="../test2" -c="../test3"

⁠Running tests on running packages

The Cucumber⁠ framework is used for testing the instantiated packages.

For docker instances, update the .env.local file with the instances' host urls and ports, and then run

yarn test

For kubernetes instances, update the .env.remote file with the instances' host urls and ports, and then run

yarn test:remote