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

Developer Services Portal v. 4.16.05

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

インストールを続行する前に、Drupal ウェブのルート ディレクトリ全体のバックアップを作成します。デフォルトのインストール場所は /var/www/html ですが、インストール時に変更した可能性があります。以下で説明するインストール手順を完了したら、バックアップからカスタマイズを復元できます。

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

http://community.apigee.com/content/apigee-customer-support にアクセスし、[Login to your Support Portal] を選択して、次のいずれかの方法で Developer Channel Services の .tar ファイルをリクエストします。

• Edge for Private Cloud のダウンロード ディレクトリへのアクセスをリクエストします。
• デベロッパー チャネル サービスの .tar ファイルの URL をリクエストします。

2. システムがシステム要件を満たしていることを確認する

ポータルをインストールする前に、サーバーが次の要件を満たしている必要があります。

1. サポートされているバージョンの Red Hat Enterprise Linux、CentOS、または Oracle の 64 ビット版にインストールしていることを確認します。サポートされているバージョンのリストはこちらでご確認ください。
2. Yum がインストールされていることを確認します。
3. （インターネット接続がないサーバーにインストールする場合）まず、必要なすべてのファイルを 1 つの .tar.gz ファイルとしてインターネット接続があるサーバーにダウンロードする必要があります。次に、その .tar.gz ファイルをインターネット接続のないサーバーにコピーして、インストールを実行します。
   1. インターネット接続されているサーバーに root またはスーパーユーザーとしてログインします。
   2. インストール ファイル用のディレクトリ（portal_tar など）を作成します。
   3. 新しいディレクトリに移動し、Developer Channel Services の DeveloperServices_x.y.z.tar ファイルをダウンロードします。ここで、x.y.z はポータルのバージョン番号に対応します。
   4. 次のコマンドを使用して、Developer Channel Services の .tar ファイルの内容を抽出します。
      > tar -xvf <tar file>
   5. DeveloperServices-4.x.y.z に移動します。
   6. 次のコマンドを使用して、ポータルの .tar.gz ファイルを作成します。
      > ./non-networked-install.sh
      
      このコマンドは、必要なすべてのファイルをダウンロードし、1 つの .tar.gz ファイルにまとめます。次に、その .tar.gz ファイルをインターネットに接続されていないサーバーにコピーして、インストールを完了します。
4. ポータル サーバーのコマンド プロンプトから次の cURL コマンドを実行して、Edge Management Server への接続をテストします。
   > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}
   
   ここで、EMAIL と PASSWORD は、ORGNAME の管理者のメールアドレスとパスワードです。
   
   Edge のインストールに固有のホスト名とポート番号を指定してください。ポート 8080 は、Edge が使用するデフォルトのポートです。クラウド上の組織に接続している場合は、リクエスト URL は次のようになります:
   https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}
   
   成功した場合、このコマンドは次のような応答を返します:
   {
   "createdAt" : 1348689232699,
   "createdBy" : "USERNAME",
   "displayName" : "cg",
   "environments" : [ "test", "prod" ],
   "lastModifiedAt" : 1348689232699,
   "lastModifiedBy" : "foo@bar.com",
   "name" : "cg",
   "properties" : {
   "property" : [ ]
   },
   "type" : "trial"
   }

3. 自動インストール スクリプトを使用して Developer Channel Services をインストールする

自動インストール スクリプトを使用してポータルをインストールする手順は次のとおりです。この手順は、外部インターネット接続の有無にかかわらず、サーバーで機能します。

1. root またはスーパーユーザーとしてサーバーにログインします。
2. インストール ファイル用のディレクトリ（portal など）を作成します。
3. インターネットに接続されているサーバーの場合:
   1. 新しい portal ディレクトリに移動し、Developer Channel Services の DeveloperServices_x.y.z.tar ファイルをダウンロードします。ここで、x.y.z はポータルのバージョン番号に対応します。
      
      Apigee から送信されたリンクからファイルをダウンロードするには、ブラウザでリンクを開くか、リンクをコピーして次の cURL コマンドに追加します。
      > curl -kOL <ここにリンクを貼り付け>
   2. 次のコマンドを使用して、Developer Channel Services の .tar ファイルの内容を抽出します。
      > tar -xvf <tar file>
   3. DeveloperServices-4.x.y.z に移動します。
   4. 次のコマンドを使用してインストール スクリプトを実行します。
      > ./networked-install.sh
