From 6d8fd9a7037f89cdaf0687967d7b1a9c875582b4 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Wed, 20 Aug 2025 15:33:25 -0400 Subject: [PATCH] OLS-2040: Delete OLS files that are not used --- modules/ols-about-azure-openai.adoc | 8 ---- modules/ols-about-openai.adoc | 6 --- modules/ols-about-rhelai.adoc | 13 ------ modules/ols-about-rhoai.adoc | 11 ----- modules/ols-about-watsonx.adoc | 8 ---- modules/ols-asking-about-cluster-state.adoc | 42 ----------------- ...eting-lightspeed-installation-process.adoc | 45 ------------------- modules/ols-release-0-3-0-known-issues.adoc | 13 ------ modules/ols-release-notes-known-issues.adoc | 13 ------ 9 files changed, 159 deletions(-) delete mode 100644 modules/ols-about-azure-openai.adoc delete mode 100644 modules/ols-about-openai.adoc delete mode 100644 modules/ols-about-rhelai.adoc delete mode 100644 modules/ols-about-rhoai.adoc delete mode 100644 modules/ols-about-watsonx.adoc delete mode 100644 modules/ols-asking-about-cluster-state.adoc delete mode 100644 modules/ols-completing-lightspeed-installation-process.adoc delete mode 100644 modules/ols-release-0-3-0-known-issues.adoc delete mode 100644 modules/ols-release-notes-known-issues.adoc diff --git a/modules/ols-about-azure-openai.adoc b/modules/ols-about-azure-openai.adoc deleted file mode 100644 index f9721b548b9d..000000000000 --- a/modules/ols-about-azure-openai.adoc +++ /dev/null @@ -1,8 +0,0 @@ -// Module included in the following assemblies: -// about/ols-about-openshift-lightspeed.adoc - -:_mod-docs-content-type: CONCEPT -[id="ols-about-azure-openai_{context}"] -= About Azure OpenAI - -To use {azure-official} with {ols-official}, you must have access to {azure-openai}. \ No newline at end of file diff --git a/modules/ols-about-openai.adoc b/modules/ols-about-openai.adoc deleted file mode 100644 index 42163616c7b4..000000000000 --- a/modules/ols-about-openai.adoc +++ /dev/null @@ -1,6 +0,0 @@ -:_mod-docs-content-type: CONCEPT -[id="ols-about-openai"] -= About OpenAI -:context: ols-about-openai - -To use {openai} with {ols-official}, you will need access to the {openai} link:https://openai.com/api/[API platform]. diff --git a/modules/ols-about-rhelai.adoc b/modules/ols-about-rhelai.adoc deleted file mode 100644 index cdc51ef070f3..000000000000 --- a/modules/ols-about-rhelai.adoc +++ /dev/null @@ -1,13 +0,0 @@ -// Module included in the following assemblies: - -// * about/ols-about-openshift-lightspeed.adoc - -:_mod-docs-content-type: CONCEPT -[id="ols-about-rhelai_{context}"] -= About {rhelai} - -{rhelai} is OpenAI API-compatible, and is configured in a similar manner as the OpenAI provider. - -You can configure {rhelai} as the (Large Language Model) LLM provider. - -Because the {rhel} is in a different environment than the {ols-long} deployment, the model deployment must allow access using a secure connection. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_ai/1.2/html-single/building_your_rhel_ai_environment/index#creating_secure_endpoint[Optional: Allowing access to a model from a secure endpoint]. diff --git a/modules/ols-about-rhoai.adoc b/modules/ols-about-rhoai.adoc deleted file mode 100644 index 11383284dbfa..000000000000 --- a/modules/ols-about-rhoai.adoc +++ /dev/null @@ -1,11 +0,0 @@ -// Module included in the following assemblies: - -// * about/ols-about-openshift-lightspeed.adoc - -:_mod-docs-content-type: CONCEPT -[id="ols-about-rhoai_{context}"] -= About {rhoai} - -{rhoai} is OpenAI API-compatible, and is configured largely the same as the OpenAI provider. - -You need a Large Language Model (LLM) deployed on the single model-serving platform of {rhoai} using the Virtual Large Language Model (vLLM) runtime. If the model deployment is in a different {ocp-short-name} environment than the {ols-long} deployment, the model deployment must include a route to expose it outside the cluster. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2-latest/html/serving_models/serving-large-models_serving-large-models#about-the-single-model-serving-platform_serving-large-models[About the single-model serving platform]. diff --git a/modules/ols-about-watsonx.adoc b/modules/ols-about-watsonx.adoc deleted file mode 100644 index 1c394a342066..000000000000 --- a/modules/ols-about-watsonx.adoc +++ /dev/null @@ -1,8 +0,0 @@ -// Module included in the following assemblies: -// about/ols-about-openshift-lightspeed.adoc - -:_mod-docs-content-type: CONCEPT -[id="ols-about-watsonx_{context}"] -= About WatsonX - -To use {watsonx} with {ols-official}, you will need an account with link:https://www.ibm.com/products/watsonx-ai[IBM Cloud's WatsonX]. \ No newline at end of file diff --git a/modules/ols-asking-about-cluster-state.adoc b/modules/ols-asking-about-cluster-state.adoc deleted file mode 100644 index fe72e5016088..000000000000 --- a/modules/ols-asking-about-cluster-state.adoc +++ /dev/null @@ -1,42 +0,0 @@ -// This module is used in the following assemblies: -// ols-using-openshift-lightspeed.adoc - -:_mod-docs-content-type: PROCEDURE -[id="ols-asking-about-cluster-state_{context}"] -= Attaching an object to a Lightspeed query - -This procedure shows how to attach an object to a {ols-long} query, and how to prompt {ols-long} to expand upon the answer. - -.Procedure - -. In the {ocp-product-title} web console, select the Administrator perspective. - -. Click the *Projects* dropdown list. - -. Enable the toggle control to show all projects. - -. Select *openshift-lightspeed*. - -. Click to *Workloads* -> *DaemonSets*. - -. Click the {ols-official} icon in the lower-right corner of the screen. - -. Click the Plus button in the OpenShift Lightspeed user interface. - -. Select YAML. -+ -This action adds the YAML definition for the DaemonSet into the conversation to provide additional context. - -. Enter the following question into the {ols-short} user interface: -+ -What nodes will these pods run on? - -. Click the *Submit* button. -+ -The information {ols-short} returns is influenced by the content of the YAML file. - -. Enter the following question and click the *Submit* button: -+ -Why? -+ -{ols-short} returns more specific details. \ No newline at end of file diff --git a/modules/ols-completing-lightspeed-installation-process.adoc b/modules/ols-completing-lightspeed-installation-process.adoc deleted file mode 100644 index 0953647b79d2..000000000000 --- a/modules/ols-completing-lightspeed-installation-process.adoc +++ /dev/null @@ -1,45 +0,0 @@ -// This module is used in the following assemblies: -// configure/ols-configuring-openshift-lightspeed.adoc - -:_mod-docs-content-type: PROCEDURE -[id="ols-completing-lightspeed-installation-process_{context}"] -= Completing the Lightspeed installation process - -In the developer perspective of the {ocp-product-title} web console, you can monitor the progression of the {ols-long} installation process. - -.Prerequisites - -* You are logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. - -* You have access to the {oc-first}. - -* You have access to the {ocp-short-name} CLI (oc). - -* You have installed the {ols-long} Operator. - -* You have created the credentials secret and the OLSConfig custom resource configuration file. - -.Procedure - -* On the left navigation of the {ocp-product-title} web console, select the *Developer perspective* from the drop-down list at the top of the pane. - -* In the *Project* drop-down list, select *openshift-lightspeed*. -+ -You may need to toggle the switch for *Show default projects*. - -* Click the *Topology*. -+ -When the circle around the Lightspeed icon turns dark blue, the installation process is complete. - -* Confirm {ols-long} is ready by running the following command: -+ -[source,terminal] ----- -$ oc logs deployment/lightspeed-app-server -c lightspeed-service-api -n openshift-lightspeed | grep Uvicorn ----- -+ -.Example output -[source,terminal] ----- -INFO: Uvicorn running on https://0.0.0.0:8443 (Press CTRL+C to quit) ----- \ No newline at end of file diff --git a/modules/ols-release-0-3-0-known-issues.adoc b/modules/ols-release-0-3-0-known-issues.adoc deleted file mode 100644 index 28b9bbbe7071..000000000000 --- a/modules/ols-release-0-3-0-known-issues.adoc +++ /dev/null @@ -1,13 +0,0 @@ -// This module is used in the following assemblies: - -// * lightspeed-docs-main/release_notes/ols-release-notes.adoc - -:_mod-docs-content-type: REFERENCE -[id="ols-release-0-3-known-issues_{context}"] -= Known issues - -The following issues are identified with {ols-official} 0.3.0: - -* If the {ols-long} Operator is installed in a namespace other than `openshift-lightspeed`, the Operator cannot reconcile the secret used to authenticate the Large Language Model (LLM) provider. -+ -Workaround: The LLM provider secret must be created before the `OLSConfig` custom resource is created. Then, the Operator can reconcile the secret. link:https://issues.redhat.com/browse/OLS-1426[OLS-1426]. diff --git a/modules/ols-release-notes-known-issues.adoc b/modules/ols-release-notes-known-issues.adoc deleted file mode 100644 index a1b887843133..000000000000 --- a/modules/ols-release-notes-known-issues.adoc +++ /dev/null @@ -1,13 +0,0 @@ -// This module is used in the following assemblies: -// release_notes/ols-release-notes.adoc - -:_mod-docs-content-type: REFERENCE -[id="ols-release-notes-known-issues_{context}"] -= Known issues - -This section captures the issues identified in {ols-long} releases. - -[id="ols-known-issues-version-0-1-5_{context}"] -== Known issues identified in version 0.1.5 - -* OLS-757: The {ols-long} image size has grown due to changes associated with the hermetic build process. As a result, the time to obtain the image has increased by a few minutes. \ No newline at end of file