keptn Contributing to Keptn, 20 Feb 2022

Previous Meeting

⏯

youtube image

►

From YouTube: Get Started with Keptn Development using K3d locally - Part 2

Description

In this video we will continue by making a change to Keptns approavl-service and deploying it to the Kubernetes cluster.

Part 1: https://youtu.be/zVFLxaa2xkw

Links:
- Keptn website: https://keptn.sh
- Keptn GitHub Repo: https://github.com/keptn/keptn
- VS Code: https://code.visualstudio.com/download
- Skaffold: https://skaffold.dev/docs/install/#standalone-binary
- Job-Executor-Service: https://github.com/keptn-contrib/job-executor-service

- Need help? Keptn Slack: https://slack.keptn.sh

A

Welcome back everybody in the last video I've shown you how to install a lightweight qranatas cluster k3d locally on your machine and then install captain into it or actually, what we did is we installed captain control plane into it and in this video we're gonna make use of this to do some development using captain or actually developing captain um yeah. For this you will need an ide of your choice.

A

I often use chatbrains goland, but you can as well just use visual studio code and for the purpose of this video I will keep using visual studio code. In addition to that, you should also have scaffold installed. I will quickly show you how to do that.

A

I think it's scaffold.def yeah, um just like gets careful cli and you can see there is some commands how to download it, and I will just do that in my terminal.

A

Okay, it wants my password should be fine, and now I should have scaffold installed.

A

Version 1.35.2 is here: okay, nice, good next thing, you want to verify that you are connected to your captain cluster and that it's up and running using captain status as we're connected to our local k3d. It's printing it here and also it's printing, the ip address of our local cluster. So everything seems to be working, fine, next step.

A

What you really want is you want to clone the captain repository so you're going to go to github.com, captain slash captain and, depending on what you do, you should either fork it directly, which is in the top right corner. You can can't see it because my video is hovering over here, actually quickly going to hide it. There is fork or um yeah. You know what we can actually do that let's fork it.

A

I want to fork it into my um github repo here and then you click on code and you want to clone the repository now I usually clone it using ssh. You can also clone it using https, just use whatever you usually do and yeah so we're just gonna, say: git clone copy paste. This url, as I'm using ssh and my keys, are already in there. It will automatically authenticate it might ask you for your credentials if you do that so yeah.

A

As you can see, cloning will take quite some time and you need a good internet connection, because the repository is rather big, but that's okay, all right and now we can change directory into the captain folder and you just get the whole thing like the same on a repo here and if you want to develop what you do, is you don't want to develop like straight away from the captain folder here you want to go into a separate folder.

A

So, for instance, let's say you want to fix it back in lighthouse service or I don't know, let's use something different, something simpler. You want to fix a bug in approval service or you implement the feature, an approval service and what you want to do is you want to open your ide in that folder?

A

So this is really a mono wrapper and you should open the ide in the folder that you're at and we're using visual studio code, which you can install various ways. Just google, it install vs code and you should see like code.visualstudio.com.download and it will give you separate, download options. I'll put the link to that in the video description below and um yeah, I'm just opening it using visual studio code, um spoiler alert. I do have some plugins already installed.

A

Oh yeah, it's asking you. If you want to trust the authors because of yeah there could be some some malicious code in there yeah. I recommend trusting it in this case um yeah I'm using some pre-installed plug-ins. Basically, whenever you open a source code file, it will suggest to you: hey. There is a plug-in for go. You should install it or hey, there's a plug-in for docker file. You should install it now.

A

What I want to do is I want to change something in main.go and let's just say: where is it some of the main functions we can actually see there? We go that's the main function. What I want to do is here. I want to say format: dot, printf, hello, captain community.

A

And apparently, format is not imported here and yeah. As you can see, it is suggesting us to do something so yeah it will auto import it so visual studio code with the proper plugins. That's it for you and how do we actually deploy this change now to our kubernetes cluster, where captain is running? So, if you look at this cluster in namespace captain, we will see that there is a port approval service somewhere yeah. Here we go there.

