KubeNexus

Installation

macOS

1. Download the kubernetes_debugger_pro_mac executable.
2. Place the executable in your desired directory.
3. Open Terminal and navigate to the directory containing the executable.
4. Run the executable:

   ./kubernetes_debugger_pro_mac

Configuration

Ensure your Kubernetes configuration file is set up correctly:

• macOS: ~/.kube/config

Features

1. View and Manage Resources
2. Monitor Cluster Metrics
3. Explore Custom Resources
4. Visualize Network Graphs

Detailed Description

Context based buttons for resource types

Pods -

Services -

Secrets -

Events -

In built terminal for quick access -

1. View and Manage Resources

This tab provides a comprehensive interface to view and manage various Kubernetes resources such as Pods, Deployments, StatefulSets, Jobs, CronJobs, PVCs, PVs, Secrets, ConfigMaps, and Nodes.

Monitor Cluster Metrics

This tab provides a real-time overview of node and pod metrics, including CPU and memory usage, requests, and limits.

How It Helps

• Node Metrics: Displays metrics for all nodes in the cluster including CPU and memory capacities, requests, limits, and usage percentages.
• Pod Metrics: Shows detailed metrics for pods filtered by namespace or labels, including CPU and memory usage, requests, limits, and GPU usage.
• Auto-Refresh: Options to auto-refresh metrics at specified intervals.
• Search and Filter: Allows users to search and filter pod metrics to quickly find specific data.
• Export Metrics: Provides functionality to download pod metrics as CSV files.

How It Helps

• Resource Overview: Allows users to view detailed information about resources across different namespaces.
• Manual and Auto-Refresh: Provides options for auto-refresh intervals to keep resource information up-to-date.
• Namespace Comparison: Enables comparison of resources between two namespaces.
• Resource Actions: Facilitates actions like editing, deleting, and streaming logs for resources.
• Resource Filtering: Offers search and filter capabilities to quickly locate specific resources.
• Event Monitoring: Displays latest events in the cluster with filtering options.

How to Use

1. Select Cluster: Choose the desired cluster from the dropdown menu.
2. Set Auto-refresh: Select an auto-refresh interval or choose 'Off' to disable auto-refresh.
3. Choose Namespaces: Select two namespaces to compare resources.
4. Select Resource Type: Pick the resource type (Pods, Deployments, etc.) from the dropdown.
5. View Resource Table: The table will display resources based on the selected filters. Use the 'Refresh' button for manual refresh.
6. Perform Actions: Use the action buttons in the table to delete, edit, or stream logs of resources.
7. Filter Events: Use the filter input to narrow down events displayed in the events table.

2. Node metrics

3. Pod metrics

4. Explore Custom Resources

This tab enables users to explore custom resources, cluster roles, service accounts, roles, and bindings.

How It Helps

• Custom Resource Definitions: Allows viewing and managing custom resource definitions (CRDs).
• Cluster Roles and Bindings: Provides a list of cluster roles, service accounts, roles, and their bindings.
• Resource Details: Displays detailed information about selected resources, including metadata and spec details.
• CRD Definitions: Offers the capability to view CRD definitions in a readable format.

How to Use

1. Select Resource Type: Choose from 'Custom Resources', 'Cluster Roles', 'Service Accounts', 'Roles', 'Cluster Role Bindings', or 'Role Bindings'.
2. Filter Resources: Use the filter input to narrow down the resource list.
3. Select Resource: Click on a resource to view its details.
4. View Details: The table and info pane will display detailed information about the selected resource.
5. View CRD Definition: Click the 'View CRD Definition' button to see the CRD definition.

5. Visualize Network Graphs

This tab provides graphical visualizations of the cluster's network topology, including namespace overviews, service dependencies, ingress traffic flows, network policies, node-to-pod mappings, and PVC connections.

How It Helps

• Namespace Overview: Visualizes the relationships between different resources within a namespace.
• Service Dependency: Shows the dependencies between services and endpoints.
• Ingress Traffic Flow: Illustrates the traffic flow through ingress resources to services.
• Network Policy: Displays the application of network policies on pods.
• Node-to-Pod Mapping: Maps pods to the nodes they are running on.
• PVC Connections: Shows the connections between pods and persistent volume claims (PVCs).
• Custom Resource Dependency: Visualizes dependencies involving custom resources.

How to Use

1. Select Namespace: Choose a namespace from the dropdown menu.
2. Select Graph Type: Choose from 'Namespace Overview', 'Service Dependency', 'Ingress Traffic Flow', 'Network Policy', 'Node-to-Pod Mapping', 'PVC Connections', or 'Custom Resource Dependency'.
3. View Graph: The graph will be generated and displayed in the web view.
4. Interact with Graph: Right-click on nodes to view detailed information.

6. Github

7. JIRA

8. Jenkins

9. System

By using the kubenexus tool, users can effectively manage Kubernetes resources, monitor cluster performance, explore custom resources, and visualize network topologies, all from a single, lightweight GUI application.