Skip to content

HDDS-15915. Document Recon chatbot gateway provider and update JCEKS setup in admin guide.#496

Merged
ArafatKhan2198 merged 1 commit into
masterfrom
HDDS-15915
Jul 20, 2026
Merged

HDDS-15915. Document Recon chatbot gateway provider and update JCEKS setup in admin guide.#496
ArafatKhan2198 merged 1 commit into
masterfrom
HDDS-15915

Conversation

@ArafatKhan2198

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

This PR updates the Recon AI Assistant administrator guide to document the gateway LLM provider and to expand the existing JCEKS credential-provider section with setup, verification, and failure behavior that operators need in production.

Why: After the gateway provider was added to Recon (OpenAI-compatible gateways such as LiteLLM), the admin guide still described only direct openai, gemini, and anthropic providers. Operators routing all models through one gateway had no documented config path. The JCEKS section also lacked gateway alias examples, explicit keystore-password options, verification steps, and notes on plaintext fallback and error behavior observed during manual testing.

Changes:

  • Gateway provider
    • Add “Using an OpenAI-compatible gateway” (#gateway-provider) with config keys, example ozone-site.xml, and operational notes (exact model aliases, no auto-discovery, UI prefix grouping, no anthropic.base.url, fail-fast on missing gateway.base.url).
    • Extend Supported providers & models and Configuration reference with gateway, gateway.api.key, gateway.base.url, and gateway.models.
  • JCEKS
    • Document ozone.recon.chatbot.gateway.api.key alias alongside other providers.
    • Name keystore password options: HADOOP_CREDSTORE_PASSWORD and hadoop.security.credstore.java-keystore-provider.password-file.
    • Warn to remove plaintext keys when using JCEKS (Recon falls back to plaintext if JCEKS read fails).
    • Add verification (/chatbot/health, empty ozone getconf for api key when JCEKS-only).
    • Document failure behavior (bad keystore password, missing key, /chat may return 500 when gateway is the only provider).
    • Note restart required after credential rotation; JCEKS works without a secure/Kerberos cluster.
  • Operations
    • Clarify HTTP 500 when a provider key is unreadable at query time.
    • Add troubleshooting rows for JCEKS and plaintext-fallback cases.

All examples use generic placeholders (e.g. https://your-gateway/v1); no vendor-specific URLs.

What is the link to the Apache Jira?

https://issues.apache.org/jira/browse/HDDS-15915

How was this patch tested?

  • Local Docusaurus preview: npm run start (port 3001), reviewed/docs/next/administrator-guide/operations/observability/recon/recon-ai-assistant#gateway-provider
  • Verified source MDX contains new gateway and JCEKS sections and anchors
  • Confirmed no broken internal links to #gateway-provider and #managing-api-keys
  • CI website/docs checks expected to pass on PR (no code changes)

@spacemonkd spacemonkd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @ArafatKhan2198 for the patch.
LGTM, +1

@ArafatKhan2198
ArafatKhan2198 merged commit 557a0a3 into master Jul 20, 2026
19 checks passed
errose28 added a commit to errose28/ozone-site that referenced this pull request Jul 20, 2026
* master: (34 commits)
  HDDS-15915. Document Recon chatbot gateway provider and update JCEKS setup in admin guide. (apache#496).
  HDDS-15801. Add blogs on S3 compatibility and S3 conditional requests (apache#488)
  HDDS-14343. Apache Knox integration documentation and Docker Compose demo (apache#490)
  HDDS-15884. Allow GitHub avatar sources in blog CSP (apache#495)
  HDDS-15878. Update the Roadmap After releasing 2.2.0 (apache#494)
  HDDS-15506. Update Ozone website for 2.2.0 release (apache#492)
  HDDS-14082. Add Hue integration guide and verification compose stack (apache#203)
  HDDS-15767. Update system internal docs since pull replication is removed (apache#489)
  HDDS-15746. [Auto] Update configuration documentation (apache#487)
  HDDS-15619. Add user documentation for Recon AI Assistant. (apache#469)
  HDDS-15017. [Website v2] [Docs] [Administrator Guide] Directory Configurations for Datanode. (apache#392)
  HDDS-15018. [Website v2] [Docs] [Administrator Guide] Directory Configurations for Recon. (apache#393)
  HDDS-15613. Publish the Read Operation Implementation doc (apache#484)
  HDDS-15683. Updated doc for Supported Grafana version (apache#475)
  HDDS-15714. Group actions/cache version bumps (apache#479)
  HDDS-15725. zizmor check should reflect failure in fork (apache#483)
  HDDS-14733. Standardize the usage of the term IO in the documentation (apache#486)
  HDDS-15719. Add check for allowed action usage in workflows (apache#485)
  HDDS-15584. Add supported awscli version paragraph to user guide (apache#482)
  HDDS-15707. Bump Docusaurus from 3.7.0 to 3.10.1 (apache#481)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants