hirosassa / ksnotify

A CLI command to parse kubectl diff result and notify it to GitLab

ksnotify

A CLI command to parse kubectl diff result and notify it to GitLab

What ksnotify does

1. Parse the execution result of kubectl diff
2. Notify it to GitLab

The comment posted by ksnotify is as follows:

---

Plan result

CI link

• updated
  • apps.v1.Deployment.test.test-app

Details (Click me)

apps.v1.Deployment.jasmine.test-app

 @@ -5,7 +5,6 @@
     deployment.kubernetes.io/revision: "3"
+  labels:
+    app: test-app
   name: test-app
   namespace: test
 spec:
@@ -27,7 +26,6 @@
       creationTimestamp: null
       labels:
         app: test-app
-        skaffold.dev/run-id: 1234
     spec:
       containers:
       - args:

---

Install

GitHub Releases

Download the prebuilt binary from GitHub Releases and install it to $PATH.

aqua

Install ksnotify with aqua, which is a declarative CLI Version Manager.

$ aqua g -i hirosassa/ksnotify

Usage

prerequisites

Create and export GitLab access token to environmental variables as follows:

export KSNOTIFY_GITLAB_TOKEN="xxxxxx"

ref: Project access tokens | GitLab

Post diff results to GitLab

Basic usage is as follows:

skaffold render -p dev | kubectl diff -f - 2> /dev/null | | ksnotify --notifier gitlab --ci gitlab

If you want to update existing comment instead of create a new comment, you should add --patch flag like

skaffold render -p dev | kubectl diff -f - 2> /dev/null | | ksnotify --notifier gitlab --ci gitlab --patch

To suppress skaffold labels like skaffold.dev/run-id: 1234 automatically added by skaffold, you should add --suppress-skaffold flag like

skaffold render -p dev | kubectl diff -f - 2> /dev/null | | ksnotify --notifier gitlab --ci gitlab --suppress-skaffold

The concrete example of GitLab CI configuration is shown in example.

For developers

To run ksnotify locally, use local option for debug. For local mode, ksnotify just renders contents on stdout.

skaffold render -p dev | kubectl diff -f - 2> /dev/null | ~/Dev/ksnotify/ksnotify --ci local --notifier gitlab --suppress-skaffold

> ## Plan result
> [CI link](  )
>
> * updated
> blah
> blah

ksnotify's Issues

handle config file

implement config file handling feature

currently fixed file handling (only ksnotify.yaml on current directory available)

ksnotify/src/main.rs

Line 170 in 2f4ef31

let notifier = Notifier::new(ci, "ksnotify.yaml")?;

Add the installation guide with aqua to the document

Hi, thank you for your great project!

We suggest to add the installation guide with aqua to the document.
aqua is a declarative CLI Version Manager.
You can install this tool with aqua.

aqua init # Create aqua.yaml
aqua g -i hirosassa/ksnotify # Add this tool to aqua.yaml
aqua i # Install tools

For the detail of aqua, please see the official document.

We expect you can just copy and paste the following guide to your document.

---

Install with aqua

You can install this tool with aqua.

aqua g -i hirosassa/ksnotify # Add hirosassa/ksnotify to aqua.yaml

---

Thank you.

This issue was created automatically by script. For the detail, please see here.

implement CI/CD

Proposal: Add --ignore-image-tag option

In many cases, we use ksnotify with skaffold. skaffold change tags every time, so I want to ignore tag change.

support GitHub as notification platform

SSIA

support other platforms

implement notifier for other platforms e.g. GitHub, Slack, Jenkins

suppress skaffold run

If you using skaffold, skaffold added label to every resources automatically.

skaffold.dev/run-id: 1234

Since this label is not essential difference, we want to suppress this.

ref:
https://skaffold.dev/docs/tutorials/skaffold-resource-selector/

divide files

add concrete example for gitlab ci/cd

flexible template for notifications

like tfnotify

add tests

Repository description is wrong (Not `kustomize build` but `kubectl diff`)

I'm sorry if I'm misunderstanding, but I suspect the repository description A CLI command to parse kustomize build result and notify it to GitLab is wrong.

I guess the correct description is A CLI command to parse kubectl diff result and notify it to GitLab.