GitLab과 Pantheon을 연결하고 Drupal 및 WordPress 워크플로를 최적화하는 방법

Pantheon의 게스트 개발자 도구 작성자가 GitLab CI/CD를 사용하여 WordPress 배포를 자동화하는 방법에 대해 이야기합니다.

В 판테온 저는 개발자 관계 업무를 하고 있기 때문에 항상 WordPress와 Drupal 개발자가 작업 흐름의 자동화 문제를 해결하는 데 도움을 줄 수 있는 새로운 방법을 찾고 있습니다. 이를 위해 저는 새로운 도구를 실험하고 서로 결합하여 효과적으로 작업하는 것을 좋아합니다.

저는 개발자들이 단일 스테이징 서버로 인해 어려움을 겪는 것을 종종 봅니다.

중간 서버를 사용할 차례를 기다리거나 "여기를 보되 아직 여기를 보지 마세요"라는 메모와 함께 클라이언트에게 URL을 보내는 것은 정말 즐거운 일입니다.

다중 개발 환경 - 멋진 Pantheon 도구 중 하나 - 이 문제를 해결합니다. 이 도구를 사용하면 필요에 따라 Git 브랜치를 위한 환경을 만들 수 있기 때문입니다. 각 다중 개발 환경에는 고유한 URL과 데이터베이스가 있으므로 개발자는 서로의 발끝을 밟지 않고도 조용히 작업하고, 품질을 확인하고, 승인을 얻을 수 있습니다.

그러나 Pantheon에는 버전 제어나 CI/CD(지속적인 통합 및 배포)를 위한 도구가 없습니다. 그러나 이는 모든 도구를 통합할 수 있는 유연한 플랫폼입니다.

또한 팀에서는 개발을 위해 특정 도구를 사용하고 조립 및 배포를 위해 다른 도구를 사용한다는 점도 알아냈습니다.

예를 들어 버전 제어 및 CI/CD를 위한 다양한 도구가 있습니다. 코드를 편집하고 문제를 진단하려면 도구를 이리저리 살펴보고 전환해야 합니다.

에 GitLab 버전 제어, 티켓, 병합 요청, 동급 최고의 CI/CD 파이프라인, 컨테이너 레지스트리 등을 위한 전체 개발 도구 세트가 있습니다. 개발 워크플로를 관리하는 데 이렇게 많은 기능을 제공하는 애플리케이션을 아직 본 적이 없습니다.

저는 자동화를 좋아하기 때문에 GitLab의 메인 브랜치에 대한 커밋이 Pantheon의 메인 개발 환경에 배포되도록 Pantheon을 GitLab에 연결하는 방법을 배웠습니다. 그리고 GitLab의 병합 요청은 Pantheon의 다중 개발 환경에 코드를 생성하고 배포할 수 있습니다.

이 튜토리얼에서는 GitLab과 Pantheon 간의 연결을 설정하고 WordPress 및 Drupal 워크플로를 최적화하는 방법을 안내합니다.

물론 가능합니다. GitLab 저장소 미러링하지만 우리는 탐구하기 위해 모든 것을 손으로 할 것입니다 깃랩 CI 앞으로는 이 도구를 배포에만 사용하는 것이 아닙니다.

소개

이 게시물에서는 Pantheon이 각 사이트를 코드, 데이터베이스, 파일의 세 가지 요소로 분류한다는 점을 이해해야 합니다.

코드에는 WordPress 코어, 플러그인 및 테마와 같은 CMS 파일이 포함되어 있습니다. 이러한 파일은 다음에서 관리됩니다. 힘내 저장소, Pantheon에서 호스팅하므로 Git을 사용하여 GitLab에서 Pantheon으로 코드를 배포할 수 있습니다.
Pantheon의 파일은 미디어 파일, 즉 사이트의 이미지입니다. 일반적으로 사용자가 업로드하며 Git은 이를 무시합니다.

무료 계정 만들기, 자세히 알아보기 판테온 작업흐름 또는 데모 등록 pantheon.io에서

가정

Pantheon과 GitLab에 대한 내 프로젝트는 다음과 같습니다. pantheon-gitlab-blog-demo. 프로젝트 이름은 고유해야 합니다. 여기서는 WordPress 사이트를 다루겠습니다. Drupal을 사용할 수 있지만 몇 가지 사항을 변경해야 합니다.

나는 사용할 것이다 Git 명령줄그리고 당신은 일할 수 있습니다 그래픽 인터페이스, 원하는 경우.

프로젝트 만들기

먼저, 만들어 보겠습니다. GitLab 프로젝트 (나중에 이에 대해 다시 설명하겠습니다).

지금 Pantheon에서 WordPress 웹사이트 만들기. 그런 다음 사이트 대시보드용 WordPress를 설치합니다.

예를 들어 플러그인을 제거하거나 추가하는 등 무언가를 변경하고 싶어 손이 가렵다면 인내심을 가지십시오. 사이트가 아직 GitLab에 연결되어 있지 않으며 모든 코드 변경 사항이 GitLab을 통과하기를 원합니다.

WordPress를 설치한 후 Pantheon 웹사이트 대시보드로 돌아가 개발 모드를 Git으로 변경합니다.

GitLab의 초기 커밋

이제 초기 WordPress 코드를 Pantheon 사이트에서 GitLab으로 전송해야 합니다. 이를 위해 Pantheon 사이트의 Git 저장소에서 코드를 로컬로 복제한 다음 GitLab 저장소로 보냅니다.

보다 쉽고 안전하게 하기 위해, Pantheon에 SSH 키 추가 Pantheon Git 저장소를 복제할 때마다 비밀번호를 입력할 필요가 없습니다. 동시에 이미 GitLab에 SSH 키 추가.

이렇게 하려면 사이트 대시보드의 Clone with Git 필드에서 명령을 복사하여 Pantheon 사이트를 로컬로 복제합니다.

도움이 필요하면 설명서를 읽어보세요. Pantheon용 Git 시작하기.

이제 바꿔보자 git remote originPantheon 대신 GitLab을 가리킵니다. 그것은 할 수 있다 командой git remote.

GitLab 프로젝트로 이동하여 프로젝트 세부정보 페이지의 복제 드롭다운에서 저장소 URL을 복사해 보겠습니다. SSH 키를 이미 구성했으므로 SSH로 복제 옵션을 선택하겠습니다.

기본적으로 git remote 코드 저장소의 로컬 복사본의 경우 - origin. 이것은 변경될 수 있습니다. git remote set-url origin [URL репозитория GitLab], 대괄호 대신 실제 URL을 입력합니다.

드디어 출시합니다 git push origin master --forceWordPress 코드를 Pantheon에서 GitLab으로 푸시합니다.

–force 옵션은 한 번만 필요합니다. 그럼 팀으로 git push GitLab에는 없을 것입니다.

자격 증명 및 변수 설정

Pantheon과 GitLab에 로그인하기 위해 SSH 키를 로컬로 추가한 방법을 기억하시나요? SSH 토큰을 사용하여 GitLab 및 Pantheon을 인증할 수 있습니다.

GitLab에는 훌륭한 문서가 있습니다. 보자 GitLab CI/CD에서 SSH 키 사용에 대한 문서의 Docker 실행기를 사용할 때 SSH 키에 대한 섹션.

이제 처음 두 단계를 완료하겠습니다. ssh-keygen을 사용하여 로컬에서 새 SSH 키 쌍을 생성하고 개인 키를 프로젝트에 변수로 추가해 보겠습니다..

그럼 우리가 물어볼게 SSH_PRIVATE_KEY как GitLab CI/CD 환경 변수 프로젝트 설정에서.
세 번째와 네 번째 단계에서는 파일을 만듭니다. .gitlab-ci.yml 다음과 같은 내용으로:

before_script:
  # See https://docs.gitlab.com/ee/ci/ssh_keys/README.html
  - eval $(ssh-agent -s)
  - echo "$SSH_PRIVATE_KEY" | tr -d 'r' | ssh-add - > /dev/null
  - mkdir -p $HOME/.ssh && echo "StrictHostKeyChecking no" >> "$HOME/.ssh/config"
  - git config --global user.email "$GITLAB_USER_EMAIL"
  - git config --global user.name "Gitlab CI"

아직 파일을 커밋하지 마세요. .gitlab-ci.yml, 그런 다음 다른 것을 추가해야 합니다.

이제 우리는 다섯 번째 단계를 수행하고 빌드 환경에서 액세스해야 하는 서비스에 첫 번째 단계에서 생성한 공개 키를 추가합니다..

우리의 경우 GitLab에서 Pantheon에 액세스하려고 합니다. 우리는 Pantheon 문서의 지침을 따릅니다. Pantheon에 SSH 키 추가 이 단계를 수행합니다.

기억하세요: 비공개 SSH는 GitLab에 있고 공개 SSH는 Pantheon에 있습니다.

몇 가지 환경 변수를 더 설정해 보겠습니다. 첫 번째는 PANTHEON_SITE입니다. 해당 값은 컴퓨터에 있는 Pantheon 사이트의 이름입니다.

머신의 이름은 Git으로 복제 명령 끝에 나열됩니다. 이미 사이트를 로컬로 복제했으므로 이것이 로컬 저장소 디렉터리의 이름이 됩니다.

다음으로 환경 변수를 설정해 보겠습니다. PANTHEON_GIT_URL. 이는 이미 사용한 Pantheon 사이트의 Git 저장소 URL입니다.

없이 SSH 저장소 URL만 입력하세요. git clone 그리고 끝에는 컴퓨터의 사이트 이름이 표시됩니다.

휴. 완료되었습니다. 이제 파일을 완성할 수 있습니다. .gitlab-ci.yml.

배포 작업 생성

처음에 GitLab CI를 사용하여 수행할 작업은 과거에 Git 리포지토리를 사용하여 수행한 작업과 매우 유사합니다. 하지만 이번에는 Pantheon 저장소를 두 번째 원격 Git 소스로 추가한 다음 코드를 GitLab에서 Pantheon으로 푸시하겠습니다.

이렇게 하려면 다음을 구성해 보겠습니다. 무대 deploy и 직무 deploy:dev, 왜냐하면 우리는 Pantheon의 개발 환경에 배포할 것이기 때문입니다. 결과 파일 .gitlab-ci.yml 다음과 같이 보일 것입니다 :

stages:
- deploy

before_script:
  # See https://docs.gitlab.com/ee/ci/ssh_keys/README.html
  - eval $(ssh-agent -s)
  - echo "$SSH_PRIVATE_KEY" | tr -d 'r' | ssh-add - > /dev/null
  - mkdir -p $HOME/.ssh && echo "StrictHostKeyChecking no" >> "$HOME/.ssh/config"
  - git config --global user.email "$GITLAB_USER_EMAIL"
  - git config --global user.name "Gitlab CI"

deploy:dev:
  stage: deploy
  environment:
    name: dev
    url: https://dev-$PANTHEON_SITE.pantheonsite.io/
  script:
    - git remote add pantheon $PANTHEON_GIT_URL
    - git push pantheon master --force
  only:
    - master

변수들 SSH_PRIVATE_KEY, PANTHEON_SITE и PANTHEON_GIT_URL 익숙해 보일 것입니다. 이러한 환경 변수를 더 일찍 설정했습니다. 이 변수를 사용하면 파일의 값을 사용할 수 있습니다 .gitlab-ci.yml 여러 번 업데이트하면 한 곳에서만 업데이트하면 됩니다.

마지막으로 파일을 추가하고 커밋하고 보냅니다. .gitlab-ci.yml GitLab에서.

배포 확인

모든 일을 올바르게 수행했다면 작업은 deploy:dev GitLab CI/CD에서 성공적으로 실행되고 커밋을 제출합니다. .gitlab-ci.yml 판테온에서. 한번 살펴보자.

Pantheon에 병합 요청 스레드 보내기

여기서는 제가 가장 좋아하는 Pantheon 기능을 사용하겠습니다. 다중 개발자, 요청 시 Git 브랜치를 위한 추가 Pantheon 환경을 생성할 수 있습니다.

다중 개발자에 대한 액세스가 제한됩니다.이므로 이 섹션을 건너뛸 수 있습니다. 그러나 액세스 권한이 있는 경우 GitLab 병합 요청에서 Pantheon의 다중 개발 환경 자동 생성을 설정하여 생산성을 크게 높일 수 있습니다.

먼저 다음을 사용하여 로컬에서 새 Git 브랜치를 만들어 보겠습니다. git checkout -b multidev-support. 이제 다시 뭔가를 바꿔보겠습니다. .gitlab-ci.yml.

Pantheon 환경 이름에 병합 요청 번호를 포함하는 것을 좋아합니다. 예를 들어 첫 번째 병합 요청은 다음과 같습니다. mr-1, 두번째 - mr-2 등.

병합 요청이 변경되므로 Pantheon 분기 이름을 동적으로 결정해야 합니다. GitLab에서는 쉽습니다. 사용하기만 하면 됩니다. 사전 정의된 환경 변수.

우리는 걸릴 수 있습니다 $CI_MERGE_REQUEST_IID병합 요청 번호를 지정합니다. 이전에 지정한 전역 환경 변수와 함께 이 모든 것을 적용하고 파일 끝에 새 배포:multidev 작업을 추가해 보겠습니다. .gitlab-ci.yml.

deploy:multidev:
  stage: deploy
  environment:
    name: multidev/mr-$CI_MERGE_REQUEST_IID
    url: https://mr-$CI_MERGE_REQUEST_IID-$PANTHEON_SITE.pantheonsite.io/
  script:
    # Checkout the merge request source branch
    - git checkout $CI_COMMIT_REF_NAME
    # Add the Pantheon git repository as an additional remote
    - git remote add pantheon $PANTHEON_GIT_URL
    # Push the merge request source branch to Pantheon
    - git push pantheon $CI_COMMIT_REF_NAME:mr-$CI_MERGE_REQUEST_IID --force
  only:
    - merge_requests

우리의 임무와 비슷할 거예요 deploy:dev, 브랜치만 판테온으로 보내지고, 판테온으로는 보내지지 않습니다. master.

업데이트된 파일을 추가하고 커밋했습니다. .gitlab-ci.yml이제 다음을 사용하여 GitLab에 새 브랜치를 푸시하겠습니다. git push -u origin multidev-support.

이제 브랜치에서 새로운 병합 요청을 생성해 보겠습니다. multidev-support눌러 병합 요청 만들기.

병합 요청을 생성한 후 CI/CD 작업이 어떻게 실행되는지 살펴봅니다. deploy:multidev.

보세요, 새로운 스레드가 판테온으로 전송되었습니다. 하지만 Pantheon 사이트 대시보드의 다중 개발자 섹션으로 이동하면 거기에서 새로운 환경을 볼 수 없습니다.

Git Branches 섹션을 살펴보겠습니다.

결과적으로 우리 스레드는 mr-1 판테온에 도착했습니다. 브랜치에서 환경을 만들어보자 mr-1.

다중 개발 환경을 만들었습니다. 이제 GitLab으로 돌아가서 섹션을 살펴보겠습니다. 운영 > 환경. 다음에 대한 항목이 표시됩니다. dev и mr-1.

항목을 추가했기 때문입니다. environment 이름으로 name и url CI/CD 작업으로 전환합니다. 개방형 환경 아이콘을 클릭하면 Pantheon의 다중 개발 환경 URL로 이동됩니다.

다중 개발 생성 자동화

원칙적으로 여기에서 멈추고 각 병합 요청에 대해 다중 개발 환경을 생성하는 것만 기억하면 되지만 이 프로세스는 자동화될 수 있습니다.

Pantheon에는 명령줄 도구가 있습니다. 말단, 플랫폼에서 자동으로 작업할 수 있습니다. Terminus를 사용하면 명령줄에서 다중 개발 환경을 만들 수 있습니다. 깃랩 CI.

이를 테스트하려면 새로운 병합 요청이 필요합니다. 다음을 사용하여 새 분기를 만들어 보겠습니다. git checkout -b auto-multidev-creation.

GitLab CI/CD 작업에서 Terminus를 사용하려면 Terminus를 사용한 인증을 위한 머신 토큰과 Terminus를 사용한 컨테이너 이미지가 필요합니다.

