Introduction
\
- Welcome to RunWhen Local!
- Who Can Benefit?
- Where Can You See It in Action?
- How Can I Get It?
- How You Can Contribute
- Connect with the RunWhen Community
- Check Out Our Documentation
- Stay Updated with Release Notes
Welcome to RunWhen Local!
Are you tired of searching through files and wikis for those elusive CLI commands that come in handy but always need tweaking?
RunWhen Local is like your personal troubleshooter's toolbox. It's a friendly container that offers an easy-to-use web interface, filled with helpful copy & paste CLI commands specifically designed to troubleshoot applications in your Kubernetes environment. And guess what? It's open-source! Here's how it works:
- You launch the container.
- It scans your clusters.
- It identifies the perfect troubleshooting commands tailored to your resources.
- You simply copy and paste the commands to help solve your issues!
Can it Automatically Run These Commands?
Yes, but only when connected to the RunWhen Platform SaaS service. RunWhen Local can be installed in Kubernetes, connected to the RunWhen Platform, with self-hosted private runners. In this configuration, your RunWhen Workspace is automatically updated with:
- newly discovered cloud resources
- automation tasks
- troubleshooting tasks
- health checks
- workflows
- SLI and SLO alerting
- and much more!
See www.runwhen.com or docs.runwhen.com for more details, or jump to kubernetes_self_hosted_runner for more details on this installation option.
Who Can Benefit?
If you're involved with Kubernetes or Public Cloud environments, RunWhen Local could be for you. It’s designed for:
- Kubernetes administrators
- Kubernetes application developers
- Support teams working with Kubernetes
- Cloud infrastructure teams in GCP, AWS, or Azure
- Public cloud administrators managing workloads or services
- Anyone needing help troubleshooting cloud-based services
Where Can You See It in Action?
Curious to see it in action? We've got a few options for you:
- Check out our live demo instance here. Please note that it's linked to our sandbox cluster, so the commands are suited for that environment.
- Explore our YouTube Channel with short demo videos in this playlist
- Want to check out the RunWhen Platform? We have tutorials that you can play with right in our sandbox cluster. Click here. Sign in. Play.
How Can I Get It?
Ready to dive in? Run it yourself.
How You Can Contribute
We love when the community gets involved! There are two main ways you can contribute:
Expanding the Troubleshooting Library
Contribute to Existing Libraries
Our troubleshooting library is fully open-source and welcomes contributions. You can contribute directly to any of the CodeCollection libraries hosted in our Registry.
For more details, check out the contribution guides within each repo.
Create Your Own Library
Interested in maintaining your own code collection and being rewarded for your efforts? Learn more about the RunWhen Author Program.
Share New Commands or Enhance Existing Ones
Join the community by:
- Contributing an awesome troubleshooting command
- Requesting a new command
- Engaging in discussions on GitHub Discussions.
Improving RunWhen Local
Your ideas matter! Help us enhance the tool:
- Report bugs or share feedback
- Want to make your own changes? Read the CONTRIBUTING documentation, fork the repo, and explore the DEVELOPMENT documentation.
Connect with the RunWhen Community
We're a friendly bunch! Connect with us on:
Check Out Our Documentation
All documentation is stored in /docs, but is also rendered by GitBook here.
Stay Updated with Release Notes
Catch up on our latest updates in the release notes.
Welcome to RunWhen Local – your go-to troubleshooter's companion! 🚀