GitLab Protect Stage, 14 Sep 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Setup GDK and GitLab Runner on a Macbook

Description

For any questions or comments feel free to reach me out:

https://gitlab.com/svedova
https://twitter.com/savasvedova

===============================================

Scripts: https://gitlab.com/gitlab-org/gitlab/-/snippets/2408961

A

Hello, um this is savash from gitlab. I am a senior frontend engineer and um I recently received my new macbook and um I was waiting for this for a long time for two reasons: one because of the new macbook and then the second one, because I we have an issue to facilitate the.

A

The process to set up the the gitlab runner on on on a local environment, so I thought, while I'm gonna, set up my computer, I'm also. uh I can also record a video uh to walk through the required steps, so.

B

Before we get started.

A

There are some requirements which I'm not going to go through in this video and they are setting up ssh and then installing brew and uh we'll be using docker and colima for the.

B

Gitlab runner so also installing those uh tools once you have them.

A

We can go ahead and then start installing gdk, so we have a one liner script, which you can find in the description of this video. So you don't have to type this manually and let's go ahead. Let's copy that and then.

B

I'm gonna go inside my projects, folder and then.

A

Execute the script, so the script will install a gdk in the location that we provide here and then it will clone the repository uh by default. It's uh the gitlab repository, so you can go ahead and then press enter. um I'm not gonna do that in this video because it takes quite a bit to um to install all the dependencies. I already done that before this video, so we should have it here.

B

In our gdk folder uh perfect so we're there now um the gdk is configured.

A

Through the gdk yaml file, currently it's empty and um we're gonna. We're gonna update that uh in a moment. But before we do that, the um the install script will make use of astf to install all the required tools so, for instance, and also the versions so, for instance, ruby or golang or node.js. They they're all going to be installed uh by asdf and when we.

B

Check our um so if, if.

A

You if you go ahead and then type which ruby so in my case, this is now the updated one, uh but it should be by default. It should be, I think, it's user bin and then ruby yeah, it's this one. So we need to tell um so we need to source this this, the the astf script, so that gdk makes use of the versions that it actually installed, um because otherwise it's going to use the system defaults uh if there are any and- and it may cause some some some problems. So let's go.

B

Ahead and then, um let's source, the I'm sorry, not this one, but this one uh source uh yeah, I'm just gonna change, so I spit over here. Take that so, if you do that.

A

It should be fine, but just bear in mind that this script works only for this session of the terminal and.

B

In order to make it persistent, we can go to our profile and then add the source here.

B

So once you've done. That.

A

Let's go ahead and start our gdk.

B

It's taking a couple of seconds, let me drink some.

A

B

All right, so our local host. Let me just close this one.

A

And then we see that it seems to be working so this this is the boot screen. um It will take a few seconds until gitlab is ready, um but I'm not going to wait that, because this page is already enough for me to show that it's it's actually working. So um next step is to now gdk is is running and we also want to install and configure the gitlab runner and gitlab runner runs inside a docker container.

A

So since docker container is an isolated environment, it does not have access to our gdk instance on the host machine and the next steps are going to provide um the necessary configuration for docker to communicate with uh with the gdk, with with the gitlab instance. I'm sorry. So let's go ahead.

B

And then update our um hosts file.

B

Go here at this line so basically.

A

We tell that this ip resolves to gdk.test we're going to be using gdk test and the register test. If I'm not mistaken, this was uh something regarding the container or registry, something like that. But it's not that important for at least I guess uh for this- for this example. So.

B

A

Here um next step is that we want to create a loopback interface, uh so go ahead and copy the script and right now in theory, uh docker should be able to communicate with gdk with gitlab instance through this. This ip, so just bear in mind that this this command. It's it's going to reset if you reboot your computer. So if you want to persist that go ahead and then copy this, this file um so copy this content and then create a file called like this and inside uh just paste the this content.

A

This will tell the uh it will create a um a startup script to configure the loopback interface. So now, we've done that as well, and then the next step is to tell gitlab to use gdk test instead of local host. We do this because if the docker container inside the container tries to reach localhost, it's actually the container's localhost, so it's not reaching the host machine's, localhost and uh gdk test.

A

It's we're, basically creating a network um with the with the configuration that we did a few seconds ago and we'll be using gdk test as a host name for that.

A

So let's go ahead and then type this command, gdk config set hostname gdk.test, uh it's gonna update the gdk file and let's go ahead and then also set the listen address.

B

Which is this one? One? Seven, two one, six one, two three one perfect. So uh if we check our gdk.

A

Emo file now we see that these options.

B

Are present perfect next step is to reconfigure our gdk, so the changes are updated.

A

