Added documentation, redacted images, fixed bug with table graph ui, added sample csv for vendors, updated readme, added licenses

Author: lmfarley10

.gitignore

@@ -55,13 +55,23 @@ __pycache__/
 !clientApp/trusted.png
 !clientApp/untrusted.png 
 !/vbcs_oda_archives/vbcs_apps/vbcs-askdata/webApps/nl2sqlbot/resources/images/*
-!nl2sql-main/vbcs_oda_archives/vbcs_apps/vbcs-askdata/webApps/nl2sqlbot/resources/images
+
+# Added images for documentation (redacted)
+!mkdocs/docs/deployment/business_media/media/*
+!mkdocs/docs/deployment/apex/media/*
+!mkdocs/docs/deployment/images/*
+!mkdocs/docs/deployment/lb/media/*
+!mkdocs/docs/deployment/terraform/*
 
 *.jpeg
+!mkdocs/docs/deployment/business_media/media/*
+
 *.jpg
 !/vbcs_oda_archives/vbcs_apps/vbcs-askdata/webApps/nl2sqlbot/resources/images/*
+
 *.gif
 *.webp
+
 *.ico
 !/vbcs_oda_archives/vbcs_apps/vbcs-askdata/webApps/nl2sqlbot/resources/images/*
 
@@ -91,31 +101,31 @@ clientApp/autoprompt/semantic_suggest_runbook.md
 mkdocs/mkdocs.yml
 
 # Reference to api gateway
-mkdocs/docs/deployment/adw_private.md
+# mkdocs/docs/deployment/adw_private.md # cleaned up sensitive info
 
 # Reference to idcs discovery url 
-mkdocs/docs/deployment/business_api_gateway.md
+#mkdocs/docs/deployment/business_api_gateway.md # cleaned up/masked sensitive data
 
 # Reference to oda instance 
-mkdocs/docs/deployment/business_idcs.md 
+# mkdocs/docs/deployment/business_idcs.md # cleaned/masked data
 
 # Reference to oracle redis 
-mkdocs/docs/deployment/nl2sql_engine.md 
+# mkdocs/docs/deployment/nl2sql_engine.md # removed sensitive data. There are a lot of references to websocket... maybe we can remove this in the near future
 
 # Reference to API GW url 
-mkdocs/docs/deployment/oda.md 
+# mkdocs/docs/deployment/oda.md  # masked sensitive data 
 
 # Reference to OCI tenancy 
-mkdocs/docs/deployment/trust-service.c.md
-mkdocs/docs/deployment/trust-service.md
+# mkdocs/docs/deployment/trust-service.c.md # cleaned sensitive data. There are a couple references to artifactory here
+# mkdocs/docs/deployment/trust-service.md # cleaned
 
 # Reference to IDCS/API GW 
-mkdocs/docs/deployment/trust-ui.md 
-mkdocs/docs/deployment/validation.md 
-mkdocs/docs/deployment/VBCS.md 
+# mkdocs/docs/deployment/trust-ui.md 
+# mkdocs/docs/deployment/validation.md # cleaned
+# mkdocs/docs/deployment/VBCS.md # masked
 
 # ips 
-/mkdocs/docs/rest/nl2sql-trust/installation.md
+# /mkdocs/docs/rest/nl2sql-trust/installation.md # masked ips 
 
 # Reference to OCIDs 
 /mkdocs/Finetune-DAC/finetune-dac-python.py

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2024 Oracle and/or its affiliates.
+Copyright (c) 2025 Oracle and/or its affiliates.
 
 The Universal Permissive License (UPL), Version 1.0
 

NOTICE.txt

@@ -0,0 +1,4 @@
+This software is licensed under the Universal Permissive License (UPL) 1.0
+
+The Universal Permissive License (UPL), Version 1.0
+Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.

README.md

@@ -64,29 +64,30 @@ I ran a dry deployment using the cleaned repo on our tenancy. Listed are some of
     - Would have to be refactored if using e.g. cohere on demand 
 - The existing documentation suggests deploying api gateway on private subnet due to lack of authentication. 
     - I was able to deploy the api gateway on public subnet with oauth2.0 authentication to idcs server and invoke from oda with token, so not sure why private subnet deployment for api gateway is suggested
+    - Possible separate deployment down the line for connecting customer vpn
 - The existing code expects api keys and wallets configured directly on the server, at least for the client business engine 
+    - Possible future code refactor
 - Redis is required but no instructions given 
 - There was no example data given for the vendors table, so I exported the table from the main deployment as a csv and imported to ours
     - Vendors table is for client business db 
-    - How do we want to provide this csv?
+    - Provided csv in clientApp folder
 - The business app is dependent on the trust db (trust library), i.e. the trusted prompts, which isn't intuitive 
     - The code expects the TRUST_LIBRARY table to have at least one entry, otherwise it bombs 
     - I provided a sample entry in the sql file 
-The sql for the client business db is outside the clientapp directory, & there are no instructions given on which db to upload to (upload to business db)
-
-The business app is exposed on an API Gateway with the main entry /prompt, which maps to <business-app-ip>:8000... this will be used by ODA app.
+- The sql for the client business db is outside the clientapp directory
+    - There are no instructions given on which db to upload to 
+        - Execute nl2sql_datamodel_schema on business db 
+        - sample_setup_ras seems to apply to trust db
+            - sample_setup_ras wasn't required to run the business app 
+- The business app is exposed on an API Gateway with the main entry /prompt, which maps to <business-app-ip>:8000... this will be used by ODA app.
 
 There are a handful of files required and provided within the repo, but no instructions on how/when to use them. 
 Examples include : 
-1. Under sql, nl2sql_datamodel_schema.sql needds to be ran in the trust database 
-    - Was able to run the client engine without the sql/sample_setup_ras.sql file. 
-    - This is a prequisite to run the business client engine, which isn't intuitive 
-2. Within the rest (trust) directory there are docker files... I think we can remove these? 
+1. Within the rest (trust) directory there are docker files... I think we can remove these? 
     - Haven't tested full trust deployment yet.
-
-Some files I don't think are necessary at all 
-1. autoprompt 
 2. mkdocs... this is documentation we can perhaps repurpose (at least the md files)
+    - Repurposed documentation in latest commit
+3. sqlGenApp. Not sure where this is used
 
 Below are the various requirements and findings from deploying the infrastructure components on our tenancy - 
 
@@ -105,31 +106,33 @@ Below are the various requirements and findings from deploying the infrastructur
 
 1. The zipped askdata vbcs app in here looks to be outdated. 
     - It's a more simple implementation, which might be best for now
+    - The deployment with the extra navigation pane uses new apis on the engine 
+        - These apis haven't been pushed to main yet
 2. Reference to websocket - to be deprecated? Need to test if working without 
     - Tested, seems to be unnecessary
-3. App import relies on various images in the directory... do we want to provide these images in the repo?
-    - I'm going to include them for now, since they are dependencies
 
 ### API Gateway 
 1. API Gateway is configured with Single Authentication OAuth2.0 which requires a vault. 
 2. The existing mkdocs documentation said to deploy the api gateway to private subnet due to lack of authentication... authentication can be added to api gateway on public subnet 
+    - Can possibly add different implementation later for connecting to customer vpn 
 
 ### Redis 
 1. Redis is required but there were no instructions given on configuration
 
 ### Generative AI 
 1. Existing deployment was using dedicated ai cluster/data science. I was able to get it to work with on demand model. 
     - Code is hard coded to handle only the llama models. Cohere models would require refactoring. 
+    - Haven't tested the deployment with dedicated cluster. This would require gpus which we don't have for our tenancy
+    - Haven't tested data science deployment
 
 ### NL2SQL Business Engine 
-1. The code is currently expecting the user to upload their own api keys 
+1. The code is currently expecting the user to upload their own api keys to the server
 2. Database wallets need to be uploaded manually 
 3. png files trusted & untrusted.png are required to run the server.
-4. autoprompt - need to test if working without (deprecated?)
 
 ### Client Database
 1. The vendors table didn't have any example data. I had to export the table from the existing implementation and import as csv 
-    - Do we want to include this csv in the repo, or add to object storage bucket and provide link? 
+    - Included csv in repo
 
 ### Trust Database
 1. Engine code expects at least one entry in Trust library table before execution
@@ -139,5 +142,9 @@ Below are the various requirements and findings from deploying the infrastructur
 Haven't gotten this far, but the basic prompt endpoint does use the trust library table. 
 
 ## APEX
-tbd ... do we want to include this in the first version? 
+tbd ...
+
+### Troubleshooting 
 
+1. Graph isn't showing in Table Graph VB App
+    - Solution: Make sure to assign user role to idcs group in app settings