New Edge エクスペリエンスのインストール

Edge for Private Cloud v4.19.01

このドキュメントでは、Edge for Private Cloud の New Edge エクスペリエンスをインストールする方法について説明します。New Edge エクスペリエンスは次世代の Edge UI です。

Edge for Private Cloud インストール環境で New Edge エクスペリエンスを試すには、次の作業が必要です。

Edge で SAML を有効にします。New Edge experience は、認証メカニズムとして SAML のみサポートします。
New Edge エクスペリエンスを独自のノードにインストールします。他の Edge コンポーネントが含まれるノード（既存の Edge UI が存在するノードなど）に New Edge エクスペリエンスをインストールすることはできません。そうすると、ユーザーが従来の Edge UI にログインできなくなります。

New Edge エクスペリエンスの詳細については、New Edge エクスペリエンス for Private Cloud をご覧ください。

インストールの概要

Edge for Private Cloud の New Edge エクスペリエンスをインストールするには、次の 2 種類のインストールプロセスを実施します。

「shoehorn」と呼ばれる基本 Edge UI をインストールし、Edge での認証に SAML を使用するよう Edge UI を構成します。

注: 基本 Edge UI を使用して Edge に接続することはできません。これは単に New Edge エクスペリエンスのインストールに必要なだけです。
New Edge experience をインストールし、Edge で認証に SAML を使用するよう New Edge experience を構成します。New Edge experience をインストールしたら、ログインして Edge で使用できます。

インストールの前提条件

New Edge experience をインストールする前に、Edge で SAML を有効にする必要があります。New Edge experience は、認証メカニズムとして SAML のみサポートします。
注: 本番環境以外では、Edge で Basic 認証を有効にしたままにできます。これにより従来の UI や Edge API のユーザーは、引き続き Basic 認証を使用できます。

Edge で SAML を有効にする方法の詳細については、Edge for Private Cloud での SAML のサポートをご覧ください。
New Edge エクスペリエンスでは TLS v1.2 のみがサポートされます。SAML IDP には TLS で接続するため、使用する SAML IDP が TLS v1.2 をサポートしている必要があります。
New Edge エクスペリエンスは独自のノードにインストールする必要があります。他の Edge コンポーネントが含まれるノード（既存の Edge UI が存在するノードなど）に New Edge エクスペリエンスをインストールすることはできません。

このノードは次の要件を満たしている必要があります。
- JAVA 1.8
- 4 GB の RAM
- 2 コア
- 60 GB のディスク容量
- Edge apigee-setup ユーティリティのインストールの説明に従って、まず apigee-setup ユーティリティのバージョン 4.19.01 をこのノードにインストールする必要があります。
- ポート 3001 が開いている必要があります。これは New Edge エクスペリエンスへのリクエストに使用されるデフォルトのポートです。後述のプロパティを使用してポートを変更する場合は、そのポートが開いていることを確認します。

New Edge エクスペリエンスをインストールする前の考慮事項

上記の前提条件で説明したように、New Edge experience では、Edge で SAML を有効にする必要があります。つまり、ユーザー認証は SAML IDP によって管理され、ユーザー ID としてメールアドレスを使用するように SAML IDP を構成します。したがって、すべての New Edge experience ユーザーを SAML IDP に登録する必要があります。

Edge for the Private Cloud とともにインストールされるデフォルトの UI である Edge classic UI は、SAML を必要としません。SAML か Basic 認証のどちらでも使用できます。つまり、次のどちらも可能です。

classic UI と New Edge experience の両方で SAML サポートを有効にする。
このシナリオでは、classic UI と New Edge experience のユーザーはすべて、SAML IDP に登録されます。SAML IDP に新しいユーザーを登録する方法の詳細については、新しい Edge ユーザーを登録するをご覧ください。
Edge で SAML サポートを有効にするが、Basic 認証は有効のままにしておく。New Edge experience では SAML を使用し、classic UI では引き続き Basic 認証を使用する。
このシナリオでは、classic UI ユーザーはすべて Basic 認証情報でログインし、認証情報は Edge OpenLDAP データベースに格納されます。New Edge experience ユーザーは SAML IDP に登録され、SAML を使用してログインします。