Pantheon 머신 토큰 생성, 안전한 장소에 저장하고 이름으로 GitLab의 전역 환경 변수로 추가하십시오. PANTHEON_MACHINE_TOKEN.

GitLab 환경 변수를 추가하는 방법을 잊어버린 경우 정의한 위치로 돌아가세요. PANTHEON_SITE.

Terminus가 있는 Dockerfile 만들기

Docker를 사용하지 않거나 파일이 마음에 들지 않는 경우 Dockerfile, 내 이미지를 가져가세요 registry.gitlab.com/ataylorme/pantheon-gitlab-blog-demo:latest 이 섹션을 건너뛰세요.

GitLab에는 컨테이너 레지스트리가 있습니다., 프로젝트에 대한 Dockerfile을 빌드하고 배치할 수 있습니다. Pantheon과 함께 작동하기 위해 Terminus가 포함된 Dockerfile을 만들어 보겠습니다.

Terminus는 PHP 명령줄 도구이므로 PHP 이미지부터 시작해 보겠습니다. Composer를 통해 Terminus를 설치하고 있으므로 다음을 사용하겠습니다. 공식 Docker Composer 이미지. 우리는 창조한다 Dockerfile 다음 내용이 포함된 로컬 저장소 디렉터리에:

# Use the official Composer image as a parent image
FROM composer:1.8

# Update/upgrade apk
RUN apk update
RUN apk upgrade

# Make the Terminus directory
RUN mkdir -p /usr/local/share/terminus

# Install Terminus 2.x with Composer
RUN /usr/bin/env COMPOSER_BIN_DIR=/usr/local/bin composer -n --working-dir=/usr/local/share/terminus require pantheon-systems/terminus:"^2"

섹션의 이미지 수집 및 전송에 대한 지침을 따르십시오. 이미지 빌드 및 푸시 в 컨테이너 레지스트리 문서에서 이미지를 수집하려면 Dockerfile GitLab으로 푸시합니다.

섹션 열기 레지스트리 GitLab 프로젝트에서. 모든 것이 계획대로 진행된다면 우리의 이미지는 그대로 유지될 것입니다. 이미지 태그에 대한 링크를 기록해 두십시오. 파일에 필요합니다. .gitlab-ci.yml.

섹션 script 문제에 deploy:multidev 이(가) 커지기 시작하므로 별도의 파일로 옮겨 보겠습니다. 새 파일 만들기 private/multidev-deploy.sh:

#!/bin/bash

# Store the mr- environment name
export PANTHEON_ENV=mr-$CI_MERGE_REQUEST_IID

# Authenticate with Terminus
terminus auth:login --machine-token=$PANTHEON_MACHINE_TOKEN

# Checkout the merge request source branch
git checkout $CI_COMMIT_REF_NAME

# Add the Pantheon Git repository as an additional remote
git remote add pantheon $PANTHEON_GIT_URL

# Push the merge request source branch to Pantheon
git push pantheon $CI_COMMIT_REF_NAME:$PANTHEON_ENV --force

# Create a function for determining if a multidev exists
TERMINUS_DOES_MULTIDEV_EXIST()
{
    # Stash a list of Pantheon multidev environments
    PANTHEON_MULTIDEV_LIST="$(terminus multidev:list ${PANTHEON_SITE} --format=list --field=id)"

    while read -r multiDev; do
        if [[ "${multiDev}" == "$1" ]]
        then
            return 0;
        fi
    done <<< "$PANTHEON_MULTIDEV_LIST"

    return 1;
}

# If the mutltidev doesn't exist
if ! TERMINUS_DOES_MULTIDEV_EXIST $PANTHEON_ENV
then
    # Create it with Terminus
    echo "No multidev for $PANTHEON_ENV found, creating one..."
    terminus multidev:create $PANTHEON_SITE.dev $PANTHEON_ENV
else
    echo "The multidev $PANTHEON_ENV already exists, skipping creating it..."
fi

스크립트는 개인 디렉토리에 있으며 Pantheon에 대한 웹 액세스를 허용하지 않습니다. 다중 개발자 논리에 대한 스크립트가 있습니다. 이제 섹션을 업데이트해 보겠습니다. deploy:multidev 파일 .gitlab-ci.yml그래서 다음과 같이 밝혀졌습니다.

