GitLab CI/CD - Hands-On Lab: Working with CI/CD Components

Estimated time to complete: 15 minutes

Objectives

A component is a reusable CI/CD configuration. Many of GitLab’s provided CI/CD features are provided as components. In this lab, you will learn how to create and add a CI/CD component to your GitLab project.

Task A. Creating a Component

Let’s create a component to use in our GitLab project.

1. Navigate to your My Test Group by clicking it in the breadcrumb at the top of the page.

2. From your My Test Group in GitLab, click the New project button.

3. Click the Create blank project tile.

4. Name your project Example Component.

5. Leave all other values as their default, and click the Create project button and wait for GitLab to redirect you to the new project’s main page.

Now, we need to set up the configuration for the component.

1. In the repository of your Example Component project, click the + button, then click the New Directory option.

2. For the directory name, type in templates. Make sure that it is in lower case.

3. Click the Commit changes button, and commit it to the main branch.

4. Ensure you are now in the new templates directory. Click on the + button, then click the New file button.

5. Type in sample-template.yml as the file name.

6. In the body of the file, copy the following text to create your sample component:

spec:
  inputs:
    stage:
      default: test
---
component-job:
  script: echo job 1
  stage: $[[ inputs.stage ]]

Here, we are creating a component with an input called stage. The stage input has a default value of ’test’, which we will override in our other project.

1. Click Commit changes, and then click Commit changes in the pop-up screen.

Now we have a component file, but in order for the component to be accessible by other projects, we need to publish the component. Note that since the project is private, it will only be accessible by you.

Task B. Publishing the Component

1. On the lefthand toolbar, select Settings > General.

2. All components require a project description. Write in your project description section, “This component is an example component, and is meant for demonstration purposes only.”

3. Expand Visibility, project features, permissions.

4. Turn on the CI/CD Catalog project toggle. Click Save changes.

This will now make the project a CI/CD Catalog project. Any templates in the templates directory will now be available to any project, provided we make a release. Next we will use a component to make a release on our new custom component.

1. In the repository of your Example Component project, click the + button, then click the New File option.

2. Title the file .gitlab-ci.yml.

3. In the .gitlab-ci.yml file, add the following code snippet.

stages:
  - release
release component:
  stage: release
  image: registry.gitlab.com/gitlab-org/release-cli:latest
  script:
    - echo "Releasing the latest version of our component."
  release: 
    tag_name: '1.$CI_PIPELINE_IID.0'
    description: 'The latest component release.'
  rules:
    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH

This code looks similar to our release component we made in a similar lab, but there is one key difference- component releases require a release format in semantic versioning (MAJOR.MINOR.PATCH). We use the PATCH version to differentiate between each commit.

1. Click Commit changes, and then click Commit changes in the pop-up screen.

2. Wait for the pipeline to complete.

Task C. Adding the Created Component to our Project

1. Navigate to your CI/CD Catalogue by clicking on the search bar, and then clicking the Explore option.

2. Click on the CI/CD Catalog option on the left.

3. Click on the Example component component. This component will be only visible to you.

4. Copy the include statmement in the component. It should look similar to this:

include:
  - component: $CI_SERVER_FQDN/training-users/session-0a9ee9b9/iuhrhhmd/example-component/sample-template@v0.4.0

1. Navigate to your CI/CD project by clicking on the Tanuki logo in the top left corner of the page, then click on your project name.

2. From the project, select your .gitlab-ci.yml file.

3. Select Edit > Edit in Pipeline Editor.

4. At the top of your file, below the image, add in the custom component we created earlier.

The top of the .gitlab-ci.yml file should look like this:

workflow:
  rules:
    - if: $CI_COMMIT_TAG
      when: never 
    - when: always

default:
  image: golang

include:
  - component: $CI_SERVER_FQDN/training-users/session-0a9ee9b9/iuhrhhmd/example-component/sample-template@v0.4.0

1. Select Commit changes.

2. After committing your changes, navigate to the pipeline created for your commit. You will now see a new job named component-job. This job is the custom job we have imported using the include keyword.

3. Let’s try overriding the stage to instead run in the build stage by adding the following to the .gitlab-ci.yml file:

     include:
       - component: $CI_SERVER_FQDN/training-users/session-0a9ee9b9/iu6t0rjr/example-component/sample-template@v0.36.0
         inputs:
           stage: build
   

4. Select Commit changes, and watch as your component-job now runs in the build stage.

Lab Guide Complete

You have completed this lab exercise. You can view the other lab guides for this course.

Suggestions?

If you wish to make a change to the Hands-On Guide for GitLab CI/CD, please submit your changes via Merge Request.

View page source - Edit this page - please contribute.