From 37c30bd0a3e413293e274f3954a2ba2979fd3c82 Mon Sep 17 00:00:00 2001
From: bdattoma <bdattoma@redhat.com>
Date: Tue, 27 Feb 2024 13:27:54 +0100
Subject: [PATCH] update docs

---
 ods_ci/tests/Resources/CLI/Minio.resource              | 10 +++++++++-
 .../422__model_serving_llm_tgis_object_storages.robot  |  8 ++++----
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/ods_ci/tests/Resources/CLI/Minio.resource b/ods_ci/tests/Resources/CLI/Minio.resource
index 143614f06..e7cbd171f 100644
--- a/ods_ci/tests/Resources/CLI/Minio.resource
+++ b/ods_ci/tests/Resources/CLI/Minio.resource
@@ -12,6 +12,7 @@ ${MINIO_SA_FILEPATH}=    ${MINIO_RESOURCES_DIRPATH}/minio_serviceaccount.yaml
 
 *** Keywords ***
 Deploy MinIO
+    [Documentation]    Deploys MiniIO pod, service and route using the given ${minio_image}
     [Arguments]    ${minio_image}=quay.io/modh/ods-ci-minio-models:1.0
     ...            ${namespace}=minio    ${podname}=ods-ci-minio
     ...            ${service_name}=ods-ci-minio-srv    ${route_name}=ods-ci-minio-route
@@ -38,11 +39,13 @@ Deploy MinIO
     RETURN    ${route}
 
 Generate Minio Random Credentials
+    [Documentation]    Generates a random pair of keywords to be used as default MinIO user credentials
     ${key}=    Generate Random String    chars=[NUMBERS][LETTERS]
     ${pw}=    Generate Random String    chars=[NUMBERS][LETTERS]    length=12
     RETURN    ${key}    ${pw}
 
 Get Minio Credentials
+    [Documentation]    Extracts the default MinIO user credentials from the pod env variables
     [Arguments]    ${namespace}    ${podname}=ods-ci-minio
     ${rc}    ${key}=    Run And Return Rc And Output
     ...    oc get pod ${podname} -n ${namespace} -o jsonpath='{range .spec.containers[*].env[?(@.name=="MINIO_ACCESS_KEY")]}{@.value}{end}'    # robocop: disable
@@ -50,4 +53,9 @@ Get Minio Credentials
     ${rc}    ${pw}=    Run And Return Rc And Output
     ...    oc get pod ${podname} -n ${namespace} -o jsonpath='{range .spec.containers[*].env[?(@.name=="MINIO_SECRET_KEY")]}{@.value}{end}'    # robocop: disable
     Should Be Equal As Integers    ${rc}    ${0}
-    RETURN    ${key}    ${pw}
\ No newline at end of file
+    RETURN    ${key}    ${pw}
+
+Remove Minio
+    [Documentation]    Delete the MinIO objects from the cluster
+    Log    message=To Be Implemented
+    # for the time being the test using Minio is deleting the NS.
\ No newline at end of file
diff --git a/ods_ci/tests/Tests/400__ods_dashboard/420__model_serving/LLMs/422__model_serving_llm_tgis_object_storages.robot b/ods_ci/tests/Tests/400__ods_dashboard/420__model_serving/LLMs/422__model_serving_llm_tgis_object_storages.robot
index 426ee4c6d..bf260f98a 100644
--- a/ods_ci/tests/Tests/400__ods_dashboard/420__model_serving/LLMs/422__model_serving_llm_tgis_object_storages.robot
+++ b/ods_ci/tests/Tests/400__ods_dashboard/420__model_serving/LLMs/422__model_serving_llm_tgis_object_storages.robot
@@ -1,5 +1,6 @@
 *** Settings ***
-Documentation     Collection of CLI tests to validate the model serving stack for Large Language Models (LLM).
+Documentation     Collection of CLI tests to validate fetching models from different object storages
+...               in the scope of model serving stack for Large Language Models (LLM).
 ...               These tests leverage on TGIS Standalone Serving Runtime
 Resource          ../../../../Resources/OCP.resource
 Resource          ../../../../Resources/CLI/ModelServing/llm.resource
@@ -14,13 +15,12 @@ Test Tags         KServe
 ${MODEL_S3_DIR}=    flan-t5-small-hf
 ${TEST_NS}=    tgis-storages
 ${TGIS_RUNTIME_NAME}=    tgis-runtime
-@{SEARCH_METRICS}=    tgi_    istio_
 
   
 *** Test Cases ***
 Verify User Can Serve And Query A Model From Minio
     [Documentation]    Basic tests for preparing, deploying and querying a LLM model
-    ...                using Kserve and Caikit+TGIS runtime
+    ...                using Kserve and TGIS runtime fetching models from a MinIO server
     [Tags]    Tier1    RHOAIENG-3490
     ${minio_namespace}=    Set Variable    minio-models
     ${minio_endpoint}=    Deploy MinIO    namespace=${minio_namespace}
@@ -59,4 +59,4 @@ Suite Setup
     Skip If Component Is Not Enabled    kserve
     RHOSi Setup
     Load Expected Responses
-    Run    git clone https://github.com/IBM/text-generation-inference/
\ No newline at end of file
+    Run    git clone https://github.com/IBM/text-generation-inference/