Cloud Native Computing Foundation KubeCon + CloudNativeCon Europe 2020 - Virtual, 4 Sep 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: SIG-CLI - Open Doors - Maciej Szulik, Red Hat

Description

Don’t miss out! Join us at our upcoming events: EnvoyCon Virtual on October 15 and KubeCon + CloudNativeCon North America 2020 Virtual from November 17-20. Learn more at https://kubecon.io. The conferences feature presentations from developers and end users of Kubernetes, Prometheus, Envoy, and all of the other CNCF-hosted projects.

SIG-CLI - Open Doors - Maciej Szulik, Red Hat

This session is intended for all interested in what SIG-CLI is and what it does. Whether you're fresh to Kubernetes or an old-timer you are more than welcome. This session will be fully interactive, and its contents will entirely rely on the expectations of the attendees. Topics will include, but are not limitted to: - Kubectl code tour which will provide basic knowledge for working on kubectl itself, as well as how to write kubectl plugins. - The main initiatives SIG-CLI is undertaking (splitting kubectl out of main Kubernetes repository, plugins - its development and management, resource configuration with kustomize, dynamic commands, etc.) - Gathering feedback and discussing problems people struggle the most with kubectl.

https://sched.co/Zeu4

A

Good morning, good afternoon, good evening, depending on where you are, this is how we greet each other during our bi-weekly six cli meetings, and today it's my pleasure to welcome you on the six cli open doors during kubecon eu virtual.

A

My name is mache and I'll, be your host today.

A

So what is six cli and what are our main goals that we uh that we take care of so the most important mission for our special interest group is ensuring that the cube cuddle, which is a common line interface to kubernetes cluster, is working properly, has the necessary features as well as we are, ensuring that all the bugs all the security problems and every single issue that the users are reporting to us is being actively worked on.

A

Aside from the cube cuddle itself, there is a bunch of other sub projects that we are looking after. The cli runtime is a library that is help that provides helpers for writing, cube cuddle plugins.

A

One example is simple: cli plugin, which reuses cli, runtime and, of course, cube. Cuddle itself is the primary consumer of the cli runtime. We have three sub projects that our special interest group is looking after. One of them is customize which allows you to customize free without any templating engine row, yum kubernetes yums, to shape them per your needs per environment, there's also crew, which is a cube, cuddle, plugin manager, and, along with that, there is a crew index that has all the plugins available for users. And finally, there is a graphical user interface.

A

It's an atom on top of the cube cuddle, which presents the results that the cube cuddle does in a more graphical user. Friendlier way.

A

6Cli has three persons that are in charge of the sig. We have two technical leads which are responsible for leading uh the technical and advancing the technical side of things for our sake, and that will be myself and filled with drug.

A

On top of that, we have two people that are responsible for organizational side of things, and that will be again myself and sean saliva. This time, I've attached both github handles and as well slack handles. So if you want to reach out to any of us, feel free to do so in kubernetes slack, which I'll be posting links to, as well as through github issues.

A

Our special interest group is meeting bi-weekly on wednesday. It is 6 p.m. In the european time, which is 12, u.s, eastern and 9 00 a.m.

A

U.S western time you can find us on the six cli kubernetes slack channel, and there we also have a kubernetes-sig-cli google group, where we answer all the questions that people might have with regards to any of the projects that I mentioned before, with the main information about the organizational information about our sick out of the way, let me jump to answering a few of the top uh ask questions that we are answering throughout the lifetime of our sick.

A

So the main topic that we are currently working on for probably two years now is moving cube cuddle to a staging repository.

A

You might be probably wondering what's a staging, so let me show you how the kubernetes main repository looks like if you go check out on github page, the layout of the kubernetes main repository you'll notice that there is a cryptic directory that is called staging.

A

The staging directory contains a set of libraries that are being then published using the kubernetes publishing book two separate repositories.

A

The goal of this exercise is to ensure that all the libraries, all the sub packages of the staging directory do not rely on the internal packages from within the main kubernetes repository.

A

This is needed so that at some point in time, each or hopefully all of those repositories will be eventually split out of the main kubernetes repository coupe cuddle is probably um the first one to be extracted out, and the reason that we want to have cube cuddle extracted out is that we would like to be able to move faster and release more frequently keep cuddle with fixes, as well as with new commands, to work and improve your experience working with a kubernetes cluster.

