New Edge Experience のインストール

Edge for Private Cloud v4.19.01

このドキュメントでは、Edge for Private Cloud 用の新しい 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 エクスペリエンスの詳細については、Private Edge 用の New Edge エクスペリエンスをご覧ください。

インストールの概要

Edge for Private Cloud 用の New Edge エクスペリエンスをインストールするには、次の 2 つの方法があります。

  • shoehorn という名前のベース Edge UI をインストールし、SAML を使用して Edge の認証を行うようにベース Edge UI を構成します。
  • New Edge エクスペリエンスをインストールし、SAML を使用して Edge の認証を行うように New Edge エクスペリエンスを構成します。New Edge エクスペリエンスをインストールしたら、ログインして Edge で操作できます。

インストールの前提条件

  • New Edge エクスペリエンスをインストールする前に、Edge で SAML を有効にする必要があります。New Edge エクスペリエンスでは、認証メカニズムとして SAML のみがサポートされています。

    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 が開いている必要があります。これは、新しい 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 および従来の UI と New Edge エクスペリエンスの両方で SAML サポートを有効にします。

    このシナリオでは、従来の UI と New Edge エクスペリエンスのユーザーはすべて SAML IDP に登録されます。SAML IDP に新しいユーザーを追加する方法については、新しい Edge ユーザーを登録するをご覧ください。

  • Edge で SAML サポートを有効にするが、基本認証は有効のままにする。New Edge エクスペリエンスは SAML を使用し、従来の UI は引き続き基本認証を使用します。

    このシナリオでは、すべての従来の UI ユーザーが基本認証情報を使用してログインし、認証情報が Edge OpenLDAP データベースに保存されます。新しい Edge エクスペリエンス ユーザーは SAML IDP に登録され、SAML を使用してログインします。

    ただし、従来の UI ユーザーは、新しい Edge ユーザーを登録するの説明に従って SAML IDP に追加しないと、新しい 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 の構成をご覧ください。

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

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

構成ファイルには、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_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 エクスペリエンスをインストールする前に、shoehorn というベース Edge UI をインストールする必要があります。

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

  1. Edge apigee-setup ユーティリティのインストールの説明に従って、apigee-setup ユーティリティのバージョン 4.19.01 をノードにインストールします。
  2. Clean Yum: 
    sudo yum clean all
  3. 前述のように構成ファイルを作成し、所有者が「apigee」ユーザーであることを確認します。 
    chown apigee:apigee configFile

    ここで、configFile は、上記のインストール構成ファイルで説明した構成ファイルです。

  4. 構成ファイルの MANAGEMENT_UI_SSO_CSRF_SECRET プロパティの値を CSRF Secret に変更します。
  5. Shoehorn バージョンの Edge UI をインストールします。 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. Edge UI を構成します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. Edge UI で SAML を有効にします。 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

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

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

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

  1. New Edge エクスペリエンスをインストールします。 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. edge-management-ui ディレクトリに移動します。 
    cd /opt/apigee/edge-management-ui
  3. New Edge エクスペリエンスを構成します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    ここで、configFile は、上記のインストール構成ファイルで説明した構成ファイルです。

  4. New Edge エクスペリエンスで SAML を有効にします。 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. ブラウザで次の URL を開いて New Edge エクスペリエンスにログインします。 
    http://newEdgeExperienceIP:3001

    ここで、newEdgeExperienceIP は New Edge エクスペリエンスをホストするノードの IP アドレスです。SAML 認証情報の入力を求められます。認証情報を入力すると、New Edge エクスペリエンスが表示されます。

  6. 詳細については、Private Cloud 用の新しい Edge エクスペリエンスをご覧ください。New 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 を完全に削除するには:

  1. マシンで実行されているすべての Edge サービスを停止します。 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Yum キャッシュを削除します。 
    sudo yum clean all
  3. Apigee RPM をすべて削除します。 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. インストール ルート ディレクトリ 
    sudo rm -rf /opt/apigee
    を削除します。