Skip to content

Commit 0c6e51c

Browse files
tisniktisnik
authored
Merge pull request lightspeed-core#848 from tisnik/lcore-973-database-configuration-description
LCORE-973: database configuration description
2 parents 8088ac5 + d9d6953 commit 0c6e51c

3 files changed

Lines changed: 60 additions & 49 deletions

File tree

‎docs/config.html‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ <h1 class="title"> </h1>
173173
</header>
174174
<h1 id="lightspeed-core-stack">Lightspeed Core Stack</h1>
175175
<hr />
176-
<h1 id="configuration-schema">📋 Configuration schema</h1>
176+
<h1 id="components">📋 Components</h1>
177177
<h2 id="accessrule">AccessRule</h2>
178178
<p>Rule defining what actions a role can perform.</p>
179179
<table>
@@ -222,12 +222,12 @@ <h2 id="authenticationconfiguration">AuthenticationConfiguration</h2>
222222
</tr>
223223
<tr class="odd">
224224
<td>k8s_cluster_api</td>
225-
<td></td>
225+
<td>string</td>
226226
<td></td>
227227
</tr>
228228
<tr class="even">
229229
<td>k8s_ca_cert_path</td>
230-
<td></td>
230+
<td>string</td>
231231
<td></td>
232232
</tr>
233233
<tr class="odd">
@@ -456,7 +456,7 @@ <h2 id="configuration">Configuration</h2>
456456
<tbody>
457457
<tr class="odd">
458458
<td>type</td>
459-
<td></td>
459+
<td>string</td>
460460
<td></td>
461461
</tr>
462462
<tr class="even">
@@ -512,7 +512,7 @@ <h2 id="customization">Customization</h2>
512512
<tbody>
513513
<tr class="odd">
514514
<td>profile_path</td>
515-
<td></td>
515+
<td>string</td>
516516
<td></td>
517517
</tr>
518518
<tr class="even">
@@ -522,12 +522,12 @@ <h2 id="customization">Customization</h2>
522522
</tr>
523523
<tr class="odd">
524524
<td>system_prompt_path</td>
525-
<td></td>
525+
<td>string</td>
526526
<td></td>
527527
</tr>
528528
<tr class="even">
529529
<td>system_prompt</td>
530-
<td></td>
530+
<td>string</td>
531531
<td></td>
532532
</tr>
533533
<tr class="odd">
@@ -551,12 +551,12 @@ <h2 id="databaseconfiguration">DatabaseConfiguration</h2>
551551
<tr class="odd">
552552
<td>sqlite</td>
553553
<td></td>
554-
<td></td>
554+
<td>SQLite database configuration</td>
555555
</tr>
556556
<tr class="even">
557557
<td>postgres</td>
558558
<td></td>
559-
<td></td>
559+
<td>PostgreSQL database configuration</td>
560560
</tr>
561561
</tbody>
562562
</table>
@@ -591,12 +591,12 @@ <h2 id="inferenceconfiguration">InferenceConfiguration</h2>
591591
<tbody>
592592
<tr class="odd">
593593
<td>default_model</td>
594-
<td></td>
594+
<td>string</td>
595595
<td></td>
596596
</tr>
597597
<tr class="even">
598598
<td>default_provider</td>
599-
<td></td>
599+
<td>string</td>
600600
<td></td>
601601
</tr>
602602
</tbody>
@@ -705,22 +705,22 @@ <h2 id="llamastackconfiguration">LlamaStackConfiguration</h2>
705705
<tbody>
706706
<tr class="odd">
707707
<td>url</td>
708-
<td></td>
708+
<td>string</td>
709709
<td></td>
710710
</tr>
711711
<tr class="even">
712712
<td>api_key</td>
713-
<td></td>
713+
<td>string</td>
714714
<td></td>
715715
</tr>
716716
<tr class="odd">
717717
<td>use_as_library_client</td>
718-
<td></td>
718+
<td>boolean</td>
719719
<td></td>
720720
</tr>
721721
<tr class="even">
722722
<td>library_client_config_path</td>
723-
<td></td>
723+
<td>string</td>
724724
<td></td>
725725
</tr>
726726
</tbody>
@@ -811,7 +811,7 @@ <h2 id="modelcontextprotocolserver">ModelContextProtocolServer</h2>
811811
</tr>
812812
<tr class="even">
813813
<td>namespace</td>
814-
<td></td>
814+
<td>string</td>
815815
<td>Database namespace</td>
816816
</tr>
817817
<tr class="odd">
@@ -827,7 +827,7 @@ <h2 id="modelcontextprotocolserver">ModelContextProtocolServer</h2>
827827
</tr>
828828
<tr class="odd">
829829
<td>ca_cert_path</td>
830-
<td></td>
830+
<td>string</td>
831831
<td>Path to CA certificate</td>
832832
</tr>
833833
</tbody>
@@ -939,7 +939,7 @@ <h2 id="rhidentityconfiguration">RHIdentityConfiguration</h2>
939939
<tbody>
940940
<tr class="odd">
941941
<td>required_entitlements</td>
942-
<td></td>
942+
<td>array</td>
943943
<td></td>
944944
</tr>
945945
</tbody>
@@ -1049,17 +1049,17 @@ <h2 id="tlsconfiguration">TLSConfiguration</h2>
10491049
<tbody>
10501050
<tr class="odd">
10511051
<td>tls_certificate_path</td>
1052-
<td></td>
1052+
<td>string</td>
10531053
<td>SSL/TLS certificate file path for HTTPS support.</td>
10541054
</tr>
10551055
<tr class="even">
10561056
<td>tls_key_path</td>
1057-
<td></td>
1057+
<td>string</td>
10581058
<td>SSL/TLS private key file path for HTTPS support.</td>
10591059
</tr>
10601060
<tr class="odd">
10611061
<td>tls_key_password</td>
1062-
<td></td>
1062+
<td>string</td>
10631063
<td>Path to file containing the password to decrypt the SSL/TLS private
10641064
key.</td>
10651065
</tr>
@@ -1083,7 +1083,7 @@ <h2 id="userdatacollection">UserDataCollection</h2>
10831083
</tr>
10841084
<tr class="even">
10851085
<td>feedback_storage</td>
1086-
<td></td>
1086+
<td>string</td>
10871087
<td></td>
10881088
</tr>
10891089
<tr class="odd">
@@ -1093,7 +1093,7 @@ <h2 id="userdatacollection">UserDataCollection</h2>
10931093
</tr>
10941094
<tr class="even">
10951095
<td>transcripts_storage</td>
1096-
<td></td>
1096+
<td>string</td>
10971097
<td></td>
10981098
</tr>
10991099
</tbody>

