change-previewer

A tool for assisting the code review process through ephemeral deploys

Installation

Add the kamenev controller to your cluster:

kubectl apply -f https://raw.githubusercontent.com/felipemarinho97/change-previewer/main/kamenev/kamenev.yaml

This will provide the kamenev controller with the necessary permissions to watch for changes in the kubernetes resources. Check if the controller is running:

kubectl get all -n kamenev-system

Check if the CRD was created:

kubectl get crd | grep "change-previewer"

Usage

Deploy a montor with the preferred configuration for your namespace. Example:

echo "apiVersion: change-previewer.com.github.felipemarinho97/v1
kind: KamenevMonitor
metadata:
  name: kamenevmonitor-sample
  namespace: default # change this to your namespace where you want to deploy the monitor
spec:
  maxLifeTime: 1800 # in seconds (30 minutes)
" | kubectl apply -f -

Just anotate your kubernetes manifests with the following annotation:

metadata:
  annotations:
    com.github.felipemarinho97.change-previewer/enabled": "true"

How it works

The change-previewer will watch for changes in the kubernetes resources and will schedule a deletion of the resource after the time specified in the spec maxLifeTime (default: 30 minutes) of your KamenevMonitor resource.

Deploy a nginx sample to test it out:

kubectl apply -f https://raw.githubusercontent.com/felipemarinho97/change-previewer/main/kamenev/nginx.yaml