Skip to content

docs(okp): add RH_SERVER_OKP and change recommended OKP port to 8081 #1623

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
tisnik merged 1 commit into from
Apr 29, 2026
+9 −6
Merged

docs(okp): add RH_SERVER_OKP and change recommended OKP port to 8081 #1623

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
15 changes: 9 additions & 6 deletions docs/okp_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,21 +47,21 @@ OKP (Offline Knowledge Portal) provides a Solr-backed RAG source that Lightspeed
Start the OKP RAG service with Podman:

```bash
podman run --rm -d -p 8983:8080 registry.redhat.io/offline-knowledge-portal/rhokp-rhel9:latest
podman run --rm -d -p 8081:8080 registry.redhat.io/offline-knowledge-portal/rhokp-rhel9:latest
```

> **Note:** Remove `-d` to run in the foreground.

* The service listens on **port 8983** on the host (mapped from 8080 in the container).
* The service listens on **port 8081** on the host (mapped from 8080 in the container). Lightspeed Stack itself listens on `8080`, so this avoids port conflicts.
* Confirm it is running by opening in a browser or with `curl`:

```bash
curl -s http://localhost:8983
curl -s http://localhost:8081
```

Or visit: **http://localhost:8983**
Or visit: **http://localhost:8081**

> **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8983. If you need a different OKP url, you can set the SOLR_URL environment variable with the correct url prior to launching Lightspeed stack and that value will be used instead.
> **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8081. If you need a different OKP url, you can set the SOLR_URL environment variable with the correct url prior to launching Lightspeed stack and that value will be used instead.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 28, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Fix env var name on the “different OKP url” note (likely should be RH_SERVER_OKP, not SOLR_URL).

Line [64] says: “set the SOLR_URL environment variable…”. But the rest of this guide sets RH_SERVER_OKP (line [74]) and the config examples wire okp.rhokp_url: ${env.RH_SERVER_OKP} (lines [109] and [120]). If SOLR_URL isn’t actually supported by Lightspeed Stack, this will confuse users.

🛠️ Proposed fix 
-If you need a different OKP url, you can set the SOLR_URL environment variable with the correct url prior to launching Lightspeed stack and that value will be used instead.
+If you need a different OKP url, you can set the `RH_SERVER_OKP` environment variable with the correct url before launching Lightspeed Stack, and that value will be used instead.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8081. If you need a different OKP url, you can set the SOLR_URL environment variable with the correct url prior to launching Lightspeed stack and that value will be used instead.
> **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8081. If you need a different OKP url, you can set the `RH_SERVER_OKP` environment variable with the correct url before launching Lightspeed Stack, and that value will be used instead.
🧰 Tools
🪛 LanguageTool

[style] ~64-~64: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...vironment variable with the correct url prior to launching Lightspeed stack and that val...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/okp_guide.md` at line 64, Update the note to reference the correct
environment variable name: replace SOLR_URL with RH_SERVER_OKP so it matches the
rest of the doc and the configuration examples (referencing okp.rhokp_url:
${env.RH_SERVER_OKP}); ensure the note instructs users to set RH_SERVER_OKP to
their OKP URL (e.g., http://localhost:8081) before launching Lightspeed stack.

---

## Step 2: Setup llamastack config environment variables
Expand All @@ -71,6 +71,7 @@ Set the required environment variables. The external providers path must point t
```bash
export EXTERNAL_PROVIDERS_DIR=../lightspeed-providers/resources/external_providers
export OPENAI_API_KEY=<your-openai-api-key>
export RH_SERVER_OKP=http://localhost:8081
```

Adjust `EXTERNAL_PROVIDERS_DIR` if your lightspeed-providers repo is in a different location relative to your lightspeed-stack directory.
Expand Down Expand Up @@ -105,6 +106,7 @@ rag:
inline:
- okp
okp:
rhokp_url: ${env.RH_SERVER_OKP}
offline: true
```

Expand All @@ -115,6 +117,7 @@ rag:
tool:
- okp
okp:
rhokp_url: ${env.RH_SERVER_OKP}
offline: true
```

Expand Down Expand Up @@ -197,7 +200,7 @@ Example response excerpt:

If you see no RAG context, verify:

1. OKP is up at http://localhost:8983
1. OKP is up at http://localhost:8081
2. `lightspeed-stack.yaml` has `okp` under `rag.inline` and/or `rag.tool` as in Step 4

---
Loading