So verbinden Sie GitLab und Pantheon und optimieren Drupal- und WordPress-Workflows

Unser Gast, Entwicklertools-Ersteller von Pantheon, erklärt, wie man WordPress-Bereitstellungen mit GitLab CI/CD automatisiert.

В Pantheon Ich bin in der Entwicklerbeziehung tätig und suche daher immer nach neuen Möglichkeiten, WordPress- und Drupal-Entwicklern bei der Lösung von Problemen bei der Workflow-Automatisierung zu helfen. Dazu experimentiere ich gerne mit neuen Tools und kombiniere sie miteinander, um effektiv zu arbeiten.

Ich sehe oft, dass Entwickler Probleme mit einem einzelnen Staging-Server haben.

So lala macht es Spaß – darauf zu warten, dass Sie an der Reihe sind, einen Zwischenserver zu nutzen, oder den Clients eine URL mit der Aufschrift „Schauen Sie hier, aber schauen Sie noch nicht hier“ zu senden.

Multidev-Umgebungen - eines der coolen Pantheon-Tools - lösen dieses Problem, denn mit ihnen können Sie bei Bedarf Umgebungen für Git-Zweige erstellen. Jede Multidev-Umgebung verfügt über eine eigene URL und Datenbank, sodass Entwickler arbeiten, die Qualität überprüfen und Genehmigungen einholen können, ohne sich gegenseitig auf die Fersen zu treten.

Pantheon verfügt jedoch nicht über Tools zur Versionskontrolle oder kontinuierlichen Integration und Bereitstellung (CI/CD). Aber es ist eine flexible Plattform, mit der Sie beliebige Tools integrieren können.

Mir ist auch aufgefallen, dass Teams einige Tools für die Entwicklung und andere für die Erstellung und Bereitstellung verwenden.

Sie verfügen beispielsweise über verschiedene Tools für Versionskontrolle und CI/CD. Sie müssen herumspielen und zwischen Tools wechseln, um Code zu bearbeiten und Probleme zu diagnostizieren.

Auf Gitlab Es gibt einen kompletten Satz an Entwicklungstools: Versionskontrolle, Tickets, Zusammenführungsanfragen, erstklassige CI/CD-Pipeline, Container-Registrierung und ähnliches. Ich habe noch keine Anwendung gefunden, die so viel für die Verwaltung des Entwicklungsworkflows bietet.

Ich liebe Automatisierung, deshalb habe ich gelernt, wie man Pantheon mit GitLab verbindet, sodass Commits für den Master-Zweig auf GitLab in der Master-Entwicklungsumgebung in Pantheon bereitgestellt werden. GitLab-Merge-Anfragen können auch Code erstellen und in Multidev-Umgebungen im Pantheon bereitstellen.

In dieser Anleitung zeige ich Ihnen, wie Sie eine Verbindung zwischen GitLab und Pantheon einrichten und Ihren WordPress- und Drupal-Workflow optimieren.

Natürlich ist es möglich, Spiegeln Sie ein GitLab-Repository, aber wir werden alles mit Stiften tun, in die wir uns vertiefen können GitLab-CI und dieses Tool in Zukunft nicht nur für die Bereitstellung nutzen.

Einführung

Für diesen Beitrag müssen Sie verstehen, dass Pantheon jede Site in drei Elemente unterteilt: Code, Datenbank und Dateien.

Der Code umfasst CMS-Dateien wie Core, Plugins und WordPress-Themes. Diese Dateien werden verwaltet von Git-Repositorysgehostet von Pantheon, was bedeutet, dass wir mit Git Code von GitLab in Pantheon bereitstellen können.
Dateien im Pantheon werden Mediendateien genannt, also Bilder für die Site. Sie werden normalerweise von Benutzern hochgeladen und Git ignoriert sie.

Erstelle einen kostenlosen Account, Lerne mehr über Pantheon-Workflow oder Melden Sie sich für eine Demo an auf pantheon.io.

Annahmen