ただし従来の UI ユーザーは、新しい Edge ユーザーを登録するの説明に従って SAML IDP に登録されるまで、New Edge エクスペリエンスにログインできません。

インストール構成の以前のリリースからの変更点

New Edge エクスペリエンスのベータ版リリースから、インストール手順の以下の点が変更されました。

インストール構成の Edge 4.18.05 からの変更点

New Edge エクスペリエンスの Edge 4.19.01 リリースでは、構成ファイルが Edge 4.18.05 リリースから次のように変更されました。

変更の種類	影響を受けるプロパティ
削除	MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS このプロパティには 0.5（30 分）の値が事前定義されており、変更できません。
追加	New Edge エクスペリエンスで TLS を有効にするためのプロパティが使用できるようになりました。詳細については、New Edge エクスペリエンスに対する TLS の構成をご覧ください。

変更の種類

影響を受けるプロパティ

削除


MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

このプロパティには 0.5（30 分）の値が事前定義されており、変更できません。

追加

New Edge エクスペリエンスで TLS を有効にするためのプロパティが使用できるようになりました。詳細については、New Edge エクスペリエンスに対する TLS の構成をご覧ください。

インストール構成の Edge 4.18.01 からの変更点

New Edge エクスペリエンスの Edge 4.19.01 リリースでは、構成ファイルが Edge 4.18.01 リリースから次のように変更されました。

変更の種類	影響を受けるプロパティ
追加	# Shoehorn UI configurations. SHOEHORN_SCHEME SHOEHORN_IP SHOEHORN_PORT # Classic UI configurations. CLASSIC_UI_SCHEME CLASSIC_UI_IP CLASSIC_UI_PORT # Information about Edge SSO module. MANAGEMENT_UI_SKIP_VERIFY
削除	ROUTES_SHOEHORN ROUTES_CLASSICUI
置き換え	MANAGEMENT_UI_USE_HTTPS 置き換え元: MANAGEMENT_UI_SCHEME

変更の種類

影響を受けるプロパティ

追加


# Shoehorn UI configurations.
    SHOEHORN_SCHEME
    SHOEHORN_IP
    SHOEHORN_PORT

    # Classic UI configurations.
    CLASSIC_UI_SCHEME
    CLASSIC_UI_IP
    CLASSIC_UI_PORT

    # Information about Edge SSO module.
    MANAGEMENT_UI_SKIP_VERIFY

削除


ROUTES_SHOEHORN
    ROUTES_CLASSICUI

置き換え


MANAGEMENT_UI_USE_HTTPS

置き換え元:


MANAGEMENT_UI_SCHEME

インストール構成ファイル

構成ファイルには、New Edge experience のインストールと構成に必要な情報がすべて含まれます。基本 UI と New Edge experience の両方のインストールと構成に、同じ構成ファイルを使用できます。

構成ファイルの例は次のとおりです。

# IP of the Edge Management Server.
# This node also hosts the Edge SSO module and the current, or classic, Edge UI.
IP1=11.111.111.111

# IP of the New Edge experience node.
IP2=22.222.222.222

# Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword # If omitted, you are prompted for it.

# Edge Management Server information.
APIGEE_PORT_HTTP_MS=8080
MSIP=$IP1
MS_SCHEME=http

#
# New Edge experience configuration.
#

# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the New Edge experience.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=CHANGE_TO_YOUR_SECRET
# Duration of CSRF token.
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
# Defaults to 8760 hours, or 365 days.
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=8760

# SSO configuration for the New Edge experience.
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y
MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret111

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the New Edge experience.
SHOEHORN_SCHEME=http
SHOEHORN_IP=$MANAGEMENT_UI_IP
SHOEHORN_PORT=9000

#
# Edge Classic UI configuration.
# Some settings are for the classic UI,
# but are still required to configure the New Edge experience.
#

