Merge pull request #1347 from syedriko/syedriko-lcore-1504

LCORE-1504: Change how the OKP server is located at runtime: RH_SERVER_OKP

Author: tisnik

Makefile

@@ -67,17 +67,20 @@ docs/config.puml:	src/models/config.py ## Generate PlantUML class diagram for co
 	pyreverse src/models/config.py --output puml --output-directory=docs/
 	mv docs/classes.puml docs/config.puml
 
+# Omit --theme rose on the CLI: it fails with some plantuml.jar builds on pyreverse output.
+# To use rose, add a line after @startuml: !theme rose  (requires a recent JAR).
+# PNG is capped at 4096px per side by default; pyreverse class diagrams are often wider—raise the limit.
 docs/config.png:	docs/config.puml ## Generate an image with configuration graph
 	pushd docs && \
-	java -jar ${PATH_TO_PLANTUML}/plantuml.jar --theme rose config.puml && \
+	java -DPLANTUML_LIMIT_SIZE=16384 -jar ${PATH_TO_PLANTUML}/plantuml.jar config.puml && \
 	mv classes.png config.png && \
 	popd
 
 docs/config.svg:	docs/config.puml ## Generate an SVG with configuration graph
 	pushd docs && \
-	java -jar ${PATH_TO_PLANTUML}/plantuml.jar --theme rose config.puml -tsvg && \
+	java -jar ${PATH_TO_PLANTUML}/plantuml.jar config.puml -tsvg && \
 	xmllint --format classes.svg > config.svg && \
-	rm classes.svg && \
+	rm -f classes.svg && \
 	popd
 
 shellcheck: ## Run shellcheck

docs/config.md

@@ -407,6 +407,7 @@ Only relevant when ``"okp"`` is listed in ``rag.inline`` or ``rag.tool``.
 
 | Field | Type | Description |
 |-------|------|-------------|
+| rhokp_url | string | Base URL for the OKP server. Set to `${env.RH_SERVER_OKP}` in YAML to use the environment variable. When missing or empty, the application default is used. |
 | offline | boolean | When True, use parent_id for OKP chunk source URLs. When False, use reference_url for chunk source URLs. |
 | chunk_filter_query | string | Additional OKP filter query applied to every OKP search request. Use Solr boolean syntax, e.g. 'product:\*ansible\* AND product:\*openshift\*'. |
 

docs/config.png

