generating-ovn-topology

Generate Mermaid Markdown topology diagrams from live OVN-Kubernetes cluster data.

112|305|Updated Oct 10, 2025
One-click install
npx skills add https://github.com/openshift-eng/ai-helpers --skill generating-ovn-topology
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generating-ovn-topology
Source: https://github.com/openshift-eng/ai-helpers/tree/main/plugins/openshift/skills/generating-ovn-topology
Command: npx skills add https://github.com/openshift-eng/ai-helpers --skill generating-ovn-topology

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires kubectl, ovn-nbctl, and includes scripts (resource) components.

What problem does it solve?

This Skill eliminates the complexity of manually mapping OVN-Kubernetes network architectures, providing clear visual diagrams of your entire cluster's logical networking components.

Core Features & Use Cases

  • Automatic Discovery: Automatically detects OVN clusters across all kubeconfig contexts.
  • Comprehensive Visualization: Generates detailed Mermaid diagrams showing switches, routers, ports, pods, and their interconnections.
  • Use Case: Imagine you need to troubleshoot network connectivity issues in your 50-node OVN cluster. Use this Skill to instantly generate a complete topology diagram showing all components and their relationships.

Quick Start

Use the generating-ovn-topology skill to create a visual diagram of my OVN-Kubernetes cluster network architecture.

Frequently Asked Questions about generating-ovn-topology

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

FAQPage Schema
How do I visualize my OVN-Kubernetes network topology?

Generate OVN-Kubernetes network topology diagrams automatically from your live cluster data using this Skill. It produces Mermaid diagrams showing switches, routers, ports, MAC/IP addresses, and pod connectivity for troubleshooting and documentation.

Can I use this to troubleshoot network connectivity issues in Kubernetes clusters?

Yes. This Skill generates detailed visual diagrams of your entire OVN cluster's logical networking components, helping you identify connectivity issues, trace pod relationships, and understand interconnect configurations across all nodes.

What prerequisites do I need to generate OVN topology diagrams?

You need kubectl configured to access your OVN-Kubernetes cluster and ovn-nbctl available to query the OVN northbound database. The Skill automatically discovers OVN clusters across your kubeconfig contexts.

Does this work with both centralized and per-node OVN deployment modes?

Yes. This Skill visualizes the complete logical network for both centralized and per-node interconnect deployment architectures, showing detailed switch and router configurations for each mode.

What output format does the topology diagram use?

The Skill generates Mermaid Markdown diagrams saved to disk. Mermaid format allows you to render, share, and integrate network architecture documentation directly into markdown files and documentation systems.

Can I use this for capacity planning and architecture documentation?

Yes. Beyond troubleshooting, the generated topology diagrams provide clear visual references for capacity planning decisions, architecture reviews, and ongoing documentation of your cluster's logical network design.