keptn Keptn Tutorials, 10 Nov 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Keptn Webhook Service in 5 Minutes

Description

Example of how to use the new Webhook Service to send notifications to tools such as Slack

Learn more: https://keptn.sh
Get started with tutorials: https://tutorials.keptn.sh
Join us in Slack: https://slack.keptn.sh
Star us on Github: https://github.com/keptn/keptn
Follow us on Twitter: https://twitter.com/keptnProject
Sign up to our newsletter: https://bit.ly/KeptnNews

A

Hi I just played around with the new captain web hook service and I thought I'll give you a quick run through in five minutes uh what I've learned so far, so that you also see how easy it is to set it up and as an example, I am showing you how you can use the web hook service to send, for instance, notifications to your favorite notification tool, like slack I'm using slack in my example, so my name is andy grabner, but let's just uh dive into it. So what do I have here?

A

I have my captain installation captain and what's new is on the uniform side? You have a new default service, it's called the webhook service and the webhook service allows you per project right. I'm using. I have two projects that I want to show you today, demo rollout and also the dynasty service. But let's stick on demo rollout what you can. If you click on web book service, you can add new subscriptions.

A

That means you can say I you want to let's say, subscribe to a certain event and then trigger a web hook.

A

Let's see how this runs takes a while here, not sure why, but here we go so I you can select from any of the tasks that you have in your project, so the web hook service or the ui here is parsing your sheet pad file, and then you can say I wanna handle the evaluation.

A

There is a different options where what the team is calling uh silent and active integrations handling. The triggered event would mean you wanna trigger an external tool that is then really handling the evaluation. Where you say, I'm triggering something an external tool and then it also needs to communicate back. uh You can also handle the started and finished event, and I think in most cases, if you just want to send notifications you're interested if evaluation is finished, then you want to do something you can do some additional filter.

A

You get some some examples here on the payload that you can react to and so on and so forth. What's really cool, though, and this is what I wanted to show you and I've kind of my cheap- my cheat sheet here so you're posting this to a url here. We go I'm doing an http post, so I say captain when evaluation is finished. I want to post something to this url now I have created a secret.

A

For my slack token right, I put it into a secret once you put it into a secret, you can also nicely select it from here. I've put both the token to call slack, but also the the captain bridge url in as a secret. Why the bridge url, because I wanna reuse it in the custom payload. Let me just show you as well. I have, for instance, for evaluation.

A

I've crafted the the json that slack specifies for the web hook and I'm pasting this in here and you can see it's really cool because you can reuse a cup. All of the data elements on your payload, so dot then allows you to access all the elements you can also go into the data block. So I'm basically saying I want every time an evaluation is finished, post stuff to a particular slack channel with the username captain and then some additional blocks here and the reason why I have the other secret with the captain bridge.

A

I'm including a link back to the captain's bridge for that particular captain context, then I say subscribe and that's it now. I've already done this, so let me cancel out of here because I have already subscribed the evaluation finished and the deployment finished.

A

So in the back end, I think I actually have a sequence running, so this sequence here is part of my argo rollout tutorial. It's the demo rollout and, as you can see, there's a couple of things. Currently one is actually running. Evaluation is happening. Let me switch back over to my slack and I can see here in my demo rollout dash dash here we go. The new latest thing.

A

Just came in captain evaluation finished passed 100 from 100, I also put in project stage service and a link back to the bridge, so I click on it and it gets me automatically back to captain. So this is pretty sweet now. This also works for other projects. Let's just wait, and this is loading. My captain here runs on a very small ec2 instance. uh Some of you probably know I'm using k3s, so just you know for demo purposes. This is perfectly fine, but really cool directly getting uh into the evaluation.

A

Now let me do one more thing here. I want to do a trigger any evaluation. I have a second project, it's the dynatrace project, so I'm just kicking off an evaluation, which means the only thing I'm doing now is. I will sit and wait until I get a notification and slack and I should see it in my dynatrace demo. These are some previous results that I had so you see it's super easy. I just created the same web hook for my different projects, so this will come in in a minute.

A

I will share if you're using slack, I will share these um kind of kind of. You know. Json objects here uh for these simple messages with you in a blog post, probably soon, uh but I think just showing you. This is really super easy now. What else do I want to show you before I stop?

A

If you are creating these web hooks, then through the captain bridge, the webhook definition itself will obviously also end up in captain's, config repo. So, in my case for the dynametrist project, I have the web hook here and there's the web for gamble, and this is basically just the same curl you can see here with all the different parameters. So in the back end what the web hook service really does it takes the payload that you paste it in and it crafts a curl comment.

A

There's currently some limitations. I would say at least one that I found out curl with the payload with the data parameter, doesn't support some special characters, but the team is already addressing this, but in general this is super, easy and super nice right. I mean really really job well done and yeah. Let's see if my here we go, my evaluation is finished. Now I got the result.

A

Captain evaluation finished warning, 83 out of 100 points, click getting to my bridge with the results and whether this is teams or any other system that you have that enables or has web hook. I think it's now super easy to configure web hooks to react to it. There's also documentation. Do me a favor check out captain.sh.

A

If you go to the docs and if you go to release 10, this is where I think under custom integrations. There is a section called webhook integration, and the team already did a pretty great job in explaining. Actually just like integration is even here. Look at this slack integration there's also a jenkins integration, which is cool so calling a jenkins pipeline through the web hook and then letting jenkins even call back. So this is really really awesome stuff. All right with this enjoy the web. Hooks bye, bye,.