Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

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

Edge for Private Cloud v4.19.01

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

Edge for Private Cloud のインストールで新しい Edge エクスペリエンスを試すには、次のことを行う必要があります。

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

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

インストールの概要

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

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

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

インストールの前提条件

新しい Edge エクスペリエンスをインストールする前に、Edge で SAML を有効にする必要があります。新しい Edge エクスペリエンスでは、認証メカニズムとして SAML のみがサポートされています。
注: 非本番環境では、Edge で基本認証を有効にしたままにして、従来の UI と Edge API のユーザーが基本認証を引き続き使用できるようにします。
Edge で SAML を有効にする方法については、Edge for Private Cloud での SAML のサポートをご覧ください。
新しい Edge エクスペリエンスは TLS v1.2 のみをサポートしています。TLS 経由で SAML IDP に接続するため、SAML IDP は TLS v1.2 をサポートしている必要があります。
新しい Edge エクスペリエンスは、独自のノードにインストールする必要があります。既存の Edge UI が存在するノードなど、他の Edge コンポーネントを含むノードにはインストールできません。

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

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

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

Edge Classic UI（Edge for プライベートクラウドでインストールしたデフォルトの UI）では、SAML は必要ありません。SAML 認証または基本認証を使用できます。つまり、次のいずれかを行うことができます。

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

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

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

新しい 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 分）という事前定義値があり、変更できません。
追加	プロパティを使用して、新しい Edge エクスペリエンスで TLS を有効にできるようになりました。詳細については、新しい Edge エクスペリエンスに対する TLS の構成をご覧ください。

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

新しい 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

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

構成ファイルには、新しい Edge エクスペリエンスのインストールと構成に必要なすべての情報が含まれています。同じ構成ファイルを使用して、ベース UI と新しい 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 Experience をインストールする前に、shoehorn と呼ばれるベースの Edge UI をインストールする必要があります。

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

Edge apigee-setup ユーティリティのインストールの説明に従って、4.19.01 バージョンの apigee-setup ユーティリティをノードにインストールします。
Yum をクリーンアップします。
```
sudo yum clean all
```
上記のように構成ファイルを作成し、所有者が「apigee」ユーザーであることを確認します。
```
chown apigee:apigee configFile
```
ここで、configFile は、インストール構成ファイルで説明されている構成ファイルです。
構成ファイルの MANAGEMENT_UI_SSO_CSRF_SECRET プロパティの値を CSRF シークレットに変更します。
注: CSRF シークレットには、上記の構成ファイルの例のデフォルト値を使用しないでください。自分だけが知っている一意の値に変更します。
Shoehorn バージョンの Edge UI をインストールします。
```
/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
```
注意: 以下の新しい Edge エクスペリエンスをインストールして構成するまで、UI にログインしないでください。

新しい Edge エクスペリエンスをインストールする

ベースの Edge UI をインストールしたら、New Edge Experience をインストールして構成できます。

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

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

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

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

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

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

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

新しい Edge エクスペリエンスをアンインストールする

新しい 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
```