Skip to content

OLS-1980: Add autodiscovery for indexID value #1032

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

Merged
merged 1 commit into from
Oct 31, 2025
Merged

OLS-1980: Add autodiscovery for indexID value #1032

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
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ IMAGE_TAG_BASE ?= quay.io/openshift-lightspeed/lightspeed-operator

# BUNDLE_TAG defines the version of the bundle.
# You can use it as an arg. (E.g make bundle BUNDLE_TAG=0.0.1)
BUNDLE_TAG ?= 1.0.5
BUNDLE_TAG ?= 1.0.6

# set the base image for docker files
# You can use it as an arg. (E.g make bundle BASE_IMG=registry.redhat.io/ubi9/ubi-minimal)
Expand Down Expand Up @@ -433,4 +433,4 @@ catalog-push: ## Push a catalog image.
.PHONY: konflux-release
konflux-release: kustomize yq
mkdir -p release-konflux
$(KUSTOMIZE) build hack/release-konflux | $(YQ) -s '"release-konflux/" + .metadata.name'
$(KUSTOMIZE) build hack/release-konflux | $(YQ) -s '"release-konflux/" + .metadata.name'
4 changes: 2 additions & 2 deletions api/v1alpha1/olsconfig_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ type RAGSpec struct {
// +kubebuilder:default:="/rag/vector_db"
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Index Path in the Image"
IndexPath string `json:"indexPath,omitempty"`
// The Index ID of the RAG database
// +kubebuilder:default:="vector_db_index"
// The Index ID of the RAG database. Only needed if there are multiple indices in the database.
// +kubebuilder:default:=""
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Index ID"
IndexID string `json:"indexID,omitempty"`
// The URL of the container image to use as a RAG source
Expand Down
8 changes: 4 additions & 4 deletions bundle/manifests/lightspeed-operator.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ metadata:
]
capabilities: Basic Install
console.openshift.io/operator-monitoring-default: "true"
createdAt: "2025-10-03T15:49:27Z"
createdAt: "2025-10-10T17:31:05Z"
features.operators.openshift.io/cnf: "false"
features.operators.openshift.io/cni: "false"
features.operators.openshift.io/csi: "false"
Expand Down Expand Up @@ -97,7 +97,7 @@ spec:
- description: List of models from the provider
displayName: Models
path: llm.providers[0].models
- description: Defines the model's context window size. Default is specific to provider/model.
- description: Defines the model's context window size, in tokens. The default is 128k tokens.
displayName: Context Window Size
path: llm.providers[0].models[0].contextWindowSize
- description: Model name
Expand All @@ -106,7 +106,7 @@ spec:
- description: Model API parameters
displayName: Parameters
path: llm.providers[0].models[0].parameters
- description: Max tokens for response
- description: Max tokens for response. The default is 2048 tokens.
displayName: Max Tokens For Response
path: llm.providers[0].models[0].parameters.maxTokensForResponse
- description: Model API URL
Expand Down Expand Up @@ -335,7 +335,7 @@ spec:
- description: The URL of the container image to use as a RAG source
displayName: Image
path: ols.rag[0].image
- description: The Index ID of the RAG database
- description: The Index ID of the RAG database. Only needed if there are multiple indices in the database.
displayName: Index ID
path: ols.rag[0].indexID
- description: The path to the RAG database inside of the container image
Expand Down
5 changes: 3 additions & 2 deletions bundle/manifests/ols.openshift.io_olsconfigs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,8 +1036,9 @@ spec:
RAG source
type: string
indexID:
default: vector_db_index
description: The Index ID of the RAG database
default: ""
description: The Index ID of the RAG database. Only needed
if there are multiple indices in the database.
type: string
indexPath:
default: /rag/vector_db
Expand Down
5 changes: 3 additions & 2 deletions config/crd/bases/ols.openshift.io_olsconfigs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,8 +1036,9 @@ spec:
RAG source
type: string
indexID:
default: vector_db_index
description: The Index ID of the RAG database
default: ""
description: The Index ID of the RAG database. Only needed
if there are multiple indices in the database.
type: string
indexPath:
default: /rag/vector_db
Expand Down
3 changes: 2 additions & 1 deletion config/manifests/bases/lightspeed-operator.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,8 @@ spec:
- description: The URL of the container image to use as a RAG source
displayName: Image
path: ols.rag[0].image
- description: The Index ID of the RAG database
- description: The Index ID of the RAG database. Only needed if there are multiple
indices in the database.
displayName: Index ID
path: ols.rag[0].indexID
- description: The path to the RAG database inside of the container image
Expand Down
2 changes: 1 addition & 1 deletion docs/olsconfig-ols-openshift-io-v1alpha1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1755,7 +1755,7 @@ Required::

| `indexID`
| `string`
| The Index ID of the RAG database
| The Index ID of the RAG database. Only needed if there are multiple indices in the database.

| `indexPath`
| `string`
Expand Down
11 changes: 11 additions & 0 deletions test/e2e/byok_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
olsv1alpha1 "github.com/openshift/lightspeed-operator/api/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

var _ = Describe("BYOK", Ordered, Label("BYOK"), func() {
Expand All @@ -32,6 +33,16 @@ var _ = Describe("BYOK", Ordered, Label("BYOK"), func() {
Expect(err).NotTo(HaveOccurred())
})

It("should check that the default index ID is empty", FlakeAttempts(5), func() {
olsConfig := &olsv1alpha1.OLSConfig{
ObjectMeta: metav1.ObjectMeta{
Name: OLSCRName,
}}
err := env.Client.Get(olsConfig)
Expect(err).NotTo(HaveOccurred())
Expect(olsConfig.Spec.OLSConfig.RAG[0].IndexID).To(BeEmpty())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is failing:

BYOK [It] should check that the default index ID is empty [BYOK]
/go/src/github.com/openshift/lightspeed-operator/test/e2e/byok_test.go:36
  [FAILED] Expected
      <string>: vector_db_index
  to be empty
  In [It] at: /go/src/github.com/openshift/lightspeed-operator/test/e2e/byok_test.go:43 @ 10/08/25 05:42:53.317

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @raptorsun, I've updated the bundle.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@raptorsun Updating the bundle was not enough, the PR needs openshift/lightspeed-service#2626 to be merged.

})

It("should query the BYOK database", FlakeAttempts(5), func() {
By("Testing OLS service activation")
secret, err := TestOLSServiceActivation(env)
Expand Down