A

So you might think that, since cube, cuddle is already in the staging rep staging directory. It is almost outside of the kubernetes repository and it should be as easy. Well, not quite. Unfortunately, there are two commands: auth are to be exact, auth reconcile and convert that are stopping us from being moved entirely to the staging repository.

A

The convert command is not a problem, um even though it relies on the internal api of the kubernetes and will not be able to move outside of kubernetes uh kubernetes repository. We decided a couple versions back and we deprecated that command. So it won't be part of a cube cuddle command anymore.

A

uh What we will do is we will turn the convert command into a cube, cuddle plugin and will be still built out of the main kubernetes repository with auth reconciled. The situation is slightly more complicated.

A

Auth reconcile shares a pretty big chunk of code with the api server and unfortunately, we cannot copy this code over to cube color repository because we might be in danger of getting out of the sync with the main pieces of the code from within the kubernetes repository.

A

Thankfully, within uh the past couple of weeks, we've managed to agree on creating a shared library for this piece of code. So, within the next couple of weeks we will start moving the shared auth code to that new library.

A

And hopefully, if everything goes well by the end of this year, we will be able to fully migrate, cube cuddle to the staging.

A

Repository the next question that we are being frequently asked is why cube cuddle is using such an outdated customize.

A

We have some probably one point something version when currently customized is at version three, so the problem that I just described about the moving to staging repository, the dependencies that we have. This is the reason that we cannot vendor or upgrade to newer version of customize. The newer version of customize relied on the same libraries that the cube cuddle depends.

A

Unfortunately, due to how customize is being built, we cannot update those dependencies, so there is a work that has to happen on the cube cuddle side, and this is the move to staging as well on as on the customized size side. So currently, jeff reagan and his team are working hard to uh to progress the necessary bits so that we are able to soon upgrade customize uh within the cube cuddle. For now, we are encouraging everyone to use the standalone customized binary.

A

The next topic that I wanted to cover is how a regular cube cuddle command looks like we are being frequently approached by newcomers, people who are interested in contributing to uh to cube cuddle to six cli and the first question that we need to answer.

A

How does a cube cuddle command looks like, of course, what I'm going to describe in a minute is almost ideal for a situation for a command and you'll, probably notice that some commands do not follow the patterns, but we are on a long journey towards improving all the commands and applying the same patterns to the majority of the commands.

A

So if you look at any of the commands and I'll show, you examples in a bit you'll notice, four elements of every command that will repeat throughout the commands. There will usually be a option structure which will hold all the flags all the necessary helpers for that particular command to work. For example, annotate annotate command will have annotate options, structure, label command will have label options, structure and so on and so forth.

A

As a company, the structure will be accompanied by three or sometimes two methods. First of them will be complete. The complete method is responsible for filling for filling in all the necessary bits for the command to work that will be creating clients necessary for a command to work. It will do additional formatting for arguments that are being passed and so so on and so forth. Then there is the next command. uh The next method, which is validate and the validate is optional. It can, or it doesn't have to.

A

It will obviously depend on the command, so validate is responsible for ensuring that the structure is properly.

A

Filled with all the options that are necessary so that the actual command can succeed. Finally, there is the run and run is where the logic the meat of the command actually uh resides. So let me quickly go through an annotate command, which is a perfect example of such a of a nicely structured command. It's not the shortest one. You will find shorter commands, but I figure out that I'll pick something from uh from a from the middle of the spectrum from super easy to super hard commands.

A

So, as you see, there is annotate options and the annotate options has print flags, has functions responsible for printing objects for recording as well all the command as all the flags.

A

So if you uh type cube cuddle, annotate dash dash help you'll notice that all the flags that are here, you can easily map them, to particular uh flags, on the command line and at the bottom there are a bunch of helper methods such as annotation resources, a resource builder, and I have streams being injected into the structure, and these are necessary for the annotate command to work properly.

A

So, usually, we try to create a new annotate options or a new, your struc, your command options, method, which is responsible for returning a properly uh defaulted annotate options, structure and you'll notice. The same pattern being applied to the majority of the commands.

A

It's very useful when you try to embed one command in the other one and then a perfect example of that one is the weight command and I'll. Leave that one too to you to investigate on your own.

A

When we create each command, we inject all those bits. We wire the flags with necessary structure options, and we add it to we build the the cobra command and cobra is the library for building golang cli and we are heavily using that.

