Како да ги поврзете GitLab и Pantheon и да ги оптимизирате работните текови на Друпал и WordPress

Нашиот гостин креатор на алатки за програмери во Пантеон зборува за тоа како да се автоматизираат распоредувањата на WordPress користејќи GitLab CI/CD.

В Пантеон Работам во односи со програмери, така што секогаш барам нови начини да им помогнам на развивачите на WordPress и Drupal да ги решат проблемите со автоматизација во нивните работни процеси. За да го направам ова, сакам да експериментирам со нови алатки и да ги комбинирам едни со други за да функционирам ефективно.

Често гледам дека програмерите се борат со еден сервер за поставување.

Задоволство е да го чекате вашиот ред да користите среден сервер или да им испратите URL на клиентите со напомена: „Погледнете овде, но сè уште не гледајте овде“.

Multidev околини - една од одличните алатки на Pantheon - го решава овој проблем, бидејќи со нив можете да креирате околини за Git гранки на барање. Секоја multidev опкружување има своја URL и база на податоци, така што програмерите можат да работат тивко, да го проверуваат квалитетот и да добијат одобрение без да стапнат меѓусебно.

Но, Pantheon нема алатки за контрола на верзијата или континуирана интеграција и распоредување (CI/CD). Но, тоа е флексибилна платформа со која можете да интегрирате какви било алатки.

Забележав и дека тимовите користат одредени алатки за развој, а различни за склопување и распоредување.

На пример, тие имаат различни алатки за контрола на верзијата и CI/CD. Мора да се вртите наоколу и да се префрлате помеѓу алатките за да уредувате код и да дијагностицирате проблеми.

На GitLab има целосен сет на развојни алатки: за контрола на верзијата, билети, барања за спојување, најдобар CI/CD гасовод во класата, регистар на контејнери и сè слично. Сè уште не наидов на апликација која нуди толку многу за управување со вашиот работен тек на развој.

Ја сакам автоматизацијата, па научив како да го поврзам Pantheon со GitLab, така што обврзувањата за главната гранка на GitLab се распоредени во главната развојна околина во Pantheon. И барањата за спојување на GitLab можат да креираат и распоредуваат код во средини со мултидев во Пантеон.

Во ова упатство, ќе ве проучам како да поставите врска помеѓу GitLab и Pantheon и да го оптимизирате работниот тек на WordPress и Drupal.

Секако дека е можно, огледало на складиштето на GitLab, но ќе направиме се со наши раце да навлеземе во GitLab CI и во иднина користете ја оваа алатка не само за распоредување.

Вовед

За оваа објава, треба да разберете дека Пантеон ја разложува секоја локација на три елементи: код, база на податоци и датотеки.

Кодот вклучува CMS-датотеки како што се јадрото на WordPress, приклучоците и темите. Овие датотеки се управуваат во Git складишта, хостиран од Pantheon, што значи дека можеме да распоредиме код од GitLab во Pantheon со Git.
Датотеките во Пантеон се медиумски датотеки, односно слики за страницата. Обично тие се поставени од корисници и Git ги игнорира.

Направете бесплатна сметка, дознајте повеќе за Работен тек на Пантеон или пријавете се за демо на pantheon.io.

Претпоставки

Мојот проект за Pantheon и GitLab се вика pantheon-gitlab-blog-demo. Името на проектот мора да биде единствено. Овде ќе работиме со веб-страница на WordPress. Можете да земете Друпал, но ќе треба да промените некои работи.

ќе користам Командна линија Gitи можеш да работиш графички интерфејс, ако сакаш.

Направете проект

Прво, ајде да создадеме Проект GitLab (на ова ќе се вратиме подоцна).

сега креирање на веб-страница на WordPress на Пантеон. Потоа инсталираме WordPress за контролната табла на страницата.

Ако вашите раце ве чешаат за да промените нешто, на пример, отстранете или додадете додатоци, бидете трпеливи. Сајтот сè уште не е поврзан со GitLab и сакаме сите промени на кодот да поминат низ GitLab.

Откако ќе го инсталираме WordPress, вратете се на контролната табла на веб-страницата на Пантеон и сменете го режимот на развој во Git.

Почетно извршување на GitLab

Сега треба да го префрлите почетниот код на WordPress од страницата Pantheon во GitLab. За да го направите ова, локално го клонираме кодот од складиштето Git на страницата Pantheon, а потоа го испраќаме во складиштето GitLab.

