kubeeye

Deploy KubeEye and inspect Kubernetes clusters with OPA, PromQL, and node-level rules.

17.0k|2.8k|Updated Apr 21, 2018
One-click install
npx skills add https://github.com/kubesphere/kubesphere --skill kubeeye
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kubeeye
Source: https://github.com/kubesphere/kubesphere/tree/main/skills/kubeeye
Command: npx skills add https://github.com/kubesphere/kubesphere --skill kubeeye

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Operating Kubernetes clusters at scale makes it hard to detect misconfigured workloads, unhealthy nodes, and security risks before they cause incidents. This Skill automates the deployment of KubeEye on KubeSphere and the creation of inspection rules, plans, and reports so cluster issues surface proactively.

Core Features & Use Cases

  • Extension Deployment: Install or upgrade the KubeEye extension on KubeSphere via generated InstallPlan manifests with status polling.
  • Inspection Rule Authoring: Create InspectRule resources covering OPA/Rego policies, PromQL queries, file change checks, sysctl, systemd, node info, file filters, service connectivity, and custom commands.
  • Scheduled Inspections & Reports: Configure cron or one-shot InspectPlans, track InspectTasks, and retrieve InspectResults as YAML, HTML, or XLSX reports.
  • Use Case: A platform engineer wants a weekly security audit of all Deployments. They import the bundled OPA rules, generate an InspectPlan, and download an XLSX report listing privileged containers, missing resource limits, and hostPath volumes.

Quick Start

Ask the AI to install the KubeEye extension on your KubeSphere cluster, apply the bundled inspection rules, and run a one-shot inspection to produce a report.

Frequently Asked Questions about kubeeye

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I install KubeEye on a KubeSphere cluster?

KubeEye installs as a KubeSphere extension through an InstallPlan resource. Detect available versions with kubectl get extensionversions, generate the InstallPlan with the provided script, apply it, and poll the status until the state shows Installed.

How do I write a KubeEye inspection rule with OPA?

Create an InspectRule resource with an opas section containing Rego policies in the inspect.kubeeye package. Each deny rule matches on input.kind and input.apiVersion and returns a message with Name, Namespace, Type, Level, Message, and Reason fields.

What inspection rule types does KubeEye support?

KubeEye supports OPA/Rego policies, PromQL queries against Prometheus, file change detection, file content filtering, sysctl validation, systemd service checks, node info thresholds, service connectivity tests, and custom shell commands.

How do I schedule recurring cluster inspections with KubeEye?

Create an InspectPlan with a cron expression in the schedule field and a ruleNames list referencing your InspectRules. The controller creates an InspectTask on each trigger and populates an InspectResult when the inspection jobs finish.

Why is my KubeEye inspection producing no results?

Check that InspectRules and the InspectPlan exist, then verify InspectTask status with kubectl get inspecttask. Also confirm the kubeeye-apiserver endpoints exist in the extension-kubeeye namespace, since missing endpoints prevent result retrieval.

Can I download KubeEye inspection reports as Excel files?

Yes, the kubeeye-apiserver exposes report endpoints on port 9090. Request the inspectresult resource with type=html for an HTML report or use the /download path to get an XLSX file.