Skip to content

Commit 7008c47

Browse files
committed
Added some comments
1 parent 857ccfb commit 7008c47

File tree

4 files changed

+18
-200
lines changed

4 files changed

+18
-200
lines changed

assemblies/assembly-customizing-developer-lightspeed.adoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,12 @@
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 configuring Model Context Protocol (MCP) tools.
108

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

1311
include::modules/developer-lightspeed/proc-updating-the-system-prompt.adoc[leveloffset=+1]
1412

1513
include::modules/developer-lightspeed/proc-customizing-the-chat-history-storage.adoc[leveloffset=+1]
1614

17-
include::modules/developer-lightspeed/proc-changing-your-llm-provider.adoc[leveloffset=+1]
18-
19-
include::modules/developer-lightspeed/proc-configuring-mcp-components.adoc[leveloffset=+1]
15+
include::modules/developer-lightspeed/proc-changing-your-llm-provider.adoc[leveloffset=+1]

modules/developer-lightspeed/proc-configuring-mcp-components.adoc

Lines changed: 0 additions & 63 deletions
This file was deleted.

modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,11 @@ mcp_servers:
5555
provider_id: model-context-protocol
5656
url: https://<RHDH_HOST>/api/mcp-actions/v1
5757
----
58+
+
5859
where:
5960

60-
`mcp_servers`:: Optional: Set this configuration if you want to integrate MCP. See {model-context-protocol-link}[{model-context-protocol-title}].
61+
62+
(Optional) `mcp_servers`:: Set this configuration if you want to integrate MCP. See {model-context-protocol-link}[{model-context-protocol-title}].
6163
`mcp_servers:name`:: This value must match the entry in the {ls-short} app config file for MCP servers.
6264
`model-context-protocol`:: This is the tool runtime provider defined and configured in the llama-stack `run.yaml` configuration for use in {lcs-short}.
6365

@@ -268,7 +270,7 @@ providers:
268270
kvstore:
269271
type: sqlite
270272
namespace: null
271-
db_path: /app-root/vector_db/rhdh_product_docs/1.7/faiss_store.db
273+
db_path: /app-root/vector_db/rhdh_product_docs/1.8/faiss_store.db
272274
scoring_fns: []
273275
server:
274276
auth: null
@@ -289,11 +291,8 @@ vector_dbs:
289291
- embedding_dimension: 768
290292
embedding_model: sentence-transformers/all-mpnet-base-v2
291293
provider_id: rhdh-docs
292-
vector_db_id: rhdh-product-docs-1_7
294+
vector_db_id: rhdh-product-docs-1_8
293295
----
294-
where:
295-
`_<llm_server>_`:: Enter your LLM server details.
296-
`_<openai_api_key>_`:: Enter your OpenAI API key.
297296

298297
. Create the {ls-short} ConfigMap.
299298
+
@@ -350,7 +349,7 @@ data:
350349
----
351350
where:
352351

353-
`mcp_servers`:: Optional: Set this configuration if you want to integrate MCP.
352+
`lightspeed:mcpServers`:: Optional: Set this configuration if you want to integrate MCP.
354353

355354
. Create the Llama Stack secret file.
356355
.. In the {ocp-short} web console, go to *Secrets*.
@@ -383,7 +382,7 @@ stringData:
383382
includes:
384383
- dynamic-plugins.default.yaml
385384
plugins:
386-
- package: ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed:next__1.0.0
385+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed:next__1.0.0
387386
disabled: false
388387
pluginConfig:
389388
lightspeed:
@@ -408,7 +407,7 @@ includes:
408407
menuItem:
409408
icon: LightspeedIcon
410409
text: Lightspeed
411-
- package: ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed-backend:next__1.0.1
410+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed-backend:next__1.0.1
412411
disabled: false
413412
pluginConfig:
414413
# OPTIONAL: Port for lightspeed service (default: 8080)
@@ -454,7 +453,7 @@ includes:
454453
subPath: rhdh_product_docs
455454
456455
----
457-
... Add the {ls-short} and Llama Stack Secret file as shown in the following example:
456+
... Add the Llama Stack Secret file as shown in the following example:
458457
+
459458
[source,yaml]
460459
----
@@ -465,7 +464,7 @@ includes:
465464
+
466465
[NOTE]
467466
====
468-
* Your {product-very-short} container is typically already present in your Kubernetes CR. You are adding the two additional container definitions for {lcs-short} and Llama Stack as the {lcs-short} sidecar.
467+
* Your {product-very-short} container is typically already present in your Kubernetes custom resource (CR). You are adding the two additional container definitions for {lcs-short} and Llama Stack as the {lcs-short} sidecar.
469468
====
470469
... Click *Save*. The Pods are automatically restarted.
471470
+
@@ -539,7 +538,7 @@ dynamic:
539538
includes:
540539
- dynamic-plugins.default.yaml
541540
plugins:
542-
- package: ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed:next__1.0.0
541+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed:next__1.0.0
543542
disabled: false
544543
pluginConfig:
545544
lightspeed:
@@ -564,7 +563,7 @@ dynamic:
564563
menuItem:
565564
icon: LightspeedIcon
566565
text: Lightspeed
567-
- package: ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed-backend:next__1.0.1
566+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed-backend:next__1.0.1
568567
disabled: false
569568
pluginConfig:
570569
# OPTIONAL: Port for lightspeed service (default: 8080)
@@ -595,12 +594,12 @@ extraVolumes:
595594
- mountPath: /app-root/config/lightspeed-stack.yaml
596595
name: lightspeed-stack
597596
----
598-
... Add the {ls-short} and Llama Stack Secret file as shown in the following example:
597+
... Add the Llama Stack Secret file as shown in the following example:
599598
+
600599
[source,yaml]
601600
----
602601
extraEnvVarsSecrets:
603-
- lightspeed-secrets
602+
- llama-stack-secrets
604603
----
605604
... Add the {lcs-short} image as shown in the following example:
606605
+
@@ -609,9 +608,9 @@ extraVolumes:
609608
extraContainers:
610609
envFrom:
611610
- secretRef:
612-
name: lightspeed-secrets
611+
name: llama-stack-secrets
613612
image: 'quay.io/redhat-ai-dev/llama-stack:latest'
614-
name: road-core-sidecar
613+
name: llama-stack
615614
ports:
616615
- containerPort: 8080
617616
name: lcs-backend
@@ -662,10 +661,6 @@ upstream:
662661
- mountPath: /app-root/config/lightspeed-stack.yaml
663662
name: lightspeed-stack
664663
subPath: lightspeed-stack.yaml
665-
# OPTIONAL: `llama-stack-config mount path configuration is only needed if you want to override the custom configuration
666-
- mountPath: /app-root/run.yaml
667-
name: llama-stack-config
668-
subPath: run.yaml
669664
extraEnvVars:
670665
...
671666
extraEnvVarsSecrets:

modules/developer-lightspeed/proc-using-question-validation.adoc

Lines changed: 0 additions & 110 deletions
This file was deleted.

0 commit comments

Comments
 (0)