GitLab と Pantheon を接続し、Drupal と WordPress のワークフローを最適化する方法

Pantheon のゲスト開発者ツール作成者が、GitLab CI/CD を使用して WordPress デプロイメントを自動化する方法について語ります。

В パンテオン 私は開発者関係の仕事をしているので、WordPress や Drupal の開発者がワークフロー内の自動化の問題を解決できるよう支援する新しい方法を常に探しています。 そのために、私は新しいツールを試し、それらを組み合わせて効果的に機能させるのが好きです。

開発者が単一のステージング サーバーで苦労しているのをよく見かけます。

中間サーバーを使用する順番を待つか、「ここを見てください。ただし、まだここは見ていないでください」という注記を含む URL をクライアントに送信するのは、とても楽しいことです。

マルチ開発環境 Pantheon の優れたツールの XNUMX つであるこの問題は、オンデマンドで Git ブランチの環境を作成できるため、解決されます。 各マルチ開発環境には独自の URL とデータベースがあるため、開発者はお互いに足踏みすることなく静かに作業し、品質をチェックし、承認を得ることができます。

しかし、Pantheon にはバージョン管理や継続的インテグレーションとデプロイ (CI/CD) のためのツールがありません。 ただし、これはあらゆるツールを統合できる柔軟なプラットフォームです。

また、チームが開発には特定のツールを使用し、アセンブリと展開には別のツールを使用していることにも気づきました。

たとえば、バージョン管理と CI/CD 用にさまざまなツールがあります。 コードを編集して問題を診断するには、ツールをいじったり切り替えたりする必要があります。

На GitLab バージョン管理、チケット、マージリクエスト、クラス最高の CI/CD パイプライン、コンテナー レジストリなど、あらゆる開発ツールのフルセットがあります。 開発ワークフローの管理にこれほど多くの機能を提供するアプリケーションにはまだ出会っていません。

私は自動化が大好きなので、Pantheon を GitLab に接続して、GitLab のメイン ブランチへのコミットが Pantheon のメイン開発環境にデプロイされるようにする方法を学びました。 また、GitLab のマージ リクエストにより、コードを作成して Pantheon のマルチ開発環境にデプロイできます。

このチュートリアルでは、GitLab と Pantheon 間の接続を設定し、WordPress と Drupal のワークフローを最適化する方法を説明します。

もちろんそれは可能ですが、 GitLab リポジトリをミラーリングする、でも私たちはすべてを自分の手で掘り下げていきます。 GitLab CI そして将来的には、このツールを展開だけでなく使用する予定です。

導入

この記事では、Pantheon が各サイトをコード、データベース、ファイルの XNUMX つの要素に分割していることを理解する必要があります。

コードには、WordPress コア、プラグイン、テーマなどの CMS ファイルが含まれています。 これらのファイルは次の場所で管理されます Gitリポジトリ、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 Web サイトのダッシュボードに戻り、開発モードを Git に変更します。

GitLab での最初のコミット

次に、初期の WordPress コードを Pantheon サイトから GitLab に転送する必要があります。 これを行うには、Pantheon サイトの Git リポジトリからローカルにコードのクローンを作成し、それを GitLab リポジトリに送信します。

より簡単かつ安全にご利用いただくために、 Pantheon に SSH キーを追加する また、Pantheon Git リポジトリのクローンを作成するたびにパスワードを入力する必要がなくなります。 同時にすでに SSH キーを GitLab に追加する.