A

It is, and it has been running for 20 minutes, and this is the part that we want to replace essentially and what you could do now is you could build this docker file and deploy it to some registry and then hope that everything works, but I think this is not needed. You could just use scaffold.

A

What scaffold is doing is it will build the docker file that is linked here and it will deploy it using cubectl by deploying the manifest in the deploy directory service, yaml and granted this this method might change, but for now sometimes you have to adapt certain things in this manifest like the resource requests or the captain distributor version. As you can see, this is like really old distributor here, so this should really be captain zero twelve to two for what we do, and it should also come from the from the captain um image here.

A

uh Yeah like you will have to adapt something. Sometimes please ask for for help in the slack channel if you need help, but other than that, you should be able to just go into your terminal.

A

And specify scaffold run and what I suggest is use minus minus tail, so you get the log output, we will see if this actually works. I haven't tested this, so this is basically a live demo and what it starts doing is. It starts building the docker file. I mean this should work because this is working every day. In the background, anyway, I'm going to pause the video quickly until the docker file has been built.

A

All right, the docker file has been built. We can see it here. This is the last command in production. It's writing that into a docker image and it will now try to deploy it to our cluster. We can, I was just gonna say we can watch it live, but there is no need to watch it live because it seems it has worked.

A

The distributor is already up and running. What we now need is the approval service image that we've built to be up and running.

A

Because what I want is, I want to see our hello captain community message.

A

So, let's quickly investigate um did the approval service part change, approval service approval service yeah. So it's says running two of two. What we can do now is we can see what kind of images are running. So, let's do kept manage namespace captain get deployments.

A

The deployment in this case is just called approval service and we actually want to see the images this is gonna be done by setting the output type to white and we can see it is using captain dev approval service and some random string. This is like a hash created by by scaffold.

A

But I'm not seeing the log output in here.

A

This worries me a little bit so one thing we can do now is to say um logs of approval service.

A

And we need to specify we could, we could do minus minus all containers and no, I'm not seeing my log output.

A

Let me pause the video for troubleshooting quickly and we're back. I don't know what it was. I just cancelled, the current run and ran it again and now I'm getting the output so for whatever reason, something something wasn't working, but it's working now so yeah. That is how I just deployed a container here and that should be working for you as well.

A

So there is some pitfalls with this method using scaffold because there is a helm chart in the background that we are overriding now and what will happen when we stop scaffolding using control c is usually that we will lose the up or we might. We actually will not lose it now. It will stay because we, we didn't say it to clean up, but scaffold can be configured to clean up afterwards, so yeah, but it's okay. It has work. It has worked so far.

A

So what you would do now is you could create, or you could push your change into um your git repo and then make a pull request and yeah some. Some people will review it and give you comments about it and yeah. This is how you would develop, but what, if you don't want to actually develop a captain core service? What if what you want to develop is an additional service. Let's say you want to create an integration that interacts with terraform what it interacts with prometheus or anything else.

A

Then this is the wrong service for you to look at what you would like. What you would have to look at then, is captain's job executor service.

A

This can also be found in github. I will put a link onto it into the video description below, but this is the job executor, service and job executor service allows you to just create customizable tasks with captain as cuban leaders jobs by specifying.

A

um Let me see if there's a conflict file there we go by specifying an event that you want to listen at and when this event is received, you want this chop to run a docker container in this case alpine and in this container run a command in this case. As you hello world.

A

However, this is a topic for another video, so stay tuned subscribe to the channel. I will create a video about shop. Executor soon and then I will also show you how to develop something for shop executor. All right, if you have any questions, feel free to comment down below other than that. I'm also inviting you to the captain's like. I will also put a link to that in the video description below, so you can ask questions there and get immediate feedback and yeah see you until the next time. Bye, bye,.