Skip to content

Commit c23124e

Browse files
committed
Updating troubleshooting and images
1 parent 893e1fc commit c23124e

File tree

5 files changed

+76
-57
lines changed

5 files changed

+76
-57
lines changed

content/patterns/medical-diagnosis/_index.adoc

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -94,19 +94,10 @@ The following diagram shows the components that are deployed with the the data f
9494
9595
image::medical-edge/physical-dataflow.png[link="/images/medical-edge/physical-dataflow.png"]
9696
97-
== Recorded demo
98-
99-
link:/videos/xray-deployment.svg[image:/videos/xray-deployment.svg[Demo\]]
100-
10197
== Presentation
10298
10399
View presentation for the Medical Diagnosis Validated Pattern link:https://speakerdeck.com/rhvalidatedpatterns/md-speakerdeck[here]
104100
105-
[id="demo-script"]
106-
== Demo Script
107-
108-
Use this demo script to successfully complete the Medical Diagnosis pattern demo link:demo-script/#demo-intro[here]
109-
110101
[id="next-steps_med-diag-index"]
111102
== Next steps
112103

content/patterns/medical-diagnosis/demo-script.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Verifying the demo Medical diagnosis pattern
2+
title: Verifying the demo
33
weight: 20
44
aliases: /medical-diagnosis/demo/
55
---
@@ -27,23 +27,23 @@ We simulate the function of the remote medical facility with an application call
2727
[id="viewing-the-grafana-based-dashboard-getting-started"]
2828
== Enabling the Grafana based dashboard
2929

30-
The Grafana dashboard is a visual representation of the AI/ML workflow. It provides the CPU and Memory metrics for the pod running the risk assessment application. The dashboard also provides visual representation of the AI/ML workflow from the images being generated at the remote medical facility. Carry out the following steps to view the dashboard:
30+
The Grafana dashboard offers a visual representation of the AI/ML workflow, including CPU and memory metrics for the pod running the risk assessment application. Additionally, it displays a graphical overview of the AI/ML workflow, illustrating the images being generated at the remote medical facility.
3131

32-
This showcase application is deployed using self-signed certificates that are untrusted by our browser. Unless you have provisioned valid certificates for your OpenShift cluster you must accept the invalid certificates for:
32+
This showcase application is deployed with self-signed certificates, which are considered untrusted by most browsers. If valid certificates have not been provisioned for your OpenShift cluster, you will need to manually accept the untrusted certificates by following these steps:
3333

34-
. Accept the SSL certificates on the browser for the dashboard. In the {ocp} web console, go to the Routes for *All Projects*. Click the URL for the `s3-rgw`.
34+
. Accept the SSL certificates on the browser for the dashboard. In the {ocp} web console, go to the *Netwoorking* > *Routes* for *All Projects*. Click the URL for the `s3-rgw`.
3535
+
3636
image::../../images/medical-edge/storage-route.png[s3-rgw route]
3737
+
3838
Ensure that you see some XML and not the access denied error message.
3939
+
4040
image::../../images/medical-edge/storage-rgw-route.png[link="/images/medical-edge/storage-rgw-route.png"]
4141

42-
. While still looking at Routes, change the project to `xraylab-1`. Click the URL for the `image-server`. Ensure that you do not see an access denied error message. You must to see a `Hello world` message.
42+
. While still looking at *Routes*, change the project to `xraylab-1`. Click the URL for the `image-server`. Ensure that you do not see an access denied error message. You must to see a `Hello world` message.
4343

4444
This showcase application does not have access to a x-ray machine hanging around that we can use for this demo, so one is emulated by creating an s3 bucket and hosting the x-ray images within it. In the "real world" an x-ray would be taken at an edge medical facility and then uploaded to an OpenShift Data Foundations (ODF) S3 compatible bucket in the Core Hospital, triggering the AI/ML workflow.
4545

