APIs generated using LoopBack 4 CLI with the initial project layout.
- Gravitate-Health G-Lens: Medication Information.
This repository contains the configuration and deployment files needed for the "G-Lens: Medication Information" module. This module handles medication information models, following the HL7-FHIR interoperability standard.
This application is generated using LoopBack 4 CLI with the initial project layout.
This readme will help the reader to deploy the system, but also to understand the configuration and be able to edit/expand it.
git clone https://github.com/Gravitate-Health/MedicationInfo.gitcd MedicationInfoBy default, dependencies were installed when this application was generated. Whenever dependencies in package.json are changed, run the following command:
npm installTo only install resolved dependencies in package-lock.json:
npm ciFor the Kubernetes deployment first of all, the module must be compiled into a docker image and uploaded into a registry accessible by the Kubernetes cluster, the MongoDB is pulled from the official docker registry.
git clone https://github.com/Gravitate-Health/MedicationInfo.git
cd MedicationInfo
docker build . -t <docker-registry>/med-information:latest
docker push <docker-registry>/med-information:latestThe name of the image is specified in the medication information module deployment file, 004_med-information-deployment.yaml. In that file you can also specify a registry secret in case the registry is behind authorization. Here is the documentation regarding private registries.
Both the deployment files for the MongoDB and the medication information module contain several environment variables which can be modified. These environment variables are the ones we used, but the configuration allows for much more.
- Mongo environment variables
| Environment Variable | description | default |
|---|---|---|
| MONGO_SIDECAR_POD_LABELS | Labels to be applied to the sidecar container | role=mongo-med-info,name=mongo-med-info |
| KUBE_NAMESPACE | Namespace where the Mongo is deployed | development |
- Medication information module environment variables
| Environment Variable | description | default |
|---|---|---|
| DB_HOST | Database host | mongo-med-info |
| DB_URL | Full database connection URL | mongodb://mongo-med-info:27017/ |
The next step is to apply the Kubernetes files in the cluster, the services will be deployed in the development namespace. In case the namespace has not been created before you can create it with the following commands, or change the name in metadata.namespace:
First we deploy the database:
kubectl create namespace <namespace> # Only if namespace not created and/or the current context
kubectl config set-context --current --namespace=<namespace> # Only if namespace not created and/or the current context
kubectl apply -f YAMLs/001_mongo-service-med-info.yaml
kubectl apply -f YAMLs/002_mongo-stateful-med-info.yamlOnce the database is ready the medication information module can be deployed, you can check if the database is ready by running:
kubectl get pod | grep "mongo-med-info"NAMESPACE NAME READY STATUS RESTARTS AGE
<namespace> mongo-med-info-2 2/2 Running 0 13d
<namespace> mongo-med-info-0 2/2 Running 0 13d
<namespace> mongo-med-info-1 2/2 Running 0 13dIf the status is running proceed with the medication information module deployment:
kubectl apply -f YAMLs/003_med-information-service.yaml
kubectl apply -f YAMLs/004_med-information-deployment.yamlYou can check if the deployment is ready by running:
kubectl get pod | grep "med-info"NAMESPACE NAME READY STATUS RESTARTS AGE
<namespace> med-info-6d97c6956b-k92l2 1/1 Running 0 13dIf the pod is ready you can access the service by other services in the same namespace by using the name of its Kubernetes service and the port (especified in 003_med-information-service.yaml). You can also obtain both by running the following commands:
kubectl get svc | grep "med-info"NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
mongo-med-info ClusterIP 10.152.183.99 <none> 27017/TCP 40dThe type of the service is ClusterIP which means that the service can only be accessed from inside the cluster. Moreover, if the Kubernetes cluster has a DNS manager other services can access services in other namespaces using the following URL: http://<service-name>.<namespace>.svc.cluster.local. To learn more about the types of services and its uses in Kubernetes, here is the official documentation. Alternatively if the Gateway has been deployed, the service will be proxied to the outside of the cluster at https://<DNS>/med-information/.
Inside the directory, run the following command:
npm startOpen http://127.0.0.1:3000 in your browser, preferably Google Chrome, in private or incognito mode.
Some of the most useful enpoints are listed below:
POST request, adds a new object to the G-Lens DB:
https://gravitate-health.lst.tfo.upm.es/med-information/med-informations
GET request, returns the count of the objects stored in the DB:
https://gravitate-health.lst.tfo.upm.es/med-information/med-informations/count
GET request, returns the list of the objects stored in the DB:
https://gravitate-health.lst.tfo.upm.es/med-information/med-informations
PATCH request, updates the object that matches the body of the request:
https://gravitate-health.lst.tfo.upm.es/med-information/med-informations
GET request, returns a single object with ID :
https://gravitate-health.lst.tfo.upm.es/med-information/med-informations/<id>
PATCH request, updates the object with ID :
https://gravitate-health.lst.tfo.upm.es/med-information/med-informations/<id>
PUT request, replaces the object with ID :
https://gravitate-health.lst.tfo.upm.es/med-information/med-informations/<id>
DEL request, deletes the object with ID :
https://gravitate-health.lst.tfo.upm.es/med-information/med-informations/<id>
For further details check the openapi
None are known at this time
In case you find a problem or you need extra help, please use the issues tab to report the issue.
Also you can check the following documentation
Please check out LoopBack 4 documentation to understand how you can continue to add features to this application.
Please check out the FHIR Medication Model, used for the definition of Loopback Models
To contribute, fork this repository and send a pull request with the changes squashed.
This project is distributed under the terms of the Apache License, Version 2.0 (AL2). The license applies to this file and other files in the GitHub repository hosting this file.
Copyright 2022 Universidad Politécnica de Madrid
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- Óscar Ansótegui (@oansotegui)
- Álvaro Belmar (@abelmarm)
-@2x.png){kind=icon}