Developer Services ポータルのインストール

デベロッパー サービス ポータル v. 4.16.09

インストールする前に、次の点を確認してください。

  • サポートされている 64 ビット版の Red Hat Enterprise Linux、CentOS、または Oracle でインストールを行っている。サポートされているバージョンの一覧については、こちらをご覧ください。
  • Yum がインストールされていること。
  • 既存のインストールをバックアップします。Drupal コアまたはカスタム以外のモジュールでコードを変更した場合、変更は上書きされます。これには、.htaccess に加えた変更も含まれます。/sites ディレクトリの外部はすべて Drupal によって所有されていることを前提としています。robots.txt はこのルールの例外です。このファイルがウェブルートに存在する場合は、保持されます。インストールに進む前に、Drupal のウェブルート ディレクトリ全体のバックアップを作成します。デフォルトのインストール場所は /var/www/html ですが、インストール時に変更される場合があります。以下で説明するインストール手順を行った後、バックアップからカスタマイズを復元できます。

デベロッパー チャネル サービス ポータルをインストールする手順は次のとおりです。

1. デベロッパー チャネル サービス バンドルを入手する

http://community.apigee.com/content/apigee-customer-support に移動し、サポート ポータルへのログインを選択し、次のいずれかの方法で Developer Channel Services .tar ファイルをリクエストします。

  • Edge for Private Cloud のダウンロード ディレクトリへのアクセスをリクエストします。
  • Developer Channel Services .tar ファイルへの URL をリクエストします。

2. Apigee Edge への接続テスト

ポータル サーバーのコマンド プロンプトから次の cURL コマンドを実行して、Edge 管理サーバーへの接続をテストします。
> curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}

EMAIL と EMAIL のメールアドレスは、管理者のメールアドレスとパスワードです。

Edge のインストール環境に固有のホスト名とポート番号を指定します。ポート 8080 は、Edge が使用するデフォルト ポートです。クラウドに接続する組織の場合、リクエスト URL は https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

"
",











3. 7.0 より前のバージョンの PHP を削除する

インストール スクリプトは、インストールを開始する前に、システム上の 7.0 より前のバージョンの PHP がないかチェックします。7.0 より前のバージョンの PHP が存在する場合は、次の警告メッセージが表示されます。

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.
php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

CentOS と Red Hat Enterprise Linux（RHEL）の場合は、次のコマンドを使用して PHP パッケージを削除します。

yum remove <package-name>

4. 自動インストール スクリプトを使用してデベロッパー チャネル サービスをインストールする

インターネット接続の有無にかかわらずサーバーにインストールするかどうかに応じて、次のいずれかの手順でポータルをインストールします。

インターネットに接続されているサーバーで次の操作を行います。

インターネットに接続されているサーバーにデベロッパー チャネル サービスをインストールするには:

  1. root またはスーパーユーザーとしてサーバーにログインします。
  2. インストール ファイル用のディレクトリ（portal など）を作成します。
  3. CD を使用して新しいportalディレクトリに移動し、デベロッパー チャネル サービスの DeveloperServices_x.y.z.tar ファイルをダウンロードします。ここで、x.y.z はポータルのバージョン番号に対応します。

    ファイルは、Apigee から送信されたリンクからブラウザでダウンロードできます。また、ファイルをコピーして次の cURL コマンドに追加することもできます。
    > curl -kOL <ここにリンクを貼り付ける>
  4. 次のコマンドを使用して、デベロッパー チャネル サービスの .tar ファイルの内容を抽出します。
    > tar -xvf <tar ファイル>
  5. CD を DeveloperServices-4.x.y.z に保存します。
  6. 次のコマンドを使用してインストール スクリプトを実行します。
    > ./networked-install.sh
  7. 画面の指示に沿って操作します。

インターネットに接続していないサーバーの場合:

