An intelligent and intuitive Kubernetes cluster management IDE built for developers, SREs, and DevOps teams.

• About
• Features
• Screenshots
• Tech Stack
• Installation
• Run Locally
• Usage
• Environment Variables
• Roadmap
• Contributing
• Feedback and Support
• License
• Acknowledgements

Orchetrix (OX) is a powerful and intuitive graphical user interface (GUI) for managing Kubernetes clusters. Designed to simplify container orchestration, Orchetrix provides a centralized and visually rich dashboard to deploy, monitor, and troubleshoot your containerized applications. It serves as a user-friendly alternative to command-line tools like kubectl, offering a more accessible way to interact with your Kubernetes resources. With Orchetrix, you can effortlessly navigate through your namespaces, manage nodes and pods, and visualize the overall architecture of your applications, making Kubernetes management more efficient and approachable for everyone.

• Multi-cluster Management: Seamlessly connect and manage multiple Kubernetes clusters from a single interface.

• Live Monitoring: View real-time CPU, memory, and pod usage across clusters for quick insights into workload performance.

• Integrated Logs & Terminal: Directly access pod logs and open terminals inside containers with just a click—no need to switch to the CLI.

• In-Place YAML Editing: Edit resource YAMLs directly from the detail panel without opening separate editors or terminals.

• SSH into Pods: Securely connect to pods using an SSH-like terminal interface for advanced troubleshooting and debugging.

• Dark-Themed UI: Enjoy a clean, modern, and visually appealing dark UI designed for long DevOps sessions.

• Frontend: PyQt6
• Backend: Python 3
• Kubernetes API for cluster interactions
• Docker (for packaging and distribution)

To install the Orchetrix (OX), simply download the latest release from our official website:

Download Orchetrix (OX)

Full usage guides, feature explanations, and setup tutorials for Orchetrix (OX) are available at:

https://www.orchetrix.com/documentation

• Welcome to OX:
  Get started with Orchetrix in minutes — learn the basics, install the app, and explore its capabilities.

• How to:
  Step-by-step guides on using OX to manage clusters, workloads, logs, pods, and more.

• User Interface Overview:
  Discover the layout, navigation, workloads, storage, and access control panels that power your Kubernetes management.

• FAQ:
  Find answers to the most common questions and troubleshoot common issues.

• Contribute to OX:
  Learn how to join the community, contribute to development, and grow with us.

• Support:
  Need help? Get in touch with the Orchetrix team or reach out to the community.

OX Documentation

Follow the instructions below to install and run Orchetrix (OX) on your operating system.

1. Download Orchetrix for Windows

2. Unzip the file to any location.

   Note: The ZIP file is password protected. Use the password Orchetrix to extract it.

3. Open the extracted folder.

4. Double-click orchetrix.exe to launch the application.

If Windows shows a security warning, click "More info" → "Run anyway".

1. Download Orchetrix for macOS
2. Unzip the file to your Applications or preferred directory.
3. Open orchetrix.app.

If you get a message like “App can’t be opened because it is from an unidentified developer”, go to System Preferences > Security & Privacy > General, and click Open Anyway.

1. Download Orchetrix for Ubuntu22
2. Download Orchetrix for Ubuntu24
3. Unzip the file:

   unzip orchetrix-linux.zip
   cd orchetrix-linux
   

If you encounter any issues or module-related errors while installing or running Orchetrix (OX), ensure all required dependencies are properly installed.

You can use the provided requirements.txt file to install them:

pip install -r requirements.txt

Once you have installed and launched Orchetrix (OX), follow these steps to start managing your Kubernetes clusters:

1. Launch the App
   Open the Orchetrix desktop application from your installed location.

2. Select a Cluster

   • Go to the cluster panel.
   • OX will fetch all associated clusters automatically and display them in the cluster panel.
   • Select the running cluster you want to work with.

3. Navigate the Dashboard

   • View high-level resource usage (CPU, memory, pods).
   • Monitor workloads, namespaces, events, and node health.

4. Explore Resources

   • Click on Cluster, Nodes, Workloads, Config, Network, Storage, Helm, Access Control, Custom Resources, Namespaces and Events to browse K8s resources.
   • Use the search and filter options to quickly find what you need.

5. View Logs, SSH into pods and Terminal Access

   • Select a pod → Click Logs to view live logs.
   • Use the built-in terminal to execute shell commands inside containers.

6. Edit YAML Directly

   • Click on any resource to open its Detail Panel.
   • In the panel, you will find four tabs: Overview, Detail, YAML, and Events.
   • Go to the YAML tab and click Edit.
   • Make your changes directly in the YAML editor.
   • Click Deploy to apply the updated configuration immediately to your cluster.

Here are some upcoming features and improvements planned for Orchetrix (OX):

• Compare (Multi-Cluster Analysis):
  A side-by-side comparison tool that enables users to compare workloads, namespaces, services, and resource utilization across multiple clusters. Ideal for multi-environment analysis.

• AI Assist (K8s Assistant):
  An integrated AI assistant to help with daily Kubernetes tasks like generating YAML manifests, detecting common issues, suggesting optimization tips, and answering platform-specific queries, all within the app.

• App View (Architecture Visualization):
  A visual representation of your applications running in Kubernetes, showing how pods, services, volumes, and dependencies interact, making it easier to understand and debug complex systems.

• Helm Integration:
  Native support to manage Helm charts and releases directly from Orchetrix. Browse available charts, install or upgrade them, and roll back with ease, no CLI required.

• Updated UI:
  A refreshed, more modern and user-centric interface that improves navigation, responsiveness, and usability, optimized for both new users and power users alike.

We are here to help. If you have any questions, suggestions, or run into issues:

• Email us at: [email protected]
• Submit issues or feature requests via GitHub Issues

We also welcome feedback on features you would like to see in future releases.

We would like to thank the open-source community and the tools that power Orchetrix (OX):

• Kubernetes – for making container orchestration accessible and powerful
• PyQt6 – for enabling a native desktop interface
• Docker – for simplifying containerization
• All early contributors and beta testers who helped shape this project