similarweb/statusbay repository overview

⁠StatusBay

⁠Deployment visibility like a pro

Key features:

• Watch every step of K8S deployment.
• Get Slack reports on deployment progress.
• Out of the box integrations to measure your deployment quality.
• Deployed on k8s with Helm⁠.
• Easily extensible.
• Streamline the trouble shooting experience in K8S.

⁠What is StatusBay?

StatusBay is an open source tool that provides the missing visibility into the K8S deployment process. It does that by subscribing to K8S cluster(s), collecting all the relevant events from K8S and providing a step by step "zoom-in" into the deployment process. The main goal is to ease the experience of troubleshooting and debugging services in K8S and provide confidence while making changes.

StatusBay is designed to be dynamic and extensible, you can easily integrate with different metric providers to monitor the quality of the deployment over time.

We've also created an API to provide an easy way to access the data and built a UI on top of it.

⁠Getting Started

1. The quickest way to get started with StatusBay is by using K8S. Get started with StatusBay Helm Chart⁠.
2. Deploy your application. If you'd like to adopt all StatusBay features, see available configuration options in this example⁠.

See DockerHub registry⁠

⁠Documentation & Guides

• Developer Guide⁠: If you are interested in contributing, read the developer guide.
• Working with Multiple Clusters⁠: If you have multiple K8S clusters and you wish to have a unified deployment view, take a look at this guide.
• Integrations⁠: List of StatusBay supported integrations.
• External Logging System⁠: Ship StatusBay logs to your centralized logging system.
• Telemetry metrics⁠: StatusBay exposes metrics for you to pick up, see the telemetry read me to get started.

⁠How does it work?

StatusBay watcher subscribes to K8S cluster event stream and watches for resource changes (CREATE/UPDATE/DELETE). Upon a change, such as new application deployment, it starts monitoring the progress of all the resource kinds (deployment, statefulset, daemonset, etc) associated with that deployment, notifies the relevant persona on success/failure/timeout and provides detailed report through the UI.

Example Scenario:

Someone has deployed an Nginx through Helm or Kubectl.

$ helm install {{NGINX_APP}} .

# OR

$ kubectl create deployment --image nginx my-nginx

The watcher will immediately start monitoring the deployment named my-nginx and report to the user using the notifications channels configured (slack, email, etc).

The following annotations can be attached to deployment to configure the different features StatusBay has to offer.

⁠Read more on StatusBay deployment configuration annotations⁠

⁠Built With

• GO⁠.
• K8S Client Library⁠.

⁠Contributing

Thank you for your interest in contributing! Please refer to CONTRIBUTING.md⁠ for guidance.