ポータルをアップグレードする

Edge for Private Cloud v4.18.05

この手順では、オンプレミス インストールで既存の Apigee Developer Services ポータル(略して「ポータル」)をアップグレードする方法について説明します。

正しいアップデート手順の決定

ポータルのアップデート手順は現在のインストール環境によって異なります。

現在のインストール タイプの確認

現在のインストール タイプがわからない場合は、次のコマンドを使用して確認します。

  • ls /opt

    Nginx/Postgres を使用している場合、ディレクトリの /opt/apigee/opt/nginx が表示されます。

    Apache/MySQL または Apache/MariaDB を使用している場合、これらのディレクトリは存在しません。

  • /opt/apigee/apigee-service/bin/apigee-all status

    Nginx/Postgres を使用している場合、次の出力が表示されます。

    + apigee-service
    apigee-drupal-devportal status
    OK: apigee-drupal-devportal is up and running
    + apigee-service apigee-lb status
    apigee-service: apigee-lb: OK
    + apigee-service apigee-postgresql status
    apigee-service: apigee-postgresql: OK
  • apachectl -S

    Apache/MySQL または Apache/MariaDB を使用している場合、次の形式でポータルのウェブルート ディレクトリが返されます。

    *:80
    192.168.56.102 (/etc/httpd/conf/vhosts/devportal.conf:1)

デフォルトのインストール ディレクトリ

アップグレード プロセスでは、ポータルが次の場所にインストールされていることを前提としています。

  • 4.17.05 以降: /opt/apigee/apigee-drupal/wwwroot
  • 4.17.05 より前: /opt/apigee/apigee-drupal(Nginx)または /var/www/html(Apache)

ポータルをデフォルト ディレクトリにインストールしていない場合は、インストール ディレクトリを使用するように以下の手順のパスを変更します。

サポートされているアップグレード バージョン

このアップグレード手順は、次のバージョンのポータルでサポートされています。

  • OPDK-17-01.x
  • OPDK-17-05.x
  • OPDK-17-09.x
  • OPDK-18-01.x

ポータルのバージョンを確認するには、ブラウザで次の URL を開きます。

http://yourportal.com/buildInfo

アップデート前の準備

既存のインストールでは、Drupal コアまたはカスタム以外のモジュールでコードを変更した場合、変更は上書きされます。これには、特に .htaccess に加えた変更が含まれます。 /sites ディレクトリ以外は Drupal が所有しているものと想定してください。このルールの例外は robots.txt です。このファイルがウェブルートに存在する場合は、保持されます。

インストールに進む前に、Drupal のウェブルート ディレクトリ全体のバックアップを作成します。以下で説明するインストール手順を行った後、バックアップからカスタマイズを復元できます。

RPM を使用してポータルをアップグレードする

