Moved the readme.md from this pr to seperate markdown file

KevinMayfield · KevinMayfield · commit 45120d0a2f5a · 2024-03-15T14:50:41.000Z
diff --git a/interoperability-standards-tools-skunkworks b/interoperability-standards-tools-skunkworks
@@ -1 +1 @@
-Subproject commit 14adf87e737aade3004b1826b72346d1d7ba2f49
+Subproject commit 01f8c0dc8da892b3cc9d4a6a9ea966089addaa18
diff --git a/readme.md b/readme.md
@@ -18,6 +18,7 @@ c. Optionally validate using the NHS England Ontology Service (configured via en
 
 The configuration is aimed at supporting different use cases. For example the lambda version with no ontology support is aimed at performing basic FHIR validation checks. This may just be FHIR core and schema validation but can also test against UKCore profiles.
 
+
 ## Docker Image 
 
 **Experimental** 
@@ -104,84 +105,3 @@ https://cnuc9zdola.execute-api.eu-west-2.amazonaws.com/dev
 
 
 
-## Variables
-
-FHIR packages: [manifest.json](https://github.com/NHSDigital/IOPS-FHIR-Validation-Service/blob/main/src/main/resources/manifest.json)
-HAPI Update: [pom.xml](https://github.com/NHSDigital/IOPS-FHIR-Validation-Service/blob/main/pom.xml)
-
-# Custom Checks
-Cusom error messages can be found within  [/src/main/kotlin/uk/nhs/england/fhirvalidator/provider/ValidateR4Provider.kt](https://github.com/NHSDigital/IOPS-FHIR-Validation-Service/blob/update/6.8.3/src/main/kotlin/uk/nhs/england/fhirvalidator/provider/ValidateR4Provider.kt)
-# Validator Update Guide
-
-## Prerequisites
-
-Installation of the following on a local machine
-
-- [Maven](https://maven.apache.org/) 
-  - Installation (Debian): [How to Install Apache Maven on Debian 11](https://www.itzgeek.com/how-tos/linux/debian/how-to-install-apache-maven-on-debian-11.html)
-
-- [Docker](https://www.docker.com/) 
-  - Installation (Debian): [Install Docker Engine](https://docs.docker.com/engine/install/)  
-*Note:*If the os is a fork from Debian, e.g. LMDE, replace $(. /etc/os-release && echo “$VERSION_CODENAME”) with $(echo <Debian- version-codename>)
-Where <Debian-version-codename> e.g. bookworm (lowercase) for Debian.
-
-- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
-- [AWS Toolkit (optional)](https://aws.amazon.com/search/?searchQuery=toolkit)
-
-- HAPI-FHIR
-  - The latest release of hapi-fhir can be found at [github.com/hapifhir/hapi-fhir](https://github.com/hapifhir/hapi-fhir) 
-  - The changelog can be found at [hapifhir.io/hapi-fhir/docs/introduction/changelog](https://hapifhir.io/hapi-fhir/docs/introduction/changelog.html) 
-
-## Update AWS Server
-
-- Go to https://github.com/NHSDigital/IOPS-FHIR-Validation-Service repo
-- Create a new branch named update/<hapi-fhir version-number>
-- edit pom.xml
-  - Set the <fhir.version> to the relevant hapi-fhir version
-  - Set the <version> to the same hapi-fhir version.
-
-- Within the validator folder run the following:
-  - $ mvn clean install
-  - $ docker build -t fhir-validator-r4 .
-  - $ docker tag fhir-validator-r4:latest <account id>.dkr.ecr.eu-west-2.amazonaws.com/fhir-validator-r4:<hapi-fhir version-number>
-  - $ docker tag fhir-validator-r4:latest <account id>.dkr.ecr.eu-west-2.amazonaws.com/fhir-validator-r4:latest
-
-- Login in to the AWS website
-- Click ‘Command line or programmatic access’ within NHS Digital IOPS FHIR dev
-- Sign into AWS using either:
-  - Copy option 1 if using bash / windows / powershell
-  - Copy Option 2 into credentials.txt if you have aws toolkit installed
-
-- run
-  - $ aws get-login-password –region eu-west-2 | docker login –username AWS –password stdin <account id>.dkr.ecr.eu-west-2.amazonaws.com
-  - $ docker push <account id>.dkr.ecr.eu-west-2.amazonaws.com/fhir-validator-r4:[hapi-fhir version-number]
-
-- In AWS go to ‘Management console’
-  - Search for ECR 
-  - Ensure the server is set to ‘eu-west-2’
-  - On the LHS choose repositories
-  - Within Private repositories choose ‘fhir-validator-r4’
-  - Ensure the latest image is the recently uploaded version.
-
-  - Search for ECS 
-  - Go to ‘Task definitions’ (on LHS)
-  - Choose ‘iops-fhir-validation-service’
-  - Choose latest revision
-  - Choose ‘Create new revision’
-  - Go to ‘Container-1’ section
-  - Update the version number within the Image URI
-  - Click ‘Create’
-
-  - Go to Clusters (on LHS)
-  - Choose ‘iops-fhir-r4’
-  - Choose ‘svc-fhir-validator’
-  - Click ‘Update service’
-  - Change ‘Revision’ to the latest version
-  - Click ‘Update’
-This will start the checks. Logs can be found within CloudWatch. ECS is set up for 1 task only so the previous task will shut down automatically.
-
-## Create PR with new update
-Once the validator update has been checked to ensure no issues with the build create a GitHub PR and get it approved. Once approved create a new release and detail the changes made.
-
-# Run Validator instance on local machine
-$ mvn spring-boot:run
diff --git a/updating-validator.md b/updating-validator.md
@@ -0,0 +1,74 @@
+# Validator Update Guide
+
+## Prerequisites
+
+Installation of the following on a local machine
+
+- [Maven](https://maven.apache.org/)
+    - Installation (Debian): [How to Install Apache Maven on Debian 11](https://www.itzgeek.com/how-tos/linux/debian/how-to-install-apache-maven-on-debian-11.html)
+
+- [Docker](https://www.docker.com/)
+    - Installation (Debian): [Install Docker Engine](https://docs.docker.com/engine/install/)  
+      *Note:*If the os is a fork from Debian, e.g. LMDE, replace $(. /etc/os-release && echo “$VERSION_CODENAME”) with $(echo <Debian- version-codename>)
+      Where <Debian-version-codename> e.g. bookworm (lowercase) for Debian.
+
+- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
+- [AWS Toolkit (optional)](https://aws.amazon.com/search/?searchQuery=toolkit)
+
+- HAPI-FHIR
+    - The latest release of hapi-fhir can be found at [github.com/hapifhir/hapi-fhir](https://github.com/hapifhir/hapi-fhir)
+    - The changelog can be found at [hapifhir.io/hapi-fhir/docs/introduction/changelog](https://hapifhir.io/hapi-fhir/docs/introduction/changelog.html)
+
+## Update AWS Server
+
+- Go to https://github.com/NHSDigital/IOPS-FHIR-Validation-Service repo
+- Create a new branch named update/<hapi-fhir version-number>
+- edit pom.xml
+    - Set the <fhir.version> to the relevant hapi-fhir version
+    - Set the <version> to the same hapi-fhir version.
+
+- Within the validator folder run the following:
+    - $ mvn clean install
+    - $ docker build -t fhir-validator-r4 .
+    - $ docker tag fhir-validator-r4:latest <account id>.dkr.ecr.eu-west-2.amazonaws.com/fhir-validator-r4:<hapi-fhir version-number>
+    - $ docker tag fhir-validator-r4:latest <account id>.dkr.ecr.eu-west-2.amazonaws.com/fhir-validator-r4:latest
+
+- Login in to the AWS website
+- Click ‘Command line or programmatic access’ within NHS Digital IOPS FHIR dev
+- Sign into AWS using either:
+    - Copy option 1 if using bash / windows / powershell
+    - Copy Option 2 into credentials.txt if you have aws toolkit installed
+
+- run
+    - $ aws get-login-password –region eu-west-2 | docker login –username AWS –password stdin <account id>.dkr.ecr.eu-west-2.amazonaws.com
+    - $ docker push <account id>.dkr.ecr.eu-west-2.amazonaws.com/fhir-validator-r4:[hapi-fhir version-number]
+
+- In AWS go to ‘Management console’
+    - Search for ECR
+    - Ensure the server is set to ‘eu-west-2’
+    - On the LHS choose repositories
+    - Within Private repositories choose ‘fhir-validator-r4’
+    - Ensure the latest image is the recently uploaded version.
+
+    - Search for ECS
+    - Go to ‘Task definitions’ (on LHS)
+    - Choose ‘iops-fhir-validation-service’
+    - Choose latest revision
+    - Choose ‘Create new revision’
+    - Go to ‘Container-1’ section
+    - Update the version number within the Image URI
+    - Click ‘Create’
+
+    - Go to Clusters (on LHS)
+    - Choose ‘iops-fhir-r4’
+    - Choose ‘svc-fhir-validator’
+    - Click ‘Update service’
+    - Change ‘Revision’ to the latest version
+    - Click ‘Update’
+      This will start the checks. Logs can be found within CloudWatch. ECS is set up for 1 task only so the previous task will shut down automatically.
+
+## Create PR with new update
+Once the validator update has been checked to ensure no issues with the build create a GitHub PR and get it approved. Once approved create a new release and detail the changes made.
+
+# Run Validator instance on local machine
+$ mvn spring-boot:run
