OKP Follow-up

[umago]

This change includes two commits:

1. Documents the available configurations under the dev: section. The dev: section is an experimental section that is used by developers only therefore it's been documented in code only.

2. In the vector_database_build.py script, the --okp-rag-only option name was a bit misleading so it has been renamed to --disable-rag-entries.

This change is a follow up on the original OKP enablement PR#110

Summary by CodeRabbit

• Documentation

  • Added comprehensive documentation for internal developer configuration options, detailing supported settings for feature flags and RAG (Retrieval-Augmented Generation) behavior with example values and default configurations.

• Chores

  • Renamed vector database configuration flag from --okp-rag-only to --disable-rag-entries to better reflect its functionality and improve code clarity.
  • Updated corresponding configuration injection logic to align with the new flag naming convention.

[coderabbitai]

📝 Walkthrough

Walkthrough

Renames the --okp-rag-only CLI flag to --disable-rag-entries in vector_database_build.py (function parameter, conditional logic, argument parser, and functools.partial wiring), updates the Go init container command to pass the new flag name, and expands the DevSpec documentation comment to enumerate supported experimental fields.

Changes

RAG flag rename across Python script and Go controller

Layer / File(s)	Summary
Python script: parameter and CLI flag rename internal/controller/assets/vector_database_build.py	lstack_process parameter renamed from okp_rag_only to disable_rag_entries; rag.inline conditional updated to if not disable_rag_entries:; parse_arguments replaces --okp-rag-only with --disable-rag-entries (store_true); main() rewires functools.partial to pass disable_rag_entries=args.disable_rag_entries.
Go controller command update and DevSpec docs internal/controller/lcore_deployment.go, api/v1beta1/openstacklightspeed_types.go	buildInitContainers switches the appended flag from --okp-rag-only to --disable-rag-entries when devConfig.OKPRagOnly is true; DevSpec comment expanded to enumerate featureFlags, okpChunkFilterQuery, and okpRagOnly with defaults and examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Suggested labels

lgtm

Suggested reviewers

• Akrog

Poem

🐇 A flag once named in RAG's old way,
Now --disable-rag-entries holds sway.
The Python script and Go aligned,
The same new name in both you'll find.
Hop along, the stack's in sync today! 🌿

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'OKP Follow-up' is vague and does not clearly convey the specific changes in the PR, which include documentation additions and flag renaming.	Use a more descriptive title that summarizes the main changes, such as 'Document dev config and rename rag-only flag' or 'Add dev config documentation and refactor RAG flag naming'.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[omkarjoshi0304]

lgtm

[lpiwowar]

/lgtm

Thank you!:) 👍

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lpiwowar, umago

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [lpiwowar,umago]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment