Skip to main content
Version: Torizon OS 7.x.y

CI/CD - Integrate With GitLab CI Pipelines

Introduction​

This article helps you to quickly configure your project for integration with GitLab CI Pipelines.

Every templates comes with the .gitlab-ci.yml file configured to build and create the application package on the Torizon Cloud.

Pre-requisites​

Configure the GitLab Repository​

After creating the GitLab repository, you need to configure the secrets and variables to be used in the GitLab CI pipeline.

  1. In the repo page, mouse hover in the Settings and click on the CI/CD:

alt

  1. Click on the Expand button from Variables section:

alt

  1. Click on the Add variable button:

alt

This will open the Add variable modal window. In the Key field, type the name of the variable. In the Value field, type the value of the variable. Also make sure to check the Mask variable checkbox for the secret data. Then, click on the Add variable button:

info

In GitLab CI is possible also protect variables to be used only in the protected branches, see GitLab CI/CD variables for more information.

alt

Then, you will see the variable added to the list:

alt

Do it for all the secrets listed below:

Torizon Cloud

Docker Hub (only for non-TorizonCore Builder templates)

  • DOCKER_LOGIN Docker Hub registry username used to push images.

  • DOCKER_PASSWORD Docker Hub registry password or access token for the account used to push images.

Qt Enterprise (optional)

  • QT_LICENSE_LOGIN Qt Enterprise account login, required only if using Qt Enterprise packages.

  • QT_LICENSE_PASSWORD Qt Enterprise account password, required only if using Qt Enterprise packages.

Adding credentials.zip as CI/CD Variable​

To use the TorizonCore Builder to create the Torizon Cloud package, we need the credentials.zip file available in the CI/CD pipeline. The .gitlab-ci.yml expects to have the PLATFORM_CREDENTIALS variable with the base64 encode of the credentials.zip file. Execute the follow command to get the base64 encode of the credentials.zip file:

base64 -w 0 ./credentials.zip

Then, add the PLATFORM_CREDENTIALS variable, with the output from command as value.

Warning

Make sure to check the Mask variable checkbox for all secrets.

Running the CI/CD Pipeline​

After configuring the variables needed, your GitLab repository is ready to run the GitLab CI pipeline. Simply push your changes to the repository and the pipeline will be triggered automatically.

The following jobs will be executed:

  • Initial Setup: This step will verify the environment variables and secrets configured in the repository. If any of the required variables are missing, the workflow will fail fast in this first step;
  • build-docker-image: This step will run the task create-production-image task. This task will create the production image and publish it to the Docker registry. See the respective Workspace Task for more information.
  • push-package-to-platform: This step will run the task tcb-platform-publish. This task will create the Torizon Cloud package and publish it to the Torizon Cloud. See the respective Workspace Task for more information.
  • update-fleet: This step will run the task platform-update-fleet. This task will update the fleet with the new package. See the respective Workspace Task for more information.
info

The update-fleet job will only be executed for a push on the main branch. If you want to trigger an update when pushing in a different branch, you need to change the if condition in the update-fleet step from the .gitlab-ci.yml file. Check the templates repository file: https://github.com/toradex/vscode-torizon-templates/blob/bookworm/assets/gitlab/.gitlab-ci.yml#L101

At the end of the pipeline, if all occurs as expected, you will have the following in the pipeline page:

alt

And the Torizon Cloud update will be triggered, you should have the devices from the fleet with Update pending state:

alt

Send Feedback!