Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions configure/ols-configuring-openshift-lightspeed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ include::_attributes/common-attributes.adoc[]

toc::[]

After the {ols-long} Operator is installed, configuring and deploying {ols-short} consists of three tasks.
After the {ols-long} Operator is installed, configuring and deploying {ols-long} 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-short} 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-long} service is operating.

include::snippets/ols-unified-perspective-web-console.adoc[]

Expand Down
2 changes: 1 addition & 1 deletion install/ols-installing-openshift-lightspeed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

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.
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.

include::modules/ols-large-language-model-overview.adoc[leveloffset=+1]
include::modules/ols-about-subscription-requirements.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion modules/ols-1-0-2-fixed-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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-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].
* 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].
10 changes: 5 additions & 5 deletions modules/ols-1-0-known-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@

The following issues are identified with {ols-official} 1.0:

* 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:
* 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:
+
--
** *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-short} icon appears. link:https://issues.redhat.com/browse/OLS-1815[OLS-1815].
Workaround: Refresh the web browser and the {ols-long} 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-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]
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]

* After restarting the `postgres` pod, the {ols-short} service pod fails to connect to the `postgres` pod.
* After restarting the `postgres` pod, the {ols-long} service pod fails to connect to the `postgres` pod.
+
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].
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].
Original file line number Diff line number Diff line change
Expand Up @@ -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-short} button; however, only users with permissions can submit questions to {ols-short}.
{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}.

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}.
2 changes: 1 addition & 1 deletion modules/ols-about-postgresql-persistence.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

:_mod-docs-content-type: CONCEPT
[id="about-postgresql-persistence_{context}"]
= About {ols-short} and PostgreSQL persistence
= About {ols-long} 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.

Expand Down
2 changes: 1 addition & 1 deletion modules/ols-asking-general-information.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ What is an OpenShift imagestream used for?

. Click the *Submit* button.
+
{ols-short} returns information that provides an explanation of an imagestream and details about usage.
{ols-long} returns information that provides an explanation of an imagestream and details about usage.
8 changes: 4 additions & 4 deletions modules/ols-asking-related-questions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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-short} 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-long} uses the conversation history to help create context.

.Procedure

Expand All @@ -14,20 +14,20 @@ How are OpenShift security context constraints used?

. Click the *Submit* button.
+
{ols-short} returns information.
{ols-long} returns information.

. Enter the following question into the *Send message* field:
+
Can I control who can use a particular SCC?

. Click the *Submit* button.
+
{ols-short} returns more highly refined information that contains additional details.
{ols-long} returns more highly refined information that contains additional details.

. Enter the following question into the *Send message* field:
+
Can you give me an example?

. Click the *Submit* button.
+
{ols-short} returns sample code that you can copy and use.
{ols-long} returns sample code that you can copy and use.
2 changes: 1 addition & 1 deletion modules/ols-attaching-a-resource-object-to-your-query.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ This procedure explains how to attach a resource object to provide additional co

. Click the *Submit* button.
+
{ols-short} returns information based on your question.
{ols-long} returns information based on your question.
2 changes: 1 addition & 1 deletion modules/ols-enabling-postgresql-persistence.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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-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.
<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.
+
If you want to change the `size` and `class` parameters, you can independently specify an explicit value for the parameter.
+
Expand Down
2 changes: 1 addition & 1 deletion modules/ols-initiating-chat-using-chat-window.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ This action presents the {ols-official} user interface.

. Click the *Submit* button.
+
{ols-short} returns information based on your question.
{ols-long} returns information based on your question.
2 changes: 1 addition & 1 deletion modules/ols-openshift-lightspeed-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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-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.
{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.
2 changes: 1 addition & 1 deletion modules/ols-providing-feedback-for-conversation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

. Click the *Submit* button.
+
{ols-short} returns information.
{ols-long} returns information.

. To provide feedback on a particular question and response, click the thumbs up or thumbs down button.
+
Expand Down
4 changes: 2 additions & 2 deletions modules/ols-using-lightspeed-to-troubleshoot-alerts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

:_mod-docs-content-type: PROCEDURE
[id="ols-using-lightspeed-to-troubleshoot-alerts_{context}"]
= Using Lightspeed to troubleshoot alerts
= Using {ols-long} to troubleshoot alerts

This procedure shows how to use {ols-long} to troubleshoot alerts.

Expand All @@ -27,4 +27,4 @@ What should I do about this alert?

. Click the *Submit* button.
+
{ols-short} references the alert information to provide context when generating the information it returns.
{ols-long} references the alert information to provide context when generating the information it returns.