Merge pull request #93627 from rh-tokeefe/OLS-1754

OLS-1754: Document PostgreSQL persistence configuration

Author: michaelryanpeter

configure/ols-configuring-openshift-lightspeed.adoc

@@ -28,3 +28,5 @@ include::modules/ols-about-cluster-interaction.adoc[leveloffset=+1]
 include::modules/ols-enabling-cluster-interaction.adoc[leveloffset=+2]
 include::modules/ols-tokens-and-token-quota-limits.adoc[leveloffset=+1]
 include::modules/ols-activating-token-quota-limits.adoc[leveloffset=+2]
+include::modules/ols-about-postgresql-persistence.adoc[leveloffset=+1]
+include::modules/ols-enabling-postgresql-persistence.adoc[leveloffset=+2]

modules/ols-about-postgresql-persistence.adoc

@@ -0,0 +1,13 @@
+// Module included in the following assemblies:
+// * lightspeed-docs-main/configure/ols-configuring-openshift-lightspeed.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="about-postgresql-persistence_{context}"]
+= 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. 
+
+:FeatureName: PostgreSQL persistence
+include::snippets/technology-preview.adoc[]
+
+PostgreSQL persistence is disabled by default. To enable the functionality, add the  `spec.ols.storage` specification to the `OLSConfig` custom resource (CR).

modules/ols-enabling-postgresql-persistence.adoc

@@ -0,0 +1,61 @@
+// Module included in the following assemblies:
+// * lightspeed-docs-main/configure/ols-configuring-openshift-lightspeed.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="enabling-postgresql-persistence_{context}"]
+= Enabling PostgreSQL persistence
+
+Modify the `OLSConfig` custom resource (CR) file to enable PostgreSQL persistence for the {ols-long} service.
+
+.Prerequisites
+
+* You are logged in to the {ocp-product-title} web console as a user account with permission to create a cluster-scoped CR file, such as a user with the `cluster-admin` role.
+
+* You have installed the {ols-long} Operator.
+
+* You have configured the large language model provider.
+
+.Procedure 
+
+. In the {ocp-product-title} web console, click *Operators* -> *Installed Operators*. 
+
+. Select *All Projects* in the  *Project* list at the top of the screen.
+
+. Click *{ols-long} Operator*.
+
+. Click *OLSConfig*, then click the `cluster` configuration instance in the list.
+
+. Click the *YAML* tab.
+
+. Insert the `spec.ols.storage` YAML code.
++
+.Example `OLSconfig` CR file
+[source,yaml,subs="attributes,verbatim"]
+----
+apiVersion: ols.openshift.io/v1alpha1
+kind: OLSConfig
+metadata:
+  name: cluster
+  namespace: openshift-lightspeed
+spec:
+  llm:
+    providers:
+...
+  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.
++
+If you want to change the `size` and `class` parameters, you can independently specify an explicit value for the parameter. 
++
+[source,yaml,subs="attributes,verbatim"]
+----
+ols:
+  storage:
+    size: 768Mi <1>
+    class: gp2-csi <2>
+----  
+<1> Specifies the size of the Requested Volume. If the size is not specified, the default value is 1 GB.
+<2> Specifies the Storage Class of the Requested Volume. If no class is specified, the storage class uses the default storage class setting for the cluster.
+
+. Click *Save*.