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

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

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

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

1. デベロッパー チャネル サービス バンドルの取得

http://community.apigee.com/content/apigee-customer-support にアクセスし、[ログイン] を選択してデベロッパー チャネル サービスの .tar ファイルをリクエストする方法は 2 通りあります。

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

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

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

1. サポートされている 64 ビット版の Red Hat Enterprise Linux、CentOS、または Oracle でインストールを行ってください。サポートされているバージョンのリストについては、こちらをご覧ください。
2. Yum がインストールされていることを確認します。
3. （インターネットに接続していないサーバーにインストールする場合）必要なすべてのファイルを、インターネット接続のあるサーバーに 1 つの .tar.gz ファイルとしてダウンロードする必要があります。インターネット接続のない .tar.gz ファイルをサーバーにコピーして、インストールを実行します。
   1. root またはスーパーユーザーとして、インターネット接続を使用してサーバーにログインします。
   2. インストール ファイルのディレクトリ（portal_tar など）を作成します。
   3. 新しいディレクトリに CD から移動し、Developer Channel Services 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
      
      必要なファイルをすべて 1 つの .tar.gz ファイルにダウンロードします。インターネット接続のないサーバーに .tar.gz ファイルをコピーして、インストールを完了します。
4. ポータルサーバーのコマンド プロンプトから次の cURL コマンドを実行して、Edge Management Server への接続をテストします。
   > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/ORGNAME}
   
   とパスワードの
   とパスワード。
   
   ご使用の Edge 環境に固有のホスト名とポート番号を指定します。ポート 8080 は、Edge が使用するデフォルトのポートです。
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   

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

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

1. root またはスーパーユーザーとしてサーバーにログインします。
2. インストール ファイル用のディレクトリ（portal など）を作成します。
3. インターネットに接続しているサーバーの場合:
   1. CD から新しいポータル ディレクトリに移動し、デベロッパー チャネル サービスの DeveloperServices_x.y.z.tar ファイルをダウンロードします。ここで、x.y.z はポータルのバージョン番号に対応します。
      
      ブラウザで Apigee から送信されたリンクからファイルをダウンロードするか、ファイルをコピーして次の cURL コマンドに追加することで、ファイルをダウンロードできます。
      > curl -kOL <insert link here>
   2. 次のコマンドを使用して、デベロッパー チャネル サービスの .tar ファイルの内容を抽出します。
      > tar -xvf <tar file>
   3. CD から DeveloperServices-4.x.y.z へ。
   4. 次のコマンドを使用してインストール スクリプトを実行します。
      > ./networked-install.sh
4. インターネットに接続していないサーバーの場合:
   1. 上記のセクション 2 で作成した .tar.gz ファイルをコピーします。システムがシステム要件を満たしていることを確認します。
   2. 次のコマンドを使用して .tar.gz ファイルの内容を抽出します。
      > tar -xvf <tar file>
   3. tar コマンドによって作成されたディレクトリに CD。
   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 エンドポイントへの接続を構成し、[保存] を選択します。
   これらの値の詳細については、デベロッパー サービス ポータルの要件の「インストールを開始する前に必要な情報」をご覧ください。
   1. デベロッパー ポータル組織
   2. デベロッパー ポータルのエンドポイント URL
   3. Endpoint Authenticated User（エンドポイント認証済みユーザー）
   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 サーバー設定を構成します。Apigee では、ポータルからメールを送信するように SMTP サーバーを構成する必要があります。
    詳細については、http://apigee.com/docs/developer-services/content/configure-email をご覧ください。
11. 次の情報を入力して、管理者ユーザーを構成して、[保存] を選択します。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 を使用して Developer Channel Services インストールの管理者ユーザーを作成します。 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 アップデート マネージャー モジュールが有効になっていることを確認します。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 では、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 ドキュメントへのリンクも含まれています。

タスク	Description
テーマのカスタマイズ	テーマによってポータルの外観（色、スタイル、その他の視覚要素）が決まります。
外観のカスタマイズ	ホームページには、メインメニュー、ウェルカム メッセージ、ヘッダー、フッター、タイトルなどが表示されます。
ユーザー アカウントの追加と管理	登録プロセスでは、新しいデベロッパーがポータルでアカウントを登録する方法を制御します。たとえば、新しいデベロッパーがポータルにすぐにアクセスできるか、管理者が確認する必要があるか、などです。また、新しいアカウントが作成されたときにポータル管理者がどのようにして通知を受け取るかも設定できます。
メールの構成	ポータルは、特定のイベントに応答してメールを送信します。たとえば、新しいデベロッパーがポータルに登録したときやデベロッパーがパスワードを忘れた場合にメールが送られます。
ユーザー アカウントの追加と管理	[Terms & Conditions] ページを追加します。デベロッパーは、利用規約に同意した場合にのみ、ポータルへのアクセスを許可されます。
ユーザー アカウントの追加と管理	ポータルには、ロールベースの認可モデルが実装されています。デベロッパーに登録を許可する前に、ポータルで使用する権限とロールを定義します。
ブログやフォーラムの投稿を追加する	ポータルには、ブログとスレッド形式のフォーラムのサポートが組み込まれています。ブログ投稿やフォーラムの投稿を表示、追加、編集、削除するために必要な権限を定義します。
データベースのバックアップを確実に行う	Drupal データベースをバックアップしていることを確認します。インストールはそれぞれ異なるため、データベースをバックアップする最適な方法は、ご自身で決定してください。
ホスト名の設定	DNS サーバーでホスト名を設定しない場合は、いつでもサーバーの IP アドレスを使用してサイトにアクセスできます。ホスト名を使用する場合は、サーバーに DNS を構成できます。DNS は、基本的な設定では他に構成しなくても正しく動作します。 ロードバランサを設定した場合、または他の理由でサイトに誤った URL が表示される場合は、デベロッパー ポータルの settings.php ファイルで $base_url を設定してください。デフォルトのファイルは /var/www/html/sites/default ディレクトリにあります。