Update Build Doco Action (#123)

gotsysdba · web-flow · commit 26a9c6ca4515 · 2025-03-27T10:10:51.000Z
* Update Documentation Action
* Update README
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -34,7 +34,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     env:
-      HUGO_VERSION: 0.134.1
+      HUGO_VERSION: 0.145.0
     steps:
       - name: Install Hugo CLI
         run: |
@@ -50,7 +50,9 @@ jobs:
       - name: Download Hugo Theme
         run: |
           mkdir -p docs/themes/relearn \
-          && wget -qO- $(curl -s https://api.github.com/repos/McShelby/hugo-theme-relearn/releases/latest | grep "tarball_url" | awk -F'"' '{print $4}') | tar --exclude='*/exampleSite' -xz -C docs/themes/relearn --strip-components=1
+          && curl -L $(curl -s https://api.github.com/repos/McShelby/hugo-theme-relearn/releases/latest \
+          | grep "tarball_url" | cut -d '"' -f 4) \
+          | tar -xz -C docs/themes/relearn --strip-components=1 --exclude='*/exampleSite'
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
diff --git a/README.md b/README.md
@@ -10,17 +10,17 @@ The **Oracle AI Explorer for Apps** (the **AI Explorer**) provides a streamlined
 
 ## AI Explorer Features
 
-- [Configuring Embedding and Chat Models](https://oracle-samples.github.io/oaim-sandbox/sandbox/configuration/model_config)
-- [Splitting and Embedding Documentation](https://oracle-samples.github.io/oaim-sandbox/sandbox/tools/split_embed)
-- [Modifying System Prompts (Prompt Engineering)](https://oracle-samples.github.io/oaim-sandbox/sandbox/tools/prompt_eng)
-- [Experimenting with **LLM** Parameters](https://oracle-samples.github.io/oaim-sandbox/sandbox/chatbot)
-- [Testbed for auto-generated or existing Q&A datasets](https://oracle-samples.github.io/oaim-sandbox/sandbox/testbed)
+- [Configuring Embedding and Chat Models](https://oracle-samples.github.io/ai-explorer/client/configuration/model_config)
+- [Splitting and Embedding Documentation](https://oracle-samples.github.io/ai-explorer/client/tools/split_embed)
+- [Modifying System Prompts (Prompt Engineering)](https://oracle-samples.github.io/ai-explorer/client/tools/prompt_eng)
+- [Experimenting with **LLM** Parameters](https://oracle-samples.github.io/ai-explorer/client/chatbot)
+- [Testbed for auto-generated or existing Q&A datasets](https://oracle-samples.github.io/ai-explorer/client/testbed)
 
 ## Getting Started
 
 The **AI Explorer** is available to install in your own environment, which may be a developer's desktop, on-premises data center environment, or a cloud provider. It can be run either on bare-metal, within a container, or in a Kubernetes Cluster.
 
-For more information, including more details on **Setup and Configuration** please visit the [documentation](https://oracle-samples.github.io/oaim-sandbox).
+For more information, including more details on **Setup and Configuration** please visit the [documentation](https://oracle-samples.github.io/ai-explorer).
 
 ### Prerequisites
 
@@ -31,11 +31,11 @@ For more information, including more details on **Setup and Configuration** plea
   - API Keys for Third-Party Models
   - On-Premises Models<sub>\*</sub>
 
-<sub>\*Oracle recommends running On-Premises Models on hardware with GPUs. For more information, please review the [Infrastructure](https://oracle-samples.github.io/oaim-sandbox/infrastructure) documentation.</sub>
+<sub>\*Oracle recommends running On-Premises Models on hardware with GPUs. For more information, please review the [Infrastructure](https://oracle-samples.github.io/ai-explorer/infrastructure) documentation.</sub>
 
 #### Bare-Metal Installation
 
-To run the application on bare-metal; download the [source](https://github.com/oracle-samples/oaim-sandbox) and from `src/`:
+To run the application on bare-metal; download the [source](https://github.com/oracle-samples/ai-explorer) and from `src/`:
 
 1. Create and activate a Python Virtual Environment:
 
@@ -61,11 +61,11 @@ To run the application on bare-metal; download the [source](https://github.com/o
 
 1. Navigate to `http://localhost:8501`.
 
-1. [Configure](https://oracle-samples.github.io/oaim-sandbox/sandbox/configuration) the **Explorer**.
+1. [Configure](https://oracle-samples.github.io/ai-explorer/client/configuration) the **Explorer**.
 
 #### Container Installation
 
-To run the application in a container; download the [source](https://github.com/oracle-samples/oaim-sandbox):
+To run the application in a container; download the [source](https://github.com/oracle-samples/ai-explorer):
 
 1. Build the all-in-one image.
 
@@ -84,7 +84,7 @@ To run the application in a container; download the [source](https://github.com/
 
 1. Navigate to `http://localhost:8501`.
 
-1. [Configure](https://oracle-samples.github.io/oaim-sandbox/sandbox/configuration/index.html) the **Explorer**.
+1. [Configure](https://oracle-samples.github.io/ai-explorer/client/configuration/index.html) the **Explorer**.
 
 ## Contributing
 
diff --git a/docs/README.md b/docs/README.md
@@ -2,7 +2,7 @@
 
 ## Description
 
-This directory contains the documentation for the the [**Oracle AI Explorer for Apps**](https://github.com/oracle-samples/oaim-sandbox).
+This directory contains the documentation for the the [**Oracle AI Explorer for Apps**](https://github.com/oracle-samples/ai-explorer).
 
 ## Getting Started - Documentation
 
@@ -25,4 +25,4 @@ From the `docs` directory:
 
 1. Start Hugo: `hugo serve`
 
-This will serve the documentation on `http://localhost:1313/oaim-sandbox/` for review.
+This will serve the documentation on `http://localhost:1313/ai-explorer/` for review.
diff --git a/opentofu/oci/schema.yaml b/opentofu/oci/schema.yaml
@@ -0,0 +1,255 @@
+# Copyright © 2023, 2025, Oracle and/or its affiliates.
+# All rights reserved. The Universal Permissive License (UPL), Version 1.0 as shown at http://oss.oracle.com/licenses/upl
+
+title: "Oracle AI Explorer for Apps"
+description: "Explore the capabilities of AI with the Oracle Database."
+schemaVersion: 1.1.0
+version: "20190304"
+logoUrl: https://github.com/oracle-samples/ai-explorer/blob/main/docs/static/images/logo.png
+locale: "en"
+
+variableGroups:
+  #########################################################################
+  # Hidden
+  #########################################################################
+  - title: "Default Hidden"
+    variables:
+      - tenancy_ocid
+      - region
+      - user_ocid
+      - current_user_ocid
+      - fingerprint
+      - private_key_path
+      - private_key
+    visible: false
+
+  - title: "Hidden (Defaults)"
+    variables:
+      - adb_version
+      - k8s_version
+      - k8s_worker_os_ver
+      - service_lb_allowed_app_client_port
+      - service_lb_allowed_app_server_port
+    visible: false
+
+  #########################################################################
+  # General (Backend as a Service)
+  #########################################################################
+  - title: "AI Explorer"
+    variables:
+      - compartment_ocid
+      - label_prefix
+    visible: true
+
+  #########################################################################
+  # Database
+  #########################################################################
+  - title: "Database Options"
+    variables:
+      - adb_license_model
+      - adb_edition
+      - adb_whitelist_cidrs
+      - adb_ecpu_core_count
+      - adb_is_cpu_auto_scaling_enabled
+      - adb_data_storage_size_in_gb
+      - adb_is_storage_auto_scaling_enabled
+    visible: true
+
+  #########################################################################
+  # Kubernetes Cluster
+  #########################################################################
+  - title: "Kubernetes Cluster Options"
+    variables:
+      - k8s_api_is_public
+      - k8s_api_endpoint_allowed_cidrs
+      - k8s_node_pool_cpu_size
+      - k8s_worker_cpu_shape
+      - k8s_worker_cpu_ocpu
+      - k8s_node_pool_gpu_deploy
+      - k8s_node_pool_gpu_size
+      - k8s_worker_gpu_shape
+    visible: true
+
+  #########################################################################
+  # Load Balancer
+  #########################################################################
+  - title: "Load Balancers Options"
+    variables:
+      - service_lb_is_public
+      - service_lb_min_shape
+      - service_lb_max_shape
+      - service_lb_allowed_app_client_cidrs
+      - service_lb_allowed_app_server_cidrs
+
+    visible: true
+
+###########################################################################
+variables:
+  compartment_ocid:
+    type: oci:identity:compartment:id
+    title: "Compartment"
+    required: true
+
+  label_prefix:
+    type: string
+    title: "Application Name"
+    pattern: "^$|^[a-zA-Z0-9]{1,12}$"
+    required: false
+
+  #########################################################################
+  adb_license_model:
+    type: enum
+    title: "Autonomous Database License Model"
+    required: true
+    default: "LICENSE_INCLUDED"
+    enum:
+      - "LICENSE_INCLUDED"
+      - "BRING_YOUR_OWN_LICENSE"
+
+  adb_edition:
+    type: enum
+    title: "Oracle Database Edition"
+    required: true
+    default: "ENTERPRISE_EDITION"
+    enum:
+      - "ENTERPRISE_EDITION"
+      - "STANDARD_EDITION"
+    visible:
+      and:
+        - eq:
+            - adb_license_model
+            - BRING_YOUR_OWN_LICENSE
+
+  adb_whitelist_cidrs:
+    type: array
+    title: "ADB Access Control"
+    required: true
+    default: "0.0.0.0/0"
+    pattern: "((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\/(3[0-2]|[1-2]?[0-9])(,?)( ?)){1,}$"
+
+  adb_ecpu_core_count:
+    type: number
+    title: "Autonomous Database Core Count"
+    required: true
+    minimum: 2
+    multipleOf: 1
+
+  adb_is_cpu_auto_scaling_enabled:
+    type: boolean
+    title: "Allow Autonomous Database CPU Auto Scaling? (3x CPU)"
+    required: true
+
+  adb_data_storage_size_in_gb:
+    type: number
+    title: "Autonomous Database Data Storage Size (GB)"
+    description: ""
+    required: true
+    minimum: 20
+    maximum: 393216
+    multipleOf: 1
+
+  adb_is_storage_auto_scaling_enabled:
+    type: boolean
+    title: "Allow Autonomous Database Storage Auto Scaling?"
+    required: true
+
+  #########################################################################
+  k8s_api_is_public:
+    type: boolean
+    title: "Public API Endpoint?"
+    required: true
+
+  k8s_api_endpoint_allowed_cidrs:
+    type: array
+    title: "API Endpoint Access Control"
+    required: true
+    default: "0.0.0.0/0"
+    pattern: "$|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\/(3[0-2]|[1-2]?[0-9])(,?)( ?)){1,}$"
+    visible: k8s_api_is_public
+
+  k8s_node_pool_cpu_size:
+    type: integer
+    title: "CPU Node Pool Workers"
+    required: true
+    minimum: 1
+    maximum: 80
+    multipleOf: 1
+
+  k8s_worker_cpu_shape:
+    type: enum
+    title: "CPU Node Pool Worker Shape"
+    required: true
+    enum:
+      - "VM.Standard.E5.Flex"
+      - "VM.Standard.E4.Flex"
+
+  k8s_worker_cpu_ocpu:
+    type: integer
+    title: "CPU Worker Core Count"
+    required: true
+    minimum: 1
+    maximum: 64
+    multipleOf: 1
+
+  k8s_node_pool_gpu_deploy:
+    type: boolean
+    title: "Deploy GPU Node Pool?"
+    required: true
+
+  k8s_worker_gpu_shape:
+    type: enum
+    title: "Node Pool Worker Shape"
+    required: true
+    default: "VM.GPU.A10.1"
+    enum:
+      - "VM.GPU.A10.1"
+    visible: k8s_node_pool_gpu_deploy
+
+  k8s_node_pool_gpu_size:
+    type: integer
+    title: "GPU Node Pool Workers"
+    required: true
+    minimum: 1
+    maximum: 80
+    multipleOf: 1
+    visible: k8s_node_pool_gpu_deploy
+
+  #########################################################################
+  service_lb_is_public:
+    type: boolean
+    title: "Enable Ingress through Public Load Balancer?"
+    default: true
+
+  service_lb_min_shape:
+    type: integer
+    title: "Minimum Load Balancer Bandwidth (Mbps)"
+    required: true
+    minimum: 10
+    maximum: 10
+    multipleOf: 10
+    visible: service_lb_is_public
+
+  service_lb_max_shape:
+    type: integer
+    title: "Maximum Load Balancer Bandwidth (Mbps)"
+    required: true
+    minimum: 10
+    maximum: 8000
+    multipleOf: 10
+    visible: service_lb_is_public
+
+  service_lb_allowed_app_client_cidrs:
+    type: array
+    title: "Public Load Balancer Access Control for GUI"
+    required: true
+    default: "0.0.0.0/0"
+    pattern: "((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\/(3[0-2]|[1-2]?[0-9])(,?)( ?)){1,}$"
+    visible: service_lb_is_public
+
+  service_lb_allowed_app_server_cidrs:
+    type: array
+    title: "Public Load Balancer Access Control for Application Server"
+    required: true
+    default: "0.0.0.0/0"
+    pattern: "((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\/(3[0-2]|[1-2]?[0-9])(,?)( ?)){1,}$"
+    visible: service_lb_is_public
diff --git a/src/client/spring_ai/README.md b/src/client/spring_ai/README.md
@@ -1,7 +1,7 @@
 # Spring AI template
 
 ## How to run:
-Prepare two configurations in the `oaim-sandbox`, based on vector stores created using this kind of configuration:
+Prepare two configurations in the `ai-explorer`, based on vector stores created using this kind of configuration:
 
 * OLLAMA: 
   * Embbeding model: mxbai-embed-large
@@ -150,10 +150,10 @@ llama3.1:latest             a80c4f17acd5    2.0 GB    3 minutes ago
 kubectl -n ollama exec svc/ollama -- ollama run "llama3.1" "what is spring boot?"
 ```
 
-* **NOTE**: The Microservices will access to the ADB23ai on which the vector store table should be created as done in the local desktop example shown before. To access the OAIM-Sandbox running on **Oracle Backend for Microservices and AI** and create the same configuration, let's do:
+* **NOTE**: The Microservices will access to the ADB23ai on which the vector store table should be created as done in the local desktop example shown before. To access the ai-explorer running on **Oracle Backend for Microservices and AI** and create the same configuration, let's do:
   * tunnel:
   ```
-  kubectl -n oaim-sandbox port-forward svc/oaim-sandbox 8181:8501 
+  kubectl -n ai-explorer port-forward svc/ai-explorer 8181:8501 
   ```
   * on localhost:
   ```
@@ -173,7 +173,7 @@ kubectl -n ollama exec svc/ollama -- ollama run "llama3.1" "what is spring boot?
   ```
 
 
-* the `bind` will create the new user, if not exists, but to have the `<VECTOR_STORE>_SPRINGAI` table compatible with SpringAI Oracle vector store adapter, the microservices need to access to the vector store table created by the OAIM-sandbox with user ADMIN on ADB:
+* the `bind` will create the new user, if not exists, but to have the `<VECTOR_STORE>_SPRINGAI` table compatible with SpringAI Oracle vector store adapter, the microservices need to access to the vector store table created by the ai-explorer with user ADMIN on ADB:
 
 ```
 GRANT SELECT ON ADMIN.<VECTOR_STORE> TO vector;
