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

Edge for Private Cloud v. 4.17.01

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

• ポータルをインストールする前に Postgres をインストールします。Postgres は一部分としてインストールすることも、 ポータルで使用する Postgres スタンドアロン インストールです。
  • Postgres をスタンドアロンでインストールする場合は、ポータルと同じノードにインストールできます。
  • Edge の一部としてインストールされた Postgres に接続し、Postgres が構成されている場合 マスター/スタンバイ モードで、マスター Postgres サーバーの IP アドレスを指定します。
• サポートされているバージョンの Red Hat の 64 ビット版でインストールを行っている Enterprise Linux、CentOS、Oracleサポート対象バージョンの一覧については、サポート対象のソフトウェアとサポート対象バージョンをご覧ください。
• Yum がインストールされています。

インストールの概要

Edge をノードにインストールした後、apigee-setup ユーティリティを使用します。 ユーティリティを使用してノードにポータルをインストールします。apigee-setup ユーティリティの形式は次のとおりです。

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

次の設定が含まれている apigee-setup ユーティリティに構成ファイルを渡します。 詳細情報を確認できます。構成ファイルに必要なリソースが apigee-setup は、 コマンドラインで名前を入力するように求められます。

唯一の要件は、構成ファイルがサービス プロバイダによってアクセス可能、または読み取り可能で 「apigee」できます。

たとえば、次のコマンドを使用してポータルをインストールします。

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

Edge apigee-setup ユーティリティをインストールするをご覧ください。 をご覧ください。

構成ファイルの作成

以下に、ポータル インストール用のサイレント構成ファイルの例を示します。このファイルを編集 構成に応じて適宜変更します。setup.sh の -f オプションを使用してこのファイルを設定します。

IP1=IPorDNSnameOfNode

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify the name of the portal database in Postgres. 
PG_NAME=devportal 

# Specify the Postgres admin credentials. 
# The portal connects to Postgres by using the 'apigee' user. 
# If you changed the Postgres password from the default of 'postgres' 
# then set PG_PWD accordingly. 
# If connecting to a Postgres node installed with Edge, 
# contact the Edge sys admin to get these credentials. 
PG_USER=apigee 
PG_PWD=postgres 

# The IP address of the Postgres server. 
# If it is installed on the same node as the portal, specify that IP. 
# If connecting to a remote Postgres server,specify its IP address. 
PG_HOST=$IP1 

# The Postgres user credentials used by the portal 
# to access the Postgres database, 
# This account is created if it does not already exist. 
DRUPAL_PG_USER=drupaladmin 
DRUPAL_PG_PASS=portalSecret 

# Specify 'postgres' as the database. 
DEFAULT_DB=postgres 

# Specify the Drupal admin account details. 
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin. 
# The installer creates this user on the portal. 
DEVPORTAL_ADMIN_FIRSTNAME=firstName 
DEVPORTAL_ADMIN_LASTNAME=lastName 
DEVPORTAL_ADMIN_USERNAME=userName 
DEVPORTAL_ADMIN_PWD=pWord 
DEVPORTAL_ADMIN_EMAIL=foo@bar.com 

# Edge connection details. 
# If omitted, you can set them in the portal UI. 
# Specify the Edge organization associated with the portal. 
EDGE_ORG=edgeOrgName 

# Specify the URL of the Edge management API. 
# For a Cloud based installation of Edge, the URL is: 
# https://api.enterprise.apigee.com/v1 
# For a Private Cloud installation, it is in the form: 
# http://<ms_ip_or_DNS>:8080/v1 or 
# https://<ms_ip_or_DNS>:TLSport/v1 
MGMT_URL=https://api.enterprise.apigee.com/v1 

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword. 
# The portal uses this information to connect to Edge. 
DEVADMIN_USER=orgAdmin@myCorp.com 
DEVADMIN_PWD=pWord 

# The PHP port. 
# If omitted, it defaults to 8888. 
PHP_FPM_PORT=8888 

# You must configure the SMTP server used by the portal. 
# The properties SMTPHOST and SMTPPORT are required. 
# The others are optional with a default value as notated below. 
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com. 
SMTPHOST=smtp.gmail.com 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# SMTP port (usually 25). 
# The value can be different based on the selected encryption protocol. 
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS. 
SMTPPORT=25 

# Username used for SMTP authentication, defaults is blank. 
SMTPUSER=your@email.com 

# Password used for SMTP authentication, default is blank. 
SMTPPASSWORD=yourEmailPassword

