Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avsthiago/kopylot?ref=awe50meAI
An AI-Powered assistant for Kubernetes developers
https://github.com/avsthiago/kopylot?ref=awe50meAI
ai chatgpt kubernetes openai-api
Last synced: about 2 months ago
JSON representation
An AI-Powered assistant for Kubernetes developers
- Host: GitHub
- URL: https://github.com/avsthiago/kopylot?ref=awe50meAI
- Owner: avsthiago
- License: mit
- Created: 2023-03-28T05:23:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-24T19:55:10.000Z (8 months ago)
- Last Synced: 2024-07-25T10:28:29.873Z (about 2 months ago)
- Topics: ai, chatgpt, kubernetes, openai-api
- Language: Shell
- Homepage:
- Size: 265 KB
- Stars: 163
- Watchers: 8
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-AI - kopylot - Powered assistant for Kubernetes developers | (Coding tools)
README
# **KoPylot**: Your AI-Powered Kubernetes Assistant 🤖
[](https://img.shields.io/github/v/release/avsthiago/kopylot)
[](https://github.com/avsthiago/kopylot/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/avsthiago/kopylot)
[](https://img.shields.io/github/commit-activity/m/avsthiago/kopylot)
[](https://img.shields.io/github/license/avsthiago/kopylot)
KoPylot is an open-source AI-powered Kubernetes assistant. Its goal is to help developers and DevOps engineers to easily manage and monitor their Kubernetes clusters.
You can read more about the project in the [blog post](https://medium.com/@thiagoalves/introducing-kopylot-a-kubernetes-ai-assistant-264cff0e7846).
## 💫 Features:
- 🔍 **Audit**: Audit a resource, such as pods, deployments, or services using an LLM model.
- 🩺 **Diagnose**: Diagnose resources, such as pods, deployments, or services using an LLM model.
- 💬 **Chat**: Start a chat with KoPylot to generate kubectl commands based on your prompts.
- ☸️ **Ctl**: A wrapper around kubectl. The arguments passed to the `ctl` subcommand are interpreted by kubectl.
## 🚀 Quick Start:
1. Requests an API key from [OpenAI](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key).
2. Export the key using the following command:
```bash
export KOPYLOT_AUTH_TOKEN=your_api_key
```
NOTE: If you want to avoid having the key in your .bashrc, .oh-my-zsh/custom dir,
or your .bash_history or .zsh_history, a possible trick is to do something like this:
```bash
export KOPYLOT_AUTH_TOKEN=$(cat ../../../keys/openai)
```
3. Install KoPylot using pip:
```
pip install kopylot
```
4. Run KoPylot:
```
kopylot --help
```
## 📖 Usage:
```
Usage: kopylot [OPTIONS] COMMAND [ARGS]...
╭─ Options ──────────────────────────────────────────────────────────────────────────╮
│ --version │
│ --install-completion [bash|zsh|fish|powershell Install completion for the │
│ |pwsh] specified shell. │
│ [default: None] │
│ --show-completion [bash|zsh|fish|powershell Show completion for the │
│ |pwsh] specified shell, to copy it │
│ or customize the │
│ installation. │
│ [default: None] │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────╮
│ audit Audit a pod, deployment, or service using an LLM model. │
│ chat Start a chat with kopylot to generate kubectl commands based your │
│ inputs. │
│ ctl A wrapper around kubectl. The arguments passed to the ctl subcommand are │
│ interpreted by kubectl. │
│ diagnose Diagnose a resource e.g. pod, deployment, or service using an LLM model. │
╰────────────────────────────────────────────────────────────────────────────────────╯
```
## 🤝 Contributions:
KoPylot is an open-source project and we welcome contributions from the community. There are a couple of ways to set up your development environment and start contributing to the project.
### 🐳 Using a Dev Container
KoPylot supports development using a dev container, which helps you set up a consistent and isolated environment for development. This makes it easy to get started without having to worry about conflicting dependencies or configurations on your local machine.
**To get started with a dev container:**
1. Install [Docker](https://www.docker.com/) and [Visual Studio Code](https://code.visualstudio.com/).
2. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension in Visual Studio Code.
3. Clone the KoPylot repository and open the project folder in Visual Studio Code.
4. Press `F1`, type `Remote-Containers: Reopen in Container`, and hit `Enter`. Visual Studio Code will build the dev container and reopen the project inside it.
You're now ready to start contributing to KoPylot using the dev container!
### 🛠️ Local Setup
If you prefer to set up your development environment locally, make sure you have [Poetry](https://python-poetry.org/) installed on your system. Then, follow these steps:
1. Clone the KoPylot repository:
```bash
git clone https://github.com/avsthiago/kopylot
```
2. Navigate to the project folder:
```bash
cd kopylot
```
3. Install the project dependencies using Poetry:
```go
make install
```
You're now ready to start contributing to KoPylot using your local setup! 😄
Before submitting a pull request, please make sure to test your changes and follow the project's coding guidelines. We appreciate your contributions and look forward to collaborating with you! 🎉
## 📄 License:
KoPylot is licensed under the MIT License. See [LICENSE](LICENSE) for more information.
## ☎️ Contact:
If you have any questions or suggestions, feel free to contact me on [https://thiagoalves.ai](https://thiagoalves.ai/contact/).
Thank you for using KoPylot! 🙌
## 🗺️ Roadmap:
- [x] Wrap the kubectl command using `ctl` subcommand.
- [x] Create the `audit` subcommand to audit kubernetes resources.
- [x] Create the `diagnose` subcommand to diagnose kubernetes resources.
- [x] Create the `chat` subcommand to generate kubectl commands using from the user prompts.
- [ ] Make it possible to use other LLM models, not just from OpenAI.
- [ ] Integrate [LangChain](https://github.com/hwchase17/langchain) into KoPylot to make it as autonomous as possible.
## ~ Similar Projects:
One of the similar projects that I found is the [Kopilot](https://github.com/knight42/kopilot) from knight42. It is also a Kubernetes assistant which uses LLMs behind the scenes. The main difference from KoPylot is that it is written in Go. At the moment, it doesn't have the Chat command implemented, but it can respond in different languages.