Skip to content

LCORE-336: Updated configuration diagram #405

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
merged 1 commit into from
Aug 17, 2025
Merged

LCORE-336: Updated configuration diagram #405

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
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.
30 changes: 27 additions & 3 deletions docs/config.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ class "AuthenticationConfiguration" as src.models.config.AuthenticationConfigura
check_authentication_model() -> Self
}
class "Configuration" as src.models.config.Configuration {
authentication : Optional[AuthenticationConfiguration]
authentication
customization : Optional[Customization]
database
inference
llama_stack
mcp_servers : list[ModelContextProtocolServer]
Expand All @@ -26,7 +27,13 @@ class "Customization" as src.models.config.Customization {
system_prompt_path : Optional[FilePath]
check_customization_model() -> Self
}

class "DatabaseConfiguration" as src.models.config.DatabaseConfiguration {
config
db_type
postgres : Optional[PostgreSQLDatabaseConfiguration]
sqlite : Optional[SQLiteDatabaseConfiguration]
check_database_configuration() -> Self
}
class "InferenceConfiguration" as src.models.config.InferenceConfiguration {
default_model : Optional[str]
default_provider : Optional[str]
Expand All @@ -52,6 +59,21 @@ class "ModelContextProtocolServer" as src.models.config.ModelContextProtocolServ
provider_id : str
url : str
}
class "PostgreSQLDatabaseConfiguration" as src.models.config.PostgreSQLDatabaseConfiguration {
ca_cert_path : Optional[FilePath]
db : str
gss_encmode : str
host : str
namespace : Optional[str]
password : str
port : int
ssl_mode : str
user : str
check_postgres_configuration() -> Self
}
class "SQLiteDatabaseConfiguration" as src.models.config.SQLiteDatabaseConfiguration {
db_path : str
}
class "ServiceConfiguration" as src.models.config.ServiceConfiguration {
access_log : bool
auth_enabled : bool
Expand All @@ -75,10 +97,12 @@ class "UserDataCollection" as src.models.config.UserDataCollection {
transcripts_storage : Optional[str]
check_storage_location_is_set_when_needed() -> Self
}

src.models.config.AuthenticationConfiguration --* src.models.config.Configuration : authentication
src.models.config.DatabaseConfiguration --* src.models.config.Configuration : database
src.models.config.InferenceConfiguration --* src.models.config.Configuration : inference
src.models.config.JwtConfiguration --* src.models.config.JwkConfiguration : jwt_configuration
src.models.config.LlamaStackConfiguration --* src.models.config.Configuration : llama_stack
src.models.config.SQLiteDatabaseConfiguration --* src.models.config.DatabaseConfiguration : sqlite
src.models.config.ServiceConfiguration --* src.models.config.Configuration : service
Comment on lines +100 to 106
Copy link
Contributor

@coderabbitai coderabbitai bot Aug 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Missing aggregation for PostgreSQL under DatabaseConfiguration.

DatabaseConfiguration exposes a postgres field but there is no matching composition line in the diagram (only sqlite exists). Add it for correctness and consistency.

Apply this diff:

 src.models.config.AuthenticationConfiguration --* src.models.config.Configuration : authentication
 src.models.config.DatabaseConfiguration --* src.models.config.Configuration : database
 src.models.config.InferenceConfiguration --* src.models.config.Configuration : inference
 src.models.config.JwtConfiguration --* src.models.config.JwkConfiguration : jwt_configuration
 src.models.config.LlamaStackConfiguration --* src.models.config.Configuration : llama_stack
 src.models.config.SQLiteDatabaseConfiguration --* src.models.config.DatabaseConfiguration : sqlite
+src.models.config.PostgreSQLDatabaseConfiguration --* src.models.config.DatabaseConfiguration : postgres
 src.models.config.ServiceConfiguration --* src.models.config.Configuration : service
 src.models.config.TLSConfiguration --* src.models.config.ServiceConfiguration : tls_config
 src.models.config.UserDataCollection --* src.models.config.Configuration : user_data_collection
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
src.models.config.AuthenticationConfiguration --* src.models.config.Configuration : authentication
src.models.config.DatabaseConfiguration --* src.models.config.Configuration : database
src.models.config.InferenceConfiguration --* src.models.config.Configuration : inference
src.models.config.JwtConfiguration --* src.models.config.JwkConfiguration : jwt_configuration
src.models.config.LlamaStackConfiguration --* src.models.config.Configuration : llama_stack
src.models.config.SQLiteDatabaseConfiguration --* src.models.config.DatabaseConfiguration : sqlite
src.models.config.ServiceConfiguration --* src.models.config.Configuration : service
src.models.config.AuthenticationConfiguration --* src.models.config.Configuration : authentication
src.models.config.DatabaseConfiguration --* src.models.config.Configuration : database
src.models.config.InferenceConfiguration --* src.models.config.Configuration : inference
src.models.config.JwtConfiguration --* src.models.config.JwkConfiguration : jwt_configuration
src.models.config.LlamaStackConfiguration --* src.models.config.Configuration : llama_stack
src.models.config.SQLiteDatabaseConfiguration --* src.models.config.DatabaseConfiguration : sqlite
src.models.config.PostgreSQLDatabaseConfiguration --* src.models.config.DatabaseConfiguration : postgres
src.models.config.ServiceConfiguration --* src.models.config.Configuration : service
src.models.config.TLSConfiguration --* src.models.config.ServiceConfiguration : tls_config
src.models.config.UserDataCollection --* src.models.config.Configuration : user_data_collection
🤖 Prompt for AI Agents 
In docs/config.puml around lines 100 to 106, the diagram is missing a
composition/aggregation line for the postgres configuration under
DatabaseConfiguration; add a line similar to the sqlite entry to link
src.models.config.PostgresDatabaseConfiguration (or the correct class name used
in codebase) to src.models.config.DatabaseConfiguration with label : postgres so
the diagram correctly represents the postgres field.

src.models.config.TLSConfiguration --* src.models.config.ServiceConfiguration : tls_config
src.models.config.UserDataCollection --* src.models.config.Configuration : user_data_collection
Expand Down