Mein Pantheon- und GitLab-Projekt heißt pantheon-gitlab-blog-demo. Der Projektname muss eindeutig sein. Hier werden wir mit einer WordPress-Site arbeiten. Sie können Drupal verwenden, aber Sie müssen etwas ändern.

ich werde benützen Git-Befehlszeileund du kannst darin arbeiten GUI, wenn Sie wollen.

Erstellen Sie ein Projekt

Zunächst erstellen wir GitLab-Projekt (wir werden später darauf zurückkommen).

Jetzt Erstellen einer WordPress-Site auf Pantheon. Anschließend installieren Sie WordPress für das Dashboard der Site.

Wenn Sie Lust darauf haben, etwas zu ändern, zum Beispiel Plugins zu entfernen und hinzuzufügen, haben Sie etwas Geduld. Die Site ist noch nicht mit GitLab verbunden und wir möchten, dass alle Codeänderungen über GitLab erfolgen.

Sobald WordPress installiert ist, kehren Sie zum Pantheon-Dashboard zurück und ändern Sie den Entwicklungsmodus auf Git.

Erster Commit auf GitLab

Jetzt müssen Sie den ursprünglichen WordPress-Code von der Pantheon-Site nach GitLab übertragen. Dazu klonen wir den Code lokal aus dem Git-Repository der Pantheon-Site und senden ihn dann an das GitLab-Repository.

Um es einfacher und sicherer zu machen, SSH-Schlüssel zu Pantheon hinzufügen und wir werden das Passwort nicht jedes Mal eingeben, wenn wir das Pantheon-Git-Repository klonen. Gleichzeitig schon Fügen Sie den SSH-Schlüssel zu GitLab hinzu.

Dazu klonen wir die Pantheon-Site lokal, indem wir den Befehl aus dem Feld „Mit Git klonen“ im Site-Dashboard kopieren.

Wenn Sie Hilfe benötigen, lesen Sie die Dokumentation Erste Schritte mit Git für Pantheon.

Jetzt lasst uns etwas ändern git remote originum auf GitLab statt auf Pantheon zu verweisen. Es ist machbar командой git remote.

Gehen wir zum GitLab-Projekt und kopieren Sie die Repository-URL aus der Dropdown-Liste „Klonen“ auf der Seite mit den Projektdetails. Wählen wir die Option „Mit SSH klonen“, da wir den SSH-Schlüssel bereits konfiguriert haben.

Standardmäßig git remote für eine lokale Kopie des Code-Repositorys − origin. Dies kann von geändert werden git remote set-url origin [URL репозитория GitLab], wobei wir anstelle von Klammern die tatsächliche URL eingeben.

Endlich starten wir git push origin master --forceum den WordPress-Code von der Pantheon-Site an GitLab zu übertragen.

Die Option --force wird nur einmal benötigt. Dann in Teams git push GitLab wird es nicht haben.

Anmeldeinformationen und Variablen einrichten

Erinnern Sie sich, wie wir lokal einen SSH-Schlüssel hinzugefügt haben, um uns bei Pantheon und GitLab anzumelden? Mit dem SSH-Token können GitLab und Pantheon autorisiert werden.

GitLab verfügt über eine großartige Dokumentation. Mal sehen Weitere Informationen finden Sie im Abschnitt zu SSH-Schlüsseln bei Verwendung des Docker-Executors im Dokument zur Verwendung von SSH-Schlüsseln mit GitLab CI/CD.

Wir werden nun die ersten beiden Schritte abschließen: Erstellen Sie lokal mit ssh-keygen ein neues SSH-Schlüsselpaar und fügen Sie den privaten Schlüssel als Variable zum Projekt hinzu.

Dann legen wir fest SSH_PRIVATE_KEY als GitLab CI/CD-Umgebungsvariable in den Projekteinstellungen.
Im dritten und vierten Schritt erstellen wir eine Datei .gitlab-ci.yml mit Inhalten wie diesem:

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"

Bis wir die Datei festschreiben .gitlab-ci.yml, dann müssen Sie noch etwas hinzufügen.

