Running CI/CD Pipeline with GitLab CI

GitLab allows us to deploy CI/CD pipeline runners on our own resources within our environment. This option is available not only for the self-hosted plan but also for the cloud service plan (gitlab.com). With this setup, unlike GitHub Action, we can avoid incurring additional costs for extended pipeline runtime. This is because we can deploy the runner on an on-demand server and optimize its usage.

GitLab CI offers several options for setting up resources to run CI/CD pipelines. A runner can be configured to handle jobs for specific groups or projects using designated tags. It can also be set to use different executors, such as Shell, Docker, Kubernetes, or VirtualBox. A comparison table of the supported executors is available in the executor documentation. Some executors offer greater flexibility and ease of use, while others may be more rigid but enhance server security.

Installing the runner in our machine

For example, we will deploy the runner on an Ubuntu server. It is recommended to use a separate machine from the one hosting the GitLab server. Detailed instructions can be found in the runner documentation.

curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | sudo bash
sudo apt-get install gitlab-runner

Additionally, we have to install Docker because we will use it as the executor in this process.

Registering the runner on our GitLab

We will configure the runner to handle jobs only from a specific group using designated tags. In this example, I use the latest registration mechanism available in GitLab Runner 15.10 or later.

Visit the control panel of the desired group and choose the Build > Runners menu.
Choose the "New group runner" option.
Fill in the required fields including the tags field.
Copy the command generated after submitting the form that contains the registration token.

Linking the runner with the GitLab CI instance

Next, return to the machine where the runner is installed and run the command generated in the previous step. The command will look like the example below.

gitlab-runner register --url https://YOUR_GITLAB_HOST --token glrt-xxx

When running the command, you will be prompted to answer a few questions. For the executor, you can type "docker", and for the default image, you can select "ubuntu:22.04". Detailed instructions for registering the runner are available in the runner configuration documentation.

Configuring the runner

Before the runner can function properly, we need to update certain values in the configuration file located at "/etc/gitlab-runner/config.toml". First, generate a Personal Access Token or a group-level token to allow the runner to pull the contents of the repository in the group. Then, input the token value into the configuration as shown in the example below.

[[runners]]
  name = "something"
  # ...
  executor = "docker"
  clone_url = "https://gitlab-ci-token:YOUR_PAT_OR_GROUP_TOKEN@YOUR_GITLAB_HOST"
  # ...
  [runners.docker]
    image = "ubuntu:22.04"
    pull_policy = "if-not-present"

Lastly, we must restart the runner with this command: gitlab-runner restart.

Configuring the CI/CD pipeline in our project

In GitLab CI, the pipeline script is stored in the ".gitlab-ci.yml" file within the project repository. Since the runner is configured to handle jobs with specific tags, each job in the pipeline script must be assigned the appropriate tag, as shown in the example below.

stages:
  - build
  - deploy

build-job:
  tags:
    - YOUR_TAG
  stage: build
  script:
    - echo "Compile complete."

deploy-job:
  tags:
    - YOUR_TAG
  stage: deploy
  script:
    - echo "Application successfully deployed."

After we push the update, we can check the status on the "Build > Pipelines" menu in our project repository.

Comments

Increase of Malicious Activities and Implementation of reCaptcha

In recent time, I've seen the increase of malicious activities such as login attempts or phishing emails to some accounts I manage. Let me list some of them and the actions taken. SSH Access Attempts This happened on a server that host a Gitlab server. Because of this case, I started to limit the incoming traffic to the server using internal and cloud firewall provided by the cloud provider. I limit the exposed ports, connected network interfaces, and allowed protocols. Phishing Attempts This typically happened through email and messaging platform such as Whatsapp and Facebook Page messaging. The malicious actors tried to share a suspicious link lured as invoice, support ticket, or something else. Malicious links shared Spammy Bot The actors leverage one of public endpoint on my website to send emails. Actually, the emails won't be forwarded anywhere except to my own email so this just full my inbox. This bot is quite active, but I'm still not sure what...

Configuring Swap Memory on Ubuntu Using Ansible

If we maintain a Linux machine with a low memory capacity while we are required to run an application with high memory consumption, enabling swap memory is an option. Ansible can be utilized as a helper tool to automate the creation of swap memory. A swap file can be allocated in the available storage of the machine. The swap file then can be assigned as a swap memory. Firstly, we should prepare the inventory file. The following snippet is an example, you must provide your own configuration. [server] 192.168.1.2 [server:vars] ansible_user=root ansible_ssh_private_key_file=~/.ssh/id_rsa Secondly, we need to prepare the task file that contains not only the tasks but also some variables and connection information. For instance, we set /swapfile as the name of our swap file. We also set the swap memory size to 2GB and the swappiness level to 60. - hosts: server become: true vars: swap_vars: size: 2G swappiness: 60 For simplicity, we only check the...

Deliver SaaS According Twelve-Factor App

If you haven't heard of the twelve-factor app , it gives us a recommendation or a methodology for developing SaaS or web apps structured into twelve items. The recommendation has some connections with microservice architecture and cloud-native environments which become more popular today. We can learn the details on its website . In this post, we will do a quick review of the twelve points. One Codebase Multiple Deployment We should maintain only one codebase for our application even though the application may be deployed into multiple environments like development, staging, and production. Having multiple codebases will lead to any kinds of complicated issues. Explicitly State Dependencies All the dependencies for running our application should be stated in the project itself. Many programming languages have a kind of file that maintains a list of the dependencies like package.json in Node.js. We should also be aware of the dependencies related to the pla...

Kenshin VS The Assassin

It is an assassin versus assassin.

Handling PDF Generation in Web Service

If we are building a website that requires a PDF generation feature, there are several options for implementing it based on the use cases or user requirements. First, we can generate the PDF on the client side using any available client library. It is suitable if the use case is to print out some data that is already available inside certain website components, and we want to maintain the styles of the components in the document. Second, we can do it fully in the back-end using any library available, such as PDF-lib, jsPDF, and so on. This approach is suitable if we want to keep the data processing or any related business functions in the back-end server. This second approach might have disadvantages, such as the difficulty of maintaining the design assets and styles which are already on our website. Third, it is using a hybrid approach, where certain processes are handled on the client side, and some are handled on the back-end. In this post, I want to discuss more about the...

Free Cloud Services from UpCloud

Although I typically deploy my development environment or experimental services on UpCloud , I do not always stay updated on its announcements. Recently, I discovered that UpCloud has introduced a new plan called the Essentials plan, which enables certain cloud services to be deployed at no cost. The complimentary services are generally associated with network components or serve as the foundation for other cloud services. This feature is particularly useful when retaining foundational services, such as a load balancer, is necessary, while tearing down all services and reconfiguring the DNS and other application settings each time we temporarily clean up infrastructure to reduce costs is undesirable. When reviewing the service specifications of the cloud services in the Essentials plan, they appear to be very similar to those in the Development plan. The difference in service levels is unclear, but it could be related to hardware or resource allocation. For instance, the loa...

LUKI NOTES

Search This Blog