これを行うには、サイト ダッシュボードの [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 オプションは XNUMX 回だけ必要です。 それからチームで git push GitLab には存在しません。

資格情報と変数のセットアップ

Pantheon と GitLab にログインするためにローカルで SSH キーを追加した方法を覚えていますか? SSH トークンは、GitLab と Pantheon を認証するために使用できます。

GitLab には優れたドキュメントがあります。 見てみましょう GitLab CI/CD での SSH キーの使用に関するドキュメントの Docker executor を使用する場合の SSH キーに関するセクション.

ここで最初の XNUMX つのステップを完了します。 ssh-keygen を使用してローカルに新しい SSH キー ペアを作成し、秘密キーを変数としてプロジェクトに追加しましょう.

それではお尋ねします SSH_PRIVATE_KEY 方法 GitLab CI/CD 環境変数 プロジェクト設定で。
XNUMX 番目と XNUMX 番目のステップでは、ファイルを作成します .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, その場合は、それに何か他のものを追加する必要があります。

ここで XNUMX 番目のステップを実行し、 最初のステップで作成した公開キーを、ビルド環境でアクセスする必要があるサービスに追加します。.

私たちの場合は、GitLab から Pantheon にアクセスしたいと考えています。 パンテオンの文書の指示に従います。 SSH キーを Pantheon に追加する そしてこのステップを実行します。

覚えておいてください: プライベート SSH は GitLab にあり、オープン SSH は Pantheon にあります。

さらにいくつかの環境変数を設定してみましょう。 最初のものは PANTHEON_SITE と呼ばれます。 その値は、マシン上の Pantheon サイトの名前です。

マシン上の名前は、Clone with Git コマンドの最後にリストされます。 すでにサイトのクローンをローカルに作成しているため、これがローカル リポジトリ ディレクトリの名前になります。

次に、環境変数を設定しましょう PANTHEON_GIT_URL。 これは、すでに使用している Pantheon サイトの Git リポジトリ URL です。

SSH リポジトリ URL のみを入力します。 git clone 最後にマシン上のサイトの名前が表示されます。

ふー。 これでファイルを完成させることができます .gitlab-ci.yml.

デプロイメントタスクを作成する

最初に GitLab CI で行うことは、過去に Git リポジトリで行ったことと非常に似ています。 ただし、今回は、Pantheon リポジトリを XNUMX 番目のリモート 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 何度も更新する必要があるのは XNUMX か所だけです。

最後に、ファイルを追加、コミット、送信します .gitlab-ci.yml GitLab 上で。

展開を確認す​​る

すべてを正しく実行した場合、タスクは deploy:dev GitLab CI/CD で正常に実行され、コミットが送信されます .gitlab-ci.yml パンテオンで。 見てみましょう。

マージ リクエスト スレッドを Pantheon に送信する

ここでは、私のお気に入りの Pantheon 機能を使用します- マルチ開発, ここでは、オンデマンドで Git ブランチ用の追加の Pantheon 環境を作成できます。

multidev へのアクセスは制限されています, したがって、このセクションはスキップできます。 ただし、アクセス権がある場合は、GitLab マージ リクエストから Pantheon 上でマルチ開発環境の自動作成を設定することで、生産性を大幅に向上させることができます。

まず、次を使用してローカルに新しい Git ブランチを作成しましょう git checkout -b multidev-support。 では、もう一度何かを変更してみましょう .gitlab-ci.yml.

私は Pantheon 環境名にマージ リクエスト番号を含めることを好みます。 たとえば、最初のマージ リクエストは次のようになります。 mr-1、 XNUMX番 - mr-2 等

マージ リクエストは変化するため、Pantheon ブランチ名を動的に決定する必要があります。 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.

新しいスレッドがパンテオンに送信されました。 ただし、Pantheon サイトのダッシュボードの multidev セクションに移動しても、そこに新しい環境は表示されません。

Git ブランチセクションを見てみましょう。

その結果、私たちのスレッドは mr-1 パンテオンに着きました。 ブランチから環境を作成してみよう mr-1.

マルチ開発環境を作成しました。GitLab に戻ってセクションを見てみましょう。 操作 > 環境。 のエントリが表示されます dev и mr-1.

これはエントリを追加したためです environment 名前で name и url CI/CD タスクに組み込みます。 環境を開くアイコンをクリックすると、Pantheon 上のマルチ開発環境の URL に移動します。

multidev の作成を自動化する

原則として、ここで停止し、マージ リクエストごとにマルチ開発環境を作成することを忘れないでください。ただし、このプロセスは自動化できます。

Pantheon にはコマンドライン ツールがあります 終点、プラットフォームを自動的に操作できます。 Terminus を使用すると、コマンド ラインからマルチ開発環境を作成できます。 GitLab 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

スクリプトはプライベート ディレクトリにあり、 パンテオンへの Web アクセスを許可しません。 マルチ開発ロジック用のスクリプトがあります。 セクションを更新しましょう 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 タスクが完了するのを待ちます。 しばらくお待ちください。multidev の作成には数分かかる場合があります。

次に、Pantheon の multidev リストを確認します。 ああ奇跡！ マルチ開発環境 mr-2 もうここにいる。

まとめ

マージリクエストを開いて環境を自動的に作成し始めてから、私のチームはさらに楽しくなりました。

GitLab と Pantheon の強力なツールを使用すると、GitLab を Pantheon に自動的に接続できます。

私たちは GitLab CI/CD を使用しているため、ワークフローには拡張の余地があります。 始めるためのアイデアをいくつか紹介します。

• ビルドステップを追加します。
• 自動テストを追加します。
• コード標準が満たされていることを確認するタスクを追加します。
• 追加する 動的アプリケーションセキュリティテスト.

GitLab、Pantheon、自動化についてのご意見をお聞かせください。

PS Pantheon のコマンド ライン ツールである Terminus をご存知でしたか? プラグイン経由で拡張可能?

私たちパンテオンは、バージョン 2 で良い仕事をしました。 Terminus ビルド ツール用のプラグイン GitLab サポート付き。 各プロジェクトの設定に煩わされたくない場合は、このプラグインを試して、v2 ベータ版のテストに協力してください。 ターミナルチームにとって build:project:create 必要なのは Pantheon トークンと GitLab トークンのみです。 彼女は、Composer と自動テストを備えたサンプル プロジェクトの XNUMX つをデプロイし、GitLab、新しい Pantheon サイトに新しいプロジェクトを作成し、環境変数と SSH キーを使用してそれらを接続します。

著者について

Andrew Taylor は開発者向けのツールを作成しています パンテオン.

出所： habr.com