HDDS-15619. Add user documentation for Recon AI Assistant.#469
HDDS-15619. Add user documentation for Recon AI Assistant.#469ArafatKhan2198 wants to merge 8 commits into
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Add LLM, JCEKS, rollups, and firewalled to the cspell dictionary so the new Recon AI Assistant page passes CI. Co-authored-by: Cursor <cursoragent@cursor.com>
…ries. Keep rollups and firewalled in the dictionary; wrap LLM and JCEKS in inline code so cspell skips them. Co-authored-by: Cursor <cursoragent@cursor.com>
priyeshkaratha
left a comment
priyeshkaratha
left a comment
There was a problem hiding this comment.
Thanks, @ArafatKhan2198, for working on this. I have a few suggestions and please take a look.
| > network when it is used. Read [Data sent to third-party providers](#5-data-sent-to-third-party-llm-providers) | ||
| > before enabling it. The feature is marked unstable and may change between releases. | ||
|
|
||
| ## 2. Architecture at a glance |
There was a problem hiding this comment.
I would prefer to explain the architecture using a simple diagram that illustrates how a user query is transformed into an API call, how the LLM processes the request, and how it generates a plain English response.
| |---|---|---| | ||
| | `anthropic.beta.header` | `context-1m-2025-08-07` | Anthropic beta header (enables the 1M-token context window). Set empty to disable. | | ||
|
|
||
| ## 9. Using the assistant - what you can ask |
There was a problem hiding this comment.
Do you think it would be helpful to add a short sample video of the UI in this section? It could explain the workflow more effectively than plain text.
| | Utilization | `api_v1_utilization_containerCount` | Container-count distribution by size tier. | | ||
| | Tasks | `api_v1_task_status` | Recon background task and sync status. | | ||
|
|
||
| ## 11. Limits & boundary conditions |
There was a problem hiding this comment.
Should we mention the current limitations, such as the chatbot not retaining conversation context? Each user query is processed independently, so previous interactions are not remembered.
| task and sync state - and exposes it across many REST endpoints and UI screens. In practice most of | ||
| that information is never seen or correlated, because you have to know which endpoint or screen holds | ||
| the answer. | ||
|
|
There was a problem hiding this comment.
Just an improvement idea that came to mind: it would be useful to ask the Recon Assistant for metrics related to one or more services. Since there are so many metrics, instead of returning raw JMX query results, the AI could summarize the most relevant metrics and present them in a concise, easy-to-understand format.
- Soften "not an analytics engine": LLM can reason over fetched data but does not run server-side cross-endpoint aggregations - Change "unstable" to "Beta" - Add Mermaid sequence diagram to Architecture section - Elaborate air-gapped/in-VPC gateway note with concrete examples (vLLM, Ollama, LiteLLM) and placeholder-key guidance - Add "No conversation memory" limit to Section 11 - Add stable Docusaurus anchor IDs; update all cross-references - Embed demo video in Section 9 (Using the assistant) Co-authored-by: Cursor <cursoragent@cursor.com>
|
Can you please check the spellcheck CI? |
Co-authored-by: Cursor <cursoragent@cursor.com>
|
@spacemonkd @priyeshkaratha please take a look now! |
spacemonkd
left a comment
spacemonkd
left a comment
There was a problem hiding this comment.
Thanks for the changes @ArafatKhan2198.
LGTM +1
priyeshkaratha
left a comment
priyeshkaratha
left a comment
There was a problem hiding this comment.
Thanks @ArafatKhan2198 for improving the PR. Changes LGTM +1
4 participants
What changes were proposed in this pull request?
Adds a new docs page for the Recon AI Assistant under Administrator Guide → Operations → Observability → Recon.
It explains how to enable, configure, and use the feature - including API keys/JCEKS, config options, usage, limits, REST API, and security notes.
The page is in Latest Docs only (
/docs/next/...), not in the 2.1.0 snapshot yet.What is the link to the Apache Jira?
https://issues.apache.org/jira/browse/HDDS-15619
How was this patch tested?
Previewed locally with
docker compose upat:http://localhost:3001/docs/next/administrator-guide/operations/observability/recon/recon-ai-assistant