Docker - Installer et utiliser Git dans un container comme sur votre machine hôte

Bon, ce n'est plus la peine de le préciser : je fais tout dans des containers Docker, même coder (puisque je code avec des devcontainers) mais... jusqu'ici, j'utilisais git uniquement sur mon host.

Je veux dire : j'ai besoin de git sur mon host parce que je dois pouvoir cloner un repository. Mais la question est la suivante : dois-je utiliser git depuis mon host en dehors du git clone ? Est-ce que je peux travailler dans mon container et, de là, faire des actions comme un git push ?

Mon workflow actuel : depuis mon host, je clone un repo sur mon disque, puis je construis la ou les images Docker, je lance le ou les containers et je saute dedans (comme démarrer mon devcontainer). Je démarre aussi une console dans mon container pour lancer des processus, travailler sur des fichiers, ...

De temps en temps, je pousse mes modifications vers mon système de versioning (comme Gitlab/GitHub) et c'est là que le bât blesse : je dois quitter mon devcontainer (ou utiliser une autre console), revenir sur mon host et y lancer des commandes comme git add . && git commit -m "feat: The great feature I'm working on it" && git push.

Voyons comment améliorer ce processus et pouvoir lancer les commandes git depuis l'intérieur de notre container.

Partager votre clé SSH avec un container en cours d'exécution, comme nous le faisons ici, n'est pas le même problème que de l'utiliser pendant le build d'une image ; ce second cas est traité dans Docker secrets : utiliser votre clé SSH pendant le build. Et le .gitconfig que nous allons monter est celui décrit dans Git - Quelques astuces pour votre fichier .gitconfig.

Pourquoi ça fonctionne​

• Votre .gitconfig et votre clé SSH sont montés, pas copiés, dans le container — en lecture seule pour la clé — donc il n'y a rien à garder synchronisé et rien de supplémentaire figé dans l'image.
• git tourne dans le container mais s'authentifie et identifie les commits exactement comme il le ferait sur votre host, puisqu'il lit les mêmes fichiers.

Créer un container de démonstration​

Comme toujours, nous allons construire un exemple pleinement fonctionnel.

Créez un dossier bidon et allez dedans :

$ mkdir /tmp/git && cd $_

Il nous faut un Dockerfile, créons-le :

# syntax=docker/dockerfile:1

FROM alpine:latest?

# Install git and ssh so we can use our SSH credentials
RUN apk add --no-cache git openssh-client?

WORKDIR /root

RUN set -e -x && \?
    mkdir -p -m 0700 ~/.ssh?

# Keep the container running
ENTRYPOINT ["tail", "-f", "/dev/null"]?

Nous allons aussi utiliser un compose.yaml, créez également ce fichier :

services:
  docker_git:
    build: .?
    tty: true?
    volumes:
      # Share our SSH key
      - ${HOME}/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro?
      # and share our git configuration file
      - ${HOME}/.gitconfig:/root/.gitconfig?

Lancer le tout​

Nous allons créer notre image Docker et créer un container avec cette seule commande : docker compose up --detach --build.

Et, maintenant, nous allons entrer dans le container en lançant : docker compose exec docker_git /bin/sh.

Première vérification : lancez simplement git --version pour contrôler que git est bien installé (ce qui est le cas).

Partager votre configuration​

Jetez un œil au fichier compose.yaml que vous avez créé précédemment.

Nous y avons la ligne suivante :

- ${HOME}/.gitconfig:/root/.gitconfig

Cela dit à Docker de partager (monter) notre fichier local ${HOME}/.gitconfig (c'est-à-dire notre fichier de configuration) avec le container. Comme, dans cet exemple, nous lançons le container en tant que root, nous devons mettre /root/.gitconfig comme cible.

Vérifions si ça fonctionne, toujours dans la console à l'intérieur du container : lancez git config --list dans le shell de votre container. Vous verrez la même configuration que celle de votre machine hôte. Le partage a fonctionné comme prévu.

Partager vos credentials​

Regardez encore une fois le fichier compose.yaml.

Nous y avons cette ligne :

- ${HOME}/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro

Pensez à remplacer id_ed25519 par le nom de la clé que vous utilisez, comme par exemple id_rsa si nécessaire.

Donc, puisque nous avons déjà partagé à la fois notre fichier de configuration et notre clé SSH, vous pouvez, depuis l'intérieur du container, lancer une commande git comme git clone git@your_private_repo et, comme mentionné dans l'introduction, travailler sur votre codebase puis lancer git add . && git commit -m "feat: The great feature I'm working on it" && git push.

Conclusion​

Dès maintenant, vous pouvez utiliser n'importe quelle commande git dans votre container.

Si vous avez suivi le tutoriel ci-dessus, vous pouvez à présent parfaitement faire git clone <<your_private_repo>> depuis l'intérieur du container et ça fonctionnera.

Pour aller plus loin, jetez un œil à l'article Git - pre-commit hooks pour apprendre à configurer votre container afin de lancer des hooks avant de committer des fichiers.