Oto .gitlab-ci.yml, którego używam dla aplikacji Laravel na GitLabie: testy, trzy obrazy Dockera budowane przez buildx i wdrożenie przez SSH.
1. Wstęp
Pipeline testuje aplikację, buduje obrazy Node, PHP i Nginx, wypycha je do rejestru GitLaba i wdraża na jeden serwer produkcyjny. Testy działają też na merge requestach, a budowanie i wdrożenie tylko na main.
2. Struktura pipeline’u
Pełny przykład: .gitlab-ci.yml
Cały plik:
image: docker:latest
stages:
- test
- build
- deploy
variables:
DOCKER_BUILDKIT: 1
DOCKER_HOST: tcp://docker:2375/
DOCKER_TLS_CERTDIR: ""
IMAGE_NAMESPACE: dommmin/laravel-production
REGISTRY: registry.gitlab.com
services:
- docker:dind
before_script:
- docker info
- echo "$CI_REGISTRY_PASSWORD" | docker login -u "$CI_REGISTRY_USER" --password-stdin "$CI_REGISTRY"
test_php:
stage: test
image: dommin/php-8.4-fpm:latest
needs: [test_node]
before_script:
- git config --global --add safe.directory $(pwd)
- composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
script:
- cp .env.testing .env
- php artisan key:generate
- php artisan ziggy:generate
- composer larastan
- composer pint
- php artisan test --env=testing
variables:
DB_CONNECTION: sqlite
DB_DATABASE: ":memory:"
SESSION_DRIVER: array
artifacts:
paths:
- storage/logs/
expire_in: 1 week
only:
- main
- merge_requests
test_node:
stage: test
image: dommin/php-8.4-fpm:latest
before_script:
- git config --global --add safe.directory $(pwd)
- npm ci
- npm run build
script:
- npm run format
- npm run types
- npm run lint
artifacts:
paths:
- node_modules/
- public/build/
expire_in: 1 hour
only:
- main
- merge_requests
build_node:
stage: build
image: docker:24.0.5
needs: [test_node]
script:
- docker buildx create --use
- |
docker buildx build \
--platform linux/amd64 \
--file docker/node/Dockerfile \
--tag $REGISTRY/$IMAGE_NAMESPACE/node:latest \
--tag $REGISTRY/$IMAGE_NAMESPACE/node:$CI_COMMIT_SHA \
--push \
.
only:
- main
build_php:
stage: build
image: docker:24.0.5
needs: [test_php, build_node]
script:
- docker buildx create --use
- |
docker buildx build \
--platform linux/amd64 \
--file docker/php/Dockerfile \
--tag $REGISTRY/$IMAGE_NAMESPACE/php:latest \
--tag $REGISTRY/$IMAGE_NAMESPACE/php:$CI_COMMIT_SHA \
--push \
--build-context node=docker-image://$REGISTRY/$IMAGE_NAMESPACE/node:$CI_COMMIT_SHA \
.
only:
- main
build_nginx:
stage: build
image: docker:24.0.5
needs: [test_node, build_node]
script:
- docker buildx create --use
- |
docker buildx build \
--platform linux/amd64 \
--file docker/nginx/Dockerfile \
--tag $REGISTRY/$IMAGE_NAMESPACE/nginx:latest \
--tag $REGISTRY/$IMAGE_NAMESPACE/nginx:$CI_COMMIT_SHA \
--push \
--build-context node=docker-image://$REGISTRY/$IMAGE_NAMESPACE/node:$CI_COMMIT_SHA \
--build-arg HTPASSWD_USER="$HTPASSWD_USER" \
--build-arg HTPASSWD_PASS="$HTPASSWD_PASS" \
.
only:
- main
deploy_production:
stage: deploy
image: alpine:3.19
needs: [build_node, build_php, build_nginx]
before_script:
- apk add --no-cache openssh-client
- mkdir -p ~/.ssh
- echo "$SSH_KEY" | tr -d '\r' > ~/.ssh/id_rsa
- chmod 600 ~/.ssh/id_rsa
- ssh-keyscan -p $SSH_PORT $SSH_HOST >> ~/.ssh/known_hosts
script:
- cat "$ENV_FILE" > .env
- echo >> .env
- |
echo "REGISTRY=$REGISTRY" >> .env
echo "IMAGE_NAMESPACE=$IMAGE_NAMESPACE" >> .env
echo "NODE_IMAGE_NAME=$IMAGE_NAMESPACE/node" >> .env
echo "PHP_IMAGE_NAME=$IMAGE_NAMESPACE/php" >> .env
echo "NGINX_IMAGE_NAME=$IMAGE_NAMESPACE/nginx" >> .env
echo "TAG=$CI_COMMIT_SHA" >> .env
- scp -P $SSH_PORT docker-compose.production.yml $SSH_USER@$SSH_HOST:~/laravel/docker-compose.yml
- scp -P $SSH_PORT .env deploy.sh $SSH_USER@$SSH_HOST:~/laravel/
- echo "$CI_REGISTRY_PASSWORD" | ssh -p $SSH_PORT $SSH_USER@$SSH_HOST "docker login -u $CI_REGISTRY_USER --password-stdin $CI_REGISTRY"
- ssh -p $SSH_PORT $SSH_USER@$SSH_HOST "cd ~/laravel && chmod +x deploy.sh && ./deploy.sh"
only:
- main
3. Testy: PHP i Node
Testy PHP
Job PHP osobno:
test_php:
stage: test
image: dommin/php-8.4-fpm:latest
needs: [test_node]
before_script:
- composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
script:
- cp .env.testing .env
- php artisan key:generate
- php artisan ziggy:generate
- composer larastan
- composer pint
- php artisan test --env=testing
variables:
DB_CONNECTION: sqlite
DB_DATABASE: ":memory:"
SESSION_DRIVER: array
Job używa SQLite w pamięci dla szybkości i uruchamia Larastan oraz Pint przed testami, więc błąd analizy statycznej lub stylu zatrzymuje pipeline. test_php czeka na test_node (needs).
Testy Node
test_node:
stage: test
image: dommin/php-8.4-fpm:latest
before_script:
- npm ci
- npm run build
script:
- npm run format
- npm run types
- npm run lint
npm run format, npm run types i npm run lint sprawdzają formatowanie, typy i reguły lintera. Wcześniej frontend jest budowany przez npm run build, a node_modules/ i public/build/ zostają jako artefakty na godzinę.
4. Budowanie obrazów Docker
Node, PHP i Nginx budowane są jako osobne obrazy przez docker buildx:
build_node:
stage: build
image: docker:24.0.5
needs: [test_node]
script:
- docker buildx create --use
- |
docker buildx build \
--platform linux/amd64 \
--file docker/node/Dockerfile \
--tag $REGISTRY/$IMAGE_NAMESPACE/node:latest \
--tag $REGISTRY/$IMAGE_NAMESPACE/node:$CI_COMMIT_SHA \
--push \
.
Obrazy trafiają do rejestru GitLaba. Każdy obraz dostaje tag :latest i SHA commita. Produkcyjny .env celowo nie trafia do kontekstu builda: wszystko wpieczone w obraz może odczytać każdy, kto go pobierze, więc jeśli Vite potrzebuje wartości VITE_*, przekaż tylko je jako argumenty builda. build_php i build_nginx działają tak samo, ale biorą obraz Node jako dodatkowy kontekst (--build-context node=docker-image://...), dzięki czemu build frontendu trafia do nich.
5. Automatyczne wdrożenie na serwer
Wdrożenie to SSH i prosty skrypt bashowy:
deploy_production:
stage: deploy
image: alpine:3.19
needs: [build_node, build_php, build_nginx]
before_script:
- apk add --no-cache openssh-client
- mkdir -p ~/.ssh
- echo "$SSH_KEY" | tr -d '\r' > ~/.ssh/id_rsa
- chmod 600 ~/.ssh/id_rsa
- ssh-keyscan -p $SSH_PORT $SSH_HOST >> ~/.ssh/known_hosts
script:
- scp -P $SSH_PORT docker-compose.production.yml $SSH_USER@$SSH_HOST:~/laravel/docker-compose.yml
- scp -P $SSH_PORT .env deploy.sh $SSH_USER@$SSH_HOST:~/laravel/
- echo "$CI_REGISTRY_PASSWORD" | ssh -p $SSH_PORT $SSH_USER@$SSH_HOST "docker login -u $CI_REGISTRY_USER --password-stdin $CI_REGISTRY"
- ssh -p $SSH_PORT $SSH_USER@$SSH_HOST "cd ~/laravel && chmod +x deploy.sh && ./deploy.sh"
Klucz SSH pochodzi ze zmiennej CI/CD. Job kopiuje docker-compose.production.yml (jako docker-compose.yml), .env i deploy.sh do ~/laravel/ i uruchamia skrypt. W pełnym pliku job najpierw buduje .env z $ENV_FILE i dopisuje nazwy rejestru i obrazów oraz TAG=$CI_COMMIT_SHA. Potem loguje serwer do rejestru przez SSH, przekazując token joba przez stdin, więc nigdy nie ląduje on w .env ani na dysku (CI_REGISTRY_PASSWORD działa tylko, dopóki trwa job).
6. Checklist produkcyjny i dobre praktyki
- Zmienna ENV_FILE: środowisko produkcyjne przekazuj jako zmienną plikową.
- Klucze SSH: trzymaj je w GitLab CI/CD Variables.
- Testy bramkują build:
needswiąże buildy ztest_phpitest_node. - Tagi obrazów: każdy obraz jest wypychany jako
:latesti jako SHA commita, a wdrożenie używa SHA. Aby cofnąć wersję, ustawTAGw.envna serwerze na wcześniejsze SHA i uruchomdocker compose up -d. - Czyszczenie cache: po wdrożeniu uruchom
php artisan config:clear.
7. Najczęstsze problemy i debugowanie
- Błąd połączenia z Dockerem: sprawdź, czy
docker:dinddziała i czyDOCKER_HOSTjest ustawiony. - Brak uprawnień SSH: klucz potrzebuje
chmod 600i musi dotrzeć do joba nienaruszony (pełny plik usuwa\rprzeztr -d). - Nieaktualne obrazy: buildx może korzystać z cache. W razie potrzeby dodaj
--no-cache. - Problemy z siecią: serwer produkcyjny musi akceptować połączenia SSH z runnera.
8. Podsumowanie
To cały pipeline: test, budowa trzech obrazów, wdrożenie przez SSH. Celuje w jeden serwer, a pierwsze, co bym zmienił, to przypięcie docker:latest, docker:dind i obrazu PHP do stałych wersji.
Więcej porad Laravel & DevOps: Dominik Jasiński na LinkedIn