My K8S Admin is a Large Language Models (LLMs)-powered Kubernetes admin assistant. It can help improve your productivity when deploying and managing your container workloads on Kubernetes. With the power of LLMs, My K8S Admin can understand your instructions and execute management tasks on your behalf. You can also chat with My K8S Admin to obtain context-related technical information. Currently, My K8S Admin is backed by Google's PaLM 2 LLMs, specifically the chat-bison and code-bison model.
Video Demo: https://youtu.be/HYwiQVPh9eQ
This is a prototype application for exploring how LLM can improve the productivity of building, delivering, and managing cloud-native applications. It is not intended for production use. Please read the limitation section for more information.
- Git clone this repo in your Google Cloud Cloud Shell.
- Install the required Python dependencies with following command:
pip install -r requirements.txt- Set up cluster access for
kubectlas you normally would.
gcloud container clusters get-credentials <cluster-name>
- Enable the Google Cloud Vertex AI API.
You can also run the agent in your local environeent. However, you need to set up Google Cloud SDK and ADC locally.
To start My K8S Admin, simply run the following command which will start an interactive shell:
./k8s-adminYou can also run it in non-interactive action mode. Here is an example:
./k8as-admin -a show me all the nodesThe interactive mode provides and Unix shell-style interactive user interface. Users can chat with the agent, and ask the agent to execute tasks. There are two sub-mode in the interactive mode, Chat and Action.
- Hit
Enterto switch between Chat and Action mode. Chat modeallows users to interact with the agent for technical questions. For example, users can request sample Kubernetes object definitions, and ask the agent to customize these definitions.Action modeallows users to instruct the agent to perform management tasks, such as displaying all pods in the cluster, creating a new deployment, or scaling a deployment.
Following are some commands which users can use in the interactive shell.
> Type 'history' or 'his' to see model output history.
> Type 'apply @<history number>' to apply a previous definition.
> Type 'apply @' to apply the last definition.
> Add '+' at the end of your command to skip confirmation.
> Type 'help' to see this help text again.
> Type 'exit' to exitThe non-interactive mode, or so called action mode, make it convenient to use the agent in your favorite shell and integrate it with scripts and other programs. You can invoke the non-interactive mode by using option -a at start.
There is a shortcut wrapper for the non-interactive action mode. You can add the shortcut k to your path. After doing so, you can call the agent in a minimalist style.
k show me all the nodesUsage: k8s-admin [options] [instruction]
-s, start the interactive shell mode
-a, run non-interactive action mode
-h, help
Examples:
k8s-admin -s
k8s-admin -a list all nodes
k8s-admin -h This is a preliminary exploration on using LLM in the domain of cloud nation applications. State-of-the-art LLMs have demonstrated stunning performance, but none of them are perfect. LLMs still experience issues such as hallucinations.
My K8S Admin will request user confirmation before executing certain non-read-only actions to provide protection. However, please note that this protection is not 100% secure. Therefore, do not use this project in production environments and use it wisely and at your own risk. The author(s) of the project will not be responsible for any damage caused by using this project.
Welcome to try out My K8S Admin! Please share your feedback by filing GitHub issues or messaging me. If you find this project interesting, please consider starring it to show your support. I appreciate your help and look forward to your participation.