deploy:multidev:
  stage: deploy
  environment:
    name: multidev/mr-$CI_MERGE_REQUEST_IID
    url: https://mr-$CI_MERGE_REQUEST_IID-$PANTHEON_SITE.pantheonsite.io/
  script:
    # Run the multidev deploy script
    - "/bin/bash ./private/multidev-deploy.sh"
  only:
    - merge_requests

생성된 커스텀 이미지에서 작업이 수행되는지 확인해야 하므로 정의를 추가해 보겠습니다. image 레지스트리 URL에서 다음으로 .gitlab-ci.yml. 결과적으로 우리는 다음과 같은 파일을 갖게 되었습니다. .gitlab-ci.yml:

image: registry.gitlab.com/ataylorme/pantheon-gitlab-blog-demo:latest

stages:
- deploy

before_script:
  # See https://docs.gitlab.com/ee/ci/ssh_keys/README.html
  - eval $(ssh-agent -s)
  - echo "$SSH_PRIVATE_KEY" | tr -d 'r' | ssh-add - > /dev/null
  - mkdir -p $HOME/.ssh && echo "StrictHostKeyChecking no" >> "$HOME/.ssh/config"
  - git config --global user.email "$GITLAB_USER_EMAIL"
  - git config --global user.name "Gitlab CI"

deploy:dev:
  stage: deploy
  environment:
    name: dev
    url: https://dev-$PANTHEON_SITE.pantheonsite.io/
  script:
    - git remote add pantheon $PANTHEON_GIT_URL
    - git push pantheon master --force
  only:
    - master

deploy:multidev:
  stage: deploy
  environment:
    name: multidev/mr-$CI_MERGE_REQUEST_IID
    url: https://mr-$CI_MERGE_REQUEST_IID-$PANTHEON_SITE.pantheonsite.io/
  script:
    # Run the multidev deploy script
    - "/bin/bash ./private/multidev-deploy.sh"
  only:
    - merge_requests

추가, 커밋 및 보내기 private/multidev-deploy.sh и .gitlab-ci.yml. 이제 GitLab으로 돌아가서 CI/CD 작업이 완료될 때까지 기다립니다. 인내심을 가지십시오. 다중 개발자는 생성하는 데 몇 분이 걸릴 수 있습니다.

그런 다음 Pantheon의 다중 개발자 목록을 살펴보겠습니다. 오 기적이다! 다중개발 환경 mr-2 이미 여기에.

결론

우리 팀은 병합 요청을 열고 자동으로 환경을 생성하기 시작하면서 훨씬 더 즐거운 시간을 보냈습니다.

GitLab과 Pantheon의 강력한 도구를 사용하면 GitLab을 Pantheon에 자동으로 연결할 수 있습니다.

GitLab CI/CD를 사용하므로 워크플로가 성장할 여지가 있습니다. 시작하는 데 도움이 되는 몇 가지 아이디어는 다음과 같습니다.

• 빌드 단계를 추가합니다.
• 자동화된 테스트를 추가합니다.
• 코드 표준이 충족되는지 확인하는 작업을 추가합니다.
• 추가 동적 애플리케이션 보안 테스트.

GitLab, Pantheon 및 자동화에 대한 귀하의 생각을 알려주십시오.

PS Pantheon의 명령줄 도구인 Terminus가 플러그인을 통해 확장 가능?

Pantheon에서는 버전 2를 훌륭하게 수행했습니다. Terminus 빌드 도구용 플러그인 GitLab 지원. 각 프로젝트의 설정에 신경쓰고 싶지 않다면 이 플러그인을 사용해보고 v2 베타 테스트를 도와주세요. 터미너스 팀의 경우 build:project:create Pantheon 토큰과 GitLab 토큰만 필요합니다. 그녀는 Composer 및 자동화된 테스트를 사용하여 샘플 프로젝트 중 하나를 배포하고 새로운 Pantheon 사이트인 GitLab에서 새 프로젝트를 생성한 후 환경 변수 및 SSH 키를 사용하여 연결합니다.

Об авторе

Andrew Taylor는 개발자를 위한 도구를 만듭니다. 판테온.

출처 : habr.com