За да биде полесно и побезбедно, додадете SSH клуч во Пантеон и нема да мораме да внесуваме лозинка секогаш кога ќе клонираме складиште на Pantheon Git. Во исто време веќе додадете SSH клуч во GitLab.

За да го направите ова, клонирајте ја веб-локацијата на Пантеон локално со копирање на командата од полето Clone with Git на контролната табла на веб-локацијата.

Ако ви треба помош, прочитајте ја документацијата започнување со Git for Pantheon.

Сега да се смениме git remote originда укаже на GitLab наместо на Pantheon. Тоа може да се направи командой git remote.

Ајде да одиме до проектот GitLab и да го копираме URL-то на складиштето од паѓачкото мени Clone на страницата со детали за проектот. Да ја избереме опцијата Clone with SSH, бидејќи веќе го конфигуриравме SSH клучот.

По дифолт git remote за локална копија од складиштето на кодови - origin. Ова може да се смени в git remote set-url origin [URL репозитория GitLab], каде наместо загради ја внесуваме вистинската URL адреса.

Конечно, започнуваме git push origin master --forceда го туркате кодот на WordPress од Pantheon до GitLab.

Опцијата –force е потребна само еднаш. Потоа во тимови git push нема да биде на GitLab.

Поставување ингеренции и променливи

Се сеќавате како додадовме SSH клуч локално за да се најавите на Pantheon и GitLab? SSH токенот може да се користи за овластување на GitLab и Pantheon.

GitLab има одлична документација. Ајде да видиме дел за клучеви SSH при користење на извршителот Docker во документот за користење SSH клучеви со GitLab CI/CD.

Сега ќе ги завршиме првите два чекори: Ајде да создадеме нов SSH пар клучеви локално со ssh-keygen и да го додадеме приватниот клуч како променлива на проектот.

Потоа ќе прашаме 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. Ги следиме упатствата во документот Пантеон на додавање на SSH клуч во Пантеон и направете го овој чекор.

Запомнете: приватниот SSH е во GitLab, отворениот SSH е во Пантеон.

Ајде да поставиме уште неколку променливи на околината. Првиот се вика PANTHEON_SITE. Неговата вредност е името на страницата Пантеон на вашата машина.

Името на машината е наведено на крајот од командата Clone with Git. Веќе ја клониравте локацијата локално, така што ова ќе биде името на директориумот на локалното складиште.

Следно, ајде да ја поставиме променливата на животната средина PANTHEON_GIT_URL. Ова е URL-адресата на складиштето Git за страницата Пантеон што веќе ја користевме.

Внесете само URL-адреса на складиштето SSH, без git clone и името на локацијата на машината на крајот.

Пју. Тоа е готово, сега можеме да ја завршиме нашата датотека .gitlab-ci.yml.

Создадете задача за распоредување

Она што првично ќе го правиме со GitLab CI е многу слично на она што го правевме со складиштата на Git во минатото. Но, овој пат, ајде да го додадеме складиштето Pantheon како втор далечински извор на Git, а потоа да го туркаме кодот од GitLab во Pantheon.

За да го направите ова, ајде да конфигурираме фаза deploy и задача deploy:dev, затоа што ќе се распоредиме во развојната средина на Пантеон. Добиената датотека .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 и ќе поднесе commit .gitlab-ci.yml во Пантеон. Ајде да погледнеме.

Испраќање нишки за барање за спојување до Пантеон

Овде ќе ја користиме мојата омилена функција Pantheon − мултидев, каде што можете да креирате дополнителни Pantheon околини за Git гранки на барање.

Пристапот до multidev е ограничен, така што овој дел може да се прескокне. Но, ако имате пристап, можете сериозно да ја зголемите продуктивноста со поставување на автоматско креирање на мултидев средини на Pantheon од барањата за спојување на GitLab.

Прво, ајде да направиме нова Git гранка локално користејќи git checkout -b multidev-support. Сега да промениме нешто повторно во .gitlab-ci.yml.

Сакам да го вклучам бројот на барањето за спојување во името на околината Pantheon. На пример, првото барање за спојување е mr-1, второ - mr-2 итн.

Барањето за спојување се менува, па затоа треба динамички да ги одредиме имињата на гранките на Пантеон. Лесно е на GitLab - само треба да го користите предефинирани променливи на животната средина.

