Skip to content

LCORE-1348: Regenerated config doc #1392

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
Mar 24, 2026
Merged

LCORE-1348: Regenerated config doc #1392

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
33 changes: 28 additions & 5 deletions docs/config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,6 +740,11 @@ <h2 id="customization">Customization</h2>
<td/>
<td/>
</tr>
<tr class="odd">
<td>allow_verbose_infer</td>
<td>boolean</td>
<td/>
</tr>
</tbody>
</table>
<h2 id="databaseconfiguration">DatabaseConfiguration</h2>
Expand Down Expand Up @@ -1127,18 +1132,24 @@ <h2 id="okpconfiguration">OkpConfiguration</h2>
</thead>
<tbody>
<tr class="odd">
<td>rhokp_url</td>
<td>string</td>
<td>Base URL for the OKP server (http or https). Set to
<code>${env.RH_SERVER_OKP}</code> in YAML to use the environment
variable. When unset, the default from constants is used.</td>
</tr>
<tr class="even">
<td>offline</td>
<td>boolean</td>
<td>When True, use parent_id for OKP chunk source URLs. When False, use
reference_url for chunk source URLs.</td>
</tr>
<tr class="even">
<tr class="odd">
<td>chunk_filter_query</td>
<td>string</td>
<td>OKP filter query applied to every OKP search request. Defaults to
&#x2018;is_chunk:true&#x2019; to restrict results to chunk documents. To add extra
constraints, extend the expression using boolean syntax,
e.g.&#xA0;&#x2018;is_chunk:true AND product:<em>openshift</em>&#x2019;.</td>
<td>Additional OKP filter query applied to every OKP search request. Use
Solr boolean syntax, e.g.&#xA0;&#x2018;product:ansible AND
product:<em>openshift</em>&#x2019;.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -1375,6 +1386,11 @@ <h2 id="quotaschedulerconfiguration">QuotaSchedulerConfiguration</h2>
<h2 id="rhidentityconfiguration">RHIdentityConfiguration</h2>
<p>Red Hat Identity authentication configuration.</p>
<table>
<colgroup>
<col style="width: 26%"/>
<col style="width: 23%"/>
<col style="width: 50%"/>
</colgroup>
<thead>
<tr class="header">
<th>Field</th>
Expand All @@ -1388,6 +1404,12 @@ <h2 id="rhidentityconfiguration">RHIdentityConfiguration</h2>
<td>array</td>
<td>List of all required entitlements.</td>
</tr>
<tr class="even">
<td>max_header_size</td>
<td>integer</td>
<td>Maximum allowed size in bytes for the base64-encoded x-rh-identity
header. Headers exceeding this size are rejected before decoding.</td>
</tr>
</tbody>
</table>
<h2 id="ragconfiguration">RagConfiguration</h2>
Expand Down Expand Up @@ -1689,3 +1711,4 @@ <h2 id="userdatacollection">UserDataCollection</h2>
</table>
</body>
</html>

31 changes: 27 additions & 4 deletions docs/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@
"info",
"model_override",
"rlsapi_v1_infer",
"register_mcp_server",
"list_mcp_servers",
"delete_mcp_server",
"a2a_agent_card",
"a2a_task_execution",
"a2a_message",
Expand Down Expand Up @@ -625,6 +628,11 @@
}
],
"default": null
},
"allow_verbose_infer": {
"default": false,
"title": "Allow Verbose Infer",
"type": "boolean"
}
},
"title": "Customization",
Expand Down Expand Up @@ -905,17 +913,25 @@
"additionalProperties": false,
"description": "OKP (Offline Knowledge Portal) provider configuration.\n\nControls provider-specific behaviour for the OKP vector store.\nOnly relevant when ``\"okp\"`` is listed in ``rag.inline`` or ``rag.tool``.",
"properties": {
"rhokp_url": {
"type": "string",
"nullable": true,
"default": null,
"description": "Base URL for the OKP server (http or https). Set to `${env.RH_SERVER_OKP}` in YAML to use the environment variable. When unset, the default from constants is used.",
"title": "OKP base URL"
},
"offline": {
"default": true,
"description": "When True, use parent_id for OKP chunk source URLs. When False, use reference_url for chunk source URLs.",
"title": "OKP offline mode",
"type": "boolean"
},
"chunk_filter_query": {
"default": "is_chunk:true",
"description": "OKP filter query applied to every OKP search request. Defaults to 'is_chunk:true' to restrict results to chunk documents. To add extra constraints, extend the expression using boolean syntax, e.g. 'is_chunk:true AND product:*openshift*'.",
"title": "OKP chunk filter query",
"type": "string"
"type": "string",
"nullable": true,
"default": null,
"description": "Additional OKP filter query applied to every OKP search request. Use Solr boolean syntax, e.g. 'product:ansible AND product:*openshift*'.",
"title": "OKP chunk filter query"
}
},
"title": "OkpConfiguration",
Expand Down Expand Up @@ -1128,6 +1144,13 @@
"default": null,
"description": "List of all required entitlements.",
"title": "Required entitlements"
},
"max_header_size": {
"default": 8192,
"description": "Maximum allowed size in bytes for the base64-encoded x-rh-identity header. Headers exceeding this size are rejected before decoding.",
"minimum": 0,
"title": "Maximum header size",
"type": "integer"
}
},
"title": "RHIdentityConfiguration",
Expand Down
22 changes: 4 additions & 18 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,22 +110,6 @@ Microsoft Entra ID authentication attributes for Azure.

BYOK (Bring Your Own Knowledge) RAG configuration.

Each entry registers a local vector store. The `rag_id` is the
identifier used in `rag.inline` and `rag.tool` to select which stores to use.

Example:

```yaml
byok_rag:
- rag_id: my-docs # referenced in rag.inline / rag.tool
rag_type: inline::faiss
embedding_model: sentence-transformers/all-MiniLM-L6-v2
embedding_dimension: 384
vector_db_id: vs_abc123
db_path: /path/to/faiss_store.db
score_multiplier: 1.0
```


| Field | Type | Description |
|-------|------|-------------|
Expand Down Expand Up @@ -233,6 +217,7 @@ Service customization.
| agent_card_path | string | |
| agent_card_config | object | |
| custom_profile | | |
| allow_verbose_infer | boolean | |


## DatabaseConfiguration
Expand Down Expand Up @@ -407,9 +392,9 @@ 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. |
| rhokp_url | string | Base URL for the OKP server (http or https). Set to `${env.RH_SERVER_OKP}` in YAML to use the environment variable. When unset, the default from constants 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\*'. |
| 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*'. |


## PostgreSQLDatabaseConfiguration
Expand Down Expand Up @@ -516,6 +501,7 @@ Red Hat Identity authentication configuration.
| Field | Type | Description |
|-------|------|-------------|
| required_entitlements | array | List of all required entitlements. |
| max_header_size | integer | Maximum allowed size in bytes for the base64-encoded x-rh-identity header. Headers exceeding this size are rejected before decoding. |


## RagConfiguration
Expand Down
Loading