Skip to content

Latest commit

 

History

History
182 lines (137 loc) · 6.42 KB

README.md

File metadata and controls

182 lines (137 loc) · 6.42 KB
Raw

Contributors Forks Stargazers Issues LinkedIn


Kube-Finder Operator

Logo

Intelligent Kubernetes Cluster Issue Resolution
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgements

About The Project

The Kube-Finder Operator is an AI-powered tool that quickly detects and helps resolve issues within your Kubernetes clusters. By combining AI technology with the Kubernetes control loop, it automatically scans your clusters for misconfigurations and provides simple step-by-step instructions to fix them.

Key Features:

  1. AI-driven Scanning: Advanced algorithms scan your clusters, eliminating the need for manual inspection.
  2. Swift Issue Detection: Quickly identifies misconfigurations and root causes.
  3. Step-by-Step Guidance: Provides clear instructions for efficient issue resolution.
  4. Seamless Integration: Easily integrates into your existing Kubernetes environment.

Benefits:

  • Increased Efficiency: Saves time and effort by streamlining issue resolution.
  • Enhanced Cluster Security: Proactively identifies security vulnerabilities.
  • Simplified Issue Resolution: Makes complex problems easy to solve.
  • Real-time Monitoring: Monitors cluster health and provides timely alerts.

The Kube-Finder Operator optimizes cluster health and stability, saving time and resources while ensuring infrastructure security.

Getting Started

Prerequisites

  • OpenAI Token Secret
  • Slack Token Secret

Installation

  1. Add the Helm repo 
     helm repo add kube-finder https://tikalk.github.io/kube-finder   
 helm repo update
  2. Install the KubeFinder chart 
    helm install kube-finder Charts/kube-finder \ 
--create-namespace -n kube-finder
  3. Apply the Finder manifest on your Kubernetes cluster: 
    apiVersion: kubefinder.tikalk.com/v1alpha1
kind: Finder
metadata:
  name: finder-sample
spec:
    find:
    - "pods"
    notify:
        slack:
          channelID: "XXXXXXXXX"

Usage

There are many examples for manifests with misconfigurations under the path config/samples, you can use them for getting started.

To trigger the KubeFinder, you have to apply a wrong Kubernetes manifest.

kubectl apply -f <manifest.yaml>

While this manifest applied, the KubeFinder will be trigger on the Slack channel and show you the instructions to resolve youe issues:

ScreenShot_Image

ScreenShot_Limit

ScreenShot_Selector

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Creators

Gaby Tal, Amir Misgav, Guy Saar, Nissim Museri, Orel Fichman, Bar Kanias, Natalia Kagan, Carlo Smouter