Giving Kubernetes Superpowers to everyone
Go to file
AlexsJones 06fb8073dc chore: updated readme
Signed-off-by: AlexsJones <alexsimonjones@gmail.com>
2023-03-27 11:16:07 +01:00
.github chore(deps): pin amannn/action-semantic-pull-request action to c3cd5d1 2023-03-25 02:22:36 +00:00
cmd chore: moved code 2023-03-27 10:59:48 +01:00
container fix: build 2023-03-22 16:29:38 +01:00
images chore: updated readme 2023-03-27 11:16:07 +01:00
pkg chore: moved code 2023-03-27 10:59:48 +01:00
.gitignore adding workflow 2023-03-21 20:09:18 +00:00
.goreleaser.yaml fix: remove sboms from goreleaser 2023-03-24 10:06:28 +01:00
.release-please-manifest.json chore(main): release 0.0.6 2023-03-26 15:22:45 +00:00
CHANGELOG.md chore(main): release 0.0.6 (#79) 2023-03-26 18:28:24 +02:00
CONTRIBUTING.md docs: update CONTRIBUTING 2023-03-23 18:09:39 +01:00
go.mod wip fixing missing details 2023-03-27 10:25:25 +01:00
go.sum wip fixing missing details 2023-03-27 10:25:25 +01:00
LICENSE Update LICENSE 2023-03-21 22:01:53 +00:00
main.go Revert "chore: tidying" 2023-03-24 10:55:37 +00:00
README.md chore: updated readme 2023-03-27 11:16:07 +01:00
release-please-config.json fix: release please config 2023-03-22 15:46:25 +01:00
renovate.json chore: add initial renovate config 2023-03-22 07:44:38 +01:00

Text changing depending on mode. Light: 'So light!' Dark: 'So dark!'

Install it now

brew tap k8sgpt-ai/k8sgpt
brew install k8sgpt

k8sgpt is a tool for scanning your kubernetes clusters, diagnosing and triaging issues in simple english.

It has SRE experience codified into it's analyzers and helps to pull out the most relevent information to enrich it with AI.

Analyzers

K8sGPT uses analyzers to triage and diagnose issues in your cluster. It has a set of analyzers that are built in, but you will be able to write your own analyzers.

Built in analyzers

  • podAnalyzer
  • pvcAnalyzer
  • rsAnalyzer
  • serviceAnalyzer
  • eventAnalyzer

Usage

Kubernetes debugging powered by AI

Usage:
  k8sgpt [command]

Available Commands:
  analyze     This command will find problems within your Kubernetes cluster
  auth        Authenticate with your chosen backend
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command

Run a scan with the default analyzers

k8sgpt auth
k8sgpt analyze --explain

Filter on resource

k8sgpt analyze --explain --resource=Service

Output to JSON

k8sgpt analyze --explain --resource=Service --output=json

Upcoming major milestones

  • Multiple AI backend support
  • Custom AI/ML model backend support
  • Custom analyzers

What about kubectl-ai?

The the kubectl-ai project uses AI to create manifests and apply them to the cluster. It is not what we are trying to do here, it is focusing on writing YAML manifests.

K8sgpt is focused on triaging and diagnosing issues in your cluster. It is a tool for SRE, Platform & DevOps engineers to help them understand what is going on in their cluster. Cutting through the noise of logs and multiple tools to find the root cause of an issue.

Configuration

k8sgpt stores config data in ~/.k8sgpt the data is stored in plain text, including your OpenAI key.

Contributing

Please read our contributing guide.

Community