ノードのポータル RPM を更新するには:

  1. Drupal のディレクトリ(デフォルトでは /opt/apigee/apigee-drupal)に移動します。
    cd /opt/apigee/apigee-drupal
  2. Drupal データベース インスタンスをバックアップします。pg_dump コマンドは、データベースのコピーを作成します。
    pg_dump --dbname=devportal --host=host_IP_address --username=drupaladmin
      --password --format=c > /tmp/portal.dmp

    ここで

    • devportal は、ポータルのインストール構成ファイルの PG_NAME プロパティで指定されているデータベース名です。
    • host_IP_address は、ポータルノードの IP アドレスです。
    • drupaladmin は、ポータルのインストール構成ファイルの DRUPAL_PG_USER プロパティで指定されているデータベースにアクセスするためにポータルが使用する Postgres ユーザー名です。
    • ポータルのインストール構成ファイルの DRUPAL_PG_PASS プロパティで定義されている Postgres ユーザーのパスワードの入力を求められます。

    後でバックアップから復元する必要がある場合は、次のコマンドを使用します。

    pg_restore --clean --dbname=devportal --host=localhost  --username=apigee < /tmp/portal.dmp
  3. Drupal のウェブルート ディレクトリ全体のバックアップを作成します。デフォルトのインストール場所は /opt/apigee/apigee-drupal ですが、変更されている可能性もあります。

    このディレクトリの場所がわからない場合は、drush status コマンドか、Drupal のメニューで [Configuration] > [Media] > [File] エントリを使用して、公開ファイル システムとプライベート ファイル システムのパス(次のステップ用)の場所を特定します。

  4. /opt/apigee/data/apigee-drupal-devportal/private にあるファイルのバックアップを作成します。
  5. Drupal をメンテナンス モードに設定します。
    1. Drupal のメニューで [Configuration] を選択します。
    2. [構成] ページの [開発] で、[メンテナンス モード] を選択します。
    3. [サイトをメンテナンス モードにする] チェックボックスをオンにします。
    4. メンテナンス中にユーザーに表示するメッセージを入力します。
    5. [構成を保存] を選択します。
  6. Edge apigee-setup ユーティリティのインストールの説明に従って、SELinux を無効にします。
  7. /opt ディレクトリに移動します。
    cd /opt
  8. インターネットに接続しているサーバーでアップグレードする場合:
    1. Edge 4.18.05 の bootstrap_4.18.05.sh ファイルを /tmp/bootstrap_4.18.05.sh にダウンロードします。
      curl https://software.apigee.com/bootstrap_4.18.05.sh -o /tmp/bootstrap_4.18.05.sh
    2. Edge 4.18.05 の apigee-service ユーティリティと依存関係をインストールします。
      sudo bash /tmp/bootstrap_4.18.05.sh apigeeuser=uName apigeepassword=pWord

      ここで、uNamepWord は Apigee から取得したユーザー名とパスワードです。pWord を省略すると、入力するように求められます。

      デフォルトでは、Java 1.8 がインストールされているかどうかが確認されます。「C」オプションを使用すると、Java をインストールせずに続行できます。

  9. インターネットに接続していないサーバーでアップグレードする場合:
    1. ローカルに Apigee リポジトリを作成するの説明に沿って、4.18.05 リポジトリをローカルに作成します。
    2. .tar ファイルから apigee-service をインストールするには:
      1. ローカル リポジトリが存在するノードで、次のコマンドを使用して、ローカル リポジトリを /opt/apigee/data/apigee-mirror/apigee-4.18.05.tar.gz という名前の単一の .tar ファイルにパッケージ化します。
        /opt/apigee/apigee-service/bin/apigee-service apigee-mirror package
      2. Edge を更新する対象のノードに .tar ファイルをコピーします。たとえば、新しいノードの /tmp ディレクトリにコピーします。
      3. 新しいノードで、/tmp ディレクトリに tar ファイルを解凍します。
        tar -xzf apigee-4.18.05.tar.gz

        このコマンドにより、.tar ファイルを含むディレクトリに repos という新しいディレクトリが作成されます。(例: /tmp/repos)。

      4. /tmp/repos から Edge apigee-service ユーティリティと依存関係をインストールします。
        sudo bash /tmp/repos/bootstrap_4.18.05.sh apigeeprotocol="file://" apigeerepobasepath=/tmp/repos

        コマンドに repos ディレクトリへのパスが含まれている点に注意してください。

    3. Nginx ウェブサーバーを使用して apigee-service をインストールするには:
      1. Edge apigee-setup ユーティリティのインストールの「Nginx ウェブサーバーを使用してリポジトリからインストールする」の手順に沿って、Nginx ウェブサーバーを構成します。
      2. リモートノードで、Edge bootstrap_4.18.05.sh ファイルを /tmp/bootstrap_4.18.05.sh にダウンロードします。
        /usr/bin/curl http://uName:pWord@remoteRepo:3939/bootstrap_4.18.05.sh
          -o /tmp/bootstrap_4.18.05.sh

        ここで、uNamepWord は、上記でリポジトリに設定したユーザー名とパスワードです。remoteRepo は、リポジトリ ノードの IP アドレスまたは DNS 名です。

      3. リモートノードで、Edge apigee-service ユーティリティと依存関係をインストールします。
        sudo bash /tmp/bootstrap_4.18.05.sh apigeerepohost=remoteRepo:3939
          apigeeuser=uName apigeepassword=pWord apigeeprotocol=http://

        ここで、uNamepWord はリポジトリのユーザー名とパスワードです。

  10. apigee-service を使用して apigee-setup ユーティリティを更新します。
    /opt/apigee/apigee-service/bin/apigee-service apigee-setup update
  11. Postgres ノードでアップデート ユーティリティを実行します。
    /opt/apigee/apigee-setup/bin/update.sh -c ps -f configFile

    ここで、configFile は Postgres データベースのインストールに使用した構成ファイルです。構成ファイルに関する唯一の要件は、構成ファイルが「apigee」ユーザーからアクセス可能で、読み取り可能であることです。

  12. Postgres データベースを更新します。
    /opt/apigee/apigee-service/bin/apigee-service apigee-postgresql db_upgrade
  13. ノードで更新ユーティリティを実行してポータルを更新します。
    /opt/apigee/apigee-setup/bin/update.sh -c dp -f configFile

    ここで、configFile はポータルのインストールに使用した構成ファイルです。構成ファイルに関する唯一の要件は、構成ファイルが「apigee」ユーザーからアクセス可能で、読み取り可能であることです。

  14. ブラウザ ウィンドウで次の URL を開き、Drupal の update.php スクリプトを実行します。
    http://portal_IP_DNS:8079/update.php
  15. Drupal を無効にしてメンテナンス モードにします。
    1. Drupal のメニューで [Configuration] を選択します。
    2. [構成] ページの [開発] で、[メンテナンス モード] を選択します。
    3. [サイトをメンテナンス モードにする] チェックボックスをオフにします。
    4. [構成を保存] を選択します。

更新後のルート ディレクトリは次のようになります。

/opt/apigee/apigee-drupal/wwwroot

これでアップグレードは完了です。