Merge pull request #93062 from rh-tokeefe/OLS-1621

OLS-1621: Document cluster interaction feature

Author: skopacz1

configure/ols-configuring-openshift-lightspeed.adoc

@@ -23,3 +23,5 @@ include::modules/ols-about-lightspeed-and-role-based-access-control.adoc[levelof
 include::modules/ols-granting-access-to-individual-users.adoc[leveloffset=+2]
 include::modules/ols-granting-access-to-user-group.adoc[leveloffset=+2]
 include::modules/ols-filtering-and-redacting-information.adoc[leveloffset=+1]
+include::modules/ols-cluster-interaction-overview.adoc[leveloffset=+1]
+include::modules/ols-enabling-cluster-interaction.adoc[leveloffset=+2]

modules/ols-cluster-interaction-overview.adoc

@@ -0,0 +1,8 @@
+// Module included in the following assemblies:
+// * lightspeed-docs-main/configure/ols-configuring-openshift-lightspeed.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="cluster-interaction-overview_{context}"]
+= Cluster interaction overview
+
+A large language model (LLM) is used with the {ols-long} service to generate responses to questions. Use the cluster interaction feature to enhance the knowledge available to the LLM with information about an {ocp-product-title} cluster. Providing cluster information, such as the namespaces or pods that the cluster contains, enables the LLM to generate highly customized responses for your environment.

modules/ols-enabling-cluster-interaction.adoc

@@ -0,0 +1,49 @@
+// Module included in the following assemblies:
+// * lightspeed-docs-main/configure/ols-configuring-openshift-lightspeed.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="enabling-cluster-interaction_{context}"]
+= Enabling cluster interaction
+
+Modify the `OLSConfig` custom resource to enable the cluster interaction feature.
+
+:FeatureName: The cluster interaction feature
+include::snippets/technology-preview.adoc[]
+
+.Prerequisites
+
+* You are logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. Alternatively, you are logged in to a user account that has permission to create a cluster-scoped CR.
+
+* You have configured the large language model (LLM) provider.
+
+* You have installed the {ols-long} Operator.
+
+.Procedure 
+
+. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators*. 
+
+. Click {ols-long} Operator.
+
+. Click *OLSConfig*, then click the `cluster` configuration instance in the list.
+
+. Click the *YAML* tab.
+
+. Set the `spec.ols.introspectionEnabled` parameter to `true` to enable cluster interaction: 
++
+.Example `OLSconfig` CR file
+[source,yaml,subs="attributes,verbatim"]
+----
+apiVersion: ols.openshift.io/v1alpha1
+kind: OLSConfig
+metadata:
+  name: cluster
+spec:
+  ols:
+    introspectionEnabled: true  
+----
+
+. Click *Save*.
+
+. Access the {ols-long} virtual assistant and submit a question associated with the custom content that was added to the LLM.
++
+The {ols-long} virtual assistant generates a response based on the custom content.

modules/snippets

@@ -0,0 +1 @@
+../snippets