まず、インターネットに接続されているシステムに、ネットワークに接続されていないインストール スクリプトを作成します。

  1. root またはスーパーユーザーとして、インターネットに接続されたシステムにログインします。
  2. インストール ファイル用のディレクトリ（portal_tar など）を作成します。
  3. CD で portal_tar ディレクトリに移動し、デベロッパー チャネル サービスの DeveloperServices_x.y.z.tar ファイルをダウンロードします。ここで、x.y.z はポータルのバージョン番号に対応します。
  4. 次のコマンドを使用して、デベロッパー チャネル サービスの .tar ファイルの内容を抽出します。
    > tar -xvf <tar file>
  5. CD を DeveloperServices-4.x.y.z に保存します。
  6. 次のコマンドを使用して、ポータルの .tar.gz ファイルを作成します。
    > ./non-networked-install.sh

非ネットワーク インストール用の新しい .tar.gz ファイルが作成されます。

インターネットに接続せずにサーバーにデベロッパー チャネル サービスをインストールするには:

      1. root またはスーパーユーザーとしてサーバーにログインします。
      2. インストール ファイル用のディレクトリ（portal など）を作成します。
      3. portal ディレクトリに CD で転送します。
      4. 上記の手順で非ネットワーク インストール用に作成した .tar.gz ファイルを portal ディレクトリにコピーします。
      5. 次のコマンドを使用して、.tar.gz ファイルの内容を抽出します。
        > tar -xvf <tar file>
      6. tar コマンドによって作成されたディレクトリに CD で移動します。
      7. install-from-rpm-bundle.sh スクリプトに権限を設定します。
        > chmod 755 install-from-rpm-bundle.sh
      8. 次のコマンドを使用して install-from-rpm-bundle.sh スクリプトを実行します。
        > ./install-from-rpm-bundle.sh
      9. 画面の指示に沿って操作します。

      5. デベロッパー ポータルを構成する

      Drupal モジュールのインストールやデフォルトのコンテンツの作成など、ポータル構成のほとんどは、ユーザーによる操作なしで行えます。データベースを設定し、Edge エンドポイントを構成して、新しい管理者ユーザーを作成するように求められます。

      デベロッパー ポータルを構成するには:

      1. ブラウザでサーバー URL に移動します（例:
        http://localhost）。特定の IP または DNS を構成している場合は、http://IP_address または http://DNS_name に移動します。

        Apigee プロファイルのデータベース構成ページにリダイレクトされます。

        注: 通常は、ホスト名を構成して DNS サーバーに登録しているため、http://localhost を使用する必要がなくなります。
      2. データベースへの接続を構成します。データベースがリモートマシン上にある場合は、[詳細オプション] セクションを開き、そのマシンへの接続情報を入力して、[保存して次へ] を選択します。
      3. 次の情報を入力して Apigee エンドポイントへの接続を構成し、[Save] を選択します。
        これらの値の詳細については、Developer Services Portal Requirements の「Information Required before You Start the Install」をご覧ください。
        1. Management API 組織
        2. Management API エンドポイント URL
        3. エンドポイント認証済みユーザー
        4. 認証済みユーザーのパスワード
      4. 次の情報を入力して管理者ユーザーを構成し、[保存] を選択します。Drupal ではデフォルトで「admin」という名前の管理者ユーザーが作成されるため、ユーザー名に「admin」を使用しないでください。
        この手順をスキップしても、後述の 4 で説明するように、Drush を使用して管理者を作成できます。管理者ユーザーを作成します。
        1. デベロッパーの氏名
        2. デベロッパー ポータルのユーザー名
        3. Password
        4. メールアドレス
      5. インストールが完了したら、settings.php ファイルに権限を設定します。
        > chmod 640 /var/www/html/sites/default/settings.php
      6. ポータルのホームページ（http://localhost/）またはポータルの DNS 名に移動します。
      7. 管理者の認証情報を使用してポータルにログインします。

      6. 管理者ユーザーを作成する（省略可）

      Drush を使用して、デベロッパー チャネル サービスのインストールの管理者ユーザーを作成します。Drupal では、デフォルトで「admin」という名前の管理者ユーザーが自動的に作成されます。そのため、ユーザー名に「admin」を使用しないでください。

      1. drupal_root/sites/default ディレクトリに移動します。Drupal のルート ディレクトリの標準の場所は /var/www/html です。
        > cd <drupal_root>/sites/default
      2. Drupal の非公開ファイルへの書き込み権限があることを確認します。
        > drush vget file_private_path

        このコマンドは、次のように Drupal の非公開ファイルのパスを返します。
        file_private_path: 'sites/default/private'

        /var/www/html/sites/default/private/ に対応します。次のコマンドを使用して、このディレクトリがオーナーとグループによって書き込み可能であることを確認します。
        chmod -R g+w dirPathAndName
        chmod -R o+r dirPathAndName
      3. 次のコマンドを入力して管理者ユーザーを作成します。「< >」内のコマンドは実際の値に置き換えます。
        > drush user-create <username> --mail="{email-address>" --password}{password>"
        > drush user-add-role Administrator <username>
      4. 上で指定したユーザー名とパスワードを使用して、管理者としてデベロッパー ポータルにログインします。

      5. MySQL root パスワードを設定する

      ポータルのインストールの一環として MySQL をインストールした場合、インストール スクリプトは MySQL の root パスワードをデフォルト値（空白）のままにします。

      次のコマンドを使用して、root パスワードを設定します。

      > mysqladmin -u root password NEWPASSWORD

      設定済みの root パスワードを変更する場合は、次のコマンドを使用します。

      > mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

      また、/var/www/html/sites/default/settings.php ファイルのパスワードも更新する必要があります。

      6. アップデート マネージャー モジュールが有効になっていることを確認する

      Drupal のアップデート通知を受け取るには、Drupal アップデート マネージャー モジュールが有効になっていることを確認します。Drupal のメニューで [Modules] を選択し、[Updatemanager] モジュールまでスクロールします。有効になっていない場合は、有効にします。

      有効にした後は、[Reports] > [Available Updates] メニュー項目を使用して、利用可能なアップデートを確認できます。次の Drush コマンドを使用することもできます。

      > drush pm-info update

      メニュー項目 [Reports] > [Available Updates] > [Settings] を使用して、アップデートが利用可能になったときにメールを送信するようにモジュールを構成し、アップデートを確認する頻度を設定します。

      7. 本番環境サーバーにデプロイする（省略可）

      ポータルを本番環境サーバーにデプロイする場合は、次のような追加のセキュリティ手順を行う必要があります。

      1. 次のスクリプトを実行して MySQL のインストールを保護します。
        > /usr/bin/mysql_secure_installation

        このスクリプトは root パスワードを設定し、root アクセスを localhost のみに制限するオプションを提供します。また、デフォルトで作成されたテスト データベースと匿名ユーザーを削除することもできます。本番環境のサーバーでは、このスクリプトを実行することを強くおすすめします。
      2. 会社のポリシーで必要な場合は、SELinux を有効にして構成します。

      8. Apache Solr 検索エンジンを構成する（省略可）

      デフォルトでは、ポータルのインストール時に、Apache Solr 検索エンジンに接続する Drupal モジュールが無効になります。ほとんどのポータルでは内部 Drupal 検索エンジンを使用するため、Drupal Solr モジュールは必要ありません。

      検索エンジンとして Solr を使用する場合は、Solr をサーバーにローカルにインストールし、ポータルで Drupal Solr モジュールを有効にして構成する必要があります。

      Drupal Solr モジュールを有効にするには:

      1. 管理者またはコンテンツ作成権限を持つユーザーとしてポータルにログインします。
      2. Drupal のメニューで [Modules] を選択します。
      3. [Apache Solr Framework] モジュールと [Apache Solr Search] モジュールを有効にします。
      4. 変更を保存します。
      5. https://drupal.org/node/1999280 に記載されているように Solr を構成します。

      9. HTTPS をサポートする mod_ssl をインストールする（省略可）

      mod_ssl モジュールは、Apache HTTP サーバーが HTTPS 経由でウェブページを提供します。HTTPS を使用する場合は、次のコマンドを使用して mod_ssl をインストールします。

      > yum install mod_ssl

      SSL を使用するようにポータルを構成する方法については、http://apigee.com/docs/developer-services/content/using-ssl-portal をご覧ください。

      10. SmartDocs のインストール（オプション）

      SmartDocs を使用すると、完全な対話型の API ドキュメントを Developer Services ポータルに作成できます。ただし、ポータルで SmartDocs を使用するには、最初に SmartDocs を Edge にインストールする必要があります。

      • ポータルを Edge Cloud に接続する場合、SmartDocs はすでにインストールされているため、それ以上の構成は必要ありません。
      • ポータルを Edge for Private Cloud に接続する場合は、SmartDocs が Edge にインストールされていることを確認する必要があります。Edge と SmartDocs のインストールの詳細については、SmartDocs のインストールをご覧ください。

      SmartDocs の詳細については、SmartDocs を使用した API のドキュメント化をご覧ください。

      11. 次のステップ

      Developer Services ポータルをインストールしたら、次は特定の要件に合わせてポータルを構成してカスタマイズします。ポータルの構成、スタイル設定、管理に関するすべての情報は、Apigee ウェブサイトのドキュメントに記載されています。http://apigee.com/docs/developer-services/content/what-developer-portal でドキュメントにアクセスします。

      次の表に、インストール後に行う最も一般的なタスクの一部を示します。また、詳細を確認できる Apigee ドキュメントのリンクも示します。

      タスク

      Description

      テーマのカスタマイズ

      テーマにより、色、スタイル、その他の視覚的要素など、ポータルの外観が定義されます。

      外観のカスタマイズ

      ホームページには、メインメニュー、ウェルカム メッセージ、ヘッダー、フッター、タイトルがあります。

      ユーザー アカウントの追加と管理

      登録プロセスでは、新しいデベロッパーがポータルにアカウントを登録する方法を制御します。たとえば、新しいデベロッパーがポータルにすぐにアクセスできるか、または管理者による確認が必要ですか。このプロセスは、新しいアカウントが作成されたときにポータル管理者に通知する方法も制御します。

      メールの構成

      ポータルは、特定のイベントに応じてメールを送信します。たとえば、新しいデベロッパーがポータルに登録したり、デベロッパーがパスワードを紛失したりした場合などです。

      ユーザー アカウントの追加と管理

      デベロッパーがポータルへのアクセスを許可される前に同意する必要がある利用規約ページを追加します。

      ユーザー アカウントの追加と管理

      ポータルには、ロールベースの認可モデルが実装されています。デベロッパーの登録を許可する前に、ポータルで使用する権限とロールを定義します。

      ブログとフォーラムの投稿を追加する

      ポータルには、ブログとスレッド形式のフォーラムのサポートが組み込まれています。ブログとフォーラムの投稿を表示、追加、編集、削除するために必要な権限を定義します。

      データベースのバックアップを確実に行う

      Drupal データベースがバックアップされていることを確認します。インストールはそれぞれ異なるため、データベースの最適なバックアップ方法はお客様が判断する必要があります。

      ホスト名を設定する

      DNS サーバーにホスト名を設定しない場合は、サーバーの IP アドレスでいつでもサイトにアクセスできます。ホスト名を使用する場合は、サーバーの DNS を構成できます。これは、基本設定に他の構成がなくても正常に動作するはずです。

      ロードバランサを設定した場合や、なんらかの理由でサイトで誤った URL が返される場合は、デベロッパー ポータルの settings.php ファイルで $base_url を設定できます。このファイルは、デフォルトでは /var/www/html/sites/default ディレクトリにあります。