A

So, let's go through the main three methods that I mentioned at the beginning, the complete, as you see here, the complete method is responsible for creating the clients here dynamic and discovery clients. It is responsible for uh wiring and properly reading the record flags for creating the printers and as well as reading the information about the dry, the dry run flag.

A

Next, one is the validate method. The validate, as I mentioned before, is ensuring that there are no conflicting flags passed together or in case of a local. It is verifying the file names in case of a dry run. It verifies that the proper values are being passed. It is ensuring that enough amount of annotation is being passed. It is validating the annotation values themselves and upon an error, it obviously returns an error to the user.

A

Finally, there is a run, and here run is using a resource builder and resource builder is part of the cli runtime library that I've mentioned at the beginning of this presentation, which allows to either read files from your local directory or it allows you to easily work with the resources that are present on the server here. We are properly wiring all the flags to the builder, and then we are invoking something that is called a visitor.

A

So for each of the resources returned from the builder from the resource builder, we are, um we are applying the annotate, the annotation, that the user passed to us.

A

So with this, I hope that you'll have at least a little bit of experience, how a properly shaped cube, cuddle command looks like, and this will help you to.

A

To submit your first pull request to the kubernetes repository specifically to cube cuddle itself, there are a couple issues that are very good or that are long long journey issues that I pointed here and the two are first, one is removing generators from cube, cuddle, create commands and, if you're interested in working on that, uh the issue that I'm pointing here has links to the current work that has been done and all the necessary that needs to happen in the in the next couple of weeks or even months.

A

Also um zoe and arielle are responsible for for that particular uh work. So it would be good to sync with these two, if you're interested in helping with this work. The next one is something that I was presenting just recently on one of our six cli meetings, and it requires to be able to work with local. We have a code in cube cuddle that is being deprecated for quite a while. We would like to be able to remove it, but unfortunately, upon removal that piece of code, uh the local flag stops working.

A

All the details are in the issue and we are working with someone, and we are looking for someone that is interested in. In pursuing that particular issue.

A

There will be more bugs more first-time issues for good for new contributors, as well as those that are interested in helping with six cli that we will be posting on our mailing list, I'm hoping to create some kind of a spreadsheet, with contacts and links to those particular issues, so, if you're interested in make sure to subscribe to kubernetes eli google group and watch out for an email from me.

A

Additionally, every four weeks on wednesday, at the same time that I mentioned our main sexy live meeting, is which is 6 p.m, central european time or noon. U.S, eastern or 9 a.m. U.S western. We are meeting and we are going through all the poor requests as well as bugs, and we are either helping to assign them to particular reviewers or we are closing with explanation whether it is working or it is working as a design or it should be fixed during that bug scrub.

A

Everyone can pick up bugs that they want to work on, and the next meeting will be happening on august 19th. So you are more than welcome to join that that meeting.

A

I would like to close my presentation with again the dates for when we are meeting where to find us on the kubernetes 6 cli slack channel, as well as the email group, um I'm hoping to see you on one of the r one of our next sick meetings.

A

uh If you have any questions, feel free to reach out to me, you can either slack me or find me on github, although I prefer slack it's faster to get me there and thank you very much and enjoy the rest of the kubecon.

A

Welcome everyone.

A

There was one question in the chat that I've already answered: uh jeff nurick was asking about sig that kate's that io alias um into shortly uh bill on top on top of that, uh the aliases that you'll notice within the kubernetes repositories, such as kto 6k, io, the majority of them, are used for go packages so six decades.

A

That I owe actually is being um it's being directed to github dot com, slash kubernetes dash six, and this is where you find all the repositories such as customize um or cli, runtime that we mentioned, whereas the main case that io is pointing to the main kubernetes kubernetes repository. There is also a typo in the presentation. Probably there should be six. That's okay, that kate's at io, as well as there was a typo with regards to crew crew index and not k e w dash index.

A

Does anyone have any other.

A

A

Okay, I'm not seeing any questions uh being asked directly I'll be definitely available on slack for the next at least an hour or even more uh so feel free to ping. Me nancy created a thread for this particular session, so I'm there or you can directly ping me on this cncf slack channel, and I can answer all your questions with regards to sex, eli, cube cuddle and the sub project that I was talking about a minute ago.

A

Thank you very much enjoy the rest of your uh the rest of the cubecon.