Skip to content

docs(deployment): document embedding + ollama probes on /ready from #1910#2086

Merged
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-readiness-embedding-ollama-1910
May 18, 2026
Merged

docs(deployment): document embedding + ollama probes on /ready from #1910#2086
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-readiness-embedding-ollama-1910

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

Document the embedding + ollama probes that /ready returns alongside the
existing agfs / vectordb / api_key_manager keys, mirroring the live
readiness_check() body in openviking/server/routers/system.py after
#1910.

Drift

In openviking/server/routers/system.py::readiness_check(), the checks
dict currently writes five probes (lines 111/121/131/147/164):

checks["agfs"] = "ok"
checks["vectordb"] = "ok" | "unhealthy" | "not_configured"
checks["api_key_manager"] = "ok" | "not_configured"
checks["embedding"] = <probe_result> | "not_configured" | "error: probe timed out (provider unreachable)"
checks["ollama"] = "ok" | "unreachable at <host>:<port>" | "not_configured"

The ollama probe landed via #1353 (2026-04-14, embedded under
openviking-server init interactive setup wizard), and the embedding
probe just landed via #1910 (2026-05-15, fix(server): add embedding
connectivity probe to /ready endpoint).

The Kubernetes deployment guide (docs/{en,zh}/guides/03-deployment.md)
still only lists AGFS, VectorDB, APIKeyManager in the GET /ready row
and shows a 3-key example response. A reader checking the docs to wire up
a k8s readiness probe will see a smaller surface than what curl /ready
actually returns, and won't know that misconfigured embedding/ollama
providers will surface here.

Fix

Dual-doc EN + ZH:

  • table row: append , Embedding, Ollama to the probe list
  • example # {...} curl output: append "embedding": "ok", "ollama": "ok"
    to the checks dict, preserving the existing "ok" happy-path style

Pure docs, byte-for-byte mirror of the live code keys. No logic changes.

Changes

  • docs/en/guides/03-deployment.md (+2/-2)
  • docs/zh/guides/03-deployment.md (+2/-2)

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@qin-ctx qin-ctx merged commit 2146f85 into volcengine:main May 18, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants