docker dev env files moved from DRLS-Docker repo

.dockerignore

@@ -0,0 +1,5 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file
+# Put files here that you don't want copied into your bundle's invocation image
+.gitignore
+Dockerfile.tmpl
+.docker-sync/

.env

@@ -0,0 +1,2 @@
+VSAC_API_KEY=#Replace_me_with_your_api_key
+COMPOSE_PROJECT_NAME=rems_dev

.gitignore

@@ -0,0 +1,3 @@
+.cnab/
+.docker-sync/
+Zscaler_Root_CA.pem

DockerDevSetupGuideForMacOS.md

@@ -0,0 +1,295 @@
+# DRLS-REMS-Docker-The Ultimate Guide to Running DRLS REMS for Local Development
+Repository to host root docker bundle config files for local development and publishing 
+
+
+## Purpose of this guide
+
+This document details the installation process for the dockerized version of the **Documentation Requirements Lookup Service (DRLS) REMS Workflow** system for Local Development, complete with file synchronization and server reloading. To achieve this functionality, this guide takes advantage of the docker-sync tool. Be aware that each component of DRLS has its own README where you will find more detailed documentation. This document **is not designed to replace those individual READMEs**. 
+
+This document **is designed to take you through the entire set up process for DRLS using docker containers**. It is a standalone guide that does not depend on any supplementary DRLS documentation.
+
+This guide will take you through the development environment setup for each of the following DRLS components:
+1. [Coverage Requirements Discovery (CRD)](https://github.com/mcode/CRD)
+2. [(Test) EHR FHIR Service](https://github.com/HL7-DaVinci/test-ehr)
+3. [Documents, Templates, and Rules (DTR) SMART on FHIR app](https://github.com/mcode/dtr)
+4. [Clinical Decision Support (CDS) Library](https://github.com/mcode/CDS-Library)
+5. [CRD Request Generator](https://github.com/mcode/crd-request-generator)
+6. [REMS](https://github.com/mcode/REMS.git)
+7. Keycloak
+
+## Table of Contents
+- [Prerequisites](#prerequisites)
+- [Install core tools](#install-core-tools)
+    * [Installing core tools on MacOS](#installing-core-tools-on-macos)
+        + [Install Docker Desktop for Mac](#install-docker-desktop-for-mac)
+        + [Install Ruby](#install-ruby)
+        + [Install Docker-sync](#install-docker-sync)
+- [Clone DRLS REMS](#clone-drls-rems)
+- [Configure DRLS REMS](#configure-drls-rems)
+    * [CRD configs](#crd-configs)
+    * [test-ehr configs](#test-ehr-configs)
+    * [crd-request-generator configs](#crd-request-generator-configs)
+    * [dtr configs](#dtr-configs)
+    * [rems configs](#rems-configs)
+
+    * [Add VSAC credentials to your development environment](#add-vsac-credentials-to-your-development-environment)
+- [Run DRLS REMS](#run-drls)
+    * [Start Docker Sync](#start-docker-sync-application)
+    * [Stop Docker Sync](#stop-docker-sync-application-and-remove-all-containers/volumes)
+    * [Useful Docker Sync Commands](#useful-docker-sync-commands)
+- [Verify DRLS is working](#verify-drls-is-working)
+
+
+## Prerequisites
+
+Your computer must have these minimum requirements:
+- Running MacOS
+
+    > The docker synchronization strategy used by docker-sync in this guide is designed for MacOs use. The same configuration will likely not work on Windows as the synchronization strategy used by docker-sync on windows can not handle more than 30 sync files at a time. Reference documentaion: https://docker-sync.readthedocs.io/en/latest/advanced/sync-strategies.html#
+
+- x86_64 (64-bit) or equivalent processor
+    * Follow these instructions to verify your machine's compliance: https://www.macobserver.com/tips/how-to/mac-32-bit-64-bit/ 
+- At least 8 GB of RAM
+- At least 256 GB of storage
+- Internet access
+- [Chrome browser](https://www.google.com/chrome/)
+- [Git installed](https://www.atlassian.com/git/tutorials/install-git)
+
+Additionally, you must have credentials (api key) access for the **[Value Set Authority Center (VSAC)](https://vsac.nlm.nih.gov/)**. Later on you will add these credentials to your development environment, as they are required for allowing DRLS to pull down updates to value sets that are housed in VSAC. If you don't already have VSAC credentials, you should [create them using UMLS](https://www.nlm.nih.gov/research/umls/index.html).
+
+## Install core tools
+
+### Installing core tools on MacOS
+
+#### Install Docker Desktop for Mac
+
+1. Download the **stable** version of **[Docker for Mac](https://www.docker.com/products/docker-desktop)** and follow the steps in the installer.
+2. Once the installation is complete, you should see a Docker icon on your Mac's menu bar (top of the screen). Click the icon and verify that **Docker Desktop is running.**
+3. Configure Docker to have access to enough resources. To do this, open Docker Desktop and select Settings > Resources. 
+
+    The defaults for memory at 2GB and possibly CPU as well are too low to run the entire DRLS REMS workflow. If not enough resources are provided, you may notice containers unexpectedly crashing and stopping. Exact requirements for these resource values will depend on your machine. That said, as a baseline starting point, the system runs relatively smoothly at 15GB memory and 7 CPU Processors on MITRE issued Mac Devices.
+
+#### Install Ruby 
+Note: The default ruby that comes with Mac may not install the right package version for docker-sync, it is reccomended to install ruby with a package manager, this guide uses rbenv. 
+
+Reference: https://github.com/rbenv/rbenv
+
+1. Install rbenv
+  ```bash
+        brew install rbenv
+  ```
+
+2. Initialize rbenv and follow instructions (setting system path troubleshooting: https://stackoverflow.com/questions/10940736/rbenv-not-changing-ruby-version)
+  ```bash
+        rbenv init
+   ```
+3. Close Terminal so changes take affect
+4. Test rbenv is installed correctly 
+  ```bash
+        curl -fsSL https://github.com/rbenv/rbenv-installer/raw/main/bin/rbenv-doctor | bash    
+  ```
+5. Install Ruby 
+  ```bash
+        rbenv install 2.7.2 
+   ```
+6. Verify that the system is using the correct ruby verions 
+  ```bash
+        which ruby   
+        /Users/$USER/.rbenv/shims/ruby # Correct
+
+        ....
+
+        which ruby 
+        /usr/bin/ruby # Incorrect, using system default ruby. Path not set correctly, reference step 2
+   ```
+
+
+
+
+#### Install Docker-sync 
+
+1. Download and Install docker-sync using the following command:
+    ```bash
+        gem install docker-sync -v 0.7.0
+    ```
+2. Test that the right version is installed 
+    ```bash
+        docker-sync -v
+        0.7.0  # Correct 
+
+        ...
+
+        docker-sync -v
+        0.1.1  # Incorrect, make sure you have ruby installed and are not using the default system ruby 
+    ```
+
+    Note: The versioning is important, system default ruby sometimes installs version 0.1.1 if -v tag is not set. The 0.1.1 release will not work for the rest of this guide.
+
+## Clone DRLS REMS
+
+1. Create a root directory for the DRLS development work (we will call this `<drlsroot>` for the remainder of this setup guide). While this step is not required, having a common root for the DRLS components will make things a lot easier down the line. 
+    ```bash
+    mkdir <drlsroot>
+    ```
+
+    `<drlsroot>` will be the base directory into which all the other components will be installed. For example, CRD will be cloned to `<drlsroot>/crd`.
+
+    Note: If you are using a different project structure from the above description, you will need to change the corresponding repo paths in docker-compose-prior-auth-dev.yml, docker-sync.yml, and docker-compose.yml
+
+2. Now clone the DRLS component repositories from Github:
+    ```bash
+    cd <drlsroot>
+    git clone https://github.com/mcode/CRD.git CRD
+    git clone https://github.com/mcode/test-ehr.git test-ehr
+    git clone https://github.com/mcode/crd-request-generator.git crd-request-generator
+    git clone https://github.com/mcode/dtr.git dtr
+    git clone https://github.com/mcode/REMS.git REMS
+
+    cd CRD/server
+    git clone https://github.com/mcode/CDS-Library.git CDS-Library
+    ```
+
+## Configure DRLS REMS
+
+### CRD configs
+
+1. `cd <drlsroot>/crd/server/src/main/resources`
+2. Edit `application.yml` to include:
+    ```yaml
+    spring:
+        profiles:
+        active: localDb
+
+    localDb:
+        path: CDS-Library/CRD-DTR/ 
+    ```
+
+### test-ehr configs
+
+1. `cd <drlsroot>/test-ehr/src/main/resources`
+2. Edit `fhirServer.docker-dev.properties` to include:
+    ```bash
+    client_id = app-token
+    client_secret= #replaceMeWithYourClientSecret
+    realm=ClientFhirServer
+    use_oauth = false
+    oauth_token = http://host.docker.internal:8180/auth/realms/ClientFhirServer/protocol/openid-connect/token
+    oauth_authorize =  http://localhost:8180/auth/realms/ClientFhirServer/protocol/openid-connect/auth
+    auth_redirect_host = localhost 
+    ```
+
+### crd-request-generator configs
+
+1. `cd <drlsroot>/crd-request-generator/src`
+2. Edit `properties.json` to look like this:
+    ```json
+    {
+        "realm": "ClientFhirServer",
+        "client": "app-login",
+        "auth": "http://localhost:8180/auth",
+        "server": "http://localhost:8090",
+        "ehr_server": "http://localhost:8080/test-ehr/r4",
+        "ehr_base": "http://localhost:8080/test-ehr/r4",
+        "cds_service": "http://localhost:8090/r4/cds-services",
+        "order_sign": "order-sign-crd",
+        "order_select": "order-select-crd",
+        "user": "alice",
+        "password": "alice",
+        "public_keys": "http://localhost:3001/public_keys"
+    }
+    ```
+
+### dtr configs
+
+***None***
+
+### REMS configs
+
+***None***
+
+
+### Add VSAC credentials to your development environment
+
+> At this point, you should have credentials to access VSAC. If not, please refer to [Prerequisites](#prerequisites) for how to create these credentials and return here after you have confirmed you can access VSAC.
+> To download the full ValueSets, your VSAC account will need to be added to the CMS-DRLS author group on https://vsac.nlm.nih.gov/. You will need to request membership access from an admin. If this is not configured, you will get `org.hl7.davinci.endpoint.vsac.errors.VSACValueSetNotFoundException: ValueSet 2.16.840.1.113762.1.4.1219.62 Not Found` errors.
+
+> While this step is optional, we **highly recommend** that you do it so that DRLS will have the ability to dynamically load value sets from VSAC. 
+
+You can see a list of your pre-existing environment variables on your Mac by running `env` in your Terminal. To add to `env`:
+1. Set "VSAC_API_KEY" in the .env file in the REMS Repository (if following option 1) 
+2. `cd ~/`
+3. Open `.bash_profile` and add the following lines at the very bottom:
+    ```bash
+    export VSAC_API_KEY=vsac_api_key
+    ```
+4. Save `.bash_profile` and complete the update to `env`: 
+    ```bash
+    source .bash_profile
+    ```
+
+> Be aware that if you have chosen to skip this step, you will be required to manually provide your VSAC credentials at http://localhost:8090/data and hit **Reload Data** every time you want DRLS to use new or updated value sets.
+
+### Add Compose Project Name 
+
+You can see a list of your pre-existing environment variables on your Mac by running `env` in your Terminal. To add to `env`:
+1. Set "COMPOSE_PROJECT_NAME" as "rems_dev" in the .env file in the REMS Repository 
+2. `cd ~/`
+3. Open `.bash_profile` and add the following lines at the very bottom:
+    ```bash
+    export COMPOSE_PROJECT_NAME=rems_dev
+    ```
+4. Save `.bash_profile` and complete the update to `env`: 
+    ```bash
+    source .bash_profile
+    ```
+
+
+
+## Run DRLS
+
+### Start docker-sync application 
+Note: Initial set up will take several minutes and spin up fans with high resource use, be patient, future boots will be much quicker, quieter, and less resource intensive 
+
+```bash
+    docker-sync-stack start # This is the equivalent of running docker-sync start followed by docker-compose up
+```
+
+### Stop docker-sync application and remove all containers/volumes
+```bash
+    docker-sync-stack clean # This is the equivalent of running docker-sync clean followed by docker-compose down
+    docker volume prune
+```
+
+### Useful docker-sync commands
+Reference: https://docker-sync.readthedocs.io/en/latest/getting-started/commands.html
+
+## Verify DRLS is working
+
+### Register the test-ehr
+
+1. Go to http://localhost:3005/register.
+    - Client Id: **app-login**
+    - Fhir Server (iss): **http://localhost:8080/test-ehr/r4**
+2. Click **Submit**
+
+### The fun part: Generate a test request
+
+1. Go to http://localhost:3000/ehr-server/reqgen.
+2. Click **Patient Select** button in upper left.
+3. Find **William Oster** in the list of patients and click the dropdown menu next to his name.
+4. Select **E0470** in the dropdown menu.
+5. Click anywhere in the row for William Oster.
+6. Click **Submit** at the bottom of the page.
+7. After several seconds you should receive a response in the form of two **CDS cards**:
+    - **Respiratory Assist Device**
+    - **Positive Airway Pressure Device**
+8. Select **Order Form** on one of those CDS cards.
+9. If you are asked for login credentials, use **alice** for username and **alice** for password.
+10. A webpage should open in a new tab, and after a few seconds, a questionnaire should appear.
+11. Fill out questionnaire and hit next
+12. Submit REMS Request to http://localhost:9015/fhir
+
+Congratulations! DRLS is fully installed and ready for you to use!
+
+## Troubleshooting docker-sync
+Reference: https://docker-sync.readthedocs.io/en/latest/troubleshooting/sync-stopping.html