1. Apigee Edge への接続をテストする

次の cURL コマンドを実行して、Edge 管理サーバーへの接続をテストします。 ポータル サーバーのコマンド プロンプトから、次のコマンドを実行します。

> curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

または

> curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/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"
}

2. バージョン 7.0 より前の PHP を削除

インストール スクリプトは、システム上に PHP 7.0 より前のバージョンがあるかどうかを確認してから、 インストールできます。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 と RedHat Enterprise Linux（RHEL）の場合は、次のコマンドを使用して PHP パッケージを削除します。 command:

yum remove <package-name>

3. Postgres をインストールする

ポータルをインストールするには、Postgres がインストールされている必要があります。次のいずれかの方法で Edge のインストールの一環として Postgres をインストールするか、 登録できます

• Edge の一部としてインストールされた Postgres に接続し、Postgres が Google Cloud マスター/スタンバイ モードの場合は、マスター Postgres サーバーの IP アドレスを指定します。
• Postgres をスタンドアロンでインストールする場合は、ポータルと同じノードにインストールできます。

Edge のインストールの一環として Postgres をインストールする方法については、ノードに Edge コンポーネントをインストールするをご覧ください。

Postgres をスタンドアロンでインストールするには:

1. 次のコマンドを使用して、ノードに Edge apigee-setup ユーティリティをインストールします。 必要ありません。詳細については、Edge apigee-setup ユーティリティをインストールするをご覧ください。 できます。
2. 次に示すように、Postgres の構成ファイルを作成します。
   
   # Postgres の Pod とリージョン。使用 デフォルト値を使用します。
   MP_POD=gateway
   リージョン=dc-1
   
   # Postgres のパスワードを設定するデフォルト値は「postgres」です。
   PG_PWD=postgres
3. コマンド プロンプトで設定スクリプトを実行して、Postgres をインストールします。
   > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile
   
   「-p pdb」オプションは、Postgres をインストールすることを指定します。
   
   構成ファイルは、「apigee」からアクセス可能または読み取り可能である必要があります。できます。

4. ポータルをインストールする

ポータルをインストールするには:

1. Edge apigee-setup ユーティリティを ノードへの接続を確立します。詳細については、Edge apigee-setup ユーティリティをインストールするをご覧ください。 できます。
2. Postgres（スタンドアロン、または GKE の一部としての Postgres）がインストールされていることを確認してください。 説明します。
3. コマンド プロンプトで、セットアップ スクリプトを実行します。
   > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
   
   「-p dp」オプションは、ポータルのインストールを指定します。
   
   構成ファイルは、「apigee」からアクセス可能または読み取り可能である必要があります。できます。
4. ポータルのホームページ（http://localhost:8079）または DNS 名に移動します。 必要があります。
5. config で設定した管理者の認証情報を使用してポータルにログインする 表示されます。

5. アップデート マネージャー モジュールが 有効

Drupal の更新通知を受け取るには、Drupal Update Manager モジュールが 有効にします。Drupal メニューで [Modules] を選択し、 アップデート マネージャー モジュール。有効になっていない場合は有効にします。

有効にすると、[レポート] >使用可能 [更新] メニュー項目を選択します。次の Drush コマンドを使用することもできます。

> drush pm-info update

このコマンドはサイトのルート ディレクトリから実行する必要があります。デフォルトでは、 ポータルは /opt/apigee/apigee-drupal にインストールされます。そのため、まずディレクトリを /opt/apigee/apigee-drupal を確認します。ポータルを インストール ディレクトリに移動します。

[レポート >利用可能なアップデート >[Settings] メニュー項目で設定します。 アップデートが利用可能になったときにメール通知を受け取れます。また、アップデートの あります。

6. 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 を構成します。

7. SmartDocs をインストールする（省略可）

SmartDocs を使用すると、Developer Services ポータルで API を文書化して、 完全にインタラクティブな API ドキュメント。ただし、ポータルで SmartDocs を使用するには、まず Edge に SmartDocs をインストールします。

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

また、ポータルで SmartDocs を有効にする必要があります。SmartDocs の詳細については、SmartDocs を使用したドキュメントの API。

8. 次のステップ

Developer Services ポータルをインストールしたら、次に、構成とカスタマイズを行います。 カスタマイズが可能です。Apigee ウェブサイトのドキュメントには、 ポータルの構成、スタイル設定、管理に関する情報が含まれます。http://apigee.com/docs/developer-services/content/what-developer-portal でドキュメントにアクセスします。

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