troubleshoot

Diagnose KOF and KCM deployment issues by analyzing custom resources across API groups.

64|19|Updated Dec 4, 2024
One-click install
npx skills add https://github.com/k0rdent/kof --skill troubleshoot-k0rdent
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: troubleshoot
Source: https://github.com/k0rdent/kof/tree/main/.agents/skills/troubleshoot
Command: npx skills add https://github.com/k0rdent/kof --skill troubleshoot-k0rdent

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) components.

What problem does it solve?

Systematically inspect and report failures in KOF and KCM custom resources by walking the ownership and reference graph described in docs/relationships.md across multiple API groups. It covers resources in k0rdent.mirantis.com, kof.k0rdent.mirantis.com, config.projectsveltos.io, and lib.projectsveltos.io, including supporting Flux resources and core resources.

Core Features & Use Cases

  • Diagnose why a ClusterDeployment is not ready
  • Find why services are not being deployed to regional or child clusters
  • Investigate HelmRelease or Profile failures
  • Analyze a support bundle or exported object snapshots
  • Produce a structured health report of the KOF stack

Quick Start

Ask me to analyze a live Kubernetes cluster or a support bundle directory and I will produce a structured health report.

Frequently Asked Questions about troubleshoot

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

FAQPage Schema
How do I troubleshoot a Kubernetes ClusterDeployment that is not ready?

To troubleshoot a Kubernetes ClusterDeployment that is not ready, you can analyze custom resources and workload health across multiple API groups using this diagnostic tool to generate a structured health report identifying readiness failures.

What is the best way to diagnose KOF and KCM deployment issues across clusters?

The best way to diagnose KOF and KCM deployment issues is by walking the ownership and reference graph across multiple API groups to inspect readiness, template validity, and workload health, producing a structured failure report.

Can I analyze an offline support bundle to find why services are not deployed to child clusters?

Yes, you can analyze an offline support bundle to find why services are not deployed to child clusters. The tool reads bundle data from YAML/JSON sources to investigate HelmRelease or Profile failures and identify workload health issues.

How does analyzing the custom resource ownership graph help investigate HelmRelease failures?

Analyzing the custom resource ownership graph helps investigate HelmRelease failures by systematically walking resource references described in the relationship documentation across k0rdent, kof, and projectsveltos API groups to pinpoint exact failure points.

What custom resources and API groups are checked during a k0rdent health check?

A k0rdent health check inspects custom resources across k0rdent.mirantis.com, kof.k0rdent.mirantis.com, config.projectsveltos.io, and lib.projectsveltos.io API groups, including supporting Flux resources and core Kubernetes resources.

Do I need pyyaml installed to run support bundle analysis for Kubernetes deployments?

Yes, you need the pyyaml dependency installed to run support bundle analysis. The diagnostic process coordinates 12 analysis steps implemented as Python scripts that read YAML and JSON data sources to generate the final report.