4. インターネット接続のないサーバーの場合:
   1. セクション 2 で作成した .tar.gz ファイルをコピーします。システムがシステム要件を満たしていることを確認します。
   2. 次のコマンドを使用して、.tar.gz ファイルの内容を抽出します。
      > tar -xvf <tar file>
   3. tar コマンドで作成されたディレクトリに移動します。
   4. install-from-rpm-bundle.sh スクリプトの権限を設定します。
      > chmod 755 install-from-rpm-bundle.sh
   5. 次のコマンドを使用して、install-from-rpm-bundle.sh スクリプトを実行します。
      > ./install-from-rpm-bundle.sh
5. プロンプトに回答します。
6. インストールが完了したら、ブラウザでサーバーの URL（
   http://localhost など）に移動します。特定の IP または DNS が構成されている場合は、http://IP_address または http://DNS_name にアクセスします。
   
   Apigee プロファイルのデータベース構成ページにリダイレクトされます。
   
   注: 通常は、ホスト名をすでに構成して DNS サーバーに登録しているため、http://localhost を使用する必要はありません。
7. MySQL への接続を構成します。MySQL がリモートマシン上にある場合は、[詳細オプション] セクションを開いて、そのマシンへの接続情報を入力し、[保存して続行] を選択します。
8. 次の情報を入力して Apigee エンドポイントへの接続を構成し、[Save] を選択します。
   これらの値の詳細については、デベロッパー サービス ポータルの要件の「インストールを開始する前に必要な情報」をご覧ください。
   1. デベロッパー ポータル組織
   2. デベロッパー ポータルのエンドポイント URL
   3. エンドポイント認証済みユーザー
   4. 認証済みユーザーのパスワード
9. プロンプトが表示されたら、[Install Sample SmartDocs WADL] ボタンを選択して、サンプルの SmartDocs WADL をインストールします。この手順をスキップすると、サンプルの SmartDocs API がポータルに表示されません。
   注: ポータルが Apigee Edge for Private Cloud のインストールに接続し、その Edge のインストールに外部インターネット接続がない場合は、SmartDocs を使用する前に SmartDocs モジュールの追加構成を行う必要があります。SmartDocs の詳細については、http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis をご覧ください。
10. [SMTP Server Settings] を構成します。Apigee では、ポータルからメール メッセージを送信するために SMTP サーバーを構成する必要があります。
    詳細については、http://apigee.com/docs/developer-services/content/configuring-email をご覧ください。
11. 次の情報を入力して管理者ユーザーを構成し、[Save] を選択します。Drupal では、デフォルトで「admin」という名前の管理者ユーザーが作成されるため、ユーザー名として「admin」を使用しないでください。
    この手順をスキップしても、Drush を使用して管理者を作成できます。これについては、以下の 4 で説明します。管理者ユーザーを作成します。
    1. デベロッパーの氏名
    2. デベロッパー ポータルのユーザー名
    3. パスワード
    4. メールアドレス
12. インストールが完了したら、settings.php ファイルに権限を設定します。
    > chmod 640 /var/www/html/sites/default/settings.php
13. http://localhost/ のポータルのホームページ、またはポータルの DNS 名に移動します。
14. 管理者認証情報を使用してポータルにログインします。

4. 管理者ユーザーを作成する

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. Update Manager モジュールが有効になっていることを確認する

Drupal の更新に関する通知を受け取るには、Drupal Update Manager モジュールが有効になっていることを確認してください。Drupal メニューから [Modules] を選択し、[Update manager] モジュールまで下にスクロールします。有効になっていない場合は、有効にします。

有効にすると、[レポート] > [利用可能なアップデート] メニュー項目を使用して、利用可能なアップデートを確認できます。次の 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 を使用すると、Developer Services ポータルで API ドキュメントを完全な対話型のドキュメントにすることができます。ただし、ポータルで SmartDocs を使用するには、まず Edge に SmartDocs をインストールする必要があります。

• ポータルを 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 ドキュメントへのリンクも記載しています。