このページは Cloud Translation API によって翻訳されました。

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 エクスペリエンスでは、認証メカニズムとして SAML のみがサポートされています。
New Edge エクスペリエンスは単独のノードにインストールします。他の Edge コンポーネントを含むノード（既存の Edge UI が存在するノードなど）にインストールすることはできません。そのようにすると、ユーザーが従来の Edge UI にログインできなくなります。

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

インストールの概要

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

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

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

インストールの前提条件

New Edge エクスペリエンスをインストールする前に、Edge で SAML を有効にする必要があります。New Edge エクスペリエンスでは、認証メカニズムとして SAML のみがサポートされています。
注: 非本番環境では、Classic UI と Edge API のユーザーが引き続き Basic 認証を使用できるように、Edge で 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 が存在するノードなど）にインストールすることはできません。

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

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

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

Edge for Private Cloud とともにインストールされたデフォルトの UI である Edge Classic UI では、SAML は不要です。SAML 認証と Basic 認証のいずれかを使用できます。つまり、次のいずれかを行うことができます。

Edge と、Classic UI と New Edge エクスペリエンスの両方で SAML サポートを有効にします。
このシナリオでは、Classic UI と New Edge エクスペリエンスのすべてのユーザーが SAML IDP に登録されます。SAML IDP に新しいユーザーを追加する方法については、新しい Edge ユーザーを登録するをご覧ください。
Edge で SAML サポートを有効にするが、基本認証は有効のままにする。New Edge エクスペリエンスでは SAML が使用され、Classic UI では引き続き Basic 認証が使用されます。
このシナリオでは、すべての Classic UI ユーザーが基本認証情報を使用してログインします。この認証情報は Edge OpenLDAP データベースに保存されます。New Edge エクスペリエンスのユーザーは SAML IDP に登録され、SAML を使用してログインします。

ただし、Classic 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 エクスペリエンスのインストールと構成に必要なすべての情報が含まれています。同じ構成ファイルを使用して、基本 UI と New Edge エクスペリエンスの両方をインストールして構成できます。

構成ファイルの例を以下に示します。

# 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_REGISTERED_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 エクスペリエンスをインストールする前に、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 エクスペリエンスのインストールと構成が完了するまで、UI にログインしないでください。

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

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

New Edge エクスペリエンスをインストールするには:

New Edge エクスペリエンスをインストールします。

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

edge-management-ui ディレクトリに移動します。
```
cd /opt/apigee/edge-management-ui
```
New Edge エクスペリエンスを構成します。
```
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile
```
ここで、configFile は、上記のインストール構成ファイルで説明されている構成ファイルです。

New Edge エクスペリエンスで SAML を有効にします。

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

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

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

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

/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
```