GitLab 16.0: create a GitLab Runner demo

hey everyone Dion Eastman here I'm joined with Pedro and Regina and today we're going to cover the new Runner creation flow and getlab is coming on 16.0 and Gina and Pedro also do a demo of a new creation Pro as well so let's put it I'm just going to share my screen and I'll give it a quick overview a bit of background uh in terms of what we've been doing um since we last met let's see if we can get a slideshow thing to look um actually probably not because every time I do slideshows and zoom I I can never tell you how to get out of the sideshow so anyway today we'll cover the new running creation school that's coming in 16.0 this is a quick background it's basically a new workflow for creating a runner by authorized users and get that instances and replaces the previous workflow that used and always available always visible registration token actually we started masking it a few a few releases back but it always available registration token that is scope to an instance level a group or project and you can see a nice little diagram here that Jimmy put together that kind of shows the the current the the Legacy registration process flow um so just kind of quick comparing the the sort of the legs the registration Pro method with the new process um and the new in the registration in the old method you're just basically going to the UI so for example if you're in the admin area you'd make the registration token visible or unvisible or you just simply copy it and then once you've had that registration token copied um on the target environment on which you were installing or registering the runner from whether it's a kubernetes environment it's slightly different or see it on your Macintosh OS laptop or virtual machine you'd want to gitlab on a register command and you would enter that registration token that you had copy and so that's how you register your run into a getlab instance group or project and the new flow you actually authorize user actually first need to create the runner first in gitlab before the Run let's on the host can be registered um to get that instance group or project and and Gina and Page over demo that for for you so it kind of makes a little bit more sense um so there are a few key callouts for the new process so the general authentication token can be reused to register more than one order to the instance group or project but what you're talking were generated so as you can see over here on the right hand side this is kind of hopefully reasonably visible diagram that shows that I've got two different Runners on two different host systems but they were registered to group a using the same registration token so if you have workflows or use cases where the reviews of the auth token or the reviews of the runner configuration I should say to be more specific is warranted that is supported with the new method um and I think Pedro amigo I'm sorry Miguel um Gina will touch a bit more about that as they go through the demo um the other thing that also I want to call in terms of the new process the generated authentication token is only visible once in the UI so as you're going through the workflow you'll see that in a demo once you go through the creation step the token is that split at the end is only visible once in the UI so for now you have to copy the registration token string to register running using that token it is high highly recommended that you do not save the authentication token non-secure locations right because doing so into the security is because the authentication token is the thing that allows a runner entity to connect to your gitlab group project for instance and retrieve the git repository um you know and check that get repository out run scripts Etc so you want to make sure that your authentication token is stored in a super location so secure sort of location uh and so forth and then for automation you can use the API to generate an auth token that's go to the instance group of project I think page you want to make a point about the API So currently we in the old registration methods we expose an API that allows you to register or create a runner and typically people do this um before executing a job they will create a runner ad hoc with a given configuration and receive an authentication token and and use that for the for running the the job so the difference is that in the new methods you would create the the configuration in in the UI you would say Okay I want this Runner to use this specific tags and then use the generated authentication token directly on the register command as you would have done with the registration token uh so this removes uh the needs lots of times to use the rest API to to interact with gitlab in order to have access to a runner you just have to know the the authentication token we still have the ability to create new Runners through a rest API or graphql endpoint graphql mutation depending on your your preference but that should be less often needed to restart into that it's only needed if you need ad hoc configurations so you you would in a situation where you don't know upfront what tags will be needed or other configurations like that that are decided at creation time then you would resort to those apis and we can link at the end of the the video you know on the notes we can put the the links up to to those apis so yeah that's the callouts I wanted to make thanks awesome thanks Pedro um I just wrap up the slide so we can get into a demo in terms of the the status of the feature so the new creation workflows for the admin areas equipment projects that's going to be available as of your gitlab 16.0 version as shipping um here in a couple of days um and and they get a call out to make is that we are planning to completely remove the Legacy registration token method from gitlab and gitlab 17 at all which is next year so the new creation of course if you do upgrade your gitlab instances in 160169. payable you will see the new registration the new authentication or creation flows I should say and gitlab 16.0 so I'll stop sharing one thing that people we close this is in between 160 and 17-0 uh we're planning to allow admins or group project Runners project owners to disable the registration methods so that they can test out um and ensure that their um you know group or instance is locked out of the registration methods and this way they're able to decides if they're apis are you know there are scripts are all migrated and um yeah they lock out the old methods to guarantee a good migration to path to 17-0 got it so it's kind of a nice mechanism for folks to test out a new application flow and if you wanted to always go back and work out things with the Automation and that sort of thing hey that's a good call out Pedro thank you okay I'm going to stop sharing and pass it over to I think Gina you're going to do the demo yes all right I will start sharing my screen all right um so I'm in a group right now in gitlab but like Darren said this is available group projects and the admin View um so I am going to go and create a new group Runner and here you'll see a couple things up top is you'll see a message to provide feedback about this new flow we're really looking forward to hearing what you think about it if you don't want to see it you can dismiss it and it will never be seen again and then we also have this alert basically is saying exactly what Darren was saying about when we deprecate the old registration process um and we link you to gitlab Runner 160 just to see the release notes there so you can learn more if you need it further information uh but I'm gonna delete that as well and so my first thing that I'm picking here is a platform to create the runner on and uh for my instance I'm just going to do Mac OS I'm downloading it on my operating system my current MAC and then these details are optional but you're welcome to I know a lot of us use Runner descriptions to identify Runners so for this one I'll just say my group test Runner and then configuration I'm gonna have it run on Tagged jobs but you can add tags here as well and add maximum job time out so once I submit this this next page will tell me now how to actually register the runner so it was created and now I have to run the register command for it to actually register so I've copied that command I'm going to paste it in my terminal and then I'm going to select an Executor I'm just going to do shell so now I have confirmation that it's valid configuration was created um you'll see here is the runner token which Darren also mentioned that it only shows in the UI once so if you're going to copy it make sure to store it in a very secure location otherwise if you don't need it again then you don't have to copy it and then I've already choose chosen an Executor but we've heard that sometimes it's difficult to choose those because you're not sure which which one to choose basically so we do link out to documentation that gives a really great table of which one to use it for which scenarios and then the last step here it is optional depending on how you've set up your runner system but for me I need to run this command for the runner to be available to run jobs so I'm going to run gitlab runner run and I see this message so I'm going to clone stop that so now I've gotten a success message that I've created a new Runner I'm going to go back to the runners page and I should see my new Runner back at this page yep there it is and it's online um and then per usual you can click into it and see details and jobs from there oh I'm gonna go boy and then one other thing I wanted to show today was like Darren was saying you can use the same authentication token uh to run to register Runners multiple Runners and those would have the same configuration that way and if you would like to check out this epic we are planning on being able to show those in the UI so that you can actually see how many that you have in a group in that instance um this gift is going pretty fast but you'll be able to see how many are in a group and then when you click into the runner you'll be able to see the details of those like the status system ID version Etc and then um also the jobs that each one of those system IDs have run we call them Runner managers but each one has its unique system ID which is how we tell them apart and I will stop sharing now maybe you could show in the the old cylinder Legacy method that it's still available in the in the UI like how people can still use the registration Runner uh registration token yes great Point okay so in all of your in all the views you'll see this uh Kebab button and it shows still the registration token that you can use to register in the old method as well as their old registration instructions um in that modal so you can still just copy this single command and run it here I'll do it just for this and this is the flow that is going to disappear in 170 right and then so you also get this warning message that says that the support for registration tokens will it's deprecated and will be removed in 170 like theater was saying um so in this case when I refresh this it actually should show me this this Runner yep um didn't contact because I have to run that but anyways if I had run gear lab running around it would contact and then the last thing that we wanted to show here is you can still reset your registration token using the old method so nothing is uh not supported from the old method just yet so you can still do everything that you need hey I'm Pedro just a quick question so the um as you mentioned earlier the plan to allow administrators to turn off the old method once they do so I guess the ellipsia will go away but those folks that turn off the old method okay all right no uh I think uh All Points sir were covered that that's great well folks um as Junior and Petra said we'll link um on when we post a video to get that filter We'll add some links and maybe the feedback issues maybe they're epics so if you have any questions about a new flow um whether it's automation questions timing usability just go ahead and and you know ping us on the uh on the feedback issue we'd love to hear your comments as we continue to evalness I'm gdm Pages thank you so much for joining me on the demo on the great book and getting us to the statuses but this is awesome appreciate it so cheers everyone talk to you soon bye

Channel: GitLab Unfiltered

Views: 3,552

Keywords: gitlab

Id: 1s4FxnoYCMw

Length: 14min 29sec (869 seconds)

Published: Mon May 15 2023