Machen Sie nun den fünften Schritt und Fügen Sie den öffentlichen Schlüssel, den Sie im ersten Schritt erstellt haben, zu den Diensten hinzu, auf die Sie in der Build-Umgebung Zugriff benötigen.

In unserem Fall möchten wir über GitLab auf Pantheon zugreifen. Befolgen Sie die Anweisungen im Pantheon-Dokument auf Hinzufügen eines SSH-Schlüssels zu Pantheon und führen Sie diesen Schritt aus.

Denken Sie daran: Geschlossenes SSH befindet sich in GitLab, offenes SSH befindet sich in Pantheon.

Lassen Sie uns noch ein paar Umgebungsvariablen einrichten. Die erste heißt PANTHEON_SITE. Sein Wert ist der Name der Pantheon-Site auf Ihrem Computer.

Der Name der Maschine wird am Ende des Befehls „Mit Git klonen“ aufgeführt. Sie haben die Site bereits lokal geklont, daher ist dies der Verzeichnisname des lokalen Repositorys.

Als nächstes legen Sie die Umgebungsvariable fest PANTHEON_GIT_URL. Dies ist die URL des Git-Repositorys für die Pantheon-Site, die wir bereits verwendet haben.

Wir geben nur die URL des SSH-Repositorys ein, ohne git clone und am Ende den Namen der Site auf dem Computer.

Puh. Das ist erledigt, jetzt können wir unsere Datei fertigstellen .gitlab-ci.yml.

Erstellen Sie eine Bereitstellungsaufgabe

Was wir zunächst mit GitLab CI machen werden, ist dem, was wir in der Vergangenheit mit Git-Repositories gemacht haben, sehr ähnlich. Aber dieses Mal fügen wir das Pantheon-Repository als zweite Git-Remote-Quelle hinzu und übertragen dann den Code von GitLab an Pantheon.

Stellen Sie dazu ein Bühne deploy и Aufgabe deploy:dev, weil wir die Bereitstellung in der Entwicklungsumgebung auf Pantheon durchführen werden. Als Ergebnis die Datei .gitlab-ci.yml wird wie folgt aussehen:

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

Variablen SSH_PRIVATE_KEY, PANTHEON_SITE и PANTHEON_GIT_URL sollte Ihnen bekannt vorkommen – wir haben diese Umgebungsvariablen zuvor eingerichtet. Mit diesen Variablen können wir die Werte in der Datei verwenden .gitlab-ci.yml viele Male, und Sie müssen sie nur an einer Stelle aktualisieren.

Zum Schluss fügen Sie die Datei hinzu, übernehmen sie und übertragen sie per Push .gitlab-ci.yml auf Gitlab.

Überprüfung der Bereitstellung

Wenn wir alles richtig gemacht haben, ist die Aufgabe deploy:dev wird erfolgreich in GitLab CI/CD ausgeführt und das Commit gepusht .gitlab-ci.yml im Pantheon. Werfen wir einen Blick darauf.

Übermittlung von Zusammenführungsanforderungszweigen an Pantheon

Hier verwenden wir meine Lieblings-Pantheon-Funktion − MultidevHier können Sie auf Anfrage weitere Pantheon-Umgebungen für Git-Zweige erstellen.

Der Zugriff auf Multidev ist begrenzt, daher kann dieser Abschnitt weggelassen werden. Wenn Sie jedoch Zugriff haben, können Sie die Leistung erheblich verbessern, indem Sie die automatische Erstellung von Multidev-Umgebungen auf Pantheon aus GitLab-Merge-Anfragen einrichten.

Zuerst erstellen wir lokal einen neuen Git-Zweig mit git checkout -b multidev-support. Jetzt lasst uns etwas ändern .gitlab-ci.yml.

Ich füge die Zusammenführungsanforderungsnummer gerne in den Pantheon-Umgebungsnamen ein. Beispielsweise lautet die erste Zusammenführungsanforderung mr-1, zweite - mr-2 usw.