Можеме да земеме $CI_MERGE_REQUEST_IIDза да го одредите бројот на барањето за спојување. Ајде да го примениме сето ова заедно со глобалните променливи на животната средина што ги наведовме претходно и да додадеме нова задача 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:
    # 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.

Види, нова тема е испратена до Пантеон. Но, ако одиме во делот multidev на контролната табла на страницата Pantheon, нема да ја видиме новата средина таму

Ајде да го погледнеме делот Git Branches.

Како резултат на тоа, нашата нишка mr-1 стигна до Пантеон. Ајде да создадеме средина од гранка mr-1.

Создадовме мултидев средина, сега да се вратиме на GitLab и да го погледнеме делот Операции > Околини. Ќе видиме записи за dev и mr-1.

Ова е затоа што додадовме запис environment Со име name и url во CI/CD задачи. Ако кликнеме на иконата за отворено опкружување, ќе бидеме однесени до URL-то на околината multidev на Пантеон.

Автоматизирајте го создавањето на multidev

Во принцип, можете да застанете тука и само запомнете да креирате мултидев средина за секое барање за спојување, но овој процес може да се автоматизира.

Пантеон има алатка за командна линија Терминус, каде што можете автоматски да работите со платформата. Терминус ви овозможува да креирате мултидев средини од командната линија - идеални за GitLab CI.

Ни треба ново барање за спојување за да го тестираме ова. Ајде да создадеме нова гранка користејќи git checkout -b auto-multidev-creation.

За да користите Terminus во задачите на GitLab CI/CD, потребен ви е машински токен за автентикација со Terminus и слика на контејнер со Terminus.

Создавање токен на машината Пантеон, зачувајте го на безбедно место и додајте го како глобална променлива на животната средина во GitLab со името PANTHEON_MACHINE_TOKEN.

Ако сте заборавиле како да додадете променливи на околината на GitLab, вратете се таму каде што дефиниравме PANTHEON_SITE.

Создавање Dockerfile со Terminus

Ако не користите Docker или не ви се допаѓаат датотеките Dockerfile, земете ја мојата слика registry.gitlab.com/ataylorme/pantheon-gitlab-blog-demo:latest и прескокнете го овој дел.

GitLab има регистар на контејнери, каде што можеме да изградиме и поставиме Dockerfile за нашиот проект. Ајде да создадеме Dockerfile со Terminus за да работиме со Pantheon.

Терминус е алатка за командна линија PHP, па да почнеме со сликата на PHP. Го инсталирам Terminus преку Composer, па ќе користам официјална слика на 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

Скриптата е во приватен директориум и не дозволува веб пристап до Пантеон. Имаме скрипта за нашата multidev логика. Ајде сега да го ажурираме делот 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 од УРЛ на регистарот до .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. Бидете трпеливи: multidev може да потрае неколку минути за да се создаде.

Потоа одиме да ја разгледаме листата на мултидев на Пантеон. О чудо! Multidev опкружување mr-2 веќе тука.

Заклучок

Мојот тим имаше многу позабавно кога почнавме да отвораме барања за спојување и автоматски да создаваме околини.

Со моќните алатки на GitLab и Pantheon, можете автоматски да го поврзете GitLab со Pantheon.

Бидејќи користиме GitLab CI/CD, нашиот работен тек ќе има простор да расте. Еве неколку идеи за да започнете:

• Додадете чекор за градење.
• Додадете автоматско тестирање.
• Додадете задача за да се осигурате дека стандардите за код се исполнети.
• Додај динамично безбедносно тестирање на апликациите.

Кажете ни што мислите за GitLab, Pantheon и автоматизацијата.

П.С Дали знаевте дека Терминус, алатката за командна линија на Пантеон, може да се прошири преку приклучоци?

Ние во Пантеон направивме добра работа на верзијата 2 од нашата приклучок за алатки за градење на терминал со поддршка на GitLab. Ако не сакате да се мачите со поставките за секој проект, пробајте го овој приклучок и помогнете ни да ја тестираме v2 бета верзијата. За тимот на Терминус build:project:create Потребен ви е само токен Pantheon и токен GitLab. Таа ќе распореди еден од примероците проекти со Composer и автоматско тестирање, ќе создаде нов проект во GitLab, нова страница на Пантеон, и ќе ги поврзе користејќи променливи на околината и клучеви SSH.

За авторот

Ендрју Тејлор создава алатки за програмери во Пантеон.

Извор: www.habr.com