Update readme and user guide for GMC (#136)

* Update readme and user guide for GMC Signed-off-by: zhlsunshine <huailong.zhang@intel.com>
opea-project · Jun 27, 2024 · 2d17c90 · 2d17c90
1 parent 89aa5a2
commit 2d17c90
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/microservices-connector/README.md b/microservices-connector/README.md
@@ -76,6 +76,8 @@ kubectl apply -f config/crd/bases/gmc.opea.io_gmconnectors.yaml
 ```sh
 mkdir -p $(pwd)/config/manifests
 cp $(dirname $(pwd))/manifests/ChatQnA/*.yaml -p $(pwd)/config/manifests/
+cp $(dirname $(pwd))/manifests/DocSum/xeon/docsum_llm.yaml $(pwd)/config/manifests/
+cp $(dirname $(pwd))/manifests/DocSum/gaudi/docsum_gaudi_llm.yaml $(pwd)/config/manifests/
 ```
 
 **Copy GMC router manifest**
@@ -84,6 +86,15 @@ cp $(dirname $(pwd))/manifests/ChatQnA/*.yaml -p $(pwd)/config/manifests/
 cp $(pwd)/config/gmcrouter/gmc-router.yaml -p $(pwd)/config/manifests/
 ```
 
+\*\*Create Namespace for gmcmanager deployment
+
+```sh
+export SYSTEM_NAMESPACE=system
+kubectl create namespace $SYSTEM_NAMESPACE
+```
+
+**NOTE:** The SYSTEM_NAMESPACE should keep the same with the namespace defined in gmc-manager.yaml and gmc-manager-rbac.yaml.
+
 **Create ConfigMap for GMC to hold GenAI Components and GMC Router manifests**
 
 ```sh

diff --git a/microservices-connector/usage_guide.md b/microservices-connector/usage_guide.md
@@ -27,7 +27,7 @@ kubectl get service -n chatqa
 ```bash
 $kubectl get gmconnectors.gmc.opea.io -n chatqa
 NAME URL READY AGE
-chatqa http://router-service.chatqa.svc.cluster.local:8080 Success 3m
+chatqa http://router-service.chatqa.svc.cluster.local:8080  8/0/8  3m
 ```
 
 **Deploy one client pod for testing the chatQnA application**