46-
To emulate the edge medical facility we use an application called `image-generator` which (when scaled up) will download the x-rays from s3 and put them in an ODF s3 bucket in the cluster, triggering the AI/ML workflow.
46+
To emulate the edge medical facility we use an application called `image-generator` which when scaled up will download the x-rays from s3 and put them in an ODF s3 bucket in the cluster, triggering the AI/ML workflow.
4747

4848
Turn on the image file flow. There are couple of ways to go about this.
4949

@@ -85,4 +85,4 @@ You did it! You have completed the deployment of the medical diagnosis pattern!
8585

8686
The medical diagnosis pattern is more than just the identification and detection of pneumonia in x-ray images. It is an object detection and classification model built on top of Red Hat OpenShift and can be transformed to fit multiple use-cases within the object classification paradigm. Similar use-cases would be detecting contraband items in the Postal Service or even in luggage in an airport baggage scanner.
8787

88-
For more information on Validated Patterns visit our link:https://validatedpatterns.io/[website]
88+
For more information about Validated Patterns, visit our link:https://validatedpatterns.io/[website].

content/patterns/medical-diagnosis/getting-started.adoc

Lines changed: 34 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ $ python s3-create.py -b kevtest-bucket -r us-east-1 -p
130130
$ python s3-sync-buckets.py -s validated-patterns-md-xray -t kevtest-bucket -r us-east-1
131131
----
132132

133-
Note the name of the bucket for further pattern configuration. Later you will update the `bucketSource` in the `values-global.yaml` file, where there is a section for `s3:`
133+
Note the name of the bucket for further pattern configuration. Later you will update the `bucketSource` in the `values-global.yaml` file, where there is a section for `s3:`.
134134

135135
[id="preparing-for-deployment"]
136136
== Preparing for deployment
@@ -145,6 +145,37 @@ Note the name of the bucket for further pattern configuration. Later you will up
145145
$ git clone [email protected]:<your-username>/medical-diagnosis.git
146146
----
147147

148+
. Go to your repository: Ensure you are in the root directory of your Git repository by using:
149+
+
150+
[source,terminal]
151+
----
152+
$ cd /path/to/your/repository
153+
----
154+
155+
. Run the following command to set the upstream repository:
156+
+
157+
[source,terminal]
158+
----
159+
$ git remote add -f upstream [email protected]:validatedpatterns/medical-diagnosis.git
160+
----
161+
162+
. Verify the setup of your remote repositories by running the following command:
163+
+
164+
[source,terminal]
165+
----
166+
$ git remote -v
167+
----
168+
+
169+
.Example output
170+
+
171+
[source,terminal]
172+
----
173+
origin [email protected]:kquinn1204/medical-diagnosis.git (fetch)
174+
origin [email protected]:kquinn1204/medical-diagnosis.git (push)
175+
upstream [email protected]:validatedpatterns/medical-diagnosis.git (fetch)
176+
upstream [email protected]:validatedpatterns/medical-diagnosis.git (push)
177+
----
178+
148179
. Create a local copy of the Helm values file that can safely include credentials.
149180
+
150181
[WARNING]
@@ -428,7 +459,7 @@ $ ./pattern.sh make install
428459
.. Check that the *Red Hat OpenShift GitOps Operator* is installed in the `openshift-operators` namespace and its status is `Succeeded`.
429460
. Wait some time for everything to deploy. You can track the progress through the `Hub ArgoCD` UI from the nines menu.
430461
+
431-
image::multicloud-gitops/multicloud-gitops-argocd.png[Multicloud GitOps Hub]
462+
image::../../images/medical-edge/medical-diags-overview.png[link="/images/medical-edge/medical-diags-overview.png.png"]
432463

433464
As part of installing by using the script `pattern.sh` pattern, HashiCorp Vault is installed. Running `./pattern.sh make install` also calls the `load-secrets` makefile target. This `load-secrets` target looks for a YAML file describing the secrets to be loaded into vault and in case it cannot find one it will use the `values-secret.yaml.template` file in the git repository to try to generate random secrets.
434465

@@ -443,41 +474,4 @@ To check the various applications that are being deployed, you can view the prog
443474
Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the applications for the pattern in this instance.
444475
====
445476

