From 2ca629f71042497fec39b9a49fe521cdda26ddd4 Mon Sep 17 00:00:00 2001 From: Ryan Crichton Date: Wed, 1 Nov 2023 09:45:10 +0000 Subject: [PATCH] GITBOOK-44: change request with no subject merged in GitBook --- documentation/README (1).md | 17 +++++++++++------ documentation/README.md | 14 +++++++++++--- documentation/SUMMARY.md | 3 ++- documentation/community.md | 5 +++++ documentation/development.md | 2 +- documentation/packages/README.md | 2 +- .../provisioning-up-remote-servers/README.md | 12 +++++++----- 7 files changed, 38 insertions(+), 17 deletions(-) create mode 100644 documentation/community.md diff --git a/documentation/README (1).md b/documentation/README (1).md index 09fb4db4..42df9367 100644 --- a/documentation/README (1).md +++ b/documentation/README (1).md @@ -1,5 +1,5 @@ --- -description: What you need to start using Platform. +description: What you need to start using OpenHIM Platform. --- # Getting Started @@ -19,9 +19,14 @@ The following tools are needed to run/deploy platform: 1. Once Docker is installed initialise Docker Swarm: `docker swarm init` 2. Download the [Instant OpenHIE 2 binary](https://jembi.gitbook.io/instant-v2/getting-started). Once you are able to execute the instant executable, return here. -3. Create the logging directory using `mkdir -p /tmp/logs/` -4. Download the latest Jembi Platform config file which configures Instant OpenHIE 2 to use Jembi Platform packages: `wget https://raw.githubusercontent.com/jembi/platform/main/config.yaml` -5. Download the latest environment variable file, which sets configuration options for Jembi Platform packages: `wget https://raw.githubusercontent.com/jembi/platform/main/.env.local` -6. Launch some Jembi Platform packages, e.g. `./instant package init --name interoperability-layer-openhim --name message-bus-kafka --env-file .env.local --dev` This launches the OpenHIM and Kafka packages in dev mode (which exposes service ports for development purposes) using the config supplied in the env var file. +3. Go to the OpenHIM Platform [https://github.com/jembi/platform/releases/latest](https://github.com/jembi/platform/releases/latest) page and use the `` for the following steps. +4. Download the latest OpenHIM Platform config file which configures Instant OpenHIE v2 to use openHIM Platform packages: `wget https://raw.githubusercontent.com/jembi/platform//config.yaml` -Next, you might want to browse the packages available in Jembi Platform. Each package's documentation lists the variables used to configure them. For more information on how to start stop and destroy packages using the command line, see the [Instant OpenHIE 2 CLI docs](https://jembi.gitbook.io/instant-v2/cli). +{% hint style="info" %} + e.g. `wget https://raw.githubusercontent.com/jembi/platform/2.3.0/config.yaml` +{% endhint %} + +5. Download the latest environment variable file, which sets configuration options for OpenHIM Platform packages: `wget https://raw.githubusercontent.com/jembi/platform//.env.local` +6. Launch some OpenHIM Platform packages, e.g. `./instant package init --name interoperability-layer-openhim --name message-bus-kafka --env-file .env.local --dev` This launches the OpenHIM and Kafka packages in dev mode (which exposes service ports for development purposes) using the config supplied in the env var file. + +Next, you might want to browse the packages available in OpenHIM Platform. Each package's documentation lists the variables used to configure them. For more information on how to start stop and destroy packages using the command line, see the [Instant OpenHIE 2 CLI docs](https://jembi.gitbook.io/instant-v2/cli). diff --git a/documentation/README.md b/documentation/README.md index f98338f8..a75ac2a4 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,5 +1,5 @@ --- -description: What is the Jembi Platform and what can you use it for? +description: What is the OpenHIM Platform and what can you use it for? cover: >- https://images.unsplash.com/photo-1639815189096-f75717eaecfe?crop=entropy&cs=srgb&fm=jpg&ixid=M3wxOTcwMjR8MHwxfHNlYXJjaHwzfHxjb25uZWN0aW5nJTIwYmxvY2tzJTIwZGlnaXRhbHxlbnwwfHx8fDE2OTg4MzAyNjl8MA&ixlib=rb-4.0.3&q=85 coverY: 0 @@ -8,12 +8,16 @@ layout: landing # OpenHIM Platform -Jembi platform is an easy was to setup, manage and operate a Health Information Exchange (HIE). Specifically it is the following: +OpenHIM platform is an easy was to setup, manage and operate a Health Information Exchange (HIE). Specifically it is the following: * A toolbox of open-source tools, grouped into packages, that are used to in an HIE. * The glue that ties these tools together. These are often in the form of OpenHIM mediators which are just microservices that talk to the OpenHIM. * A CLI tool to deploy and manage these packages. +{% content-ref url="README (1).md" %} +[README (1).md]() +{% endcontent-ref %} + ### The Problem We at Jembi want to stop rebuilding solutions from near scratch each time we need an HIE implementation. It would beneficial to us and other doing the same work to focus more on the unique needs of a country rather than the intricacies of a production deployment of an HIE. @@ -32,10 +36,14 @@ Operating production-grade HIE systems is hard, because of these issues: ### The Solution -Jembi Platform provides an opinionated way to to deploy, secure and scale highly-available services for an HIE environment. It provides a set of services to solve common HIE challenges: +OpenHIM Platform provides an opinionated way to to deploy, secure and scale highly-available services for an HIE environment. It provides a set of services to solve common HIE challenges: * Patient matching * FHIR support * Reporting services * Extensible for country needs * Deploying/Operating/Managing HIE services + +{% hint style="info" %} +OpenHIM Platform is powered by the [Instant OpenHIE deployment tool](https://jembi.gitbook.io/instant-v2/). +{% endhint %} diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md index b25bf08b..5ab5d3bc 100644 --- a/documentation/SUMMARY.md +++ b/documentation/SUMMARY.md @@ -49,7 +49,7 @@ * [Local Development](packages/reverse-proxy-nginx/local-development.md) * [Environment Variables](packages/reverse-proxy-nginx/environment-variables.md) * [Development](development.md) -* [Provisioning up remote servers](provisioning-up-remote-servers/README.md) +* [Provisioning remote servers](provisioning-up-remote-servers/README.md) * [Ansible](provisioning-up-remote-servers/ansible.md) * [Terraform](provisioning-up-remote-servers/terraform.md) * [Config Importing](config-importing.md) @@ -58,3 +58,4 @@ * [Elasticsearch](disaster-recovery-process/elasticsearch.md) * [HAPI FHIR Data](disaster-recovery-process/hapi-fhir-data.md) * [OpenHIM Data](disaster-recovery-process/openhim-data.md) +* [Community](community.md) diff --git a/documentation/community.md b/documentation/community.md new file mode 100644 index 00000000..87d2e102 --- /dev/null +++ b/documentation/community.md @@ -0,0 +1,5 @@ +# Community + +We encourage any contributions and suggestions! If you would like to get involved, please visit us on [Github](https://github.com/jembi/platform/). Feel free to submit an issue or to create a PR to see your features included in the project. + +We look forward to growing the set of capabilities within OpenHIM Platofrm together! diff --git a/documentation/development.md b/documentation/development.md index f0a9a80d..2602744e 100644 --- a/documentation/development.md +++ b/documentation/development.md @@ -3,6 +3,6 @@ ## Adding Packages * The Go Cli runs all services from the `jembi/platform` docker image. When adding new packages or updating existing packages to Platform you will need to build/update your local `jembi/platform` image. [How to build the image](). -* As you add new packages to the platform remember to list them in the `config.yml` file - otherwise the added package will not be detected by the [platform-cli tool](http://localhost:5000/o/lTiMw1wKTVQEjepxV4ou/s/TwrbQZir3ZdvejunAFia/). +* As you add new packages to the platform remember to list them in the `config.yml` file - otherwise the added package will not be detected by the [platform-cli tool](http://127.0.0.1:5000/o/lTiMw1wKTVQEjepxV4ou/s/TwrbQZir3ZdvejunAFia/). ## diff --git a/documentation/packages/README.md b/documentation/packages/README.md index 94c5dfaf..284e919b 100644 --- a/documentation/packages/README.md +++ b/documentation/packages/README.md @@ -1,6 +1,6 @@ --- description: >- - The Jembi Platform includes a number of base packages which are useful for + The OpenHIM Platform includes a number of base packages which are useful for supporting Health Information Exchanges Workflows. Each section below describes the details of these packages. --- diff --git a/documentation/provisioning-up-remote-servers/README.md b/documentation/provisioning-up-remote-servers/README.md index 51e9d9b5..0732f007 100644 --- a/documentation/provisioning-up-remote-servers/README.md +++ b/documentation/provisioning-up-remote-servers/README.md @@ -1,12 +1,14 @@ --- -description: A package for deployment tools. +description: Infrastructure tools for the OpenHIM Platform --- -# Provisioning up remote servers +# Provisioning remote servers -This package contains two folders: ansible and terraform. +As part of the OpenHIM Platform Github repository we also provide scripts to easily setup new servers. The Terraform script are able to instanciate server in AWS and the Ansible script are able to configure those server to be ready to accept OpenHIM Platform packages. -## Ansible +## Ansible + +See [here](https://github.com/jembi/platform/tree/main/infrastructure/ansible). It is used for: @@ -19,4 +21,4 @@ In the inventories, there is different environment configuration (development, p ## Terraform -It is used to create and set AWS servers. +Is used to create and set AWS servers. See [here](https://github.com/jembi/platform/tree/main/infrastructure/terraform).