VMware Carvel Community Meetings, 21 Mar 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Demo: kctrl is kapp-controller’s native CLI

Description

Soumik Majumder, maintainer of kapp, demos kctrl. kctrl is kapp-controller’s native CLI which help users effectively interact with and observe custom resources exposed by kapp-controller (App, PackageInstall, PackageRepository, Package CRs).

The first release of kctrl focuses on helping users getting started with consuming packages with minimum friction. In the next few releases, kctrl aims to improve observability of resources created using kapp-controller’s declarative APIs, improving the debugging experience and helping users authoring Packages and AppCRs to iterate faster and more efficiently.

Check out more info in the below blog posts:
https://carvel.dev/blog/kctrl-release-blog/
https://carvel.dev/blog/making-the-most-out-of-clis/

A

um So, okay, so I'm just gonna get started by maybe adding a wrapper to the cluster.

A

I'm gonna list the repositories. uh We have none right. Now, I'm going to go ahead and add the tce repo. Yes,.

A

Well, so we specify a name for the repo well, let's add added to the cluster and the url of an image package, bundle which is pulled and then added to the cluster.

A

Now that the wrapper has reconciled, we should be able to.

B

A

Yep, so we can see the packages that are part of the tce repo and if you want to have a look at maybe one of these packages.

A

Let's have a look at contours, I'm gonna do.

A

Package install.

B

Not installed available.

A

So it lists the versions that are available and the other details and metadata that's available with that particular package.

A

um So what I'm going to do is I'm going to go ahead and install a assert manager on the cluster? um So to do that, I do key ctrl package install, I'm gonna call it sort man.

B

The package name is.

B

A

So um in case the user directly tries to install the package without specifying a version we, instead of installing the latest floating version on the cluster. What we do is we list. The version then say that we are expecting the user to provide a version explicitly that's what that's what we are doing today, and so I'm gonna specify the.

A

Oldest version.

A

So we create a bunch of resources that the package install needs to create the respective apps. Here we create a cluster role, binding a service account and a cluster role.

A

If we had specified like a values file which would need a secret to be created, we would be creating that as well and now we wait for the package installed to reconcile.

B

It has reconciled so if you have a look at it.

A

Yup, so the installation we were trying to get up and running is now reconciled. So um what I'm gonna do next is try and maybe update this installation with the with the values for you. So let's first have a look at what values we can pass to sort manager.

A

And I wouldn't have a look at the value schema.

A

Oh, I need to specify the version if I'm trying to look at the schema. So that's how we do it. It's package name, slash version.

A

uh So the values file apparently accepts a namespace value, so just to be just to make sure that works. What I'm gonna do is I'm quickly gonna.

A

See the resources that are installed right now, so if I do update the package install with the values file which specifies a particular namespace, what should happen is these namespace resources should should move to the namespace that we are specifying.

A

But once the package is finished, reconciling of course, so what I'm going to do is I'm going to go ahead and create a namespace for that to happen, I'm going to call it.

A

A

And we're gonna make a values file.

B

Space and let's search this.

A

Okay, so we're going to be kci trs package install update and the package install that we're updating is called sirtman.

A

So since the package- and the version remains the same, we are only going to specify the values file right now and the values file is values.yaml so now kctrl will create a secret and update its reference in the package install itself and then wait for it to reconcile.

A

So um I don't think I'll be doing that right now, but what we can also do is when we are dealing with um package repos. We can also update them with a new url which leads the which leads to new packages being added. Basically, if, for instance, we want to update to maybe a newer version of the reaper and the workflow is pretty similar to what we're doing over here.

A

This might take some time because I believe, what's going to happen, is it's going to delete these resources, delete the namespace and then recreate all these resources in the new namespace if it works out, so we're gonna, let it do its thing.

A

If that actually worked.

A

Yep, so all the resources that we wanted to move to the new name space have been moved to search space now and yeah.

A

There is no sort manager, name space anymore, that's been created by the app cr which is expected. um So what happened? Is uh the package installed picked up the new secret that we created while updating the package?

A

So now, what I'm going to do here, quick, is try and uh update the package install to maybe a new version, and so, instead of using package installed update.

A

What I'm going to do is I'm just going to do a package install with a newer version so that way, what I'm trying to show here is that the package install command is uh it's re-entrant like if you try to install an already installed package, it just switches to update updating it, so I'm gonna do package install I'm gonna, call it cert, one which it is and okay, I'm just gonna.

A

A

um Let's grab the version from here is that sort of manageable yep. I'm gonna update it to 1.4.4.

B

Oh same type of gun.

A

Okay, I think, since the package install already existed, it just switched to updating that package and then waits for it to you can say.

A

Okay, so since we are not gonna see any change here, I'm just gonna skip the reconciling part. We can always do.

A

A package install get to see if the reconciliation is done.

A

ah It's still reconciling, um so I think what I'm going to do is, while it's reconciling I'm going to go ahead and delete the package install. So to do that, we do kctrls.

B

Install delete and be careful.

A

It asks for confirmation, and you do want to get rid of it.

A

So we wait for the packet install to be deleted. In the same way, we wait for it to reconcile and what we will be doing. Is we also clean up the resources we created for the package installed to work like the secret, the service account and the other related resources there you go so all the resources that were created with it are cleaned up um yeah. So that's about it.

A

I'm pretty sure I haven't gone over each command in the video, but feel free to um so and like take the binary for a spin, uh I'm probably gonna leave like I don't know like instructions how to build it and like take it for a spin, maybe in the thread so yep.

A

Okay, the repository is still reconciling, but so to add on to that. um So for the future work that you've planned right. uh We often find that let's hear for package repository or if a package install is failing, users are sort of. The first instinct is to look at the package install resource and the package repository resources, and it does not surface enough information.

A

So we sort of want to surface information, that's ex, like so like exposed by the apps. Here, that's created by these resources and sort of help, users debug it better and sort of demystify what actually goes on when a package install is created.

A

um Oh yeah, I guess that's about it.

C

Yeah, I think I think it's going to be very obvious when we have that feature, what we actually, what we actually uh want to surface or what the people want to actually uh or want to see right it. It's uh you can always compare it to like the stuff that you see in cap. Deploy right is useful in understanding what the current state is right so like similar, that similar information popped up for packaging style, and even you know, app cr related interactions.

A

Any further questions or comments for for the team regarding this.

C

Okay, thanks for for doing that, sumik.