Use a template¶

⚙️ Setup¶

Follows these steps to setup your CI/CD pipeline in less than 5 minutes!

1. If you haven't yet a .gitlab-ci.yml file in the root on your repository: you can create it and use the following list of stages:

   stages:
     - build
     - tests
     - provision
     - review
     - release
     - deploy
     - others
   

   Info

   You can check the stages section to get more information about this list or if you already have a configuration with different stages.

2. Select the job templates you want in the job templates section and append their URL in the include list of your .gitlab-ci.yml file:

   include:
      - remote: 'https://api.r2devops.io/job/r/<path>@<version>.yaml'
      - remote: 'https://api.r2devops.io/job/r/<path>@<version>.yaml'
     - ...
   

3. The job templates can be customized 👉 check the job templates customization section.

4. Everything is ready! You can now benefit the full power of a CI/CD pipeline 🎉🚀

   Tip

   You can also combine job's templates and your own jobs in your .gitlab-ci.yml configuration file.

See open-source template hub

🤓 Pipeline examples¶

• Several examples of projects using R2Devops hub:

  • Python flask based REST API permitting to play TicTacToe 👉 tictactoe/grid-api
  • Vue.js project providing a client to the TicTacToe API 👉 tictactoe/grid-frontend
  • React.js project providing our landing page 👉 r2devops/landing-page

• An example of a full .gitlab-ci.yml configuration using job templates from the hub 👇

  Job templates used in the example

  • Plug-and-play set of job templates from the hub to automatically build, test and deploy static documentation website:
    • mkdocs (latest version)
    • lighthouse (latest version)
    • pages (latest version)
  • Plug-and-play set of jobs from the hub to automatically build, push and test docker images:
    • docker_build (version 0.3.0)
    • trivy_image (version 0.2.0)
  • A custom manual job unit_tests

  stages:
  - build
  - tests
  - provision
  - review
  - release
  - deploy
  - others
  
  # Jobs from r2devops.io (they don't need any configuration in standard cases)
  include:
  - remote: 'https://api.r2devops.io/job/r/gitlab/r2devops/hub/jobs/mkdocs@latest.yaml'
  - remote: 'https://api.r2devops.io/job/r/gitlab/r2devops/hub/jobs/lighthouse@latest.yaml'
  - remote: 'https://api.r2devops.io/job/r/gitlab/r2devops/hub/jobs/pages@latest.yaml'
  - remote: 'https://api.r2devops.io/job/r/gitlab/r2devops/hub/jobs/docker_build@latest.yaml'
  - remote: 'https://api.r2devops.io/job/r/gitlab/r2devops/hub/jobs/trivy_image@latest.yaml'
  
  # Locally configured job template
  unit_tests:
    image: python:3.9-alpine
    stage: tests
    before_script:
      - pip install pipenv && pipenv --bare install --dev
    script:
      - make test
  

▶ Stages¶

By default, each job templates from the hub is a part of on these stages:

• 🧱 Build: building and packaging of the software
• 🔎 Tests: testing your repository files with dynamic and static tests
• 🛠 Provision: preparation of the software infrastructure
• 👌 Review: deployment of the software in an isolated review environment
• 🏷 Release: releasing and tagging of the software
• 🚀 Deploy: deployment of the software on environments
• 🦄 Others: all other magic jobs not included in previous stages

This is an efficient and simple workflow. Nevertheless, if you want to use your own custom stage list: you can re-declare yourself the stage of any job template from the hub. Follow the customization section to do it.

🔢 Versioning¶

To retrieve a template version, choose among following syntaxes:

• To have always the latest version use: @latest
• You can otherwise precise an exact version: @<version> (ex: @1.2.3)
• To use the latest version of minor releases with a precise major: @~<major> (ex: @~1)
• Or the latest version of patch releases with a precise major and minor: @~<major>.<minor> (ex: @~1.2)

🔧 Job templates customization¶

🖌 Global¶

Each job templates of the hub can be customized. To do it, you have to include the job template URL as usual and, in addition, override the options you want to customize.

For example, if you want to use the trivy_image job template and customize it by:

• Redefining the stage to security to fit in your personal stages workflow,
• Set the variable TRIVY_VERSION to 0.9.1 to use this version instead of the default,
• Set the variable TRIVY_SEVERITY to CRITICAL to display only CRITICAL issues.

include:
  - remote: 'https://api.r2devops.io/job/r/gitlab/r2devops/hub/jobs/trivy_image.yaml'

trivy_image:
  stage: security
  variables:
    TRIVY_VERSION: "0.9.1"
    TRIVY_SEVERITY: "CRITICAL"

✏️ Use custom stage¶

If you want to use your own stage name, it's possible to do so when including your job template. Example:

stages:
  - security

include:
  - remote: 'https://api.r2devops.io/job/r/gitlab/r2devops/hub/jobs/trivy_image.yaml'

trivy_image:
  stage: security

🐳 Advanced: services¶

You may want one of your job template to interact with a container instance (API, database, web server...) to work. GitLab has an option to run a container next to a job template: services.

To use this option, you must have access to an image of the container you want to run as a service. For example, if you are using our docker_build job template to build an image of your application, and you want to test this image using the nmap job template, just add the following configuration in your .gitlab-ci.yml file:

nmap:
  services:
    - name: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
      alias: app

🎶 Multiple usage of the same job template in your pipeline¶

If you want to reuse a job template from the hub, for example launching apiDoc to build 2 API documentations in the same pipeline, you can easily do so with the Hub's job templates using extends GitLab keyword.

stages:
  - build

include:
  - remote: 'https://api.r2devops.io/job/r/gitlab/r2devops/hub/jobs/apidoc/0.2.0.yaml'

apidoc:
  variables:
    APIDOC_CONFIG_PATH: src/doc/project1/apidoc.json
    APIDOC_OUTPUT_PATH: website_build/apidoc/project1/

apidoc_project2:
  extends: apidoc
  variables:
    APIDOC_CONFIG_PATH: src/doc/project2/apidoc.json
    APIDOC_OUTPUT_PATH: website_build/apidoc/project2/