Skip to content

Commit 218e021

Browse files
committed
LCORE-1170: Updated configuration documentation
1 parent 420784e commit 218e021

2 files changed

Lines changed: 89 additions & 5 deletions

File tree

docs/config.html

Lines changed: 63 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,43 @@ <h1 class="title"> </h1>
176176
<h1 id="lightspeed-core-stack">Lightspeed Core Stack</h1>
177177
<hr/>
178178
<h1 id="configuration-schema">&#x1F4CB; Configuration schema</h1>
179+
<h2 id="a2astateconfiguration">A2AStateConfiguration</h2>
180+
<p>A2A protocol persistent state configuration.</p>
181+
<p>Configures how A2A task state and context-to-conversation mappings
182+
are stored. For multi-worker deployments, use SQLite or PostgreSQL to
183+
ensure state is shared across all workers.</p>
184+
<p>If no configuration is provided, in-memory storage is used (default).
185+
This is suitable for single-worker deployments but state will be lost on
186+
restarts and not shared across workers.</p>
187+
<p>Attributes: sqlite: SQLite database configuration for A2A state
188+
storage. postgres: PostgreSQL database configuration for A2A state
189+
storage.</p>
190+
<table>
191+
<colgroup>
192+
<col style="width: 26%"/>
193+
<col style="width: 23%"/>
194+
<col style="width: 50%"/>
195+
</colgroup>
196+
<thead>
197+
<tr class="header">
198+
<th>Field</th>
199+
<th>Type</th>
200+
<th>Description</th>
201+
</tr>
202+
</thead>
203+
<tbody>
204+
<tr class="odd">
205+
<td>sqlite</td>
206+
<td/>
207+
<td>SQLite database configuration for A2A state storage.</td>
208+
</tr>
209+
<tr class="even">
210+
<td>postgres</td>
211+
<td/>
212+
<td>PostgreSQL database configuration for A2A state storage.</td>
213+
</tr>
214+
</tbody>
215+
</table>
179216
<h2 id="apikeytokenconfiguration">APIKeyTokenConfiguration</h2>
180217
<p>API Key Token configuration.</p>
181218
<table>
@@ -491,6 +528,11 @@ <h2 id="configuration">Configuration</h2>
491528
reconfigure Llama Stack through its run.yaml configuration file</td>
492529
</tr>
493530
<tr class="odd">
531+
<td>a2a_state</td>
532+
<td/>
533+
<td>Configuration for A2A protocol persistent state storage.</td>
534+
</tr>
535+
<tr class="even">
494536
<td>quota_handlers</td>
495537
<td/>
496538
<td>Quota handlers configuration</td>
@@ -590,6 +632,16 @@ <h2 id="customization">Customization</h2>
590632
<td>string</td>
591633
<td/>
592634
</tr>
635+
<tr class="odd">
636+
<td>agent_card_path</td>
637+
<td>string</td>
638+
<td/>
639+
</tr>
640+
<tr class="even">
641+
<td>agent_card_config</td>
642+
<td>object</td>
643+
<td/>
644+
</tr>
593645
<tr class="odd">
594646
<td>custom_profile</td>
595647
<td/>
@@ -1217,31 +1269,37 @@ <h2 id="serviceconfiguration">ServiceConfiguration</h2>
12171269
<td>Service port</td>
12181270
</tr>
12191271
<tr class="odd">
1272+
<td>base_url</td>
1273+
<td>string</td>
1274+
<td>Externally reachable base URL for the service; needed for A2A
1275+
support.</td>
1276+
</tr>
1277+
<tr class="even">
12201278
<td>auth_enabled</td>
12211279
<td>boolean</td>
12221280
<td>Enables the authentication subsystem</td>
12231281
</tr>
1224-
<tr class="even">
1282+
<tr class="odd">
12251283
<td>workers</td>
12261284
<td>integer</td>
12271285
<td>Number of Uvicorn worker processes to start</td>
12281286
</tr>
1229-
<tr class="odd">
1287+
<tr class="even">
12301288
<td>color_log</td>
12311289
<td>boolean</td>
12321290
<td>Enables colorized logging</td>
12331291
</tr>
1234-
<tr class="even">
1292+
<tr class="odd">
12351293
<td>access_log</td>
12361294
<td>boolean</td>
12371295
<td>Enables logging of all access information</td>
12381296
</tr>
1239-
<tr class="odd">
1297+
<tr class="even">
12401298
<td>tls_config</td>
12411299
<td/>
12421300
<td>Transport Layer Security configuration for HTTPS support</td>
12431301
</tr>
1244-
<tr class="even">
1302+
<tr class="odd">
12451303
<td>cors</td>
12461304
<td/>
12471305
<td>Cross-Origin Resource Sharing configuration for cross-domain

docs/config.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,28 @@
55

66
# 📋 Configuration schema
77

8+
## A2AStateConfiguration
9+
10+
11+
A2A protocol persistent state configuration.
12+
13+
Configures how A2A task state and context-to-conversation mappings are
14+
stored. For multi-worker deployments, use SQLite or PostgreSQL to ensure
15+
state is shared across all workers.
16+
17+
If no configuration is provided, in-memory storage is used (default).
18+
This is suitable for single-worker deployments but state will be lost
19+
on restarts and not shared across workers.
20+
21+
Attributes:
22+
sqlite: SQLite database configuration for A2A state storage.
23+
postgres: PostgreSQL database configuration for A2A state storage.
24+
25+
26+
| Field | Type | Description |
27+
|-------|------|-------------|
28+
| sqlite | | SQLite database configuration for A2A state storage. |
29+
| postgres | | PostgreSQL database configuration for A2A state storage. |
830

931

1032
## APIKeyTokenConfiguration
@@ -128,6 +150,7 @@ Global service configuration.
128150
| inference | | One LLM provider and one its model might be selected as default ones. When no provider+model pair is specified in REST API calls (query endpoints), the default provider and model are used. |
129151
| conversation_cache | | |
130152
| byok_rag | array | BYOK RAG configuration. This configuration can be used to reconfigure Llama Stack through its run.yaml configuration file |
153+
| a2a_state | | Configuration for A2A protocol persistent state storage. |
131154
| quota_handlers | | Quota handlers configuration |
132155

133156

@@ -169,6 +192,8 @@ Service customization.
169192
| disable_query_system_prompt | boolean | |
170193
| system_prompt_path | string | |
171194
| system_prompt | string | |
195+
| agent_card_path | string | |
196+
| agent_card_config | object | |
172197
| custom_profile | | |
173198

174199

@@ -461,6 +486,7 @@ the service can handle requests concurrently.
461486
|-------|------|-------------|
462487
| host | string | Service hostname |
463488
| port | integer | Service port |
489+
| base_url | string | Externally reachable base URL for the service; needed for A2A support. |
464490
| auth_enabled | boolean | Enables the authentication subsystem |
465491
| workers | integer | Number of Uvicorn worker processes to start |
466492
| color_log | boolean | Enables colorized logging |

0 commit comments

Comments
 (0)