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

Edge for Private Cloud v4.19.01

Apigee Developer Services ポータル（略して「ポータル」）をインストールする前に、次のことを確認してください。

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

インストーラには、アプリケーションのデプロイに必要な Drupal 提供モジュールのみ Apigee Developer Services ポータル（略して「ポータル」）他の提供モジュールをインストールする方法については、以下をご覧ください。 Drupal 7 の拡張。

インストールの概要

ポータルをインストールするには、次の操作を行います。これらの各ステップについては、 以降のセクションで詳しく説明します。

  1. 接続をテストする
  2. 7.0 より前のバージョンの PHP を削除する
  3. Postgres をインストールする
  4. ポータルをインストールする
  5. アップデート マネージャーが有効になっていることを確認する
  6. （省略可）Apache Solr を構成する
  7. （省略可）SmartDocs をインストールする
  8. （省略可）JQuery を構成する

SMTPSSL プロパティのサポート終了

以前のリリースでは、SMTPSSL プロパティを使用して以下を行っていました。 ポータルに接続された SMTP サーバーで使用されるプロトコルを設定します。そのプロパティは 非推奨です。

ここでは、SMTP_PROTOCOL プロパティを使用します。 SMTPSSL プロパティではなく、 ポータルに接続された SMTP サーバーが使用しているプロトコル。有効な値: "standard"、 "ssl"、"tls"。

ポータル構成ファイルを作成する

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

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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

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

# Optionally configure the SMTP server used by the portal.
# If you do, 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

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# 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=YOUR_EMAIL_PASSWORD

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

ポータルをインストールするサーバーと Edge の間の接続をテストする （ポータル サーバーで次の curl コマンドを実行）

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 です。

成功すると、curl から次のようなレスポンスが返されます。