# These settings assume that classic UI is installed on the Management Server.
CLASSIC_UI_IP=$MSIP
CLASSIC_UI_PORT=9000
CLASSIC_UI_SCHEME=http
EDGEUI_PUBLIC_URIS=$CLASSIC_UI_SCHEME://$CLASSIC_UI_IP:$CLASSIC_UI_PORT

# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERD_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS

# Enable SSO.
EDGEUI_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso.
# The default client name is edgeui.
# Apigee recommends that you use the same settings as you used
# when enabling SAML on the classic Edge UI.
EDGEUI_SSO_CLIENT_NAME=edgeui
# Oauth client password using uppercase, lowercase, number, and special chars.
EDGEUI_SSO_CLIENT_SECRET=ssoClient123
# If set, existing EDGEUI client will deleted and new one will be created.
EDGEUI_SSO_CLIENT_OVERWRITE=y

# Information about Edge SSO module.
# Externally accessible IP or DNS of Edge SSO module.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on the Edge SSO module.
# If Edge SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# SSO admin credentials as set when you installed Edge SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

#
# Required SMTP information.
#

SKIP_SMTP=n # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.com
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPPORT=465 # If no SSL, use a different port, such as 25.
SMTPMAILFROM="My Company myco@company.com"

基本 Edge UI（shoehorn）をインストールする

New Edge experience をインストールする前に、shoehorn と呼ばれる基本 Edge UI をインストールする必要があります。

基本 UI をインストールするには:

Edge apigee-setup ユーティリティのインストールの説明に従って、apigee-setup ユーティリティのバージョン 4.19.01 をノードにインストールします。
yum のキャッシュを消去します。
```
sudo yum clean all
```
前述のとおり構成ファイルを作成し、オーナーが「apigee」ユーザーであることを確認します。
```
chown apigee:apigee configFile
```
ここで、configFile は前述のインストール構成ファイルで説明した構成ファイルです。
構成ファイル内の MANAGEMENT_UI_SSO_CSRF_SECRET プロパティの値を CSRF シークレットに変更します。
注: CSRF シークレットを、上記の構成ファイルの例に示したデフォルト値のままにしないでください。他の人に知られていない固有の値に変更してください。
Edge UI の Shoehorn バージョンをインストールします。
```
/opt/apigee/apigee-service/bin/apigee-service edge-ui install
```

Edge UI を構成します。

/opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile

Edge UI で SAML を有効にします。
```
/opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile
```
注意: 次のとおり New Edge experience をインストールして構成するまでは、UI にログインしないでください。

New Edge experience をインストールする

基本 Edge UI をインストールしたら、New Edge experience をインストールして構成できます。

New Edge experience をインストールするには:

New Edge experience をインストールします。

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui install

edge-management-ui ディレクトリに移動します。
```
cd /opt/apigee/edge-management-ui
```
New Edge experience を構成します。
```
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile
```
ここで、configFile は前述のインストール構成ファイルで説明した構成ファイルです。

New Edge experience で SAML を有効にします。

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile

ブラウザで次の URL を開いて、New Edge experience にログインします。
```
http://newEdgeExperienceIP:3001
```
ここで newEdgeExperienceIP は、New Edge experience をホストしているノードの IP アドレスです。SAML 認証情報の入力が求められます。認証情報を入力すると、New Edge エクスペリエンスが表示されます。
詳細については、New Edge エクスペリエンス for Private Cloud をご覧ください。このページには、New Edge エクスペリエンスの使用方法へのリンクがあります。

New Edge エクスペリエンスをアンインストールする

New Edge experience をアンインストールするには:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui uninstall

基本 Edge UI（shoehorn）をアンインストールするには:

/opt/apigee/apigee-service/bin/apigee-service edge-ui uninstall

ノードから Edge を完全に削除するには:

マシン上で稼働しているすべての Edge サービスを停止します。
```
/opt/apigee/apigee-service/bin/apigee-all stop
```
yum のキャッシュを消去します。
```
sudo yum clean all
```

Apigee RPM をすべて削除します。

sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")

インストールルートディレクトリを削除します。
```
sudo rm -rf /opt/apigee
```