Skip to content

Commit f8fec1a

Browse files
openshift-cherrypick-robotpabel-rh
authored andcommitted
[release-1.8] RHDHPAI-1091: Lightspeed Core Developer Lightspeed (redhat-developer#1545)
* Lightspeed Core Developer Lightspeed * Incorporated some of the comments * Fixed merge conflict * Incorporated the remaining tech comments * Incorporated Ben's comments * Added some comments * Incorporated some comments and added architecture image * Minor change * Added the new heading for install and configure * Incorporated Tim's suggestions * Fixing build error * Minor changes and rebase * updating rcs * Minor change * minor change * Minor change * Incorporated Jordan and Ben's comments * Maysuns comments and updated screenshots * rhdhbugs-2225 * Minor changes and rebase * Incorporated Karthik's comments * Added Maysun's and Stephanie's comments * Incorporated Jordan's coments * Minor * Minor changes * Minor changes --------- Co-authored-by: Priyanka Abel <[email protected]>
1 parent 180039f commit f8fec1a

21 files changed

+404
-545
lines changed

artifacts/attributes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@
5353
:odf-name: OpenShift Data Foundation
5454
:osd-brand-name: Red Hat OpenShift Dedicated
5555
:osd-short: OpenShift Dedicated
56-
:rcs-name: Road-Core Service
57-
:rcs-short: RCS
56+
:lcs-name: Lightspeed Core Service
57+
:lcs-short: LCS
5858
:rhacs-brand-name: Red Hat Advanced Cluster Security
5959
:rhacs-short: Advanced Cluster Security
6060
:rhacs-very-short: ACS

assemblies/assembly-customizing-developer-lightspeed.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44
[id="{context}"]
55
= Customizing {ls-short}
66

7-
You can customize {ls-short} functionalities, such as, question validation, gathering feedback, and storing chat history in PostgreSQL.
8-
9-
include::modules/developer-lightspeed/proc-using-question-validation.adoc[leveloffset=+1]
7+
You can customize {ls-short} functionalities such as gathering feedback, storing chat history in PostgreSQL, and {model-context-protocol-link}#proc-configure-mcp-tools-for-developer-lightspeed_assembly-model-context-protocol-tools[configuring Model Context Protocol (MCP) tools].
108

119
include::modules/developer-lightspeed/proc-gathering-feedback.adoc[leveloffset=+1]
1210

assemblies/assembly-developer-lightspeed.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::modules/developer-lightspeed/con-about-developer-lightspeed.adoc[levelo
88

99
include::modules/developer-lightspeed/con-supported-architecture.adoc[leveloffset=+1]
1010

11-
include::modules/developer-lightspeed/con-about-road-core-service.adoc[leveloffset=+2]
11+
include::modules/developer-lightspeed/con-about-lightspeed-stack-and-llama-stack.adoc[leveloffset=+2]
1212

1313
include::modules/developer-lightspeed/con-rag-embeddings.adoc[leveloffset=+1]
1414

assemblies/assembly-using-developer-lightspeed.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ endif::[]
1313

1414
{ls-brand-name} is designed to support you when performing various tasks during your development workflow.
1515

16+
[NOTE]
17+
====
18+
The `Question Validation` feature is enabled by default if you are using the `quay.io/redhat-ai-dev/llama-stack` image without overriding the `run.yaml` configuration file in the image. To disable `Question Validation`, you must mount a `run.yaml` file to the container with the following sections removed:
19+
20+
* `Safety`
21+
* `Shields`
22+
* `External_providers_dir` set to `null`
23+
====
24+
1625
With `Question Validation` enabled, you can ask {ls-short} the following types of questions:
1726

1827
* “Tell me about {product}.”
132 KB
Loading
101 KB
Loading
-154 KB
Binary file not shown.

modules/developer-lightspeed/con-about-bring-your-own-model.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[id="con-about-bring-your-own-model_{context}"]
44
= About Bring Your Own Model
55

6-
{ls-short} does not provide its own inference services, but uses a _Bring Your Own Model_ approach. This means that you can configure the {rcs-name} to talk to the inference server or service of your choice. This also means that you are responsible for ensuring that the configured service meets your particular company policies and legal requirements, including any applicable terms with the third-party model provider.
6+
{ls-short} does not provide its own inference services, but uses a _Bring Your Own Model_ approach. This means that you can configure the {lcs-name} to talk to the inference server or service of your choice. This also means that you are responsible for ensuring that the configured service meets your particular company policies and legal requirements, including any applicable terms with the third-party model provider.
77
//Add the cross reference to "Bring your own model"
88
The only technical requirements for inference services are:
99

modules/developer-lightspeed/con-about-developer-lightspeed.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This early access program enables customers to share feedback on the user experi
1414
You can experience {ls-short} Developer Preview by installing the Developer Lightspeed for {product} plugin within an existing {product-very-short} instance.
1515
Alternatively, if you prefer to test it locally first, you can try {ls-short} using {product-local-very-short}.
1616

17-
image::rhdh-plugins-reference/developer-lightspeed.png[]
17+
image::rhdh-plugins-reference/developer-lightspeed-1-8-0.png[]
1818

1919
.Additional resources
20-
* link:https://github.com/redhat-developer/rhdh-local/blob/main/README.md[{product-local-very-short}]
20+
* link:https://github.com/redhat-developer/rhdh-local/blob/main/README.md[{product-local-very-short}]
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="con-about-lightspeed-stack-and-llama-stack_{context}"]
4+
= About {lcs-name} and Llama Stack
5+
6+
The {lcs-name} and Llama Stack deploy together as sidecar containers to augment {product-very-short} functionality.
7+
8+
The Llama Stack delivers the augmented functionality by integrating and managing core components, which include:
9+
10+
* Large language model (LLM) inference providers
11+
12+
* Model Context Protocol (MCP) or Retrieval Augmented Generation (RAG) tool runtime providers
13+
14+
* Safety providers
15+
16+
* Vector database settings
17+
18+
The {lcs-name} serves as the Llama Stack service intermediary. It manages the operational configuration and key data, specifically:
19+
20+
* User feedback collection
21+
22+
* MCP server configuration
23+
24+
* Conversation history
25+
26+
Llama Stack provides the inference functionality that {lcs-short} uses to process requests. For more information, see https://llamastack.github.io/docs#what-is-llama-stack[What is Llama Stack].
27+
28+
The {ls-brand-name} plugin in {product-very-short} sends prompts and receives LLM responses through the {lcs-short} sidecar. {lcs-short} then uses the Llama Stack sidecar service to perform inference and MCP or RAG tool calling.
29+
30+
[NOTE]
31+
====
32+
{ls-brand-name} is a Developer Preview release. You must manually deploy the {lcs-name} and Llama Stack sidecar containers, and install the {ls-brand-name} plugin on your {product-very-short} instance.
33+
====

0 commit comments

Comments
 (0)