IaC and Renaming (#138)

* Github Rename
* Update Terraform
* Tags Workflow
* Documentation
* Fix for settings patching
* Updated Settings Tests
* Got OCI?
* Build Helm Chart

Author: gotsysdba

.github/workflows/documentation.yml

@@ -1,13 +1,14 @@
 # Workflow for deploying static documentation
-name: Deploy Documentation to Pages
+name: Deploy Documentation/Helm to Pages
 
 on:
   push:
     branches:
       - main
-    # Limit runs to only when docs change
+    # Limit runs to only when docs/helm change
     paths:
-      - 'docs/**'
+      - "docs/**"
+      - "helm/**"
 
   # Allows running this workflow manually
   workflow_dispatch:
@@ -39,25 +40,31 @@ jobs:
       - name: Install Hugo CLI
         run: |
           wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
-          && sudo dpkg -i ${{ runner.temp }}/hugo.deb          
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+
       - name: Install Dart Sass
         run: sudo snap install dart-sass
+
       - name: Checkout
         uses: actions/checkout@v4
         with:
           submodules: recursive
           fetch-depth: 0
+
       - name: Download Hugo Theme
         run: |
           mkdir -p docs/themes/relearn \
           && 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
+
       - name: Install Node.js dependencies
         run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
+
       - name: Build with Hugo
         env:
           HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache
@@ -68,7 +75,14 @@ jobs:
             --gc \
             --minify \
             --source docs \
-            --baseURL "${{ steps.pages.outputs.base_url }}/"          
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+
+      - name: Package Helm chart
+        run: |
+          mkdir -p docs/public/helm
+          helm package helm -d docs/public/helm
+          helm repo index docs/public/helm --url "${{ steps.pages.outputs.base_url }}/helm"
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.github/workflows/releases.yml

@@ -0,0 +1,39 @@
+name: Build Release
+on:
+  release:
+    types: [published]
+
+env:
+  IAC: ${GITHUB_REPOSITORY#${GITHUB_REPOSITORY_OWNER}/}-stack.zip
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      packages: write
+      id-token: write
+
+    steps:
+      - name: Output Environment
+        run: |
+          echo "IaC: ${{ env.IAC }}"
+      
+      - name: Validate Tag Name
+        run: |
+          if [[ ! $GITHUB_REF_NAME =~ ^v[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
+            echo "Invalid tag name format. Must be in the format vMAJOR.MINOR.PATCH"
+            exit 1
+          fi
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Build and Push Infrastructure as Code
+        run: |
+          cd opentofu
+          zip -r ${{ env.IAC }} . -x "terraform*" ".terraform*" "*/terraform*" "*/.terraform*" "generated/*"
+          gh release upload ${{github.event.release.tag_name}} ${{ env.IAC }} --clobber
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        shell: bash

.gitignore

@@ -3,15 +3,16 @@
 # Project/User Specific
 ##############################################################################
 **/*.log
+**/*.zip
 **/requirements.txt
-app/THIRD_PARTY_LICENSES.txt
+**/THIRD_PARTY_LICENSES.txt
 sbin/**
 **/*.bak
 **/tmp/**
 **/temp/**
 **/chatbot_graph.png
 **/*.sh
-!opentofu/templates/cloudinit-oke.sh
+!opentofu/**/cloudinit-oke.sh
 !src/entrypoint.sh
 !src/client/spring_ai/templates/env.sh
 tests/db_startup_temp/**
@@ -44,7 +45,8 @@ __pycache__/
 **/**.tfvars
 **/.terraform*
 **/terraform.tfstate*
-opentofu/**/examples/*.yaml
+opentofu/**/generated/*.*
+opentofu/**/generated/kubeconfig
 
 ##############################################################################
 # Helm
@@ -55,7 +57,7 @@ helm/values*.yaml
 ##############################################################################
 # Random
 ##############################################################################
-spring_ai/src/main/resources/data/explorer_settings.json
+spring_ai/src/main/resources/data/optimizer_settings.json
 spring_ai/target/**
 spring_ai/create_user.sql
 spring_ai/drop.sql

README.md

@@ -1,14 +1,14 @@
-# Oracle AI Explorer for Apps
+# Oracle AI Optimizer and Toolkit
 
 <!-- spell-checker:ignore streamlit, venv, setuptools -->
 
-🚧 The **AI Explorer** is currently in *Beta*
+🚧 The **AI Optimizer** is currently in *Beta*
 
 ## Description
 
-The **Oracle AI Explorer for Apps** (the **AI Explorer**) provides a streamlined environment where developers and data scientists can explore the potential of Generative Artificial Intelligence (GenAI) combined with Retrieval-Augmented Generation (RAG) capabilities. By integrating **Oracle Database 23ai** AI Vector Search, the Sandbox enables users to enhance existing Large Language Models (LLMs) through RAG.
+The **Oracle AI Optimizer and Toolkit** (the **AI Optimizer**) provides a streamlined environment where developers and data scientists can explore the potential of Generative Artificial Intelligence (GenAI) combined with Retrieval-Augmented Generation (RAG) capabilities. By integrating **Oracle Database 23ai** AI Vector Search, the Sandbox enables users to enhance existing Large Language Models (LLMs) through RAG.
 
-## AI Explorer Features
+## AI Optimizer Features
 
 - [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)
@@ -18,7 +18,7 @@ The **Oracle AI Explorer for Apps** (the **AI Explorer**) provides a streamlined
 
 ## 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.
+The **AI Optimizer** 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/ai-explorer).
 
@@ -61,7 +61,7 @@ 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/ai-explorer/client/configuration) the **Explorer**.
+1. [Configure](https://oracle-samples.github.io/ai-explorer/client/configuration) the **AI Optimizer**.
 
 #### Container Installation
 
@@ -73,18 +73,23 @@ To run the application in a container; download the [source](https://github.com/
 
    ```bash
    cd src/
-   podman build -t ai-explorer-aio .
+   podman build -t ai-optimizer-aio .
    ```
 
 1. Start the Container:
 
    ```bash
-   podman run -p 8501:8501 -it --rm ai-explorer-aio
+   podman run -p 8501:8501 -it --rm ai-optimizer-aio
    ```
 
 1. Navigate to `http://localhost:8501`.
 
-1. [Configure](https://oracle-samples.github.io/ai-explorer/client/configuration/index.html) the **Explorer**.
+1. [Configure](https://oracle-samples.github.io/ai-explorer/client/configuration/index.html) the **AI Optimizer**.
+
+##### Got OCI?
+The **AI Optimizer** can be deployed with an Oracle Autonomous Database 23ai using infrastructure as code.  Deploy the **AI Optimizer** in Oracle Cloud Infrastructure using OCI Resource Manager:
+
+[![Deploy to Oracle Cloud][magic_button]][magic_arch_stack]
 
 ## Contributing
 
@@ -100,3 +105,7 @@ Copyright (c) 2024 Oracle and/or its affiliates.
 Released under the Universal Permissive License v1.0 as shown at [https://oss.oracle.com/licenses/upl/](https://oss.oracle.com/licenses/upl/)
 
 See [LICENSE](./LICENSE.txt) for more details.
+
+
+[magic_button]: https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg
+[magic_arch_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle-samples/ai-explorer/releases/latest/download/ai-optimizer-stack.zip

docs/README.md

@@ -1,12 +1,12 @@
-# Oracle AI Explorer for Apps - Documentation
+# Oracle AI Optimizer & Toolkit - Documentation
 
 ## Description
 
-This directory contains the documentation for the the [**Oracle AI Explorer for Apps**](https://github.com/oracle-samples/ai-explorer).
+This directory contains the documentation for the the [**Oracle AI Optimizer & Toolkit**](https://github.com/oracle-samples/ai-explorer).
 
 ## Getting Started - Documentation
 
-The **Oracle AI Explorer for Apps** documentation is powered by [Hugo](https://gohugo.io/) using the [Relearn](https://github.com/McShelby/hugo-theme-relearn) theme.
+The **Oracle AI Optimizer & Toolkit** documentation is powered by [Hugo](https://gohugo.io/) using the [Relearn](https://github.com/McShelby/hugo-theme-relearn) theme.
 
 To contribute to the documentation, install [Hugo](https://gohugo.io/installation/). Installation instructions vary per Operating System.
 

docs/assets/css/theme-docs-dark.css

@@ -55,4 +55,8 @@ div.box, div.box code .copy-to-clipboard {
 #R-body img[src$='#floatright'] {
     float:right;
     margin-left: 1em;
+}
+
+#R-logo .powered-by {
+    font-family: "MontserratAlt1-Light",sans-serif
 }

docs/assets/css/theme-docs-light.css

@@ -55,4 +55,8 @@ div.box, div.box code .copy-to-clipboard {
 #R-body img[src$='#floatright'] {
     float:right;
     margin-left: 1em;
+}
+
+#R-logo .powered-by {
+    font-family: "MontserratAlt1-Light",sans-serif
 }

docs/content/_index.md

@@ -2,8 +2,8 @@
 title = " "
 menus = 'main'
 archetype = "home"
-description = 'Oracle AI Explorer for Apps'
-keywords = 'oracle explorer microservices development genai rag'
+description = './oai-explorer/docs'
+keywords = 'oracle optimizer toolkit microservices development genai rag'
 +++  
 
 <!--
@@ -34,8 +34,8 @@ The {{< short_app_ref >}} streamlines the entire workflow from prototyping to pr
 The {{< short_app_ref >}} 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.
 
 {{% notice style="code" title="Prefer a Step-by-Step?" icon="circle-info" %}}
-<!-- Hard-coding AI Explorer to avoid unsafe HTML, this is an exception -->
-The [Walkthrough](walkthrough) is a great way to familiarize yourself with the **AI Explorer** and its features in a development environment.
+<!-- Hard-coding AI Optimizer to avoid unsafe HTML, this is an exception -->
+The [Walkthrough](walkthrough) is a great way to familiarize yourself with the **AI Optimizer** and its features in a development environment.
 {{% /notice %}}
 
 ## Prerequisites
@@ -88,17 +88,17 @@ To run the application in a container; download the [source]({{ .Site.Params.Git
 
 1. Build the image.
 
-   From inside the `src/` directory, build the *ai-explorer-aio* image:
+   From inside the `src/` directory, build the *ai-optimizer-aio* image:
 
    ```bash
    cd src/
-   podman build -t ai-explorer-aio .
+   podman build -t ai-optimizer-aio .
    ```
 
 1. Start the Container:
 
    ```bash
-   podman run -p 8501:8501 -it --rm ai-explorer-aio
+   podman run -p 8501:8501 -it --rm ai-optimizer-aio
    ```
 
 1. Navigate to `http://localhost:8501`.