README
¶
Intuitive Discovery 🔍 ,
Limitless Insight 📊. With AI. coming soon✨
🎮 Live Demo • 🚀 Overview • ⚙️ Install • ⚡️ Quick Start • 📚 Docs
What is Karpor?
Karpor is a Modern Kubernetes Explorer focusing on 🔍 Search, 💡 Insight and 🤖 Intelligence. It has features such as non-invasive, read-only, secure, and multi-cloud and multi-cluster support, and can serve as a Kubernetes Data Plane to reduce the cost of discovering and understanding kubernetes resources.
https://github.com/KusionStack/karpor/assets/9360247/c5050dfa-23f3-49ac-ba4a-1026ab043e6c
Why Karpor?
🤝 User Friendly
|
⚡️ Lightweight and Easy to Setup One `helm` is done. 📦 Out of the Box Built-in security and compliance policies, resource sync strategy, resource transform rule, and topology relationship definitions. 🔍 Quickly search and locate resource(s) Quickly search and locate resource(s) of interest across a large number of clusters in a user-friendly way. |
|
✨ Intelligent
|
🔒 Compliance Protection Automatically identify potential risks and receive AI suggestions for remediation. 📊 Logical and topological views Logical and topological views of relevant resources within their operational context. |
⚡️ Low Burden
|
🔒 Read-Only, Non-Invasive Read-Only data plane, Non-Invasive to user cluster. ⚙️ Kubernetes Native API Compatible Seamless integration of existing kubernetes tool chain. ☁️ Multi-Cluster and Multi-Cloud/Hybrid-Cloud Natively supports Multi-Cluster and Multi-Cloud/Hybrid-Cloud. |
|
⚙️ Installation
Install with Helm
Helm is a tool for managing packages of pre-configured kubernetes resources.
$ helm repo add kusionstack https://kusionstack.github.io/charts
$ helm repo update
$ helm install karpor kusionstack/karpor
For more information about installation, please check the Installation Guide on official website.
📖 Documentation
Detailed documentation is available at Karpor Website.
🤝 How to contribute
Karpor is still in the initial stage, and there are many capabilities that need to be made up, so we welcome everyone to participate in construction with us. Visit the Contribution Guide to understand how to participate in the contribution Karpor project. If you have any questions, please Submit the Issue.
🎖︎ Contributors
Thanks all! Come and join us! 🍻
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
openapispec
Package openapispec GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
|
Package openapispec GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag |
|
hack
|
|
|
cert-generator
Module
|
|
|
pkg
|
|
|
infra/scanner
Package scanner provides an interface and primitives for implementing scanners that check Kubernetes resources for various issues, such as security vulnerabilities, misconfigurations, and best practices.
|
Package scanner provides an interface and primitives for implementing scanners that check Kubernetes resources for various issues, such as security vulnerabilities, misconfigurations, and best practices. |
|
infra/scanner/kubeaudit
Package kubeaudit wraps the kubeaudit library to provide a scanner.KubeScanner implementation for auditing Kubernetes resources against common security concerns.
|
Package kubeaudit wraps the kubeaudit library to provide a scanner.KubeScanner implementation for auditing Kubernetes resources against common security concerns. |
|
kubernetes/apis/cluster
Package cluster is the internal version of the API.
|
Package cluster is the internal version of the API. |
|
kubernetes/apis/cluster/v1beta1
Package v1beta1 Package v1beta1 is the v1beta1 version of the API.
|
Package v1beta1 Package v1beta1 is the v1beta1 version of the API. |
|
kubernetes/apis/search
Package search is the internal version of the API.
|
Package search is the internal version of the API. |
|
kubernetes/apis/search/v1beta1
Package v1beta1 Package v1beta1 is the v1beta1 version of the API.
|
Package v1beta1 Package v1beta1 is the v1beta1 version of the API. |
|
kubernetes/generated/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
kubernetes/generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
kubernetes/generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
kubernetes/generated/clientset/versioned/typed/cluster/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
kubernetes/generated/clientset/versioned/typed/cluster/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
kubernetes/generated/clientset/versioned/typed/search/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
kubernetes/generated/clientset/versioned/typed/search/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |