Removed trust instructions to avoid confusion, added clarifying instructions...

Author: lmfarley10

.gitignore

@@ -97,6 +97,23 @@ __pycache__/
 clientApp/autoprompt/ConfigFile.properties
 clientApp/autoprompt/semantic_suggest_runbook.md 
 
+# Unnecessary instructions 
+deployment-docs/docs/deployment/nginx.md
+
+deployment-docs/docs/deployment/terraform_p.md
+deployment-docs/docs/deployment/trust-service.c.md 
+deployment-docs/docs/deployment/trust-ui.md  
+deployment-docs/docs/deployment/trust-service.md 
+deployment-docs/docs/deployment/let_s_encrypt.md 
+deployment-docs/docs/deployment/let_s_encrypt_orig.md
+
+deployment-docs/docs/rest/    
+deployment-docs/docs/templates/
+deployment-docs/docs/logging.md
+
+deployment-docs/docs/deployment/apex-trust.md
+deployment-docs/docs/deployment/apex-trust-lb.md
+
 # File with reference to orahub repo 
 deployment-docs/mkdocs.yml
 

README.md

@@ -4,53 +4,68 @@
 
 ## Introduction
 
-[Introduction](deployment-docs/docs/deployment/introduction.md)
+Oracle AskData is a conversational AI platform powered by Oracle Generative AI. With AskData, you can ask natural language questions like "Give me all past due invoices" or "Show me sales for last week over $100,000" and get instant, accurate results. 
+
+The solution empowers both non-technical users and SQL experts by simplifying complex queries and freeing up time for deeper analysis and decision-making.
+
 
 ## Getting Started
-Start with familiarizing yourself with the [Architecture](deployment-docs/docs/deployment/architecture.md) & [Introduction](deployment-docs/docs/deployment/introduction.md)
+Please see the [Introduction](deployment-docs/docs/deployment/introduction.md) & [Architecture](deployment-docs/docs/deployment/architecture.md) 
 
