Skip to content

[WIP] OLS-913: Document the OLSConfig CRD configuration options #82574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[WIP] OLS-913: Document the OLSConfig CRD configuration options #82574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions configure/ols-configuring-openshift-lightspeed.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,23 @@ include::_attributes/common-attributes.adoc[]

toc::[]

After the {ols-long} Operator is installed, configuring and deploying {ols-long} consists of three tasks. First, you create a credential secret using the credentials for your Large Language Model (LLM) provider. Next, you create the `OLSConfig` custom resource (CR) that the Operator uses to deploy the service. Finally, you verify that the {ols-short} service is operating.
After the {ols-long} Operator is installed, configuring and deploying consists of three tasks:

* Create a credential secret using the credentials for your Large Language Model (LLM) provider.
* Create the `OLSConfig` Custom Resource (CR) file that the Operator uses to deploy the service.
* Verify that the {ols-short} service is operating.

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

include::modules/ols-creating-the-credentials-secret-using-web-console.adoc[leveloffset=+1]
include::modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc[leveloffset=+1]
include::modules/ols-creating-the-credentials-secret-using-cli.adoc[leveloffset=+1]
include::modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc[leveloffset=+1]
include::modules/ols-about-lightspeed-custom-resource-definition.adoc[leveloffset=+1]
include::modules/ols-custom-resource-definition-file-parameters.adoc[leveloffset=+2]
include::modules/ols-creating-lightspeed-custom-resource-file-using-web-console.adoc[leveloffset=+2]
include::modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc[leveloffset=+2]
include::modules/ols-verifying-openshift-lightspeed-deployment.adoc[leveloffset=+1]
include::modules/ols-about-lightspeed-and-role-based-access-control.adoc[leveloffset=+1]
include::modules/ols-granting-access-to-individual-users.adoc[leveloffset=+2]
Expand Down
11 changes: 11 additions & 0 deletions modules/ols-about-lightspeed-custom-resource-definition.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// Module included in the following assemblies:

// * about/ols-configuring-openshift-lightspeed.adoc

:_mod-docs-content-type: CONCEPT
[id="ols-about-lightspeed-custom-resource-definition_{context}"]
= About the Lightspeed Custom Resource

When you install the {ols-long} Operator, the `OLSConfig` Custom Resource Definition (CRD) gets installed in the {ocp-product-title} cluster. You can create a cluster-scoped custom resource named `cluster` to configure {ols-long} with your Large Language Model provider.

You can configure the `OLSConfig` CR by using either the {ocp-product-title} web console or the CLI.
Loading