
Naš gost, stvaratelj alata za programere iz Pantheon-a, govori o tome kako automatizovati WordPress isporuke pomoću GitLab CI/CD.
U Bavim se odnosima sa programerima, pa stalno tražim nove načine da pomognem programerima WordPress-a i Drupal-a da rešavaju probleme sa automatizacijom u radnim procesima. Zbog toga volim da eksperimentišem sa novim alatima i kombinujući ih kako bi rad bio efikasan.
Često vidim kako programeri pate sa jednim međuservisom.
Nije baš zabavno čekati svoj red da koristite međuservis ili slati klijentima URL sa oznakom: "Evo gde gledajte, a ovde nemojte da gledate".
– jedan od cool alata Pantheon-a – rešavaju ovaj problem jer se na zahtev mogu kreirati okruženja za Git grane. Svako multidev okruženje ima svoj URL i bazu podataka, tako da programeri mogu mirno raditi, proveravati kvalitet i dobijati odobrenje, a da se ne sapliću jedni o druge.
Ali u Pantheon-u nema alata za kontrolu verzija ili kontinuiranu integraciju i isporuku (CI/CD). Ipak, to je fleksibilna platforma sa kojom se može integrisati bilo koji alat.
Takođe, primetio sam da timovi koriste različite alate za razvoj i različite alate za isporuku.
Na primer, imaju različite alate za kontrolu verzija i CI/CD. Mora se mučiti i prebacivati između alata kako bi se uređivao kod i dijagnostikovali problemi.
Na ima potpuni set alata za razvoj: za kontrolu verzija, tikete, merge zahteve, najbolja CI/CD linija u klasi, registar kontejnera i sve to. Još nisam naišao na aplikacije koje imaju toliko toga za upravljanje radnim procesom razvoja.
Obožavam automatizaciju, tako da sam istražio kako da povežem Pantheon sa GitLab-om, da bi se promene u glavnoj grani na GitLab-u isporučivale u najozbiljnijem razvoju u Pantheon-u. Takođe, merge zahtevi na GitLab-u mogu kreirati i isporučivati kod u multidev okruženja u Pantheon-u.
U ovom vodiču ću pokazati kako postaviti konekciju između GitLab-a i Pantheon-a i optimizovati radni proces WordPress-a i Drupal-a.
Može se, naravno, , ali svi ćemo raditi ručno da istražimo i u budućnosti koristiti ovaj alat ne samo za isporuku.
Uvod
Za ovaj post treba razumjeti da Pantheon razdvaja svaku web stranicu na tri elementa: kod, bazu podataka i datoteke.
Kod obuhvata CMS datoteke, poput jezgra, dodataka i tema WordPressa. Ove datoteke se upravljaju u , smještenom na Pantheonu, što znači da možemo implementirati kod iz GitLaba u Pantheon putem Git-a.
Datoteke u Pantheonu nazivaju se medijskim datotekama, odnosno slikama za stranicu. Obično ih korisnici učitavaju, a Git ih ignorira.
, saznajte više o ili na pantheon.io.
Pretpostavke
Moj projekt na Pantheonu i GitLabu zove se pantheon-gitlab-blog-demo. Ime projekta mora biti jedinstveno. Ovdje ćemo raditi sa stranicom WordPress. Možete uzeti i Drupal, ali će biti potrebno napraviti neka podešavanja.
Ja ću koristiti , a vi možete raditi u , ako želite.
Kreiramo projekt
Za početak kreiramo (o tome ćemo se još vratiti).
Sada . Nakon toga instaliramo WordPress za nadzornu ploču stranice.
Ako vas vuče da nešto promijenite, na primjer, uklonite ili dodate dodatke, izdržite. Stranica još nije povezana s GitLabom, a želimo da sve promjene u kodu prolaze kroz GitLab.
Kada instaliramo WordPress, vraćamo se na nadzornu ploču stranice Pantheon i mijenjamo način razvoja na Git.
Početni commit na GitLabu
Sada je potrebno prebaciti početni kod WordPressa sa stranice Pantheon na GitLab. Da bismo to učinili, kloniramo kod iz Git repozitorija sa stranice Pantheon lokalno, a zatim ga šaljemo u GitLab repozitorij.
Da bismo bilo lakše i sigurnije, i nećemo svaki put unositi lozinku kada kloniramo Pantheon Git repozitorij. Usput ćemo već .
Da bismo to učinili, kloniramo stranicu Pantheon lokalno, kopirajući komandu iz polja Clone with Git na nadzornoj ploči stranice.
Ako je potrebna pomoć, pročitajte dokumentaciju .
Sada ćemo promijeniti git remote origin, kako bismo ukazali na GitLab umjesto Pantheona. To se može učiniti .
Prelazimo na GitLab projekt i kopiramo URL repozitorija iz padajuće liste Clone na stranici pojedinosti projekta. Odaberite opciju Clone with SSH, jer smo već postavili SSH ključ.
Podrazumijevano git remote za lokalnu kopiju repozitorija koda – origin. To se može promijeniti s git remote set-url origin [URL repozitorija GitLab], gdje umjesto zagrada unosimo stvarni URL.
Na kraju, pokrećemo git push origin master --force, kako bismo poslali kod WordPressa sa stranice Pantheon na GitLab.
Parametar –force se koristi samo jednom. Onda u komandama
git pushna GitLabu ga neće biti.
Podešavamo akreditive i varijable
Pamtite kako smo lokalno dodali SSH ključ za autentifikaciju na Pantheonu i GitLabu? SSH token se može koristiti za autentifikaciju na GitLabu i Pantheonu.
GitLab ima odličnu dokumentaciju. Pogledajmo .
Sada ćemo izvršiti prva dva koraka: napraviti novi par SSH ključeva lokalno sa ssh-keygen i dodati privatni ključ kao varijablu u projekat.
Potom ćemo postaviti SSH_PRIVATE_KEY kako u parametrima projekta.
Na trećem i četvrtom koraku napravimo fajl .gitlab-ci.yml sa ovim sadržajem:
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"Za sada nećemo komitovati fajl .gitlab-ci.yml, kasnije će biti potrebno dodati još nešto.
Sada izvršavamo peti korak i dodajemo otvoreni ključ koji smo stvorili u prvom koraku, servisima kojima treba pristup u radnom okruženju.
U našem slučaju želimo pristupiti Pantheonu iz GitLaba. Pratimo uputstva u dokumentu Pantheon o i izvodimo ovaj korak.
Pamtimo: privatni SSH – u GitLabu, javni – u Pantheonu.
Postavićemo još nekoliko varijabli okruženja. Prva se zove PANTHEON_SITE. Njena vrednost je ime Pantheon sajta na vašem računaru.
Ime na računaru je navedeno na kraju komande Clone with Git. Već ste lokalno klonirali sajt, tako da će to biti ime direktorijuma lokalnog repozitorijuma.
Zatim ćemo postaviti varijablu okruženja PANTHEON_GIT_URL. Ovo je URL repozitorijuma Git za Pantheon sajt koji smo već koristili.
Unosimo samo URL SSH repozitorijuma, bez
git clonei imena sajta na vašem računaru na kraju.
Uf. To smo završili, sada možemo dovršiti naš fajl .gitlab-ci.yml.
Pravimo zadatak za deploy
Ono što ćemo u početku raditi sa GitLab CI-jem je veoma slično onome što smo radili sa Git repozitorijumima ranije. Ali ovaj put ćemo dodati Pantheon repozitorijum kao drugi udaljeni Git izvor, a potom poslati kod iz GitLaba u Pantheon.
Za to ćemo postaviti deploy i deploy:dev, jer ćemo deployovati u razvojnog okruženja na Pantheonu. Kao rezultat, fajl .gitlab-ci.yml će izgledati ovako:
faze:
- implementacija
before_script:
# Pogledajte 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"
implementacija:dev:
faza: implementacija
okruženje:
ime: dev
url: https://dev-$PANTHEON_SITE.pantheonsite.io/
skripta:
- git remote add pantheon $PANTHEON_GIT_URL
- git push pantheon master --force
samo:
- masterVarijable SSH_PRIVATE_KEY, PANTHEON_SITE i PANTHEON_GIT_URL mora izgledati poznato — prethodno smo postavili ove varijable okruženja. Sa ovim varijablama možemo koristiti vrednosti u datoteci .gitlab-ci.yml više puta, a ažurirati ih treba samo na jednom mestu.
Na kraju, dodajemo, komitujemo i šaljemo datoteku .gitlab-ci.yml na GitLab.
Proveravamo implementaciju
Ako smo sve uradili ispravno, zadatak deploy:dev će se uspešno izvršiti u GitLab CI/CD i poslati komit .gitlab-ci.yml u Pantheon. Pogledajmo.
Šaljemo grane merge zahteva u Pantheon
Ovde ćemo koristiti moju omiljenu funkciju Pantheon — , gde možemo na zahtev kreirati dodatna okruženja Pantheon za grane Git.
, tako da ovaj deo nije potrebno izvoditi. Ali ako imate pristup, možete značajno povećati produktivnost podešavanjem automatskog kreiranja multidev okruženja na Pantheon-u iz merge zahteva GitLab-a.
Prvo ćemo lokalno napraviti novu granu Git koristeći git checkout -b multidev-support. Sada ponovo malo menjamo u .gitlab-ci.yml.
Sviđa mi se da u nazivu okruženja Pantheon navedem broj merge zahteva. Na primer, prvi merge zahtev — mr-1, drugi — mr-2 i tako dalje.
Merge zahtev se menja, tako da moramo dinamički odrediti nazive grana Pantheon. Na GitLab-u je to lako — potrebno je koristiti .
Možemo uzeti $CI_MERGE_REQUEST_IID, da odredimo broj merge zahteva. Pogledajmo kako ćemo to sve zajedno primeniti sa globalnim varijablama okruženja koje smo ranije naveli, i dodajmo novu zadatak deploy:multidev na kraju datoteke .gitlab-ci.yml.
deploy:multidev:
faza: implementacija
okruženje:
ime: multidev/mr-$CI_MERGE_REQUEST_IID
url: https://mr-$CI_MERGE_REQUEST_IID-$PANTHEON_SITE.pantheonsite.io/
skripta:
# Preuzimanje izvorne grane merge zahteva
- git checkout $CI_COMMIT_REF_NAME
# Dodaj Pantheon git repozitorijum kao dodatni remote
- git remote add pantheon $PANTHEON_GIT_URL
# Push izvorne grane merge zahteva u Pantheon
- git push pantheon $CI_COMMIT_REF_NAME:mr-$CI_MERGE_REQUEST_IID --force
samo:
- merge_requestsBiće slično našem zadatku deploy:dev, samo što se grana šalje u Pantheon, a ne u master.
Dodali smo i komitovali ažuriranu datoteku .gitlab-ci.yml, a sada ćemo poslati novu granu u GitLab sa git push -u origin multidev-support.
Sada ćemo kreirati novu merge request iz grane multidev-support, pritiskom na Kreiraj merge request.
Kreiravši merge request, gledamo kako se izvršava CI/CD zadatak deploy:multidev.
Pogledajte — nova grana je poslata u Pantheon. No, ako pređemo na odjeljak multidev na kontrolnoj ploči sajta na Pantheonu, nećemo vidjeti novu instancu
Pogledajmo odjeljak Git Branches.
Na kraju, naša grana mr-1 je stigla do Pantheona. Kreirajmo instancu iz grane mr-1.
Kreirali smo multidev instancu, a sada se vraćamo u GitLab i gledamo odjeljak Operation > Environments. Vidjet ćemo zapise za dev i mr-1.
To je zato što smo dodali zapis okruženje s imenom name i url u CI/CD zadacima. Ako pritisnemo ikonu otvorene instance, preći ćemo na URL multidev instance na Pantheonu.
Automatizirajmo kreiranje multidev
U zasad, ovdje možemo stati i samo se sjetiti da kreiramo multidev instancu za svaki merge request, ali ovaj proces se može automatizovati.
U Pantheonu postoji alat komandne linije , gdje možemo automatski raditi s platformom. U Terminusu možemo kreirati multidev instance iz komandne linije — savršeno za .
Trebamo novi merge request da to testiramo. Kreirajmo novu granu pomoću git checkout -b auto-multidev-creation.
Da bismo koristili Terminus u GitLab CI/CD zadacima, treba nam mašinski token za autentifikaciju u Terminusu i slika kontejnera s Terminusom.
, čuvamo ga na sigurnom mjestu i dodajemo kao globalnu varijablu okruženja u GitLab pod imenom PANTHEON_MACHINE_TOKEN.
Ako ste zaboravili kako dodati varijable okruženja u GitLab, vratite se tamo gdje smo definisali
PANTHEON_SITE.
Kreiramo Dockerfile s Terminusom
Ako ne koristite Docker ili ne volite fajlove Dockerfile, uzmite moju sliku registry.gitlab.com/ataylorme/pantheon-gitlab-blog-demo:latest i preskočite ovaj odjeljak.
, gdje možemo sastaviti i hostovati Dockerfile za naš projekat. Kreirajmo Dockerfile s Terminusom kako bismo radili s Pantheonom.
Terminus je alat komandne linije na PHP-u, pa počinjemo s PHP slikom. Instaliram Terminus putem Composer-a, tako da ću uzeti . Kreiramo Dockerfile u lokalnom repozitoriju s ovim sadržajem:
# 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"Slijedimo upute za izradu i slanje slika iz odjeljka Build and push images u , da bismo sastavili sliku iz Dockerfile i poslali je u GitLab.
Otvorite odjeljak Registry u GitLab projektu. Ako je sve prošlo prema planu, tamo će biti naša slika. Zapišite link na tag slike — trebat će nam za fajl .gitlab-ci.yml.
Particija script u zadatku deploy:multidev počinje rasti, pa hajde da ga prebacimo u zaseban fajl. Kreiramo novu datoteku 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..."
fiSkripta se nalazi u privatnom direktorijumu i . Imamo skriptu za našu logiku multidev. Sada ažurirajmo deo deploy:multidev datoteke .gitlab-ci.yml, da izgleda ovako:
deploy:multidev:
stage: deploy
environment:
name: multidev/mr-$CI_MERGE_REQUEST_IID
url: https://mr-$CI_MERGE_REQUEST_IID-$PANTHEON_SITE.pantheonsite.io/
script:
# Pokreni multidev deploy skriptu
- "/bin/bash ./private/multidev-deploy.sh"
only:
- merge_requestsMoramo se pobrinuti da naše zadatke izvršavamo u kreiranom prilagođenom imidžu, pa dodajmo definiciju image sa URL-om registara u .gitlab-ci.yml. Na kraju imamo takvu datoteku .gitlab-ci.yml:
image: registry.gitlab.com/ataylorme/pantheon-gitlab-blog-demo:latest
stages:
- deploy
before_script:
# Vidi 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:
# Pokreni multidev deploy skriptu
- "/bin/bash ./private/multidev-deploy.sh"
only:
- merge_requestsDodajemo, commitujemo i šaljemo private/multidev-deploy.sh i .gitlab-ci.yml. Sada se vraćamo u GitLab i čekamo da se CI/CD zadatak izvrši. Imajte strpljenja: multidev može biti kreiran nekoliko minuta.
Zatim idemo da pogledamo listu multidev na Pantheon. O čudo! Multidev okruženje mr-2 već je ovde.
Zaključak
Moj tim je radio mnogo veselije kada smo počeli da otvaramo merge requestove i automatski kreiramo okruženja.
Sa moćnim alatima GitLab-a i Pantheona, moguće je automatski povezati GitLab s Pantheonom.
Pošto koristimo GitLab CI/CD, naš radni proces će rasti. Evo nekoliko ideja da počnemo:
- Dodajte korak izgradnje.
- Dodajte automatizovane testove.
- Dodajte zadatak da obezbedite usklađenost sa standardima koda.
- Dodajte .
Napišite šta mislite o GitLab-u, Pantheonu i automatizaciji.
P.S. Da li ste znali da se Terminus, alat komandne linije Pantheon, ?
Mi u Pantheon-u smo marljivo radili na verziji 2 našeg sa podrškom za GitLab. Ako ne želite da se mučite s podešavanjem za svaki projekat, isprobajte ovu ekstenziju i pomozite nam da testiramo beta verziju v2. Za tim Terminus build:project:create potreban je samo Pantheon token i GitLab token. Razvešće jedan od primeraka projekta s Composer-om i automatskim testiranjem, kreiraće novi projekat u GitLab-u, novu lokaciju na Pantheon-u, i povezaće ih uz pomoć promenljivih okruženja i SSH ključeva.
O autoru
Endru Tejlor (Andrew Taylor) razvija alate za programere u .
Izvor: habr.com
