From 0612f662be991b2df4b55ec60fe51c160fc32162 Mon Sep 17 00:00:00 2001 From: Tim O'Keefe Date: Thu, 2 Oct 2025 16:18:32 -0400 Subject: [PATCH] Revert "OLS-2157: Update Lightspeed attribute" This reverts commit 6dcec6193ccb36bc0702fbdbdbf83790fbad9f2f. --- configure/ols-configuring-openshift-lightspeed.adoc | 4 ++-- install/ols-installing-openshift-lightspeed.adoc | 2 +- modules/ols-0-1-5-release-notes.adoc | 2 +- modules/ols-0-2-0-release-notes.adoc | 2 +- modules/ols-0-3-4-fixed-issues.adoc | 2 +- modules/ols-0-3-5-fixed-issues.adoc | 2 +- modules/ols-0-3-6-known-issues.adoc | 6 +++--- modules/ols-1-0-2-fixed-issues.adoc | 2 +- modules/ols-1-0-known-issues.adoc | 10 +++++----- ...about-lightspeed-and-role-based-access-control.adoc | 2 +- modules/ols-about-postgresql-persistence.adoc | 2 +- modules/ols-asking-general-information.adoc | 2 +- modules/ols-asking-related-questions.adoc | 8 ++++---- .../ols-attaching-a-resource-object-to-your-query.adoc | 2 +- modules/ols-enabling-postgresql-persistence.adoc | 2 +- modules/ols-initiating-chat-using-chat-window.adoc | 2 +- modules/ols-openshift-lightspeed-overview.adoc | 2 +- modules/ols-providing-feedback-for-conversation.adoc | 2 +- .../ols-using-lightspeed-to-troubleshoot-alerts.adoc | 2 +- 19 files changed, 29 insertions(+), 29 deletions(-) diff --git a/configure/ols-configuring-openshift-lightspeed.adoc b/configure/ols-configuring-openshift-lightspeed.adoc index a51e5eda6307..6b869be8719a 100644 --- a/configure/ols-configuring-openshift-lightspeed.adoc +++ b/configure/ols-configuring-openshift-lightspeed.adoc @@ -6,14 +6,14 @@ include::_attributes/common-attributes.adoc[] toc::[] -After the {ols-long} Operator is installed, configuring and deploying {ols-long} consists of three tasks. +After the {ols-long} Operator is installed, configuring and deploying {ols-short} consists of three tasks. [NOTE] ==== The instructions assume that you are installing {ols-long} using the `kubeadmin` user account. If you are using a regular user account with `cluster-admin` privileges, read the section of the documentation that discusses RBAC. ==== -First, create a credential secret using the credentials for your Large Language Model (LLM) provider. Next, create the `OLSConfig` custom resource (CR) that the Operator uses to deploy the service. Finally, verify that the {ols-long} service is operating. +First, create a credential secret using the credentials for your Large Language Model (LLM) provider. Next, create the `OLSConfig` custom resource (CR) that the Operator uses to deploy the service. Finally, verify that the {ols-short} service is operating. include::snippets/ols-unified-perspective-web-console.adoc[] diff --git a/install/ols-installing-openshift-lightspeed.adoc b/install/ols-installing-openshift-lightspeed.adoc index 5d50cd10a67b..4fb0c4ea8f26 100644 --- a/install/ols-installing-openshift-lightspeed.adoc +++ b/install/ols-installing-openshift-lightspeed.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -The installation process for {ols-official} consists of two main tasks: installing the {ols-long} Operator and configuring the {ols-long} Service to interact with the large language model (LLM) provider. +The installation process for {ols-official} consists of two main tasks: installing the {ols-short} Operator and configuring the {ols-short} Service to interact with the large language model (LLM) provider. include::modules/ols-large-language-model-overview.adoc[leveloffset=+1] include::modules/ols-about-subscription-requirements.adoc[leveloffset=+1] diff --git a/modules/ols-0-1-5-release-notes.adoc b/modules/ols-0-1-5-release-notes.adoc index 4f55922e823b..f94c4916e5a1 100644 --- a/modules/ols-0-1-5-release-notes.adoc +++ b/modules/ols-0-1-5-release-notes.adoc @@ -16,6 +16,6 @@ The following enhancements have been made with {ols-official} 0.1.5: * This release introduces support for Large Language Model (LLM) authentication using {azure-official} with {entra-id}. -* This release introduces the ability to attach logs on the *Details* page for the `DaemonSet`, `Deployment`, `Job`, `ReplicaSet` and `StatefulSet` resource types. When asking {ols-long} a question, attaching logs helps provide additional context so {ols-long} can provide a more refined answer. +* This release introduces the ability to attach logs on the *Details* page for the `DaemonSet`, `Deployment`, `Job`, `ReplicaSet` and `StatefulSet` resource types. When asking {ols-long} a question, attaching logs helps provide additional context so {ols-short} can provide a more refined answer. * When the {ols-long} Service is not running, the chat window now indicates that the Service is not ready. \ No newline at end of file diff --git a/modules/ols-0-2-0-release-notes.adoc b/modules/ols-0-2-0-release-notes.adoc index db5234218903..8e8974e4c1bc 100644 --- a/modules/ols-0-2-0-release-notes.adoc +++ b/modules/ols-0-2-0-release-notes.adoc @@ -12,7 +12,7 @@ The following enhancements have been made with {ols-official} 0.2.0: -* This release introduces the {ols-official} Operator as a Technology Preview release. Previously, the {ols-long} Operator was a Developer Preview release. +* This release introduces the {ols-official} Operator as a Technology Preview release. Previously, the {ols-short} Operator was a Developer Preview release. * Existing Developer Preview installations of {ols-official} version 0.1.6 and earlier that use the preview {olm} (OLM) channel must switch the update channel to *alpha* and then install the 0.2.0 Technology Preview version. diff --git a/modules/ols-0-3-4-fixed-issues.adoc b/modules/ols-0-3-4-fixed-issues.adoc index cbec6625932c..a55d643ba451 100644 --- a/modules/ols-0-3-4-fixed-issues.adoc +++ b/modules/ols-0-3-4-fixed-issues.adoc @@ -8,7 +8,7 @@ The following issues are fixed with {ols-official} 0.3.4: -* Previously, when you tried to attach logs to an {ols-long} query, the entire {ols-long} window and icon disappeared. Now, when you attach logs to a query the {ols-long} window and icon remain accessible. link:https://issues.redhat.com/browse/OLS-1634[OLS-1634]. +* Previously, when you tried to attach logs to an {ols-long} query, the entire {ols-short} window and icon disappeared. Now, when you attach logs to a query the {ols-short} window and icon remain accessible. link:https://issues.redhat.com/browse/OLS-1634[OLS-1634]. * In earlier versions, the {ols-long} Operator failed to validate the large language model (LLM) provider credential settings on the {azure-official} platform with {entra-id}. Now, the Operator can validate the LLM credential settings on the {azure-official} platform with {entra-id}. link:https://issues.redhat.com/browse/OLS-1630[OLS-1630]. diff --git a/modules/ols-0-3-5-fixed-issues.adoc b/modules/ols-0-3-5-fixed-issues.adoc index c946158df293..de9242233c81 100644 --- a/modules/ols-0-3-5-fixed-issues.adoc +++ b/modules/ols-0-3-5-fixed-issues.adoc @@ -8,4 +8,4 @@ The following issues are fixed with {ols-official} 0.3.5: -* Previously, the {ols-long} service could not support a self-hosted large language model (LLM) with OpenAI-compatible API endpoints by using a self-signed certificate with a custom CA to secure its HTTPS endpoints. Now the {ols-long} service can support a self-signed certificate with a custom CA to secure HTTPS connections to the LLM provider. link:https://issues.redhat.com/browse/OLS-1715[OLS-1715]. \ No newline at end of file +* Previously, the {ols-long} service could not support a self-hosted large language model (LLM) with OpenAI-compatible API endpoints by using a self-signed certificate with a custom CA to secure its HTTPS endpoints. Now the {ols-short} service can support a self-signed certificate with a custom CA to secure HTTPS connections to the LLM provider. link:https://issues.redhat.com/browse/OLS-1715[OLS-1715]. \ No newline at end of file diff --git a/modules/ols-0-3-6-known-issues.adoc b/modules/ols-0-3-6-known-issues.adoc index 84df713a3954..6edaede8e6c6 100644 --- a/modules/ols-0-3-6-known-issues.adoc +++ b/modules/ols-0-3-6-known-issues.adoc @@ -7,14 +7,14 @@ The following issues are identified with {ols-official} 0.3.6: -* For {ocp-product-title} 4.17 and later, the {ols-long} icon disappears when you click *Create Namespace* or *Create Project* from one of the following locations in the {ocp-product-title} web console: +* For {ocp-product-title} 4.17 and later, the {ols-short} icon disappears when you click *Create Namespace* or *Create Project* from one of the following locations in the {ocp-product-title} web console: ** *Administration -> Namespaces* ** *Home -> Projects -> Create Project* ** The *Project* drop-down menu located at the top of most pages + -Workaround: Refresh the web browser and the {ols-long} icon appears. link:https://issues.redhat.com/browse/OLS-1815[OLS-1815]. +Workaround: Refresh the web browser and the {ols-short} icon appears. link:https://issues.redhat.com/browse/OLS-1815[OLS-1815]. * Changing the value of the `quota` parameter in the `spec.ols.quota_handlers.conf` specification of the `OLSConfig` CR file does not take effect until the currently defined quota period expires. + -Workaround: Delete the {ols-long} Operator. Ensure that any operand pods that the {ols-long} Operator manages, and the Persistent Volume Claim `lightspeed-postgres-pvc` associated with the `postgres` pod are also deleted. Then, install the {ols-long} Operator again. \ No newline at end of file +Workaround: Delete the {ols-short} Operator. Ensure that any operand pods that the {ols-short} Operator manages, and the Persistent Volume Claim `lightspeed-postgres-pvc` associated with the `postgres` pod are also deleted. Then, install the {ols-short} Operator again. \ No newline at end of file diff --git a/modules/ols-1-0-2-fixed-issues.adoc b/modules/ols-1-0-2-fixed-issues.adoc index 2813b7da6f29..88f9cfdcdc74 100644 --- a/modules/ols-1-0-2-fixed-issues.adoc +++ b/modules/ols-1-0-2-fixed-issues.adoc @@ -8,4 +8,4 @@ The following issues are fixed with {ols-official} 1.0.2: -* Before this update, the cluster-wide proxy incorrectly routed large language model (LLM) provider connections, ignoring the `no_proxy` environment variable. This led to end users experiencing {ols-long} attempting to connect to the LLM provider through a proxy when the `no_proxy` variable was explicitly defined. In this release, {ols-long} now respects the `no_proxy` environment variable for LLM provider connections. As a result, {ols-long} ignores proxy settings when `no_proxy` is set, enhancing direct LLM provider connections. link:https://issues.redhat.com/browse/OLS-1861[OLS-1861]. \ No newline at end of file +* Before this update, the cluster-wide proxy incorrectly routed large language model (LLM) provider connections, ignoring the `no_proxy` environment variable. This led to end users experiencing {ols-long} attempting to connect to the LLM provider through a proxy when the `no_proxy` variable was explicitly defined. In this release, {ols-short} now respects the `no_proxy` environment variable for LLM provider connections. As a result, {ols-short} ignores proxy settings when `no_proxy` is set, enhancing direct LLM provider connections. link:https://issues.redhat.com/browse/OLS-1861[OLS-1861]. \ No newline at end of file diff --git a/modules/ols-1-0-known-issues.adoc b/modules/ols-1-0-known-issues.adoc index 1cfe553b2df4..c6bd1215e213 100644 --- a/modules/ols-1-0-known-issues.adoc +++ b/modules/ols-1-0-known-issues.adoc @@ -8,7 +8,7 @@ The following issues are identified with {ols-official} 1.0: -* For {ocp-product-title} 4.17 and later, the {ols-long} icon disappears when you click *Create Namespace* or *Create Project* from one of the following locations in the {ocp-product-title} web console: +* For {ocp-product-title} 4.17 and later, the {ols-short} icon disappears when you click *Create Namespace* or *Create Project* from one of the following locations in the {ocp-product-title} web console: + -- ** *Administration -> Namespaces* @@ -16,12 +16,12 @@ The following issues are identified with {ols-official} 1.0: ** The *Project* drop-down menu located at the top of most pages -- + -Workaround: Refresh the web browser and the {ols-long} icon appears. link:https://issues.redhat.com/browse/OLS-1815[OLS-1815]. +Workaround: Refresh the web browser and the {ols-short} icon appears. link:https://issues.redhat.com/browse/OLS-1815[OLS-1815]. * Changing the value of the `quota` parameter in the `spec.ols.quotaHandlersConfig.limitersConfig` specification of the `OLSConfig` custom resource file does not take effect until the currently defined quota period expires. + -Workaround: Delete the {ols-long} Operator. Ensure that any operand pods that the {ols-long} Operator manages, and the Persistent Volume Claim `lightspeed-postgres-pvc` associated with the `postgres` pod are also deleted. Then, install the {ols-long} Operator again. https://issues.redhat.com/browse/OLS-1826[OLS-1826] +Workaround: Delete the {ols-short} Operator. Ensure that any operand pods that the {ols-short} Operator manages, and the Persistent Volume Claim `lightspeed-postgres-pvc` associated with the `postgres` pod are also deleted. Then, install the {ols-short} Operator again. https://issues.redhat.com/browse/OLS-1826[OLS-1826] -* After restarting the `postgres` pod, the {ols-long} service pod fails to connect to the `postgres` pod. +* After restarting the `postgres` pod, the {ols-short} service pod fails to connect to the `postgres` pod. + -Workaround: Restart the {ols-long} service pod so that the service pod connects to the `postgres` pod. link:https://issues.redhat.com/browse/OLS-1815[OLS-1835]. +Workaround: Restart the {ols-short} service pod so that the service pod connects to the `postgres` pod. link:https://issues.redhat.com/browse/OLS-1815[OLS-1835]. diff --git a/modules/ols-about-lightspeed-and-role-based-access-control.adoc b/modules/ols-about-lightspeed-and-role-based-access-control.adoc index 3abc3b0f1f89..aa491933eae4 100644 --- a/modules/ols-about-lightspeed-and-role-based-access-control.adoc +++ b/modules/ols-about-lightspeed-and-role-based-access-control.adoc @@ -7,6 +7,6 @@ Role-Based Access Control (RBAC) is a system security approach to restricting system access to authorized users who have defined roles and permissions. -{ols-long} RBAC is binary. By default, not all cluster users have access to the {ols-long} interface. Access must be granted by a user who can grant permissions. All users of an {ocp-short-name} cluster with {ols-long} installed can see the {ols-long} button; however, only users with permissions can submit questions to {ols-long}. +{ols-long} RBAC is binary. By default, not all cluster users have access to the {ols-long} interface. Access must be granted by a user who can grant permissions. All users of an {ocp-short-name} cluster with {ols-long} installed can see the {ols-short} button; however, only users with permissions can submit questions to {ols-short}. If you want to evaluate the RBAC features of {ols-long}, your cluster will need users other than the `kubeadmin` account. The `kubeadmin` account always has access to {ols-long}. \ No newline at end of file diff --git a/modules/ols-about-postgresql-persistence.adoc b/modules/ols-about-postgresql-persistence.adoc index 94b1757dfa65..91c6bc43f443 100644 --- a/modules/ols-about-postgresql-persistence.adoc +++ b/modules/ols-about-postgresql-persistence.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: CONCEPT [id="about-postgresql-persistence_{context}"] -= About {ols-long} and PostgreSQL persistence += About {ols-short} and PostgreSQL persistence Using PostgreSQL persistence, you can save data, such as {ols-long} conversation history or quota usage, to a PostgreSQL database so that the data is retained in persistent volume. With PostgreSQL persistence, the data persists if the PostgreSQL pod restarts or is rescheduled in your {ocp-product-title} installation. diff --git a/modules/ols-asking-general-information.adoc b/modules/ols-asking-general-information.adoc index c9d4ca71279c..c4380347fa7d 100644 --- a/modules/ols-asking-general-information.adoc +++ b/modules/ols-asking-general-information.adoc @@ -17,4 +17,4 @@ What is an OpenShift imagestream used for? . Click the *Submit* button. + -{ols-long} returns information that provides an explanation of an imagestream and details about usage. \ No newline at end of file +{ols-short} returns information that provides an explanation of an imagestream and details about usage. \ No newline at end of file diff --git a/modules/ols-asking-related-questions.adoc b/modules/ols-asking-related-questions.adoc index 4903e7a9ea57..6e570343774f 100644 --- a/modules/ols-asking-related-questions.adoc +++ b/modules/ols-asking-related-questions.adoc @@ -2,7 +2,7 @@ [id="ols-asking-related-questions_{context}"] = Asking related questions -This procedure shows how to ask {ols-long} a series of related questions in order to obtain more highly refined information. {ols-long} uses the conversation history to help create context. +This procedure shows how to ask {ols-long} a series of related questions in order to obtain more highly refined information. {ols-short} uses the conversation history to help create context. .Procedure @@ -14,7 +14,7 @@ How are OpenShift security context constraints used? . Click the *Submit* button. + -{ols-long} returns information. +{ols-short} returns information. . Enter the following question into the *Send message* field: + @@ -22,7 +22,7 @@ Can I control who can use a particular SCC? . Click the *Submit* button. + -{ols-long} returns more highly refined information that contains additional details. +{ols-short} returns more highly refined information that contains additional details. . Enter the following question into the *Send message* field: + @@ -30,4 +30,4 @@ Can you give me an example? . Click the *Submit* button. + -{ols-long} returns sample code that you can copy and use. +{ols-short} returns sample code that you can copy and use. diff --git a/modules/ols-attaching-a-resource-object-to-your-query.adoc b/modules/ols-attaching-a-resource-object-to-your-query.adoc index 7380a6611147..6037385e6633 100644 --- a/modules/ols-attaching-a-resource-object-to-your-query.adoc +++ b/modules/ols-attaching-a-resource-object-to-your-query.adoc @@ -21,4 +21,4 @@ This procedure explains how to attach a resource object to provide additional co . Click the *Submit* button. + -{ols-long} returns information based on your question. \ No newline at end of file +{ols-short} returns information based on your question. \ No newline at end of file diff --git a/modules/ols-enabling-postgresql-persistence.adoc b/modules/ols-enabling-postgresql-persistence.adoc index 32656abc0b66..ee1aa598a815 100644 --- a/modules/ols-enabling-postgresql-persistence.adoc +++ b/modules/ols-enabling-postgresql-persistence.adoc @@ -44,7 +44,7 @@ spec: ols: storage: {} <1> ---- -<1> The class depends on the existing instances of the storage class in the cluster. If you leave the storage class empty, {ols-long} uses default values. The persistent volume allocated for the PostgreSQL database is 1 GB in size and uses the storage class of the default cluster. Specify empty braces for the `storage` parameter to use the default values. +<1> The class depends on the existing instances of the storage class in the cluster. If you leave the storage class empty, {ols-short} uses default values. The persistent volume allocated for the PostgreSQL database is 1 GB in size and uses the storage class of the default cluster. Specify empty braces for the `storage` parameter to use the default values. + If you want to change the `size` and `class` parameters, you can independently specify an explicit value for the parameter. + diff --git a/modules/ols-initiating-chat-using-chat-window.adoc b/modules/ols-initiating-chat-using-chat-window.adoc index 636a0765abd3..b67341840c23 100644 --- a/modules/ols-initiating-chat-using-chat-window.adoc +++ b/modules/ols-initiating-chat-using-chat-window.adoc @@ -17,4 +17,4 @@ This action presents the {ols-official} user interface. . Click the *Submit* button. + -{ols-long} returns information based on your question. \ No newline at end of file +{ols-short} returns information based on your question. \ No newline at end of file diff --git a/modules/ols-openshift-lightspeed-overview.adoc b/modules/ols-openshift-lightspeed-overview.adoc index d9219f6a6bea..c69a5cfd2d13 100644 --- a/modules/ols-openshift-lightspeed-overview.adoc +++ b/modules/ols-openshift-lightspeed-overview.adoc @@ -5,4 +5,4 @@ [id="ols-openshift-lightspeed-overview_{context}"] = OpenShift Lightspeed overview -{ols-official} is a generative AI-powered virtual assistant for {ocp-product-title}. {ols-long} functionality uses a natural-language interface in the {ocp-short-name} web console to provide answers to questions that you ask about the product. +{ols-official} is a generative AI-powered virtual assistant for {ocp-product-title}. {ols-short} functionality uses a natural-language interface in the {ocp-short-name} web console to provide answers to questions that you ask about the product. diff --git a/modules/ols-providing-feedback-for-conversation.adoc b/modules/ols-providing-feedback-for-conversation.adoc index eef43ddffe3c..7672c2a79cd0 100644 --- a/modules/ols-providing-feedback-for-conversation.adoc +++ b/modules/ols-providing-feedback-for-conversation.adoc @@ -19,7 +19,7 @@ . Click the *Submit* button. + -{ols-long} returns information. +{ols-short} returns information. . To provide feedback on a particular question and response, click the thumbs up or thumbs down button. + diff --git a/modules/ols-using-lightspeed-to-troubleshoot-alerts.adoc b/modules/ols-using-lightspeed-to-troubleshoot-alerts.adoc index 4461dce4b391..f498d9e1d50f 100644 --- a/modules/ols-using-lightspeed-to-troubleshoot-alerts.adoc +++ b/modules/ols-using-lightspeed-to-troubleshoot-alerts.adoc @@ -27,4 +27,4 @@ What should I do about this alert? . Click the *Submit* button. + -{ols-long} references the alert information to provide context when generating the information it returns. \ No newline at end of file +{ols-short} references the alert information to provide context when generating the information it returns. \ No newline at end of file