‎docs/config.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
---
55

6-
# 📋 Configuration schema
6+
# 📋 Components
77

88

99

@@ -37,8 +37,8 @@ Authentication configuration.
3737
|-------|------|-------------|
3838
| module | string | |
3939
| skip_tls_verification | boolean | |
40-
| k8s_cluster_api | | |
41-
| k8s_ca_cert_path | | |
40+
| k8s_cluster_api | string | |
41+
| k8s_ca_cert_path | string | |
4242
| jwk_config | | |
4343
| rh_identity_config | | |
4444

@@ -125,7 +125,7 @@ Conversation cache configuration.
125125

126126
| Field | Type | Description |
127127
|-------|------|-------------|
128-
| type | | |
128+
| type | string | |
129129
| memory | | |
130130
| sqlite | | |
131131
| postgres | | |
@@ -151,10 +151,10 @@ Service customization.
151151

152152
| Field | Type | Description |
153153
|-------|------|-------------|
154-
| profile_path | | |
154+
| profile_path | string | |
155155
| disable_query_system_prompt | boolean | |
156-
| system_prompt_path | | |
157-
| system_prompt | | |
156+
| system_prompt_path | string | |
157+
| system_prompt | string | |
158158
| custom_profile | | |
159159

160160

@@ -166,8 +166,8 @@ Database configuration.
166166

167167
| Field | Type | Description |
168168
|-------|------|-------------|
169-
| sqlite | | |
170-
| postgres | | |
169+
| sqlite | | SQLite database configuration |
170+
| postgres | | PostgreSQL database configuration |
171171

172172

173173
## InMemoryCacheConfig
@@ -189,8 +189,8 @@ Inference configuration.
189189