Die Zusammenführungsanforderung ändert sich, daher müssen wir die Namen der Pantheon-Zweige dynamisch ermitteln. Auf GitLab ist es ganz einfach – Sie müssen es verwenden vordefinierte Umgebungsvariablen.

Wir können nehmen $CI_MERGE_REQUEST_IIDum die Zusammenführungsanforderungsnummer anzugeben. Wenden wir dies alles zusammen mit den zuvor angegebenen globalen Umgebungsvariablen an und fügen am Ende der Datei eine neue Aufgabe „deploy:multidev“ hinzu .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

Es wird unserer Aufgabe ähnlich sein deploy:dev, nur der Zweig geht zum Pantheon, nicht zum master.

Wir haben die aktualisierte Datei hinzugefügt und festgeschrieben .gitlab-ci.yml, und pushen Sie nun mit einen neuen Zweig zu GitLab git push -u origin multidev-support.

Lassen Sie uns nun eine neue Zusammenführungsanforderung aus der Verzweigung erstellen multidev-supportdurch Drücken Zusammenführungsanfrage erstellen.

Nachdem wir eine Zusammenführungsanforderung erstellt haben, schauen wir uns an, wie die CI/CD-Aufgabe ausgeführt wird deploy:multidev.

Schauen Sie – ein neuer Zweig wurde zum Pantheon geschickt. Wenn wir jedoch zum Abschnitt „Multidev“ im Pantheon-Site-Dashboard gehen, sehen wir die neue Umgebung dort nicht

Werfen wir einen Blick auf den Abschnitt Git Branches.

Infolgedessen unsere Filiale mr-1 schaffte es zum Pantheon. Erstellen Sie eine Umgebung aus einem Zweig mr-1.

Wir haben eine Multidev-Umgebung erstellt. Gehen wir nun zurück zu GitLab und werfen einen Blick auf den Abschnitt Operationen > Umgebungen. Wir werden Einträge für sehen dev и mr-1.

Dies liegt daran, dass wir einen Eintrag hinzugefügt haben environment Mit Namen name и url in CI/CD-Aufgaben. Wenn wir auf das Symbol für die offene Umgebung klicken, navigieren wir zur URL der Multidev-Umgebung auf Pantheon.

Automatisieren Sie die Erstellung von Multidev

Im Prinzip können Sie hier aufhören und daran denken, für jede Zusammenführungsanforderung eine Multidev-Umgebung zu erstellen, aber dieser Prozess kann automatisiert werden.

Pantheon verfügt über ein Befehlszeilentool Endstationwo Sie automatisch mit der Plattform arbeiten können. Mit Terminus können Sie Multidev-Umgebungen über die Befehlszeile erstellen – perfekt für GitLab-CI.

Um dies zu testen, benötigen wir eine neue Zusammenführungsanforderung. Erstellen Sie einen neuen Zweig mit git checkout -b auto-multidev-creation.

Um Terminus in GitLab CI/CD-Aufgaben verwenden zu können, benötigen Sie ein Maschinentoken zur Authentifizierung bei Terminus und ein Terminus-Container-Image.

Erstellen eines Pantheon-Maschinen-Tokens, speichern Sie es an einem sicheren Ort und fügen Sie es als globale Umgebungsvariable in GitLab mit dem Namen hinzu PANTHEON_MACHINE_TOKEN.

Wenn Sie vergessen haben, wie Sie GitLab-Umgebungsvariablen hinzufügen, kehren Sie zu der von uns definierten Stelle zurück PANTHEON_SITE.

Erstellen Sie eine Docker-Datei mit Terminus

Wenn Sie Docker nicht verwenden oder Dateien nicht mögen DockerfileNimm mein Bild registry.gitlab.com/ataylorme/pantheon-gitlab-blog-demo:latest und überspringen Sie diesen Abschnitt.

GitLab verfügt über eine Container-Registrierung, wo wir eine Docker-Datei für unser Projekt erstellen und hosten können. Lassen Sie uns mit Terminus eine Docker-Datei erstellen, um mit Pantheon zu arbeiten.