446-
. Check that all applications are synchronized. There are thirteen different ArgoCD `applications` that are deployed as part of this pattern.
447-
448-
449-
450-
451-
452-
//Module to be included
453-
//:_content-type: PROCEDURE
454-
//:imagesdir: ../../../images
455-
[id="making-some-changes-on-the-dashboard-getting-started"]
456-
=== Making some changes on the dashboard
457-
458-
You can change some of the parameters and watch how the changes effect the dashboard.
459-
460-
. You can increase or decrease the number of image generators.
461-
+
462-
[source,terminal]
463-
----
464-
$ oc scale deploymentconfig/image-generator --replicas=2
465-
----
466-
+
467-
Check the dashboard.
468-
+
469-
[source,terminal]
470-
----
471-
$ oc scale deploymentconfig/image-generator --replicas=0
472-
----
473-
+
474-
Watch the dashboard stop processing images.
475-
476-
. You can also simulate the change of the AI model version - as it's only an environment variable in the Serverless Service configuration.
477-
+
478-
[source,terminal]
479-
----
480-
$ oc patch service.serving.knative.dev/risk-assessment --type=json -p '[{"op":"replace","path":"/spec/template/metadata/annotations/revisionTimestamp","value":"'"$(date +%F_%T)"'"},{"op":"replace","path":"/spec/template/spec/containers/0/env/0/value","value":"v2"}]'
481-
----
482-
+
483-
This changes the model version value, and the `revisionTimestamp` in the annotations, which triggers a redeployment of the service.
477+
. Check that all applications are synchronized. There are thirteen different ArgoCD `applications` that are deployed as part of this pattern.

content/patterns/medical-diagnosis/ideas-for-customization.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,37 @@ These are just a few ideas to help you understand how you could use the {med-pat
3030

3131
//We have relevant links on the patterns page
3232
//AI: Why does this point to AEG though? https://github.com/validatedpatterns/ansible-edge-gitops/issues[Report Bugs]
33+
34+
35+
//Module to be included
36+
//:_content-type: PROCEDURE
37+
//:imagesdir: ../../../images
38+
[id="making-some-changes-on-the-dashboard-getting-started"]
39+
=== Making some changes on the dashboard
40+
41+
You can change some of the parameters and watch how the changes effect the dashboard.
42+
43+
. You can increase or decrease the number of image generators.
44+
+
45+
[source,terminal]
46+
----
47+
$ oc scale deploymentconfig/image-generator --replicas=2
48+
----
49+
+
50+
Check the dashboard.
51+
+
52+
[source,terminal]
53+
----
54+
$ oc scale deploymentconfig/image-generator --replicas=0
55+
----
56+
+
57+
Watch the dashboard stop processing images.
58+
59+
. You can also simulate the change of the AI model version - as it's only an environment variable in the Serverless Service configuration.
60+
+
61+
[source,terminal]
62+
----
63+
$ oc patch service.serving.knative.dev/risk-assessment --type=json -p '[{"op":"replace","path":"/spec/template/metadata/annotations/revisionTimestamp","value":"'"$(date +%F_%T)"'"},{"op":"replace","path":"/spec/template/spec/containers/0/env/0/value","value":"v2"}]'
64+
----
65+
+
66+
This changes the model version value, and the `revisionTimestamp` in the annotations, which triggers a redeployment of the service.

content/patterns/medical-diagnosis/troubleshooting.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Ensure that the Prometheus data source exists and that the status is available.
9292
'''
9393
Problem:: The dashboard is showing red in the corners of the dashboard panes.
9494
+
95-
image::medical-edge/medDiag-noDB.png[link="/images/medical-edge/medDiag-noDB.png"]
95+
image::../../images/medical-edge/medDiag-noDB.png[link="/images/medical-edge/medDiag-noDB.png"]
9696

9797
Solution:: This is most likely due to the *xraylab* database not being available or misconfigured. Please check the database and ensure that it is functioning properly.
9898

0 commit comments

Comments
 (0)