Welcome to the Kubernetes Smart Doc! This document provides instructions on how to use and deploy the Kubernetes Smart Doc
The Kubernetes Smart Doc is a tool that enables you to ask questions, and receive (hopefully) helpful replies back about the Kubernetes Content document.
Workflow is:
- Ask a question, for example
When should I use a Stateful State over a Deployment?
- Kubernetes Smart Doc will prompt an AI to reply to the question, using articles from the Kubernetes Official Content document as the source
Before deploying the Kubernetes Smart Doc, you should have the following prerequisites:
- Python installed locally, version
3.10.8
was used during development - OpenAI API key set under the env var
OPENAI_API_KEY
Install dependencies
pip install -r requirements.txt
Run the flask app in development mode
flask --app kubernetes_smart_docs/app run
- A LOT!
- Unit/Integration test on flask server
- Caching for API requests
- Save word embedding in DB instead of csv
- Use a modern frontend instead of vanilla JS
- Add formatting / linting
The Kubernetes Smart Doc is licensed under the MIT license. See the LICENSE file for details.