update README and values.yaml for better read ability

helm-charts/auth-apisix/README.md

@@ -49,8 +49,10 @@ Update the following values in values.yaml
 # Install apisix api gateway and ingress controller
 helm install auth-apisix apisix/apisix -f values_apisix_gw.yaml --create-namespace --namespace auth-apisix
 
-# WAIT UNTIL apisix-ingress-controller POD IS READY.
+# WAIT UNTIL apisix-ingress-controller POD IS READY by checking status with 'kubectl get -n auth-apisix pods'
+# The pod is ready when READY status shows 1/1
 
+# Publish authenticated APIs in APISIX gateway
 helm install auth-apisix-crds . --namespace auth-apisix
 ```
 
@@ -65,7 +67,7 @@ echo http://$NODE_IP:$NODE_PORT
 # the autherticated endpoint published in APISIX gateway can be accessed as: http://$NODE_IP:$NODE_PORT/<published endpoint uri>
 
 ```
-</br></br>
+</br>
 Apisix helm chart provides configs to change the service type to other options like LoadBalancer (apisix.service.type) and externalTrafficPolicy to 'local'(apisix.service.externalTrafficPolicy). These can be added in apisix-helm/values.yaml </br></br>
 While accessing the published APIs, the HTTP Authorization header of the request should contain the Access token provided by Identity provider as 'Bearer \<Access Token\>' </br></br>
 The access token, refresh token, userinfo and user roles can be obtained by invoking OIDC auth endpoint through UI or token endpoint through curl and providing user credentials. </br>
@@ -78,6 +80,6 @@ helm uninstall auth-apisix-crds --namespace auth-apisix
 helm uninstall auth-apisix --namespace auth-apisix
 ```
 The crds installed by apisix won't be deleted by helm uninstall. Need to manually delete those crds </br>
-All APISIX spicific crds can be obtained by 'kubectl get crds' | grep apisix </br>
+All APISIX spicific crds can be obtained by 'kubectl get crds | grep apisix' </br>
 Each crd can be manually deleted by 'kubectl delete crd/\<crd name\>' </br>
 

helm-charts/auth-apisix/values.yaml

@@ -3,18 +3,18 @@
 
 # Identity provider OIDC config
 oidc:
-  realm: <your realm name>
-  client_id: <your oidc client id>
-  client_secret: <your oidc client secret>
-  discovery: <your oidc discovery endpoint>
-  introspection_endpoint: <your oidc introspection endpoint>
+  realm: your-OIDC-provider-realm # replace with your realm name for OPEA apps
+  client_id: your-OIDC-provider-client-id # replace with your oidc client id
+  client_secret: your-OIDC-provider-client-secret # your oidc client secret
+  discovery: your-OIDC-provider-openid-configuration  # replace with your oidc discovery endpoint
+  introspection_endpoint: your-OIDC-provider-introspection-endpoint  # replace with your oidc introspection endpoint>
 
 # APISIX chatqna api config
 chatqna:
-  namespace: <namespace in which your chatqna service is running>
-  hostname: <'Host' HTTP header from incoming request should match this. Wildcards like '*' allowed too>
+  namespace: default # namespace in which your chatqna service is running
+  hostname: your-hostname # 'Host' HTTP header from incoming request should match this. Wildcards like '*' allowed too
   query_api:
     path: /chatqna-oidc  # This is the path that will be published in apisix and this should be used by UI to access the chatqna service
-    backend_service: <kubernetes service name to access chatqna megaservice or gmc without .<namespace>.svc.cluster.local>
-    service_port: <port on which chatqna mega service or gmc is running>
-    service_path: <path to access chatqna mega service or gmc backend>
+    backend_service: router-service # your kubernetes service name to access chatqna megaservice or gmc without .<namespace>.svc.cluster.local
+    service_port: 8080 # port on which chatqna mega service or gmc is running
+    service_path: "/" # path to access chatqna mega service or gmc backend