/runwhen-local

RunWhen Local provides a tailored troubleshooting cheat sheet for Kubernetes environments

Primary LanguagePythonApache License 2.0Apache-2.0

Introduction

Join Discord Join Slack
Artifact Hub

RunWhen Local Overview

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:

  1. You launch the container.
  2. It scans your clusters.
  3. It identifies the perfect troubleshooting commands tailored to your resources.
  4. You simply copy and paste the commands to help solve your issues!

Who Can Benefit?

If you're involved with Kubernetes environments, RunWhen Local could be for you. It's designed for:

  • Kubernetes administrators
  • Kubernetes application developers
  • Support teams working with Kubernetes

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

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 these repositories:

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:

Improving RunWhen Local

Your ideas matter! Help us enhance the tool:

Connect with the RunWhen Community

We're a friendly bunch! Connect with us on:

Check Out Our Documentation

All documention is stored in /docs, but is also rendered by GitBook here.

What's on the Horizon?

We've got exciting plans ahead! Here's a sneak peek at what's coming:

Major Goals

Ongoing Enhancements

We're also working on:

  • Robust CI/CD: Sandbox deployment validation for PRs
  • Expanding our library of troubleshooting commands (always more to come!)
  • Improved contribution guides
  • Detailed low-level documentation

In the meantime, we're constantly adding features and troubleshooting code. Feel free to raise issues for new features or contribute your own commands!

Check out the GitHub Project for ongoing roadmap updates.

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! 🚀