Skip to content

LCORE-988: Regenerated configuration docs #887

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
Dec 9, 2025
Merged

LCORE-988: Regenerated configuration docs #887

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
23 changes: 23 additions & 0 deletions docs/config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,24 @@ <h1 class="title"> </h1>
<h1 id="lightspeed-core-stack">Lightspeed Core Stack</h1>
<hr/>
<h1 id="configuration-schema">&#x1F4CB; Configuration schema</h1>
<h2 id="apikeytokenconfiguration">APIKeyTokenConfiguration</h2>
<p>API Key Token configuration.</p>
<table>
<thead>
<tr class="header">
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>api_key</td>
<td>string</td>
<td/>
</tr>
</tbody>
</table>
<h2 id="accessrule">AccessRule</h2>
<p>Rule defining what actions a role can perform.</p>
<table>
Expand Down Expand Up @@ -240,6 +258,11 @@ <h2 id="authenticationconfiguration">AuthenticationConfiguration</h2>
<td/>
</tr>
<tr class="even">
<td>api_key_config</td>
<td/>
<td/>
</tr>
<tr class="odd">
<td>rh_identity_config</td>
<td/>
<td/>
Expand Down
36 changes: 24 additions & 12 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@



## APIKeyTokenConfiguration


API Key Token configuration.


| Field | Type | Description |
|-------|------|-------------|
| api_key | string | |


## AccessRule


Expand Down Expand Up @@ -42,6 +53,7 @@ Authentication configuration.
| k8s_cluster_api | string | |
| k8s_ca_cert_path | string | |
| jwk_config | | |
| api_key_config | | |
| rh_identity_config | | |


Expand Down Expand Up @@ -297,11 +309,11 @@ Useful resources:

Model context protocol server configuration.

MCP (Model Context Protocol) servers provide tools and
capabilities to the AI agents. These are configured by this structure.
Only MCP servers defined in the lightspeed-stack.yaml configuration are
available to the agents. Tools configured in the llama-stack run.yaml
are not accessible to lightspeed-core agents.
MCP (Model Context Protocol) servers provide tools and capabilities to the
AI agents. These are configured by this structure. Only MCP servers
defined in the lightspeed-stack.yaml configuration are available to the
agents. Tools configured in the llama-stack run.yaml are not accessible to
lightspeed-core agents.

Useful resources:

Expand All @@ -322,9 +334,9 @@ Useful resources:

PostgreSQL database configuration.

PostgreSQL database is used by Lightspeed Core Stack service for storing information about
conversation IDs. It can also be leveraged to store conversation history and information
about quota usage.
PostgreSQL database is used by Lightspeed Core Stack service for storing
information about conversation IDs. It can also be leveraged to store
conversation history and information about quota usage.

Useful resources:

Expand Down Expand Up @@ -437,10 +449,10 @@ SQLite database configuration.

Service configuration.

Lightspeed Core Stack is a REST API service that accepts requests
on a specified hostname and port. It is also possible to enable
authentication and specify the number of Uvicorn workers. When more
workers are specified, the service can handle requests concurrently.
Lightspeed Core Stack is a REST API service that accepts requests on a
specified hostname and port. It is also possible to enable authentication
and specify the number of Uvicorn workers. When more workers are specified,
the service can handle requests concurrently.


| Field | Type | Description |
Expand Down
Binary file modified docs/config.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/config.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
@startuml classes
set namespaceSeparator none
class "APIKeyTokenConfiguration" as src.models.config.APIKeyTokenConfiguration {
api_key
}
class "AccessRule" as src.models.config.AccessRule {
actions : list[Action]
role : str
Expand All @@ -8,6 +11,8 @@ class "Action" as src.models.config.Action {
name
}
class "AuthenticationConfiguration" as src.models.config.AuthenticationConfiguration {
api_key_config : Optional[APIKeyTokenConfiguration]
api_key_configuration
jwk_config : Optional[JwkConfiguration]
jwk_configuration
k8s_ca_cert_path : Optional[FilePath]
Expand Down Expand Up @@ -184,6 +189,7 @@ class "UserDataCollection" as src.models.config.UserDataCollection {
transcripts_storage : Optional[str]
check_storage_location_is_set_when_needed() -> Self
}
src.models.config.APIKeyTokenConfiguration --|> src.models.config.ConfigurationBase
src.models.config.AccessRule --|> src.models.config.ConfigurationBase
src.models.config.AuthenticationConfiguration --|> src.models.config.ConfigurationBase
src.models.config.AuthorizationConfiguration --|> src.models.config.ConfigurationBase
Expand Down
Loading
Loading