As you can see the url, uh it's not using localhost anymore, but it's using gdk test and um after that, we're gonna restart jdk. This is going to take a while. So I'm already going to to the next step to save some time, um and the next step is to install the runner. So let's go ahead. uh Let's clear this part.

B

It was from the previous recording because it's uh sometimes.

A

I do mistakes, while.

B

A

So I have to go back and then restart anyways, so just installed uh the gitlab runner.

B

um I can close this one and then let's go back so.

A

The last one was to reconfigure, so the reconfiguration is complete, so we're gonna restart this gdk restart and it should start to listen gdk test instead of localhost. So previously it was one seven one, two, seven zero zero one, but now it should be simply gtk.

B

Dot test go ahead and then yeah is it working?

B

I don't know, let's try a new tab. Let's close this one.

B

It's working perfect all right, so we have pulled the image and then the.

A

For for running for registering the the the runner inside a container um actually for registering the container, no, I'm sorry for registering the runner uh and we'll be using a container for this. So.

B

Let's go ahead and then um check the runners page here, admin and runners and we have no registered runner so far, which is normal. We haven't configured anything yet.

B

Yes, so next step is to register it.

A

And for that we're going to be using this command docker! I'm sorry! You probably.

B

Don't see this, let's move my face here and actually here I like it more on the right side, cool, um so docker run, uh and then here we bind the host directory um to the.

A

um To the etc gitlab runner inside the container.

B

But be careful, I think docker does not have access to the temp folder on mac.

A

It took me a while to figure this out, so it may be the case if you see that uh once you run this command, the the um the config tumble is not created within the directory that we're gonna create in a second. So um let's create a directory.

B

On the um okay make there, I will create a directory gdk runner in my loc in my home directory and then uh gdk runner, so it's currently it's empty. Then let's go ahead. This is going to be gdk runner, okay, go ahead; um okay, so.

A

Next thing: we're.

B

Gonna be asked some questions which we probably don't see right now. So let me move myself back to the bottom.

A

Yeah and the first question is the url of the gitlab instance. So that's gdk.test.

B

3000 port and then the registration.

A

Token can be found on the runners page and then there's the.

B

Drop down here register and instance, runner uh click on the copy to clipboard go back here. Paste this token.

A

And then um description, we don't need it tags, we don't need it maintenance node, we don't need, it. um Executor is docker and then the.

B

Default docker image we're going to use alpine latest perfect. So if we check the gdk runner directory now, we should see the config tumble perfect and if I check the content of this file, you will see that.

B

There is the runner configuration.

B

A

We want to tell gdk so gdk can can run or spin up the docker instance or the docker or the gitlab runner when we start gdk and when we stop gdk. It stops also the gitlab runner.

B

And to do that, let's take this token here and then let's go back to our gdk folder, not this one projects gdk and let's open our gdk yaml file and then here we're going.

A

To add some configuration, so I'm going to say the.

B

Runner is enabled that's true, then the executor is docker and there was something else here. Right. Install mode is also docker. The.

A

Token is the one that we got from the config tumble.

B

um Let's just to be sure, let me check if this is cad: gtk runner, traffic tunnel um yeah, it's the correct one, perfect, let's go back token extra hosts and then gdk dot test bind it to this ip. That.

A

Is the ip that we use to create the loopback interface.

B

um And yeah: let's save the file and then let's reconfigure gdk.

B

This should take a couple of seconds.

B

Let me see if I missed anything, we've done this we've done that cool. So um once this is configured we should see our.

A

Runner, actually we see the runner here right now, but it's never contacted um that's because.

A

It we just provided the configuration to gitlab pml uh and it's reconfiguring right now, and then we will need to restart uh gdk for the changes to be. If.

B

In effect, so gdk restart.

B

Let's refresh the page.

A

If, when the page loads, we see this little beautiful, green icon, it means that we are successful and there we are, we see it, it's the status is online. uh We can reach to our uh runner, which means that now we can run a pipeline and um just probably just gonna work perfectly.

A

um If you want to check the logs by the way of the runner.

B

um You have, I think you have two ways to do, that. One is to inspect docker, take the container id and then follow the logs.

B

And then the second one is gdk tail runner. I guess yes, so, as you can see here,.

A

This one seems to be more detailed because the docker displays the last three lines. If I'm not missing a little.

B

Three or five lines so um yeah there we are, we have gdk.

A

Installed the gitlab instance is running locally, and then we have a gitlab runner running locally, and that should be it. I think if you have any questions or if you.

A

If you need any assistance, just feel free to reach me out. If I can help I'll be more than happy to and I'll be leaving my contact details below the video and also the the scripts so that you don't have to type you can just copy paste uh just make sure to change the user path accordingly, and that should be it.

B

Thanks for watching.

A

um And have a great rest of the day, bye.