@@ -1,86 +1,86 @@
 @startuml classes
 set namespaceSeparator none
 class "A2AStateConfiguration" as src.models.config.A2AStateConfiguration {
-  config
+  config : Optional[SQLiteDatabaseConfiguration | PostgreSQLDatabaseConfiguration]
   postgres : Optional[PostgreSQLDatabaseConfiguration]
   sqlite : Optional[SQLiteDatabaseConfiguration]
-  storage_type
+  storage_type : Literal['memory', 'sqlite', 'postgres']
   check_a2a_state_configuration() -> Self
 }
 class "APIKeyTokenConfiguration" as src.models.config.APIKeyTokenConfiguration {
-  api_key
+  api_key : Optional[SecretStr]
 }
 class "AccessRule" as src.models.config.AccessRule {
-  actions : list[Action]
-  role : str
+  actions : Optional[list[Action]]
+  role : Optional[str]
 }
 class "Action" as src.models.config.Action {
   name
 }
 class "AuthenticationConfiguration" as src.models.config.AuthenticationConfiguration {
   api_key_config : Optional[APIKeyTokenConfiguration]
-  api_key_configuration
+  api_key_configuration : APIKeyTokenConfiguration
   jwk_config : Optional[JwkConfiguration]
-  jwk_configuration
+  jwk_configuration : JwkConfiguration
   k8s_ca_cert_path : Optional[FilePath]
   k8s_cluster_api : Optional[AnyHttpUrl]
   module : str
   rh_identity_config : Optional[RHIdentityConfiguration]
-  rh_identity_configuration
-  skip_for_health_probes : bool
+  rh_identity_configuration : RHIdentityConfiguration
+  skip_for_health_probes : Optional[bool]
   skip_tls_verification : bool
   check_authentication_model() -> Self
 }
 class "AuthorizationConfiguration" as src.models.config.AuthorizationConfiguration {
-  access_rules : list[AccessRule]
+  access_rules : Optional[list[AccessRule]]
 }
 class "AzureEntraIdConfiguration" as src.models.config.AzureEntraIdConfiguration {
-  client_id
-  client_secret
-  scope : str
-  tenant_id
+  client_id : SecretStr
+  client_secret : SecretStr
+  scope : Optional[str]
+  tenant_id : SecretStr
 }
 class "ByokRag" as src.models.config.ByokRag {
-  db_path : str
-  embedding_dimension
-  embedding_model : str
-  rag_id : str
-  rag_type : str
-  score_multiplier : float
-  vector_db_id : str
+  db_path : Optional[str]
+  embedding_dimension : Optional[PositiveInt]
+  embedding_model : Optional[str]
+  rag_id : Optional[str]
+  rag_type : Optional[str]
+  score_multiplier : Optional[float]
+  vector_db_id : Optional[str]
 }
 class "CORSConfiguration" as src.models.config.CORSConfiguration {
-  allow_credentials : bool
-  allow_headers : list[str]
-  allow_methods : list[str]
-  allow_origins : list[str]
+  allow_credentials : Optional[bool]
+  allow_headers : Optional[list[str]]
+  allow_methods : Optional[list[str]]
+  allow_origins : Optional[list[str]]
   check_cors_configuration() -> Self
 }
 class "Configuration" as src.models.config.Configuration {
-  a2a_state
-  authentication
+  a2a_state : Optional[A2AStateConfiguration]
+  authentication : Optional[AuthenticationConfiguration]
   authorization : Optional[AuthorizationConfiguration]
   azure_entra_id : Optional[AzureEntraIdConfiguration]
-  byok_rag : list[ByokRag]
-  conversation_cache
+  byok_rag : Optional[list[ByokRag]]
+  conversation_cache : Optional[ConversationHistoryConfiguration]
   customization : Optional[Customization]
-  database
-  deployment_environment : str
-  inference
-  llama_stack
-  mcp_servers : list[ModelContextProtocolServer]
-  name : str
-  okp
-  quota_handlers
-  rag
-  service
+  database : Optional[DatabaseConfiguration]
+  deployment_environment : Optional[str]
+  inference : Optional[InferenceConfiguration]
+  llama_stack : Optional[LlamaStackConfiguration]
+  mcp_servers : Optional[list[ModelContextProtocolServer]]
+  name : Optional[str]
+  okp : Optional[OkpConfiguration]
+  quota_handlers : Optional[QuotaHandlersConfiguration]
+  rag : Optional[RagConfiguration]
+  service : Optional[ServiceConfiguration]
   splunk : Optional[SplunkConfiguration]
-  user_data_collection
+  user_data_collection : Optional[UserDataCollection]
   dump(filename: str | Path) -> None
   validate_mcp_auth_headers() -> Self
 }
 class "ConfigurationBase" as src.models.config.ConfigurationBase {
-  model_config
+  model_config : ConfigDict
 }
 class "ConversationHistoryConfiguration" as src.models.config.ConversationHistoryConfiguration {
   memory : Optional[InMemoryCacheConfig]
@@ -90,13 +90,14 @@ class "ConversationHistoryConfiguration" as src.models.config.ConversationHistor
   check_cache_configuration() -> Self
 }
 class "CustomProfile" as src.models.config.CustomProfile {
-  path : str
-  prompts : dict[str, str]
+  path : Optional[str]
+  prompts : Optional[dict[str, str]]
   get_prompts() -> dict[str, str]
 }
 class "Customization" as src.models.config.Customization {
   agent_card_config : Optional[dict[str, Any]]
   agent_card_path : Optional[FilePath]
+  allow_verbose_infer : bool
   custom_profile : Optional[CustomProfile]
   disable_query_system_prompt : bool
   disable_shield_ids_override : bool
@@ -106,14 +107,14 @@ class "Customization" as src.models.config.Customization {
   check_customization_model() -> Self
 }
 class "DatabaseConfiguration" as src.models.config.DatabaseConfiguration {
-  config
-  db_type
+  config : SQLiteDatabaseConfiguration | PostgreSQLDatabaseConfiguration
+  db_type : Literal['sqlite', 'postgres']
   postgres : Optional[PostgreSQLDatabaseConfiguration]
   sqlite : Optional[SQLiteDatabaseConfiguration]
   check_database_configuration() -> Self
 }
 class "InMemoryCacheConfig" as src.models.config.InMemoryCacheConfig {
-  max_entries
+  max_entries : Optional[PositiveInt]
 }
 class "InferenceConfiguration" as src.models.config.InferenceConfiguration {
   default_model : Optional[str]
@@ -124,111 +125,113 @@ class "JsonPathOperator" as src.models.config.JsonPathOperator {
   name
 }
 class "JwkConfiguration" as src.models.config.JwkConfiguration {
-  jwt_configuration
-  url
+  jwt_configuration : Optional[JwtConfiguration]
+  url : Optional[AnyHttpUrl]
 }
 class "JwtConfiguration" as src.models.config.JwtConfiguration {
-  role_rules : list[JwtRoleRule]
-  user_id_claim : str
-  username_claim : str
+  role_rules : Optional[list[JwtRoleRule]]
+  user_id_claim : Optional[str]
+  username_claim : Optional[str]
 }
 class "JwtRoleRule" as src.models.config.JwtRoleRule {
-  compiled_regex
-  jsonpath : str
-  negate : bool
-  operator
-  roles : list[str]
-  value : Any
+  compiled_regex : Optional[Pattern[str]]
+  jsonpath : Optional[str]
+  negate : Optional[bool]
+  operator : Optional[JsonPathOperator]
+  roles : Optional[list[str]]
+  value : Optional[Any]
   check_jsonpath() -> Self
   check_regex_pattern() -> Self
   check_roles() -> Self
 }
 class "LlamaStackConfiguration" as src.models.config.LlamaStackConfiguration {
   api_key : Optional[SecretStr]
   library_client_config_path : Optional[str]
-  timeout
+  timeout : Optional[PositiveInt]
   url : Optional[AnyHttpUrl]
   use_as_library_client : Optional[bool]
   check_llama_stack_model() -> Self
 }
 class "ModelContextProtocolServer" as src.models.config.ModelContextProtocolServer {
-  authorization_headers : dict[str, str]
-  headers : list[str]
-  name : str
-  provider_id : str
-  resolved_authorization_headers
+  authorization_headers : Optional[dict[str, str]]
+  headers : Optional[list[str]]
+  name : Optional[str]
+  provider_id : Optional[str]
+  resolved_authorization_headers : dict[str, str]
   timeout : Optional[PositiveInt]
-  url : str
+  url : Optional[str]
   resolve_auth_headers() -> Self
   validate_headers(value: list[str]) -> list[str]
 }
 class "OkpConfiguration" as src.models.config.OkpConfiguration {
   chunk_filter_query : Optional[str]
-  offline : bool
+  offline : Optional[bool]
+  rhokp_url : Optional[str]
 }
 class "PostgreSQLDatabaseConfiguration" as src.models.config.PostgreSQLDatabaseConfiguration {
   ca_cert_path : Optional[FilePath]
-  db : str
-  gss_encmode : str
-  host : str
+  db : Optional[str]
+  gss_encmode : Optional[str]
+  host : Optional[str]
   namespace : Optional[str]
-  password
-  port
-  ssl_mode : str
-  user : str
+  password : Optional[SecretStr]
+  port : Optional[PositiveInt]
+  ssl_mode : Optional[str]
+  user : Optional[str]
   check_postgres_configuration() -> Self
 }
 class "QuotaHandlersConfiguration" as src.models.config.QuotaHandlersConfiguration {
-  enable_token_history : bool
-  limiters : list[QuotaLimiterConfiguration]
+  enable_token_history : Optional[bool]
+  limiters : Optional[list[QuotaLimiterConfiguration]]
   postgres : Optional[PostgreSQLDatabaseConfiguration]
-  scheduler
+  scheduler : Optional[QuotaSchedulerConfiguration]
   sqlite : Optional[SQLiteDatabaseConfiguration]
 }
 class "QuotaLimiterConfiguration" as src.models.config.QuotaLimiterConfiguration {
-  initial_quota
-  name : str
-  period : str
-  quota_increase
-  type : Literal['user_limiter', 'cluster_limiter']
+  initial_quota : Optional[NonNegativeInt]
+  name : Optional[str]
+  period : Optional[str]
+  quota_increase : Optional[NonNegativeInt]
+  type : Optional[Literal['user_limiter', 'cluster_limiter']]
 }
 class "QuotaSchedulerConfiguration" as src.models.config.QuotaSchedulerConfiguration {
-  database_reconnection_count
-  database_reconnection_delay
-  period
+  database_reconnection_count : Optional[PositiveInt]
+  database_reconnection_delay : Optional[PositiveInt]
+  period : Optional[PositiveInt]
 }
 class "RHIdentityConfiguration" as src.models.config.RHIdentityConfiguration {
+  max_header_size : Optional[PositiveInt]
   required_entitlements : Optional[list[str]]
 }
 class "RagConfiguration" as src.models.config.RagConfiguration {
-  inline : list[str]
-  tool : list[str]
+  inline : Optional[list[str]]
+  tool : Optional[list[str]]
 }
 class "SQLiteDatabaseConfiguration" as src.models.config.SQLiteDatabaseConfiguration {
-  db_path : str
+  db_path : Optional[str]
 }
 class "ServiceConfiguration" as src.models.config.ServiceConfiguration {
-  access_log : bool
-  auth_enabled : bool
+  access_log : Optional[bool]
+  auth_enabled : Optional[bool]
   base_url : Optional[str]
-  color_log : bool
-  cors
-  host : str
-  port
-  root_path : str
-  tls_config
-  workers
+  color_log : Optional[bool]
+  cors : Optional[CORSConfiguration]
+  host : Optional[str]
+  port : Optional[PositiveInt]
+  root_path : Optional[str]
+  tls_config : Optional[TLSConfiguration]
+  workers : Optional[PositiveInt]
   check_service_configuration() -> Self
   validate_root_path(value: str) -> str
 }
 class "SplunkConfiguration" as src.models.config.SplunkConfiguration {
-  enabled : bool
+  enabled : Optional[bool]
   index : Optional[str]
-  source : str
-  timeout
+  source : Optional[str]
+  timeout : Optional[PositiveInt]
   token_path : Optional[FilePath]
   url : Optional[str]
-  verify_ssl : bool
+  verify_ssl : Optional[bool]
   check_splunk_configuration() -> Self
 }
 class "TLSConfiguration" as src.models.config.TLSConfiguration {
@@ -238,9 +241,9 @@ class "TLSConfiguration" as src.models.config.TLSConfiguration {
   check_tls_configuration() -> Self
 }
 class "UserDataCollection" as src.models.config.UserDataCollection {
-  feedback_enabled : bool
+  feedback_enabled : Optional[bool]
   feedback_storage : Optional[str]
-  transcripts_enabled : bool
+  transcripts_enabled : Optional[bool]
   transcripts_storage : Optional[str]
   check_storage_location_is_set_when_needed() -> Self
 }
@@ -275,22 +278,6 @@ src.models.config.ServiceConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.SplunkConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.TLSConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.UserDataCollection --|> src.models.config.ConfigurationBase
-src.models.config.A2AStateConfiguration --* src.models.config.Configuration : a2a_state
-src.models.config.AuthenticationConfiguration --* src.models.config.Configuration : authentication
-src.models.config.CORSConfiguration --* src.models.config.ServiceConfiguration : cors
-src.models.config.ConversationHistoryConfiguration --* src.models.config.Configuration : conversation_cache
 src.models.config.CustomProfile --* src.models.config.Customization : custom_profile
-src.models.config.DatabaseConfiguration --* src.models.config.Configuration : database
-src.models.config.InferenceConfiguration --* src.models.config.Configuration : inference
-src.models.config.JsonPathOperator --* src.models.config.JwtRoleRule : operator
-src.models.config.JwtConfiguration --* src.models.config.JwkConfiguration : jwt_configuration
-src.models.config.LlamaStackConfiguration --* src.models.config.Configuration : llama_stack
-src.models.config.OkpConfiguration --* src.models.config.Configuration : okp
-src.models.config.QuotaHandlersConfiguration --* src.models.config.Configuration : quota_handlers
-src.models.config.QuotaSchedulerConfiguration --* src.models.config.QuotaHandlersConfiguration : scheduler
-src.models.config.RagConfiguration --* src.models.config.Configuration : rag
 src.models.config.SQLiteDatabaseConfiguration --* src.models.config.DatabaseConfiguration : sqlite
-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
 @enduml