190190
| Field | Type | Description |
191191
|-------|------|-------------|
192-
| default_model | | |
193-
| default_provider | | |
192+
| default_model | string | |
193+
| default_provider | string | |
194194

195195

196196
## JsonPathOperator
@@ -249,10 +249,10 @@ Llama stack configuration.
249249

250250
| Field | Type | Description |
251251
|-------|------|-------------|
252-
| url | | |
253-
| api_key | | |
254-
| use_as_library_client | | |
255-
| library_client_config_path | | |
252+
| url | string | |
253+
| api_key | string | |
254+
| use_as_library_client | boolean | |
255+
| library_client_config_path | string | |
256256

257257

258258
## ModelContextProtocolServer
@@ -291,10 +291,10 @@ Useful resources:
291291
| db | string | Database name to connect to |
292292
| user | string | Database user name used to authenticate |
293293
| password | string | Password used to authenticate |
294-
| namespace | | Database namespace |
294+
| namespace | string | Database namespace |
295295
| ssl_mode | string | SSL mode |
296296
| gss_encmode | string | This option determines whether or with what priority a secure GSS TCP/IP connection will be negotiated with the server. |
297-
| ca_cert_path | | Path to CA certificate |
297+
| ca_cert_path | string | Path to CA certificate |
298298

299299

300300
## QuotaHandlersConfiguration
@@ -346,7 +346,7 @@ Red Hat Identity authentication configuration.
346346

347347
| Field | Type | Description |
348348
|-------|------|-------------|
349-
| required_entitlements | | |
349+
| required_entitlements | array | |
350350

351351

352352
## SQLiteDatabaseConfiguration
@@ -398,9 +398,9 @@ Useful resources:
398398

399399
| Field | Type | Description |
400400
|-------|------|-------------|
401-
| tls_certificate_path | | SSL/TLS certificate file path for HTTPS support. |
402-
| tls_key_path | | SSL/TLS private key file path for HTTPS support. |
403-
| tls_key_password | | Path to file containing the password to decrypt the SSL/TLS private key. |
401+
| tls_certificate_path | string | SSL/TLS certificate file path for HTTPS support. |
402+
| tls_key_path | string | SSL/TLS private key file path for HTTPS support. |
403+
| tls_key_password | string | Path to file containing the password to decrypt the SSL/TLS private key. |
404404

405405

406406
## UserDataCollection
@@ -412,6 +412,6 @@ User data collection configuration.
412412
| Field | Type | Description |
413413
|-------|------|-------------|
414414
| feedback_enabled | boolean | |
415-
| feedback_storage | | |
415+
| feedback_storage | string | |
416416
| transcripts_enabled | boolean | |
417-
| transcripts_storage | | |
417+
| transcripts_storage | string | |

‎src/models/config.py‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,17 @@ def check_postgres_configuration(self) -> Self:
232232
class DatabaseConfiguration(ConfigurationBase):
233233
"""Database configuration."""
234234

235-
sqlite: Optional[SQLiteDatabaseConfiguration] = None
236-
postgres: Optional[PostgreSQLDatabaseConfiguration] = None
235+
sqlite: Optional[SQLiteDatabaseConfiguration] = Field(
236+
None,
237+
title="SQLite configuration",
238+
description="SQLite database configuration",
239+
)
240+
241+
postgres: Optional[PostgreSQLDatabaseConfiguration] = Field(
242+
None,
243+
title="PostgreSQL configuration",
244+
description="PostgreSQL database configuration",
245+
)
237246

238247
@model_validator(mode="after")
239248
def check_database_configuration(self) -> Self:
@@ -762,7 +771,9 @@ class Configuration(ConfigurationBase):
762771
service: ServiceConfiguration
763772
llama_stack: LlamaStackConfiguration
764773
user_data_collection: UserDataCollection
765-
database: DatabaseConfiguration = Field(default_factory=DatabaseConfiguration)
774+
database: DatabaseConfiguration = Field(
775+
default_factory=lambda: DatabaseConfiguration(sqlite=None, postgres=None),
776+
)
766777
mcp_servers: list[ModelContextProtocolServer] = Field(default_factory=list)
767778
authentication: AuthenticationConfiguration = Field(
768779
default_factory=AuthenticationConfiguration

0 commit comments

Comments
 (0)