Git/GitLab
GitLab est une forge logicielle open-source lancée en 2011.
Elle fournit une interface graphique pour créer des branches, des tags, des pull requests (appelées merge requests), les relire et les fusionner.
GitLab ne permet pas de créer de nouveaux groupes d'utilisateurs (les quatre possibles sont ceux par défaut), mais on peut inviter une personne sur un dépôt avec un autre groupe que celui qu'elle a ailleurs. Et il gère aussi des groupes d'applications dans lesquels un utilisateur peut avoir les mêmes droits.
CI/CD
modifierGitLab CI/CD est un outil d'intégration continue et de déploiement continue[1], fourni avec la forge logicielle Gitlab.
Un pipeline est un ensemble de jobs déclenché automatiquement après différentes actions manuelles (git push, création de merge request, merge de branche, création de tag, ou clique sur le job à lancer).
Ces jobs peuvent être lancés dans un certain ordre ou en parallèle, selon les étapes (stages) auxquelles ils appartiennent.
IHM
modifierDans le menu de gauche de GitLab, cliquer sur :
- "Build" pour voir les tâches qui se lancent sur les serveurs "runners" :
- Pipelines : liste des groupes de jobs déjà lancés sur le dépôt.
- Jobs : liste de tous les jobs.
- Pipeline editor : éditeur en ligne du fichier .gitlab-ci.yml du dépôt. Il s'agit du fichier versionné contenant la configuration des pipelines.
- Pipeline schedules : gestion des tâches planifiées.
- Artifacts
- Settings : accessible uniquement aux propriétaires du repo, pour configurer par exemple les branches protégées ou les conditions de fusion des merge requests.
.gitlab-ci.yml
modifierPour qu'un pipeline se lance par hook dans un dépôt, il doit contenir un fichier .gitlab-ci.yml à la racine.
Exemple simple
modifierstages:
- build
build-code:
stage: build
script:
- echo "Hello World!"
- pwd; ls -alh
before_script
modifierScript à exécuter avant chaque job.
variables
modifierVariables appelables plusieurs fois au sein du .gitlab-ci.yml. Certaines permettent de configurer le comportement de GitLab CI. Exemple :
GIT_STRATEGY
modifierPolitique de clonage :
- none : pas de clone (ex : si on utilise une image Docker).
- fetch : clone différentiel depuis le dernier.
- clone : clone à partir de zéro[2].
La valeur par défaut est définie dans l'IHM : /settings/ci_cd.
GIT_DEPTH
modifierDéfinit la profondeur lors du clone du dépôt : shallow clone[3].
CI_PIPELINE_SOURCE
modifierOrigine du pipeline (ex : push, merge, tâche planifiée, clic sur le job...).
Dans un job
modifierstage
modifierÉtape qui lancera le job.
script
modifierScript à lancer.
rules
modifierConditions pour déclencher ou interdire le job courant.
Cette clause est préconisée car plus complète, par rapport à "only" et "except" qui servent lister des branches où le job peut s'exécuter ou pas (lors des merges).
dependencies
modifierDéfinit les jobs ont on récupère les artefacts pour le courant.
needs
modifierNoms des étapes obligatoires avant.
parallel: matrix
modifierType de needs définissant des jobs à exécuter en parallèle.
parent et child
modifierJobs à exécuter dans un sous-graphe.
include
modifierInclut un .yaml de CI (local ou distant). Ce qui permet par exemple de le construire avant de l'exécuter depuis un autre job.
trigger
modifierPour déclencher une action, par exemple un "include" ou un job d'un autre projet.
Exemple complexe
modifierVoici le squelette d'un pipeline complet, dans lequel il faudrait remplacer les echo
par les vraies opérations :
stages:
- build
- test
- publish
- deploy
build:
stage: build
script:
echo 'Build'
except:
refs:
- tags
quality-check:
stage: test
script:
echo 'Quality check'
variables:
GIT_STRATEGY: clone
GIT_DEPTH: 1
tags:
- docker
only:
- branches
except:
refs:
- tags
- master
- develop
run-test:
stage: test
script:
echo 'Tests'
variables:
GIT_STRATEGY: clone
GIT_DEPTH: 1
tags:
- docker
only:
- branches
except:
refs:
- tags
- master
- develop
publish:
stage: publish
script:
echo 'Publish artefact'
variables:
GIT_STRATEGY: none
tags:
- docker
only:
- master
- develop
deploy:
stage: deploy
script:
echo 'Deploy artefact on merge in master'
rules:
- if: $CI_COMMIT_BRANCH == "master"
when: on_success
Debug
modifierVérifier les valeurs des variables[4] :
build-code:
stage: build
script:
- export
Importation
modifierIl est possible d'incorporer des tâches de GitLab dans le pipeline, par exemple pour la sécurité :
sast:
before_script: []
stage: test
include:
- template: Security/SAST.gitlab-ci.yml
Déploiements
modifierLancement de tests à chaque Merge Request
modifierÀ chaque Merge Request (alias Pull Request, ou PR, ou MR), un job est créé pour lancer les instructions du .gitlab-ci.yml dans l'ordre. Mais avant de se lancer, il doit attendre la disponibilité d'un serveur de test sur lequel s'exécuter, appelé "runner"[5].
Les runners peuvent être fournis par GitLab ou installés soi-même. Dans ce cas leur configuration se trouve dans un fichier .toml.
Une fois l'évènement GitLab déclenché, la commande pour déployer dépend de l'environnement cible. Par exemple pour Kubernetes, un curl
peut-être utilisé.
À partir d'une image Docker du registre
modifierLe principe consiste à envoyer une image Docker dans le registre GitLab pour que les conteneurs puissent l'utiliser ensuite sans avoir à le reconstruire.
$CI_REGISTRY_IMAGE
représente l'URL du registre, ex : https://registry.gitlab.com/mon_espace.
Via Docker
modifierimage: docker:latest
Via Docker-compose
modifierUtile en cas de communication entre plusieurs conteneurs.
image: docker/compose:1.27.4
Via Kaniko
modifierSi les conteneurs déployés le sont dans un autre conteneur, cela peut occasionner des problèmes de performances. Kaniko est un système pour éviter cela[6].
image: name: gcr.io/kaniko-project/executor:debug
Références
modifier- ↑ https://docs.gitlab.com/ee/ci/
- ↑ https://docs.gitlab.com/ee/ci/runners/configure_runners.html#git-strategy
- ↑ https://docs.gitlab.com/ee/ci/large_repositories/
- ↑ https://docs.gitlab.com/ee/ci/variables/#list-all-environment-variables
- ↑ https://docs.gitlab.com/runner/
- ↑ https://docs.gitlab.com/ee/ci/docker/using_kaniko.html