From 9772459304f2a35a51004f09b4936a8eef4c6222 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Mon, 6 Jan 2025 16:18:03 +0000 Subject: [PATCH 01/11] TELCODOCS-2143 Updating Medical diags documentation --- .../medical-diagnosis/getting-started.adoc | 57 +++++++++++++------ 1 file changed, 39 insertions(+), 18 deletions(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 53d728aa9..1fc7f91ce 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -33,6 +33,10 @@ $ oc get storageclass -o custom-columns=NAME:.metadata.name,PROVISIONER:.provisi NAME PROVISIONER DEFAULT gp2-csi ebs.csi.aws.com gp3-csi ebs.csi.aws.com true +<<<<<<< HEAD +======= + +>>>>>>> 6f4d67c21 (TELCODOCS-2143 Updating Medical diags documentation) ---- + For more information about creating a dynamic `StorageClass`, see the https://docs.openshift.com/container-platform/latest/storage/dynamic-provisioning.html[Dynamic provisioning]. @@ -64,7 +68,6 @@ For the official documentation on creating the buckets on AWS and other cloud pr //AI: Update the use of community and VP post naming tier update Follow this procedure to use the scripts provided in the link:https://github.com/validatedpatterns/utilities[utilities] repo to configure and S3 bucket in your AWS environment for the x-ray images. - .Procedure . Fork the link:https://github.com/validatedpatterns/utilities[utilities] repository on GitHub. Forking the repository allows you to update the repository as part of the GitOps and DevOps processes. @@ -89,7 +92,6 @@ $ cd utilities ---- git remote add -f upstream git@github.com:validatedpatterns/utilities.git ---- - . Change to the `aws-tools` directory: + [source,terminal] @@ -121,10 +123,15 @@ $ python s3-create.py -b kevtest-bucket -r us-east-1 -p + [source,terminal] ---- -$ python s3-sync-buckets.py -s validated-patterns-md-xray -t kevtest-bucket -r us-east-1 +$ python s3-sync-buckets.py -s validated-patterns-md-xray -t mytest-bucket -r us-east-1 ---- ++ +[NOTE] +==== +You can do this on the cloud providers console as well. +==== -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:`. +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:` [id="preparing-for-deployment"] == Preparing for deployment @@ -251,11 +258,29 @@ $ git checkout -b my-branch $ vi values-global.yaml ---- + -.Example edited `values-global.yaml` file ++ +.Example `values-global.yaml` file + [source,yaml] ---- -global: + global: + pattern: xray + + options: + useCSV: False + syncPolicy: Automatic + installPlanApproval: Automatic + + datacenter: + storageClassName: gp3-csi + + xraylab: + namespace: "xraylab-1" + + s3: + # Values for S3 bucket access + # bucketSource: "provide s3 bucket name where images are stored" + bucketSource: global: pattern: xray options: @@ -265,10 +290,6 @@ global: datacenter: storageClassName: gp3-csi - cloudProvider: aws - region: us-east-1 - clustername: mytestcluster - domain: aws.validatedpatterns.io xraylab: namespace: "xraylab-1" @@ -286,13 +307,13 @@ main: enabled: true clusterGroupChartVersion: 0.9.* -# Example Configuration - #datacenter: - # cloudProvider: aws - # storageClassName: gp2 - # region: us-east-1 - # clustername: example-sample - # domain: patterns.redhat.com + + datacenter: + cloudProvider: aws + storageClassName: gp3-csi + region: us-east-1 + clustername: mytestcluster + domain: aws.validatedpatterns.io ---- . Add `values-global.yaml` to the staging area: @@ -468,4 +489,4 @@ To check the various applications that are being deployed, you can view the prog Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the applications for the pattern in this instance. ==== -. Check that all applications are synchronized. There are thirteen different ArgoCD `applications` that are deployed as part of this pattern. \ No newline at end of file +. Check that all applications are synchronized. There are thirteen different ArgoCD `applications` that are deployed as part of this pattern. From 05f2840d6475c8c8d900bb0f0ad45537a2990883 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Tue, 7 Jan 2025 18:28:36 +0000 Subject: [PATCH 02/11] test another change 2 --- content/patterns/medical-diagnosis/getting-started.adoc | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 1fc7f91ce..5a3abb0e6 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -68,6 +68,7 @@ For the official documentation on creating the buckets on AWS and other cloud pr //AI: Update the use of community and VP post naming tier update Follow this procedure to use the scripts provided in the link:https://github.com/validatedpatterns/utilities[utilities] repo to configure and S3 bucket in your AWS environment for the x-ray images. + .Procedure . Fork the link:https://github.com/validatedpatterns/utilities[utilities] repository on GitHub. Forking the repository allows you to update the repository as part of the GitOps and DevOps processes. @@ -92,6 +93,7 @@ $ cd utilities ---- git remote add -f upstream git@github.com:validatedpatterns/utilities.git ---- + . Change to the `aws-tools` directory: + [source,terminal] @@ -125,11 +127,6 @@ $ python s3-create.py -b kevtest-bucket -r us-east-1 -p ---- $ python s3-sync-buckets.py -s validated-patterns-md-xray -t mytest-bucket -r us-east-1 ---- -+ -[NOTE] -==== -You can do this on the cloud providers console as well. -==== 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:` @@ -258,7 +255,6 @@ $ git checkout -b my-branch $ vi values-global.yaml ---- + -+ .Example `values-global.yaml` file + [source,yaml] From 12000aba201eca0ca91513f5b30f7553abf398bd Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Wed, 8 Jan 2025 14:08:16 +0000 Subject: [PATCH 03/11] test another change 3 --- .../medical-diagnosis/getting-started.adoc | 42 ++++++------------- 1 file changed, 13 insertions(+), 29 deletions(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 5a3abb0e6..9848b984e 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -33,10 +33,6 @@ $ oc get storageclass -o custom-columns=NAME:.metadata.name,PROVISIONER:.provisi NAME PROVISIONER DEFAULT gp2-csi ebs.csi.aws.com gp3-csi ebs.csi.aws.com true -<<<<<<< HEAD -======= - ->>>>>>> 6f4d67c21 (TELCODOCS-2143 Updating Medical diags documentation) ---- + For more information about creating a dynamic `StorageClass`, see the https://docs.openshift.com/container-platform/latest/storage/dynamic-provisioning.html[Dynamic provisioning]. @@ -255,11 +251,11 @@ $ git checkout -b my-branch $ vi values-global.yaml ---- + -.Example `values-global.yaml` file +.Example edited `values-global.yaml` file + [source,yaml] ---- - global: +global: pattern: xray options: @@ -269,23 +265,11 @@ $ vi values-global.yaml datacenter: storageClassName: gp3-csi - - xraylab: - namespace: "xraylab-1" - - s3: - # Values for S3 bucket access - # bucketSource: "provide s3 bucket name where images are stored" - bucketSource: global: - pattern: xray - - options: - useCSV: False - syncPolicy: Automatic - installPlanApproval: Automatic - - datacenter: + cloudProvider: aws storageClassName: gp3-csi + region: us-east-1 + clustername: mytestcluster + domain: aws.validatedpatterns.io xraylab: namespace: "xraylab-1" @@ -303,13 +287,13 @@ main: enabled: true clusterGroupChartVersion: 0.9.* - - datacenter: - cloudProvider: aws - storageClassName: gp3-csi - region: us-east-1 - clustername: mytestcluster - domain: aws.validatedpatterns.io +# Example Configuration + #datacenter: + # cloudProvider: aws + # storageClassName: gp2 + # region: us-east-1 + # clustername: example-sample + # domain: patterns.redhat.com ---- . Add `values-global.yaml` to the staging area: From 03b9fd821a015013a2fa83f54c0f03f2166d5e6d Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Mon, 13 Jan 2025 15:35:41 +0000 Subject: [PATCH 04/11] Update image dir path --- .../medical-diagnosis/getting-started.adoc | 83 ++++++++++++++++++- 1 file changed, 82 insertions(+), 1 deletion(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 9848b984e..64e789303 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -121,7 +121,7 @@ $ python s3-create.py -b kevtest-bucket -r us-east-1 -p + [source,terminal] ---- -$ python s3-sync-buckets.py -s validated-patterns-md-xray -t mytest-bucket -r us-east-1 +$ python s3-sync-buckets.py -s validated-patterns-md-xray -t kevtest-bucket -r us-east-1 ---- 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:` @@ -470,3 +470,84 @@ Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the appli ==== . Check that all applications are synchronized. There are thirteen different ArgoCD `applications` that are deployed as part of this pattern. + + +//Module to be included +//:_content-type: PROCEDURE +//:imagesdir: ../../../static/images +[id="viewing-the-grafana-based-dashboard-getting-started"] +=== Viewing the Grafana based dashboard + +. Accept the SSL certificates on the browser for the dashboard. In the {ocp} web console, go to the Routes for project `openshift-storage``. Click the URL for the `s3-rgw`. ++ +image::medical-edge/storage-route.png[link="/images/medical-edge/storage-route.png"] ++ +Ensure that you see some XML and not the access denied error message. ++ +image::medical-edge/storage-rgw-route.png[link="/images/medical-edge/storage-rgw-route.png"] + +. 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. ++ +image::medical-edge/grafana-routes.png[link="/images/medical-edge/grafana-routes.png"] + +. Turn on the image file flow. There are three ways to go about this. ++ +You can go to the command-line (make sure you have KUBECONFIG set, or are logged into the cluster). ++ +[source,terminal] +---- +$ oc scale deploymentconfig/image-generator --replicas=1 -n xraylab-1 +---- ++ +Or you can go to the OpenShift UI and change the view from Administrator to Developer and select Topology. From there select the `xraylab-1` project. ++ +image::medical-edge/dev-topology.png[link="/images/medical-edge/dev-topology.png"] ++ +Right-click on the `image-generator` pod icon and select `Edit Pod count`. ++ +image::medical-edge/dev-topology-menu.png[link="/images/medical-edge/dev-topology-menu.png"] ++ +Up the pod count from `0` to `1` and save. ++ +image::medical-edge/dev-topology-pod-count.png[link="/images/medical-edge/dev-topology-pod-count.png"] ++ +Alternatively, you can have the same outcome on the Administrator console. ++ +Go to the OpenShift UI under Workloads, select Deploymentconfigs for Project `xraylab-1`. +Click `image-generator` and increase the pod count to 1. ++ +image::medical-edge/start-image-flow.png[link="/images/medical-edge/start-image-flow.png"] + + +//Module to be included +//:_content-type: PROCEDURE +//:imagesdir: ../../../images +[id="making-some-changes-on-the-dashboard-getting-started"] +=== Making some changes on the dashboard + +You can change some of the parameters and watch how the changes effect the dashboard. + +. You can increase or decrease the number of image generators. ++ +[source,terminal] +---- +$ oc scale deploymentconfig/image-generator --replicas=2 +---- ++ +Check the dashboard. ++ +[source,terminal] +---- +$ oc scale deploymentconfig/image-generator --replicas=0 +---- ++ +Watch the dashboard stop processing images. + +. You can also simulate the change of the AI model version - as it's only an environment variable in the Serverless Service configuration. ++ +[source,terminal] +---- +$ 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"}]' +---- ++ +This changes the model version value, and the `revisionTimestamp` in the annotations, which triggers a redeployment of the service. From 4ef0d682bc3c2b63387b9ded9886a40c48848981 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Mon, 20 Jan 2025 12:24:41 +0000 Subject: [PATCH 05/11] Update values-global.yaml 2 --- content/patterns/medical-diagnosis/getting-started.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 64e789303..90c5ee2e0 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -464,6 +464,7 @@ For more information, see section on https://validatedpatterns.io/secrets/vault/ To check the various applications that are being deployed, you can view the progress of the {rh-gitops-short} Operator. +. [IMPORTANT] ==== Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the applications for the pattern in this instance. @@ -480,7 +481,7 @@ Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the appli . Accept the SSL certificates on the browser for the dashboard. In the {ocp} web console, go to the Routes for project `openshift-storage``. Click the URL for the `s3-rgw`. + -image::medical-edge/storage-route.png[link="/images/medical-edge/storage-route.png"] +image::medical-edge/storage-route.png[link="/static/images/medical-edge/storage-route.png"] + Ensure that you see some XML and not the access denied error message. + From 419a8215da4182a755c80ed2e1d2057569b13f82 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Wed, 22 Jan 2025 22:38:29 +0000 Subject: [PATCH 06/11] Updating based on peer review phase 3 --- content/patterns/medical-diagnosis/getting-started.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 90c5ee2e0..9191ecd6f 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -266,7 +266,6 @@ global: datacenter: storageClassName: gp3-csi cloudProvider: aws - storageClassName: gp3-csi region: us-east-1 clustername: mytestcluster domain: aws.validatedpatterns.io From 2d31ccaf13c079f68e33547275f007318847ceac Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Thu, 23 Jan 2025 09:58:28 +0000 Subject: [PATCH 07/11] getting images to display --- content/patterns/medical-diagnosis/getting-started.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 9191ecd6f..f3acf2917 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -474,13 +474,13 @@ Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the appli //Module to be included //:_content-type: PROCEDURE -//:imagesdir: ../../../static/images +//:imagesdir: ../../../images [id="viewing-the-grafana-based-dashboard-getting-started"] -=== Viewing the Grafana based dashboard +== Viewing the Grafana based dashboard -. Accept the SSL certificates on the browser for the dashboard. In the {ocp} web console, go to the Routes for project `openshift-storage``. Click the URL for the `s3-rgw`. +. 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`. + -image::medical-edge/storage-route.png[link="/static/images/medical-edge/storage-route.png"] +image::medical-edge/storage-route.png[s3-rgw route] + Ensure that you see some XML and not the access denied error message. + From 07c95c73c72358c2c73946610e15592590d98943 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Thu, 23 Jan 2025 11:34:56 +0000 Subject: [PATCH 08/11] getting images to display 2 --- .../medical-diagnosis/getting-started.adoc | 30 +++++++------------ 1 file changed, 11 insertions(+), 19 deletions(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index f3acf2917..2d573046e 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -463,7 +463,6 @@ For more information, see section on https://validatedpatterns.io/secrets/vault/ To check the various applications that are being deployed, you can view the progress of the {rh-gitops-short} Operator. -. [IMPORTANT] ==== Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the applications for the pattern in this instance. @@ -478,45 +477,38 @@ Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the appli [id="viewing-the-grafana-based-dashboard-getting-started"] == Viewing the Grafana based dashboard -. 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`. +. 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`. + -image::medical-edge/storage-route.png[s3-rgw route] +image::../../images/medical-edge/storage-route.png[s3-rgw route] + Ensure that you see some XML and not the access denied error message. + -image::medical-edge/storage-rgw-route.png[link="/images/medical-edge/storage-rgw-route.png"] +image::../../images/medical-edge/storage-rgw-route.png[link="/images/medical-edge/storage-rgw-route.png"] . 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. + -image::medical-edge/grafana-routes.png[link="/images/medical-edge/grafana-routes.png"] +image::../../images/medical-edge/grafana-routes.png[link="/images/medical-edge/grafana-routes.png"] -. Turn on the image file flow. There are three ways to go about this. +. Turn on the image file flow. There are couple of ways to go about this. + -You can go to the command-line (make sure you have KUBECONFIG set, or are logged into the cluster). +You can go to the {ocp} web console and change the view from *Administrator* to *Developer* and select *Topology*. From there select the `xraylab-1` project. + -[source,terminal] ----- -$ oc scale deploymentconfig/image-generator --replicas=1 -n xraylab-1 ----- -+ -Or you can go to the OpenShift UI and change the view from Administrator to Developer and select Topology. From there select the `xraylab-1` project. -+ -image::medical-edge/dev-topology.png[link="/images/medical-edge/dev-topology.png"] +image::../../images/medical-edge/dev-topology.png[link="/images/medical-edge/dev-topology.png"] + Right-click on the `image-generator` pod icon and select `Edit Pod count`. + -image::medical-edge/dev-topology-menu.png[link="/images/medical-edge/dev-topology-menu.png"] +image::../../images/medical-edge/dev-topology-menu.png[link="/images/medical-edge/dev-topology-menu.png"] + Up the pod count from `0` to `1` and save. + -image::medical-edge/dev-topology-pod-count.png[link="/images/medical-edge/dev-topology-pod-count.png"] +image::../../images/medical-edge/dev-topology-pod-count.png[link="/images/medical-edge/dev-topology-pod-count.png"] + Alternatively, you can have the same outcome on the Administrator console. + -Go to the OpenShift UI under Workloads, select Deploymentconfigs for Project `xraylab-1`. +Go to the OpenShift UI under Workloads, select *Deployments* for the *Project* `xraylab-1`. Click `image-generator` and increase the pod count to 1. + -image::medical-edge/start-image-flow.png[link="/images/medical-edge/start-image-flow.png"] +image::../../images/medical-edge/start-image-flow.png[link="/images/medical-edge/start-image-flow.png"] //Module to be included From 812fe323894b3c35b060a7d1999e543980600434 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Thu, 23 Jan 2025 11:41:30 +0000 Subject: [PATCH 09/11] getting images to display 3 --- content/patterns/medical-diagnosis/getting-started.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 2d573046e..b471bb346 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -477,7 +477,7 @@ Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the appli [id="viewing-the-grafana-based-dashboard-getting-started"] == Viewing the Grafana based dashboard -. 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`. +. test. 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`. + image::../../images/medical-edge/storage-route.png[s3-rgw route] + From 0f69799f301597706f82542e1912aa906f12e495 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Thu, 23 Jan 2025 12:31:53 +0000 Subject: [PATCH 10/11] updating demo section --- .../medical-diagnosis/demo-script.adoc | 12 +++--- .../medical-diagnosis/getting-started.adoc | 37 ------------------- 2 files changed, 7 insertions(+), 42 deletions(-) diff --git a/content/patterns/medical-diagnosis/demo-script.adoc b/content/patterns/medical-diagnosis/demo-script.adoc index a446fd616..e15c6a1da 100644 --- a/content/patterns/medical-diagnosis/demo-script.adoc +++ b/content/patterns/medical-diagnosis/demo-script.adoc @@ -1,6 +1,8 @@ --- title: Verifying the demo weight: 20 +title: Verifying the demo Medical diagnosis pattern +weight: 20 aliases: /medical-diagnosis/demo/ --- @@ -27,19 +29,19 @@ We simulate the function of the remote medical facility with an application call [id="viewing-the-grafana-based-dashboard-getting-started"] == Enabling the Grafana based dashboard -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. +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: -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: +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: -. Accept the SSL certificates on the browser for the dashboard. In the {ocp} web console, go to the *Networking* > *Routes* for *All Projects*. Click the URL for the `s3-rgw`. +. 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`. + image::../../images/medical-edge/storage-route.png[s3-rgw route] + -Ensure that you see XML and not the access denied error message. +Ensure that you see some XML and not the access denied error message. + image::../../images/medical-edge/storage-rgw-route.png[link="/images/medical-edge/storage-rgw-route.png"] -. While still looking at *Routes*, change the project to `xraylab-1`. Click the URL for the `image-server` and ensure that you do not see an access denied error message. You should see a `Hello world` message. +. 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. 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. diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index b471bb346..3b114acb6 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -471,44 +471,7 @@ Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the appli . Check that all applications are synchronized. There are thirteen different ArgoCD `applications` that are deployed as part of this pattern. -//Module to be included -//:_content-type: PROCEDURE -//:imagesdir: ../../../images -[id="viewing-the-grafana-based-dashboard-getting-started"] -== Viewing the Grafana based dashboard - -. test. 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`. -+ -image::../../images/medical-edge/storage-route.png[s3-rgw route] -+ -Ensure that you see some XML and not the access denied error message. -+ -image::../../images/medical-edge/storage-rgw-route.png[link="/images/medical-edge/storage-rgw-route.png"] - -. 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. -+ -image::../../images/medical-edge/grafana-routes.png[link="/images/medical-edge/grafana-routes.png"] -. Turn on the image file flow. There are couple of ways to go about this. -+ -You can go to the {ocp} web console and change the view from *Administrator* to *Developer* and select *Topology*. From there select the `xraylab-1` project. -+ -image::../../images/medical-edge/dev-topology.png[link="/images/medical-edge/dev-topology.png"] -+ -Right-click on the `image-generator` pod icon and select `Edit Pod count`. -+ -image::../../images/medical-edge/dev-topology-menu.png[link="/images/medical-edge/dev-topology-menu.png"] -+ -Up the pod count from `0` to `1` and save. -+ -image::../../images/medical-edge/dev-topology-pod-count.png[link="/images/medical-edge/dev-topology-pod-count.png"] -+ -Alternatively, you can have the same outcome on the Administrator console. -+ -Go to the OpenShift UI under Workloads, select *Deployments* for the *Project* `xraylab-1`. -Click `image-generator` and increase the pod count to 1. -+ -image::../../images/medical-edge/start-image-flow.png[link="/images/medical-edge/start-image-flow.png"] //Module to be included From 78d74e0b63faf5249590c1f34a335ff14c7a6fa2 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Fri, 24 Jan 2025 11:29:21 +0000 Subject: [PATCH 11/11] Updating troubleshooting and images --- .../medical-diagnosis/demo-script.adoc | 10 ++--- .../medical-diagnosis/getting-started.adoc | 41 +------------------ 2 files changed, 6 insertions(+), 45 deletions(-) diff --git a/content/patterns/medical-diagnosis/demo-script.adoc b/content/patterns/medical-diagnosis/demo-script.adoc index e15c6a1da..6994046b6 100644 --- a/content/patterns/medical-diagnosis/demo-script.adoc +++ b/content/patterns/medical-diagnosis/demo-script.adoc @@ -1,8 +1,6 @@ --- title: Verifying the demo weight: 20 -title: Verifying the demo Medical diagnosis pattern -weight: 20 aliases: /medical-diagnosis/demo/ --- @@ -29,11 +27,11 @@ We simulate the function of the remote medical facility with an application call [id="viewing-the-grafana-based-dashboard-getting-started"] == Enabling the Grafana based dashboard -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: +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. -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: +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: -. 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`. +. 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`. + image::../../images/medical-edge/storage-route.png[s3-rgw route] + @@ -41,7 +39,7 @@ Ensure that you see some XML and not the access denied error message. + image::../../images/medical-edge/storage-rgw-route.png[link="/images/medical-edge/storage-rgw-route.png"] -. 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. +. 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. 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. diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 3b114acb6..53d728aa9 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -124,7 +124,7 @@ $ python s3-create.py -b kevtest-bucket -r us-east-1 -p $ python s3-sync-buckets.py -s validated-patterns-md-xray -t kevtest-bucket -r us-east-1 ---- -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:` +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:`. [id="preparing-for-deployment"] == Preparing for deployment @@ -468,41 +468,4 @@ To check the various applications that are being deployed, you can view the prog Examine the `medical-diagnosis-hub` ArgoCD instance. You can track all the applications for the pattern in this instance. ==== -. Check that all applications are synchronized. There are thirteen different ArgoCD `applications` that are deployed as part of this pattern. - - - - - -//Module to be included -//:_content-type: PROCEDURE -//:imagesdir: ../../../images -[id="making-some-changes-on-the-dashboard-getting-started"] -=== Making some changes on the dashboard - -You can change some of the parameters and watch how the changes effect the dashboard. - -. You can increase or decrease the number of image generators. -+ -[source,terminal] ----- -$ oc scale deploymentconfig/image-generator --replicas=2 ----- -+ -Check the dashboard. -+ -[source,terminal] ----- -$ oc scale deploymentconfig/image-generator --replicas=0 ----- -+ -Watch the dashboard stop processing images. - -. You can also simulate the change of the AI model version - as it's only an environment variable in the Serverless Service configuration. -+ -[source,terminal] ----- -$ 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"}]' ----- -+ -This changes the model version value, and the `revisionTimestamp` in the annotations, which triggers a redeployment of the service. +. Check that all applications are synchronized. There are thirteen different ArgoCD `applications` that are deployed as part of this pattern. \ No newline at end of file