{"id":13493613,"url":"https://github.com/kubesphere/kubeeye","last_synced_at":"2025-05-14T00:05:27.527Z","repository":{"id":37098444,"uuid":"310904702","full_name":"kubesphere/kubeeye","owner":"kubesphere","description":"KubeEye aims to find various problems on Kubernetes, such as application misconfiguration, unhealthy cluster components and node problems.","archived":false,"fork":false,"pushed_at":"2025-04-17T08:26:17.000Z","size":231173,"stargazers_count":829,"open_issues_count":28,"forks_count":131,"subscribers_count":17,"default_branch":"release-1.0","last_synced_at":"2025-05-12T02:26:21.422Z","etag":null,"topics":["cluster-analysis","k8s","kubeeye","kubernetes","observability"],"latest_commit_sha":null,"homepage":"https://kubesphere.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kubesphere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"docs/roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-11-07T18:12:40.000Z","updated_at":"2025-05-11T04:01:58.000Z","dependencies_parsed_at":"2023-02-05T03:17:03.900Z","dependency_job_id":"2409c855-5a0f-49ab-888d-26b480cac9d5","html_url":"https://github.com/kubesphere/kubeeye","commit_stats":{"total_commits":516,"total_committers":28,"mean_commits":"18.428571428571427","dds":0.436046511627907,"last_synced_commit":"dc9d07bb1ad1dbc933470d4b40aafe6916a3a081"},"previous_names":["kubesphere/kubeye"],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fkubeeye","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fkubeeye/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fkubeeye/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fkubeeye/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kubesphere","download_url":"https://codeload.github.com/kubesphere/kubeeye/tar.gz/refs/heads/release-1.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254043360,"owners_count":22004936,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cluster-analysis","k8s","kubeeye","kubernetes","observability"],"created_at":"2024-07-31T19:01:17.097Z","updated_at":"2025-05-14T00:05:27.508Z","avatar_url":"https://github.com/kubesphere.png","language":"Go","funding_links":[],"categories":["开源类库","Go","3. Collect","Open source library","K8S-Tools"],"sub_categories":["集群管理","Events \u0026 Problems","Cluster Management"],"readme":"\u003cdiv align=center\u003e\u003cimg src=\"docs/images/KubeEye-O.svg?raw=true\"\u003e\u003c/div\u003e\n\n\u003cp align=center\u003e\n\u003ca href=\"https://github.com/kubesphere/kubeeye/actions?query=event%3Apush+branch%3Amain+workflow%3ACI+\"\u003e\u003cimg src=\"https://github.com/kubesphere/kubeeye/workflows/CI/badge.svg?branch=main\u0026event=push\"\u003e\u003c/a\u003e\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n\u003ca href=\"https://github.com/kubesphere/kubeeye#contributors-\"\u003e\u003cimg src=\"https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\u003c/p\u003e\n\n\u003e English | [中文](README_zh.md)\n\nKubeEye is a cloud-native cluster inspection tool specifically designed for Kubernetes, capable of identifying issues and risks within the Kubernetes cluster based on custom rules.\n\n## QuickStart\n\n### Installation\nDownload the installation package from [Releases](https://github.com/kubesphere/kubeeye/releases), which includes Helm chart, demo rules, and images for offline installation.\n\n```shell\nVERSION=v1.0.3\n\nwget https://github.com/kubesphere/kubeeye/releases/download/${VERSION}/kubeeye-offline-${VERSION}.tar.gz\n\ntar -zxvf kubeeye-offline-${VERSION}.tar.gz\n\ncd kubeeye-offline-${VERSION}\n\n# offline installation, please import the images in the 'images' folder into the local container repository yourself and modify the images repo in `chart/kubeeye/values.yaml`.\n\nhelm upgrade --install kubeeye chart/kubeeye -n kubeeye-system --create-namespace\n\n```\n\n### Usage\n\n#### Import Inspect Rules\n   \n\u003e The `rules` directory in the installation package provides demo rules, which can be customized according to specific needs.\n\n\u003e Notice： PromQL rules need to have the endpoint of Prometheus set in advance.\n\n```shell\nkubectl apply -f rules\n```\n\n#### Create Inspect Plan\n\nConfigure inspection plans on demand.\n```shell\ncat \u003e plan.yaml \u003c\u003c EOF\napiVersion: kubeeye.kubesphere.io/v1alpha2\nkind: InspectPlan\nmetadata:\n  name: inspectplan\nspec:\n  # The planned time for executing inspections only supports cron expressions. For example, '*/30 * * * ?' means that the inspection will be performed every 30 minutes.'\n  # If only a single inspection is required, then remove this parameter.\n  schedule: \"* */12 * * ?\"\n  # The maximum number of retained inspection results, if not filled in, will retain all.\n  maxTasks: 10 \n  # Should the inspection plan be paused, applicable only to periodic inspections, true or false (default is false).\n  suspend: false\n  # Inspection timeout, default 10 minutes.\n  timeout: 10m\n  # Inspection rule list, used to associate corresponding inspection rules, please fill in the inspectRule name.\n  # Execute `kubectl get inspectrule` to view the inspection rules in the cluster.\n  ruleNames:\n  - name: configmap-inspect-rules\n  - name: cronjob-inspect-rules\n  - name: daemonset-inspect-rules\n  - name: deployment-inspect-rules\n  - name: event-inspect-rules\n  - name: job-inspect-rules\n  - name: node-inspect-rules\n  - name: pod-inspect-rules\n  - name: pod-state-inspect-rules\n  # nodeName: master\n  # nodeSelector:\n  #   node-role.kubernetes.io/master: \"\"        \n  # Multi-cluster inspection (currently only supports multi-cluster inspection in KubeSphere)\n  # clusterName: \n  # - name: host\nEOF\n\n\nkubectl apply -f plan.yaml\n```\n\n#### Obtaining Inspection Reports\n##### Check Inspection Results\n```shell\n# View the name of the inspection result for inspection report download.\nkubectl get inspectresult\n```\n###### Command\n```shell\n## Get the address and port of kubeeye-apiserver service.\nkubectl get svc -n kubeeye-system kubeeye-apiserver -o custom-columns=CLUSTER-IP:.spec.clusterIP,PORT:.spec.ports[*].port\n\n## Download the inspection report, and please replace \u003c\u003e with the actual information obtained from the environment.\ncurl http://\u003csvc-ip\u003e:9090/kapis/kubeeye.kubesphere.io/v1alpha2/inspectresults/\u003cresult name\u003e\\?type\\=html -o inspectReport.html\n\n## After downloading, you can use a browser to open the HTML file for viewing.\n```\n###### Web Console\n```shell\n## Create a nodePort type svc for kubeeye-apiserver.\nkubectl -n kubeeye-system expose deploy kubeeye-apiserver --port=9090 --type=NodePort --name=ke-apiserver-node-port\n\n## Enter the inspection report URL in the browser to view, and remember to replace \u003c\u003e with the actual information obtained from the environment.\nhttp://\u003cnode address\u003e:\u003cnode port\u003e/kapis/kubeeye.kubesphere.io/v1alpha2/inspectresults/\u003cresult name\u003e?type=html\n```\n## Supported Rules List\n* OPA \n* PromQL \n* File Change\n* Kernel Parameter Configuration\n* Systemd Service Status\n* Node Basic Info\n* File Content Inspection\n* Service Connectivity\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubesphere%2Fkubeeye","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubesphere%2Fkubeeye","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubesphere%2Fkubeeye/lists"}