kuberhealthy

Note: Kuberhealthy is currently undergoing a total rewrite in the main branch.

Kuberhealthy is a Kubernetes operator for synthetic monitoring and continuous process verification. Write your own tests in any language and Kuberhealthy will run them for you. Automatically creates metrics for Prometheus. Includes simple JSON status page. Now part of the CNCF!

❓ What is Kuberhealthy?
🚀 Installation
📈 Visualized
🧪 Create Synthetic Checks
📊 Status Page
🤝 Contributing
📅 Monthly Community Meeting

What is Kuberhealthy?

Kuberhealthy lets you continuously verify that your applications and Kubernetes clusters are working as expected. By creating a custom resource (a KuberhealthyCheck) in your cluster, you can easily enable various synthetic tests and get Prometheus metrics for them.

Kuberhealthy comes with lots of useful checks already available to ensure the core functionality of Kubernetes, but checks can be used to test anything you like. We encourage you to write your own check container in any language to test your own applications. It really is quick and easy!

Kuberhealthy serves the status of all checks on a simple JSON status page, a Prometheus metrics endpoint (at /metrics), and supports InfluxDB metric forwarding for integration into your choice of alerting solution.

Installation

Kuberhealthy requires Kubernetes 1.16 or above. You can install it with plain YAML manifests or with Helm.

For detailed installation steps, see the installation guide.
To configure Kuberhealthy after installation, see the configuration documentation.

Visualized

Here is an illustration of how Kuberhealthy provisions and operates checker pods. The following process is illustrated:

An admin creates a KuberhealthyCheck resource that calls for a synthetic Kubernetes daemonset to be deployed and tested every 15 minutes. This will ensure that all nodes in the Kubernetes cluster can provision containers properly.
Kuberhealthy observes this new KuberhealthyCheck resource.
Kuberhealthy schedules a checker pod to manage the lifecycle of this check.
The checker pod creates a daemonset using the Kubernetes API.
The checker pod observes the daemonset and waits for all daemonset pods to become Ready
The checker pod deletes the daemonset using the Kubernetes API.
The checker pod observes the daemonset being fully cleaned up and removed.
The checker pod reports a successful test result back to Kuberhealthy’s API.
Kuberhealthy stores this check’s state and makes it available to various metrics systems.

Included Checks

You can use any of the pre-made checks by simply enabling them. By default Kuberhealthy comes with several checks to test Kubernetes deployments, daemonsets, and DNS.

Some checks you can easily enable:

SSL Handshake Check - checks SSL certificate validity and warns when certs are about to expire.
CronJob Scheduling Failures - checks for events indicating that a CronJob has failed to create Job pods.
Image Pull Check - checks that an image can be pulled from an image repository.
Deployment Check - verifies that a fresh deployment can run, deploy multiple pods, pass traffic, do a rolling update (without dropping connections), and clean up successfully.
Daemonset Check - verifies that a daemonset can be created, fully provisioned, and torn down. This checks the full kubelet functionality of every node in your Kubernetes cluster.
Storage Provisioner Check - verifies that a pod with persistent storage can be configured on every node in your cluster.

Create Synthetic Checks for Your APIs

You can easily create synthetic tests to check your applications and APIs with real world use cases. This is a great way to be confident that your application functions as expected in the real world at all times.

Here is a full check example written in go. Just implement doCheckStuff and you’re off!

package main

import (
  "github.com/kuberhealthy/kuberhealthy/v2/pkg/checks/external/checkclient"
)

func main() {
  ok := doCheckStuff()
  if !ok {
    checkclient.ReportFailure([]string{"Test has failed!"})
    return
  }
  checkclient.ReportSuccess()
}

You can read more about how checks are configured and learn how to create your own check container. Checks can be written in any language and helpful clients for checks not written in Go can be found in the clients directory.

Status Page

Kuberhealthy serves a simple JSON status page and Prometheus metrics endpoint. See the status page guide for output examples and details.

Contributing

If you’re interested in contributing to this project:

Check out the Contributing Guide.
If you use Kuberhealthy in a production environment, add yourself to the list of Kuberhealthy adopters!
Check out open issues. If you’re new to the project, look for the good first issue tag.
We’re always looking for check contributions (either in suggestions or in PRs) as well as feedback from folks implementing Kuberhealthy locally or in a test environment.

Hermit

While working on Kuberhealthy, you can take advantage of the included Hermit dev environment to get Go & other tooling without having to install them separately on your local machine.

Just use the following command to activate the environment, and you’re good to go:

. ./bin/activate-hermit

Monthly Community Meeting

If you would like to talk directly to the core maintainers to discuss ideas, code reviews, or other complex issues, we have a monthly Zoom meeting on the 24th day of every month at 04:30 PM Pacific Time.

Table of Contents