-For policies see [Defining Policies](deployment-docs/docs/deployment/generic.md)
+For policies see [Defining Policies](deployment-docs/docs/deployment/generic.md#dynamic-groups)
 
+### Prerequisites
 The CIS Landing Zone is optional but helps with providing a sandbox environment with best practices
-[Deploy CIS LZ](deployment-docs/docs/deployment/landing_zone.md)
 
-### Prerequisites
+- [Deploy CIS LZ](deployment-docs/docs/deployment/landing_zone.md)
+
+
 This solution assumes you have access to an OCI tenancy with the admin ability to provision the following resources: 
-- VBCS 
-    - [Deploy VBCS](deployment-docs/docs/deployment/VBCS.md)
-- ODA
-    - [Deploy ODA](deployment-docs/docs/deployment/oda.md)
-- IAM Confidential App 
+
+- IDCS/IAM Confidential App 
     - [Deploy IAM App](deployment-docs/docs/deployment/business_idcs.md)
 - Vault
     - [Deploy Vault](deployment-docs/docs/deployment/vault.md)
-- API Gateway
-    - [Deploy API Gateway](deployment-docs/docs/deployment/business_api_gateway.md)
-- Business (client) ADW database
+- Business (Client) ADB database
     - [Deploy Database](deployment-docs/docs/deployment/database.md)
 - Trust ADB database
     - [Deploy Database](deployment-docs/docs/deployment/database.md)
-- Redis Cache 
+- OCI Cache 
+    - [Deploy OCI Cache Cluster](https://docs.oracle.com/en-us/iaas/Content/ocicache/createcluster.htm#top) 
 - VCN 
-    - Two VMs, one for engine in private sn and one bastion/jump host 
+    - Private Subnet
+    - Public Subnet 
+    - [Deploy a VCN](https://docs.oracle.com/en-us/iaas/Content/Network/Tasks/quickstartnetworking.htm#Virtual_Networking_Quickstart)
+- Two VMs
+    - Engine 
         - [Deploy Engine Documentation](deployment-docs/docs/deployment/nl2sql_engine.md)
-
+    - Bastion/jump host
+        - To access engine in private subnet
+- API Gateway
+    - [Deploy API Gateway](deployment-docs/docs/deployment/business_api_gateway.md)
+    - (Optional) If deploying API Gateway privately, see [ADW API Gateway Private Access](deployment-docs/docs/deployment/adw_private.md)
+- VBCS 
+    - [Deploy VBCS](deployment-docs/docs/deployment/VBCS.md)
+- ODA
+    - [Deploy ODA](deployment-docs/docs/deployment/oda.md)
 ## Deployment Steps
 
-1. Configure Business App
-    - Configure Business DB
-    - Configure Trust DB
-2. Configure IDCS App
-3. Configure API Gateway
-4. Configure ODA Skills
-5. Configure VB Apps 
+1. Configure Business DB
+2. Configure Trust DB
+3. Configure IDCS App
+4. Configure OCI Cache
+4. Configure Engine 
+5. Configure API Gateway
+6. Configure ODA Skills
+7. Configure VB Apps 
 
-## Notes/Issues
+### Validation 
 
-See [Troubleshooting](deployment-docs/docs/deployment/architecture.md)
+[Validation Testing](deployment-docs/docs/deployment/validation.md)
+
+## Notes/Issues
 
-This first release is focused on deploying the NL Engine/ClientApp for the business user. The Trust Framework plans to be added next release. However, documentation is available under [Deployment](deployment-docs/docs/deployment/)
-if you'd like to get familiar. All documentation related to apex & trust service would be for the trust framework. 
+See [Troubleshooting](deployment-docs/docs/deployment/troubleshooting.md)
 
 ## URLs
 * Nothing at this time

clientApp/ConfigFile.properties

@@ -68,7 +68,8 @@ file.embdgs=notused
 file.col_embdgs=notused
 librarymatch.threshold=0.80
 librarymatch.upperthreshold=1.0
-[DEFAULT] # trust db connection
+[DEFAULT] 
+# trust db connection
 user=xxxxxx
 password=xxxxx
 dsn= xxxxx

deployment-docs/docs/deployment/Deployment.md

@@ -1,5 +1,13 @@
 # VBCS Deployment
 
+### Prerequisites 
+
+This section assumes the following resources are configured: 
+* [IDCS Application](./business_idcs.md)
+* [Engine Application](./nl2sql_engine.md)
+* [API Gateway](./business_api_gateway.md)
+* [ODA](./oda.md)
+
 ### Setup Identity Group
 
 #### Create Group
@@ -31,12 +39,9 @@
 1. Open the OCI Console.
 
 2. In the upper-left corner, click **Navigation Menu**
-    
-<br>
 
 ![ ](./business_media/media/image68.png)
 
-
 3. Select **Developer Services** and then select **Visual Builder**.
 
 <br>
@@ -110,6 +115,11 @@ Search keyword example: nl2sql
 
 **(you may need to zip the above folder for the main app before importing)**
 
+- **Update** The VBCS application files are found in [vbcs_oda_archives](../../../vbcs_oda_archives/).
+    - Navigate to vbcs_oda_archives and zip the respective applications
+        - zip -r my-vb-app.zip ./<my-vb-app>
+    - Import the zip to VBCS
+
 ![ ](./business_media/media/image78.png)
 
 2.  Navigate to your Visual Applications Home page and click **Import**.
@@ -195,11 +205,11 @@ Click on the pencil icon
 Verify/Edit the Instance URL. This points to APIGW. Therefore, this should match the APIGW url. 
 \[Example, <https://apigw-url.apigateway.us-chicago-1.oci.customer-oci.com/v1>\]
 
-Verify/Edit Authentication section. This should match the IDCS confidential app that was setup earlier.
+Verify/Edit Authentication section. This should match the [IDCS confidential app](./business_idcs.md) that was setup earlier.
 
 - Authentication: OAuth 2.0 Client Credentials
 - Client ID & Secret: \<click pencil icon to enter client id and secret\>
-- Scope: \<Example: urn:opc:idm:\_\_myscopes\_\_\>
+- Scope: \<Example: urn:opc:idm:\_\_myscopes\_\_\> (if using same instructions from IDCS App, odatest)
 - Token URL: \<Example:
 <https://idcs-server.identity.oraclecloud.com/oauth2/v1/token>\>
 
@@ -256,7 +266,19 @@ Make a note of URLs, especially Table_Graph app and InteractiveGraph app as you
 >
 ![ ](./business_media/media/server-config.png)
 
+### Test Application
+
+Once engine config is updated to include the above vb applications, and everything is configured correctly, you should be able to converse with AskData: 
+
+![AskData](./images/askdata-app.png)
 
+![AskData](./images/askdata-app-2.png)
+
+> **Note** You can select "View Full Result Set" to open another visual interface 
+
+![AskData](./images/askdata-app-3.png)
+
+![AskData](./images/askdata-app-4.png)
 ## Private Resources
 
 This section is applicable only if the target APIs accessed by ODA and
@@ -310,4 +332,10 @@ If you don’t see the Private Endpoint enablement option or list of available p
 
 !["Select private endpoint for REST service"](./business_media/media/image107.jpeg)
 
-Note that the private endpoint feature is not supported by the custom component of ODA. Therefore, you may create a public load balancer is such cases.
+Note that the private endpoint feature is not supported by the custom component of ODA. Therefore, you may create a public load balancer is such cases.
+
+
+## Troubleshooting 
+
+1. Graph isn't showing in Table Graph VB App
+    - Solution: Make sure to assign user role to idcs group in app settings

deployment-docs/docs/deployment/VBCS.md

@@ -3,8 +3,7 @@
 # 1. Introduction
 
 By default, ADW uses public endpoints for its communication to
-supporting services. As the API gateway deployments are not oAuth
-protected, it needs to be private.
+supporting services. For using ADW with a private API gateway, see below.
 
 For this to work, we will need the followings: