Repository navigation
Replies: 5 comments 1 reply
|
Hi @debjotyms, thanks for the suggestion. 👋 SIG Docs co-chair here.
Hope this helps. Tagging @reylejano @natalisucks @katcosgrove @dipesh-rawat @salaxander here for their opinions. |
|
Yes, to echo @divya-mohan0209 here, we have already had extensive chats with the Kapa.ai team, and also with SIG Contributor Experience (as they would own any kind of integration of a Slack bot) and the consensus is that we are unable to make use of the chat bot option, all while the current SIG Docs reviewers and approvers do not wish to maintain a separate docs instance for the purposes of AI search that wouldn't clash with the needs of LFX examinations team. Link here specifically to the Slack bot thread we had with SIG ContribEx and SIG K8s Infra members: https://kubernetes.slack.com/archives/C1TU9EB9S/p1776163892561899 |
|
As stated, SIG Docs co-chairs had several chats and also met in-person with the Kapa.ai team. In addition to "current SIG Docs reviewers and approvers do not wish to maintain a separate docs instance for the purposes of AI search that wouldn't clash with the needs of LFX examinations team", current SIG Docs reviewers and approvers do not wish to be "support" or "point-of-contact" for LFX exam takers during exams if the solution is to build the docs site locally which has been discussed as an alternative. |
|
Hi folks, Jumping in from the kapa.ai team, thanks for flagging this @debjotyms ! As the SIG docs co-chairs mentioned it was deemed not feasible to deploy kapa in Slack or on the documentation. On your point regarding the MCP server:
This is something that is included in the CNCF partnership with kapa, and utilized by OpenTelemetry, OpenFGA, EnvoyGateway etc. Leaving the documentation here for the SIGs: https://docs.kapa.ai/retrieval/hosted-mcp-server if interesting to explore this. The TLDR is essentially: Let coding agents query the Kubernetes knowledge-base, to ensure the information is always up to date. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Exploring AI / RAG-Powered Search and Documentation Assistant for Kubernetes.io
What is this about?
Many modern documentation sites now use AI-powered search and chat assistants (based on RAG, or Retrieval-Augmented Generation) to help developers find answers quickly. These tools index the official docs and let users ask questions in plain language instead of searching by keyword.
Right now,
kubernetes.iouses Pagefind for keyword search. It is fast and works well, but it has limits. For example, it can be hard to find deeply nested concepts, compare API fields across versions, or understand how multiple resources work together. These are common pain points for both beginners and experienced users.A previous proposal to add
llms.txtfor LLM-friendly indexing (#51544) was closed without active maintainer sponsorship. This discussion aims to explore the broader question: shouldkubernetes.iooffer some form of AI-powered documentation help? And if so, what are the options, risks, and constraints?What other CNCF projects are already doing
The CNCF has an official partnership with Kapa.ai to give all hosted projects a RAG-based documentation assistant at zero cost. Projects can request it through the CNCF Service Desk.
Several graduated and incubating CNCF projects have already adopted it:
CNCF itself also uses an AI assistant at ask.cncf.io for governance and contributor questions.
What other open-source projects are doing
An important trend: Many projects are now moving away from web chatbot widgets and toward MCP (Model Context Protocol) servers and
llms.txtstandards instead. This lets developers query docs directly from their IDE (Cursor, Claude Code, etc.) without needing a browser widget at all.Community-built Kubernetes RAG tools like K8sGPT (CNCF Sandbox), k8s-docs-assistant-rag, k8sAI, and Kubernetes-Documentation-Bot show that there is real demand for grounded Kubernetes AI assistants.
Challenges and constraints
1. CKA / CKAD / CKS exam integrity
This is probably the biggest concern.
Linux Foundation certification exams (CKA, CKAD, CKS) allow candidates to open
kubernetes.io/docs/inside the PSI Secure Browser during the exam. The exam handbooks explicitly ban AI tools with zero-tolerance enforcement:Violations can lead to exam termination, certification revocation, and even a lifetime ban.
If an AI chatbot is embedded directly on
kubernetes.io/docs/, candidates could use it to generate complete YAML manifests or troubleshooting answers. This would be a serious policy conflict.Possible solutions:
ask.kubernetes.ioorai.kubernetes.io). The PSI Secure Browser uses URL-based allowlisting, so it can allowkubernetes.io/docs/while blockingask.kubernetes.ioat the same time.2. Cost (the Bing to Pagefind precedent)
Kubernetes previously used Bing Custom Search, which cost CNCF thousands of dollars per month in API fees. SIG Docs migrated to Pagefind specifically to remove that recurring cost. Any new AI solution will face the same scrutiny.
Good news: the CNCF Kapa.ai partnership is free for all projects. This directly addresses the cost concern. An MCP server approach also avoids per-query API costs because inference happens on the developer's machine. Self-hosted open-source options (like vLLM or Ollama running Llama, Mistral, or Gemma) could use CNCF community infrastructure grants.
3. CNCF vendor neutrality and third-party content policy
Kubernetes documentation has a Third-Party Content Policy that requires vendor-neutral references. Options that work within this policy:
4. Kubernetes version drift and deprecations
Kubernetes APIs change frequently across releases. Old APIs get removed (for example,
PodSecurityPolicywas removed in v1.25). The AI system must know which version the user is looking at so it does not generate outdated or broken YAML. Pagefind already handles versioned content. An AI layer must respect this too.5. Multi-language (i18n) support
Kubernetes docs are translated into 15+ languages. The assistant should work across these languages and return content in the user's selected locale. The ongoing AI-assisted localization work (#54075) could complement this.
6. Trust and "AI slop" concerns
SIG Docs already has strict rules about AI-generated contributions. Any AI assistant must clearly show source citations, link back to the official docs, and include appropriate disclaimers to maintain trust in the documentation.
A possible step-by-step plan
Instead of trying to do everything at once, here is a phased approach:
Step 1: Machine readability (low effort)
Revive the
llms.txtproposal (the closed #51544). Adding/llms.txtand/llms-full.txttokubernetes.iolets external AI tools, IDE agents, and coding assistants read the docs more accurately. This is a small change with big impact and no policy risk.Step 2: Official MCP server (medium effort)
Provide an official Kubernetes Docs MCP server, following what Docker, Terraform, Astro, and MongoDB have already done. This lets developers query versioned K8s docs directly from their IDE. It avoids any web widget and has no conflict with exam policies.
Step 3: Evaluate the CNCF Kapa.ai partnership (low cost)
Since the CNCF partnership covers all costs, evaluate onboarding Kubernetes through the CNCF Service Desk. Prometheus, Envoy Gateway, and OpenTelemetry have already done this successfully. A pilot could start in the
#sig-docsSlack channel before any website changes.Step 4: Dedicated experimental assistant (higher effort)
If Step 3 shows strong demand, build a standalone assistant on a separate subdomain (
ask.kubernetes.io) that is explicitly excluded from exam allowlists.Questions for SIG Docs and the community
llms.txt?llms.txtproposal (#51544) be revisited as a low-risk first step?I would love to hear thoughts from maintainers and the community. Thank you for reading!
All reactions