added basic files for devrel

JBAnderson5 · JBAnderson5 · commit 0ac25a5ee7a6 · 2025-08-26T09:41:00.000-07:00
diff --git a/README-old.md b/README-old.md
@@ -0,0 +1,111 @@
+# nl2sql
+
+## Deployment Steps
+
+1. Deploy Terraform Script
+2. Configure Business App
+    - Configure Business DB
+    - Configure Trust DB
+3. Configure IDCS App
+4. Configure API Gateway
+5. Configure Trust App
+6. Configure ODA Skills
+7. Configure VB Apps 
+
+### TBD 
+8. Deploy Trust Framework
+9. Deploy APEX
+
+## Overview
+
+I ran a dry deployment using the cleaned repo on our tenancy. Listed are some of my findings & outstanding questions. 
+
+- I was able to get the client business app deployed on our tenancy. A few things I noticed - 
+    - The code expects a llama model, at least for the on demand configuration
+    - 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 
+    - 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 
+        - 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. Within the rest (trust) directory there are docker files... I think we can remove these? 
+    - Haven't tested full trust deployment yet.
+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 - 
+
+### ODA 
+
+1. Configure IDCS Server first 
+    - ODA skill expects a token to execute
+    - Configured manually for now. Expects ODA client callback to work
+2. Configured API gateway with nl2sql engine backend - provide api gateway endpoint in skill
+    - Configured bearer token with IDCS app 
+3. There are two skill zips that don't seem to be used and not referenced in the documentation - 
+    - oda-skill-EmbeddedCont.changeit.zip
+    - oda-skill-ExtOracleFn.changeit.zip 
+
+### VBCS 
+
+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
+
+### 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 to the server
+2. Database wallets need to be uploaded manually 
+3. png files trusted & untrusted.png are required to run the server.
+
+### 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 
+    - Included csv in repo
+
+### Trust Database
+1. Engine code expects at least one entry in Trust library table before execution
+    - Provided an example entry with sample embedding
+
+### Trust REST Framework
+Haven't gotten this far, but the basic prompt endpoint does use the trust library table. 
+
+## APEX
+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 
diff --git a/README.md b/README.md
@@ -39,112 +39,3 @@ Licensed under the Universal Permissive License (UPL), Version 1.0.
 See [LICENSE](LICENSE.txt) for more details.
 
 ORACLE AND ITS AFFILIATES DO NOT PROVIDE ANY WARRANTY WHATSOEVER, EXPRESS OR IMPLIED, FOR ANY SOFTWARE, MATERIAL OR CONTENT OF ANY KIND CONTAINED OR PRODUCED WITHIN THIS REPOSITORY, AND IN PARTICULAR SPECIFICALLY DISCLAIM ANY AND ALL IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.  FURTHERMORE, ORACLE AND ITS AFFILIATES DO NOT REPRESENT THAT ANY CUSTOMARY SECURITY REVIEW HAS BEEN PERFORMED WITH RESPECT TO ANY SOFTWARE, MATERIAL OR CONTENT CONTAINED OR PRODUCED WITHIN THIS REPOSITORY. IN ADDITION, AND WITHOUT LIMITING THE FOREGOING, THIRD PARTIES MAY HAVE POSTED SOFTWARE, MATERIAL OR CONTENT TO THIS REPOSITORY WITHOUT ANY REVIEW. USE AT YOUR OWN RISK. 
-## Deployment Steps
-
-1. Deploy Terraform Script
-2. Configure Business App
-    - Configure Business DB
-    - Configure Trust DB
-3. Configure IDCS App
-4. Configure API Gateway
-5. Configure Trust App
-6. Configure ODA Skills
-7. Configure VB Apps 
-
-### TBD 
-8. Deploy Trust Framework
-9. Deploy APEX
-
-## Overview
-
-I ran a dry deployment using the cleaned repo on our tenancy. Listed are some of my findings & outstanding questions. 
-
-- I was able to get the client business app deployed on our tenancy. A few things I noticed - 
-    - The code expects a llama model, at least for the on demand configuration
-    - 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 
-    - 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 
-        - 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. Within the rest (trust) directory there are docker files... I think we can remove these? 
-    - Haven't tested full trust deployment yet.
-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 - 
-
-### ODA 
-
-1. Configure IDCS Server first 
-    - ODA skill expects a token to execute
-    - Configured manually for now. Expects ODA client callback to work
-2. Configured API gateway with nl2sql engine backend - provide api gateway endpoint in skill
-    - Configured bearer token with IDCS app 
-3. There are two skill zips that don't seem to be used and not referenced in the documentation - 
-    - oda-skill-EmbeddedCont.changeit.zip
-    - oda-skill-ExtOracleFn.changeit.zip 
-
-### VBCS 
-
-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
-
-### 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 to the server
-2. Database wallets need to be uploaded manually 
-3. png files trusted & untrusted.png are required to run the server.
-
-### 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 
-    - Included csv in repo
-
-### Trust Database
-1. Engine code expects at least one entry in Trust library table before execution
-    - Provided an example entry with sample embedding
-
-### Trust REST Framework
-Haven't gotten this far, but the basic prompt endpoint does use the trust library table. 
-
-## APEX
-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 
diff --git a/thirdpartynotices.txt b/thirdpartynotices.txt