{
  "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

次のコマンドを使用して PHP パッケージを削除します。

yum remove package_name

PHP がサーバーにインストールされているかどうかわからない場合は、次のコマンドを使用します。

rpm -qa | grep -i php

ポータルでは PHP バージョン 4.18.01 ～ 0.0.49 を使用します。これは、 Apigee Edge for Private Cloud のバージョン番号。

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 構成ファイルを作成します。 
    # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost
HOSTIP=$(hostname -i)

# The pod and region of Postgres. Use the default values shown below.
MP_POD=gateway
REGION=dc-1

# Set the Postgres password. The default value is 'postgres'.
PG_PWD=postgres
  3. コマンド プロンプトで、設定スクリプトを実行して Postgres をインストールします。 
    /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

    -p pdb オプションは、Postgre をインストールするように指定します。構成ファイルは、 「apigee」がアクセスまたは読み取りできるようにするできます。

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

ポータルをインストールする前に、 3.Postgres をインストールする:

  1. ポータルのノードに Edge apigee-setup ユーティリティをインストールする
  2. Postgres をスタンドアロンで、または Edge のインストールの一環としてインストールします。

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

  1. コマンド プロンプトで、setup スクリプトを実行します。 
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    ここで

    • configFile は、次のポータル構成ファイルです。 ポータル構成ファイルを作成します。
    • -p dp は、setup スクリプトにポータルをインストールするように指示します。

ポータルのインストールが成功したことを確認するには:

  1. ポータルのホームページ（http://localhost:8079）または DNS 名に移動します 確認できます。
  2. ポータルで設定した管理者認証情報を使用してポータルにログインする 構成ファイルが更新されます。
  3. [レポート >Status レポートを Drupal のメニューから ポータルの現在のステータスを確認できます。
  4. Management Server への接続が成功したことを確認します。登録されていない場合: <ph type="x-smartling-placeholder">
      </ph>
    1. ポータルの [Connection Configuration] ページに移動します（ http://portal_IP:8079/admin/config/devconnect）。
    2. [Test Connection] ボタンをクリックします。接続に成功したら 完了です。接続に失敗した場合は、続行します。
    3. エンドポイントと認証の設定を確認します。 <ph type="x-smartling-placeholder">
        </ph>
      • Management API endpoint URL: プロトコル（HTTP または HTTPS）が IP または DNS 名、ポート番号が正しいことを確認します。次に例を示します。 
        http://10.10.10.10:8080/v1
      • エンドポイント認証されたユーザー: 組織管理者の 表示されます。
      • Authenticated user's password: 組織管理者の あります。

      デフォルト値には、作成したポータル構成ファイルの設定が反映されています。 自動的に作成します。

      これらの値は、ms_IP_or_DNS、email、および ステップで使用した password の値 1: Apigee Edge への接続をテストする。 また、ユーザー名とパスワードは USER_NAME の値と一致している必要があります。 および USER_PWD プロパティを オンボーディング構成ファイル、 組織管理者というロールを持つユーザーの、認証情報を取得できます。

    4. Management Server への接続に成功したら、[Save 設定ボタンをクリックして変更を保存します。

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

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

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

drush pm-info update

このコマンドはサイトのルート ディレクトリから実行する必要があります。デフォルトでは、 ポータルは /opt/apigee/apigee-drupal/wwwroot にインストールされます。したがって、 最初にディレクトリを /opt/apigee/apigee-drupal/wwwroot に変更してから、 表示されます。ポータルをデフォルト ディレクトリにインストールしていない場合は、 ディレクトリに配置します。

[レポート >利用可能なアップデート >[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 を使用すると、ポータル上の API を、 完全にインタラクティブな API ドキュメント。ただし、ポータルで SmartDocs を使用するには、まず Edge に SmartDocs をインストールします。

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

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

8. 構成する インターネット以外のインストール用の JQuery 更新モジュール（省略可）

インターネット以外の環境に JQuery 更新モジュールをインストールして使用する場合は、次のことを行う必要があります。 ローカル バージョンの JQuery を使用するようにモジュールを構成します。CDN を使用してモジュールを構成し、 インターネット以外のインストールでは CDN にアクセスを試み、ページで遅延を発生させます。 読み込み中。JQuery 更新モジュールの詳細については、このモジュールの https://www.drupal.org/project/jquery_update.

ローカル バージョンの JQuery を使用するように JQuery 更新モジュールを構成するには:

  1. 管理者またはコンテンツ作成権限を持つユーザーとしてポータルにログインします。
  2. [Configuration] >開発 >JQuery Update] をクリックします。
  3. 左側のナビゲーションで [パフォーマンス] をクリックします。
  4. [JQuery and JQuery UI CDN] プルダウンで [None] を選択します。
  5. [構成を保存] をクリックします。

9. 次のステップ

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

タスク 説明

テーマをカスタマイズする

テーマによって、色、スタイル、その他の形式など、ポータルの外観が サポートします。

外観をカスタマイズする

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

ユーザー アカウントの管理

登録プロセスでは、新しいデベロッパーが 登録できますたとえば、新しい開発者がポータルに即座にアクセスできるようにするか、 管理者が確認する必要があります。また、このプロセスでは、 新しいアカウントが作成されると管理者に通知されます。

メールの構成

特定のイベントが発生すると、ポータルからメールが送信されます。たとえば、 デベロッパーがポータルに登録し、デベロッパーがパスワードを紛失したとき。

ユーザー アカウントの管理

キーワードを追加してデベロッパーが許可する前に同意する必要がある [Conditions] ページ 登録する必要があります

ユーザー アカウントの管理

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

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

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

データベースのバックアップを行ってください。

Drupal データベースをバックアップしていることを確認します。なお、 バックアップとバックアップはそれぞれ異なるため、 データベースです

バックアップの実行方法もご覧ください。

ホスト名を設定する

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

ロードバランサを設定している場合や、サイトの一部で正しくない URL を取得している場合 その他の理由で、Drupal に $base_url を設定するには、次の手順を行います。

  1. ディレクトリ /opt/apigee/data/apigee-drupal-devportal/sites/default/includes を作成します。 返されます。
  2. このディレクトリに settings.php という名前のファイルを作成します。
  3. 次のコードを settings.php ファイルに追加します。 
    /**
* Base URL (optional).
*
* If Drupal is generating incorrect URLs on your site, which could
* be in HTML headers (links to CSS and JS files) or visible links
* on pages (such as in menus), uncomment the Base URL statement
* below (remove the leading hash sign) and fill in the absolute URL
* to your Drupal installation.
*
* You might also want to force users to use a given domain.
* See the .htaccess file for more information.
*
* Examples:
*   $base_url = 'http://www.example.com';
*   $base_url = 'http://www.example.com:8888';
*   $base_url = 'http://www.example.com/drupal';
*   $base_url = 'https://www.example.com:8888/drupal';
*
* It is not allowed to have a trailing slash; Drupal will add it
* for you.
*/
# $base_url = 'http://www.example.com/';  // NO trailing slash!
$base_url = ‘http://www.example.com’;
  4. 最後の $base_url 行をサイトのホスト名に変更します。
  5. ファイルを保存します。

/opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php のその他の設定もこのファイルに追加できます。

$base_url プロパティの詳細については、以下をご覧ください。
カスタム開発 また、ポータルの外部にカスタムコードを使用して、ポータルの機能を できます。そのためには、Drupal の モジュール トピックを確認し、/sites/all/modules されます。