https://github.com/zapier/kubechecks

Check your Kubernetes changes before they hit the cluster
https://github.com/zapier/kubechecks

argocd cicd kubernetes

Last synced: 15 days ago
JSON representation

Check your Kubernetes changes before they hit the cluster

• Host: GitHub
• URL: https://github.com/zapier/kubechecks
• Owner: zapier
• License: mpl-2.0
• Created: 2023-06-01T14:58:22.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-15T23:10:42.000Z (27 days ago)
• Last Synced: 2024-11-15T23:22:14.890Z (27 days ago)
• Topics: argocd, cicd, kubernetes
• Language: Go
• Homepage: https://kubechecks.readthedocs.io/en/latest/
• Size: 67.2 MB
• Stars: 187
• Watchers: 5
• Forks: 17
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - zapier/kubechecks - Check your Kubernetes changes before they hit the cluster (Go)
• awesome-argo - kubechecks - request will make to your ArgoCD applications, with reporting directly in the PR. (Ecosystem Projects)

README

        
![logo-transparent](https://github.com/zapier/kubechecks/assets/33305772/ea7947eb-b7db-4e08-b047-cf16ab22a1d3)

# kubechecks - Fearless Kubernetes App Updates

[![Documentation Status](https://readthedocs.org/projects/kubechecks/badge/?version=latest)](https://kubechecks.readthedocs.io/en/latest/?badge=latest)

`kubechecks` allows users of Github and Gitlab to see exactly what their changes will affect on their current ArgoCD deployments, as well as automatically run various conformance test suites prior to merge.

## Pull/Merge Request driven checks

When using ArgoCD, it can be difficult to tell just how your Pull/Merge Request (PR/MR) will impact your live deployment. `kubechecks` was designed to address this problem; every time a new PR/MR is created, `kubechecks` will automatically determine what's changed and how it will impact your `main`/default branchs state, informing you of the details directly on the PR/MR. As a bonus, it also lints and checks your Kubernetes manifests to let you know ahead of time if something is outdated, invalid, or otherwise not good practice.

![Demo](./docs/gif/kubechecks.gif)

### How it works

This tool provides a server function that processes webhooks from Gitlab/Github, clones the repository at the `HEAD` SHA of the PR/MR, and runs various check suites, commenting the output of each check in a single comment on your PR/MR. `kubechecks` talks directly to ArgoCD to get the live state of your deployments to ensure that you have the most accurate information about how your changes will affect your production code.

### Architecture

`kubechecks` consists of a high level structures for communicating with your VCS provider of choice, representing a PR/MR internally, and running checks for that code; read more in [the docs](./docs/architecture.md)

![](./docs/img/flow.png)

## Installation

### Helm

See [Installation Docs](https://kubechecks.readthedocs.io/en/stable/usage/)

## Contributing

The [contributing](https://kubechecks.readthedocs.io/en/stable/contributing/) has everything you need to start working on `kubechecks`.

## Documentation

To learn more about `kubechecks` [go to the complete documentation](https://kubechecks.readthedocs.io/).

## Contributors

![contributors](https://contrib.rocks/image?repo=zapier/kubechecks)

---

Made by SRE Team @ ![zapier](https://zapier-media.s3.amazonaws.com/zapier/images/logo60orange.png)