Use the hub¶
- 🦊 Manage your project in Gitlab and understand what is CI/CD with Gitlab
- 🔫 Be aware each file modification in your project can trigger a Pipeline
- 🗝 Have access to the pipelines page in your Gitlab project and write access to your project
⏳ Quick setup¶
Follows these steps to setup your CI/CD pipeline in less than 5 minutes !
If you haven't yet a
.gitlab-ci.ymlfile in the root on your repository: create it with the list of stages:
stages: - static_tests - build - dynamic_tests - provision - review - release - deploy - others
Check stages section to get more information about this list or if you already have a configuration with different stages.
Select Jobs you want in jobs section and append their URL in the
includelist of your
include: - remote: 'https://jobs.r2devops.io/<job_name>.yml' - remote: 'https://jobs.r2devops.io/<job_name>.yml' - ...
By default, the
latestversion of a job is used. You can choose to use a specific version using a
tag. Available tags are described for each job in jobs section. Description of
tagformat is available in Versioning page.
Once your pipeline is functional, we recommend using a specific version for jobs in order to ensure that your pipeline will not be broken by a job update.
Jobs can be customized 👉 check the jobs customization section.
Everything is ready! You can now benefit the full power of a CI / CD pipeline 🎉🚀
You can also combine jobs templates and your own jobs in
🤓 Pipeline examples¶
Several examples of projects using the r2devops hub:
An example of a full
.gitlab-ci.ymlconfiguration using jobs from the hub 👇
Jobs used in the example
- Plug-and-play set of jobs from the hub to automatically build, test and deploy static documentation website:
- Plug-and-play set of jobs from the hub to automatically build, push and test docker images:
- A custom manual job
stages: - static_tests - build - dynamic_tests - provision - review - release - deploy - others # Jobs from r2devops.io (they don't need any configuration in standard cases) include: - remote: 'https://jobs.r2devops.io/latest/mkdocs.yml' - remote: 'https://jobs.r2devops.io/latest/lighthouse.yml' - remote: 'https://jobs.r2devops.io/latest/pages.yml' - remote: 'https://jobs.r2devops.io/0.3.0/docker_build.yml' - remote: 'https://jobs.r2devops.io/0.2.0/trivy_image.yml' # Locally configured job unit_tests: image: python:3.9-alpine stage: static_tests before_script: - pip install pipenv && pipenv --bare install --dev script: - make test
By default, each job from the hub is a part of on these stages:
- 🔎 Static_tests: static testing of repository files
- 🧱 Build: building and packaging of software
- 🔥 Dynamic_tests: dynamic testing of a running version of the software
- 🛠 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 from the hub. Follow the customization section to do it.
🔧 Jobs customization¶
All jobs from the
r2devops/hub specify a docker image to be run in a docker container
Each jobs of the hub can be customized. To do it, you have to include the job URL as usual and, in addition, override the options you want to customize.
In this way, you can override all Gitlab jobs parameters. All parameters are described in Gitlab documentation.
For example, if you want to use the trivy_image job and customize it by:
- Redefining the
securityto fit in your personal stages workflow
- Set the variable
0.9.1to use this version instead of the default
- Set the variable
CRITICALto display only CRITICAL issues
include: - remote: 'https://jobs.r2devops.io/trivy_image.yml' 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. Example:
stages: - security include: - remote: 'https://jobs.r2devops.io/trivy_image.yml' trivy_image: stage: security
You may want one of your job to interact with a container instance (API, database, web server...) to work. GitLab has an option to run a container next to a job:
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 to build an image of your application, and you want to test this image using the nmap job, just add the following configuration in your
nameoption must contain your image name and tag or an image name from Docker Hub.
aliasoption permits to the job to reach your application using a name. This name must be the same that the one specified inside the job target's variable.
- You may also run some other services like a database depending on your application needs.
nmap: services: - name: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA alias: app
🎶 Multiple usage of the same job in your pipeline¶
If you want to reuse a job on the hub, for example launching
apiDoc to build 2 API documentations in the same pipeline:
You can easily do so with Hub's jobs using extends GitLab keyword.
stages: - build include: - remote: 'https://jobs.r2devops.io/0.2.0/apidoc.yml' 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/
Be aware to have different artifacts path not to overwrite your first artifact by the second one.