GitLab Runner UX, 1 Mar 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Upcoming deprecations for Runners (16.0)

Description

Pedro Pombeiro (Senior Backend Engineer - Verify:Runner), Miguel Rincon (Senior Frontend Engineer - Verify:Runner), and Gina Doyle (Product Designer - Verify:Runner & Pipeline Insights) explain the upcoming deprecations that will impact your Runner API and UI experiences.

Epic that this corresponds to: https://gitlab.com/groups/gitlab-org/-/epics/7177
Rename runner model's active flag to paused: https://gitlab.com/gitlab-org/gitlab/-/issues/347211

A

Hello: everyone.

A

uh Today we are recording uh with gina doyle, uh pedro, conveyor and and myself megavinca uh the precacions and changes we have done to our apis and our ui uh in the runners area, and we are very happy to explain to our users what things are improving and how uh things are changing to make our our runner's statuses and filters better.

A

So first gina will give some introduction and then pedro will explain some more detail. Changes in the apis.

B

Thank you all right. I'm gonna share my screen and just walk through this epic, which um does a good job of explaining the changes that we're making in the ui and where these really came about. um So these came about because we had pretty inconsistent ways of showing runner status across the different views. So from the admin view to group view to project view, we were using different um status names and they weren't always used in each area.

B

We have a pretty good visual of that by this current status. Audit. So, specifically, one of the most confusing ones was active versus online and active.

B

We were saying is a status and it's the definition is that it's ready to receive the runners ready to receive jobs and then online, on the other hand, says that the runner is connected um and we were presenting both of those at the same time, and it was a little confusing um with the ple the play and pause button that we have as well.

B

So I'm going to jump over to our current ui and just show what that looks like.

B

So what I was referring to is the statuses that we were showing within this table were overlapping and inconsistent with the other views, like our group and project view, and also we allow for you to filter by status right now, you're able to filter by active paused online offline, never connect, never contacted and stale um stale is the newer filter that we enabled recently, and these other ones active and pause they're going to actually turn into one filter called paused rather than status, and then it will either be true or false, and the reason why we're we're doing this is because, if a runner is active, we're actually displaying that by the pause and play button.

B

That's within the table as well as when you go and look at a runner. It says if it's paused or played so we wanted to make it more obvious and then make it more consistent throughout the other views.

B

The other views that I was referring to is like this one, which is when you look at a runner detail from the group um or project view. You get this view and we're mixing active and the other statuses in this one view, so it gets a little confusing, so in general, we're going to be making those more consistent and applying those across all the different views that we have.

B

I'm gonna pass it to pedro now to talk more about the api and the other changes that we've made.

C

Thank you, gina. um Let me share my screen, so yeah we've made change the respective changes in both the rest api and the graphql api to bring it up to today's with respect to you know, changing from active to paused nomenclature and also removing or deprecating, in this case those values from this status, so ci runner status in the case of the graphql api.

C

These are the three values that we'll be leaving, so these are more like the actual status not really configuration.

C

The ones that were referring to configuration um will be moved out in 16-0, so we already have introduced the the newer uh properties for this. So you do have a paused property.

C

Which will completely replace those values in sixteen zero? So if we run this, which was the using the deprecated active value for status, if we run this.

C

We get, as you can see, even though we're we're asking for active we're getting different uh status values, so they are active but at the same time they're not connected or they're offline.

C

um So it's a bit confusing um the newer way to write. This would be- let's say I don't know, what's happening with my keyboard: okay, so paused.

C

False would be the equivalent um query, okay, so it's less confused because you're not actually requesting a status, and so you you do get the same status, but it's not as confusing for the rest. Api uh we've done the the same, so you can ask um for a flag. You know all give me all the runners with the status equals active and you received one with offline and the newer way to do that is paused equals false.

C

There you go so we added disposed.

C

Property and deprecated the the other values to be removed in sixteen zero yeah. That's what I had for the rest api and the graphql apis.

B

Right, thank you, and we hope that this is helpful and please leave comments for us in the links that will attach to the video. If you have any feedback thanks.