Terminus ist ein PHP-Befehlszeilentool. Beginnen wir also mit dem PHP-Image. Ich installiere Terminus über Composer, also werde ich es verwenden offizielles Docker Composer-Image. Wir erstellen Dockerfile im lokalen Repository-Verzeichnis mit folgendem Inhalt:

# 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"

Befolgen Sie die Anweisungen zum Erstellen und Senden von Bildern im Abschnitt Erstellen und pushen Sie Bilder в Dokumentation zur Containerregistrierungein Bild daraus zusammensetzen Dockerfile und senden Sie es an GitLab.

Abschnitt öffnen Registratur im GitLab-Projekt. Wenn alles nach Plan läuft, wird unser Image da sein. Notieren Sie sich einen Link zum Bild-Tag – wir benötigen ihn für die Datei .gitlab-ci.yml.

Abschnitt script in der Aufgabe deploy:multidev beginnt zu wachsen, also verschieben wir es in eine separate Datei. Erstellen Sie eine neue Datei 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

Das Skript befindet sich in einem privaten Verzeichnis und erlaubt keinen Webzugriff auf Pantheon. Wir haben ein Skript für unsere Multidev-Logik. Lassen Sie uns den Abschnitt jetzt aktualisieren deploy:multidev Datei .gitlab-ci.ymldamit es so aussieht:

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

Wir müssen sicherstellen, dass unsere Aufgaben im erstellten benutzerdefinierten Image ausgeführt werden. Fügen wir also eine Definition hinzu image mit Registrierungs-URL in .gitlab-ci.yml. Als Ergebnis haben wir eine solche Datei .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

Hinzufügen, Commit und Senden private/multidev-deploy.sh и .gitlab-ci.yml. Jetzt kehren wir zu GitLab zurück und warten, bis die CI/CD-Aufgabe abgeschlossen ist. Seien Sie geduldig: Die Erstellung von Multidev kann mehrere Minuten dauern.

Dann schauen wir uns die Multidev-Liste auf Pantheon an. O Wunder! Multidev-Umgebung mr-2 schon da.

Abschluss

Mein Team hatte viel mehr Spaß, als wir anfingen, Zusammenführungsanfragen zu öffnen und Umgebungen automatisch zu erstellen.

Mit den leistungsstarken Tools von GitLab und Pantheon können Sie GitLab automatisch mit Pantheon verbinden.

Da wir GitLab CI/CD verwenden, wird unser Workflow Raum für Erweiterungen haben. Hier sind ein paar Ideen, um Ihnen den Einstieg zu erleichtern:

• Fügen Sie einen Build-Schritt hinzu.
• Fügen Sie automatisierte Tests hinzu.
• Fügen Sie eine Aufgabe hinzu, um sicherzustellen, dass Codestandards eingehalten werden.
• hinzufügen Dynamische Anwendungssicherheitstests.

Schreiben Sie, was Sie über GitLab, Pantheon und Automatisierung denken.

PS Wussten Sie, dass Terminus, das Befehlszeilentool von Pantheon, über Plugins erweiterbar?

Wir von Pantheon haben bei Version 2 unserer Version gute Arbeit geleistet Plugin für Terminus-Build-Tools mit GitLab-Unterstützung. Wenn Sie sich nicht mit der Einrichtung pro Projekt herumschlagen möchten, probieren Sie dieses Plugin aus und helfen Sie uns beim Testen der v2-Beta. Für das Terminus-Team build:project:create Sie benötigen lediglich einen Pantheon-Token und einen GitLab-Token. Es wird eines der Beispielprojekte mit Composer und automatisierten Tests bereitstellen, ein neues Projekt in GitLab, einer neuen Pantheon-Site, erstellen und diese mithilfe von Umgebungsvariablen und SSH-Schlüsseln verbinden.

Über den Autor

Andrew Taylor erstellt Tools für Entwickler in Pantheon.

Source: habr.com