ArafatKhan2198 opened a new pull request, #496:
URL: https://github.com/apache/ozone-site/pull/496
## 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)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
