新しい Edge UI をインストールする

このドキュメントでは、Apigee Edge for Private Cloud の Edge UI をインストールする方法について説明します。Edge UI は、 UI の生成について見ていきましょう。

前提条件

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

• Edge UI を独自のノードにインストールします。既存の VM で実行されているノードには、 には、既存の Classic UI が存在するノードなど、他の Edge コンポーネントが含まれます。 そのようにすると、ユーザーが従来の UI にログインできなくなります。

  Edge UI のノードは、次の要件を満たす必要があります。

  • Java 1.8
  • 4 GB の RAM
  • 2 コア
  • 60 GB のディスク容量
  • まず、バージョン 4.51.00 の apigee-setup をインストールする必要があります。 （インストール Edge apigee-setup ユーティリティ。
  • ポート 3001 が開いている必要があります。これは、Edge UI へのリクエストに使用されるデフォルトのポートです。条件 ポートを変更する場合は、 新しい UE 構成ファイルの場合は、 ポートが開いています。
• Edge で外部 IDP を有効にします。Edge UI では、サービス アカウントとして SAML または LDAP を あります。
• （SAML IDP のみ）Edge UI は TLS v1.2 のみをサポートしています。Google Cloud の SAML IDP over TLS の場合は、SAML を使用する場合は、ご利用の IDP が TLS v1.2 をサポートしている必要があります。

Edge UI の詳細については、Private Cloud 用の新しい Edge UI をご覧ください。

インストールの概要

Apigee Edge for Private Cloud の Edge UI をインストールするプロセスの概要は次のとおりです。

• クラスタに新しいノードを追加する
• 新しいノードにログインする
• apigee-setup ユーティリティをダウンロードする
• 構成ファイルを作成し、設定で変更する
• apigee-setup ユーティリティを実行する
• 新しい UE にログインしてテストする

新しいノードで実行すると、apigee-setup ユーティリティは次の処理を行います。

• 「shoehorn」と呼ばれる従来の基本 UI がインストールされます。 は、外部 IDP を使用して Edge で認証するように Classic UI を構成します。
• 新しい Edge UI をインストールし、外部ユーザー インターフェースを使用するように Edge UI を構成します。 IDP を使用して Edge で認証します。

新しい Edge をインストールする前の考慮事項 UI

前述の前提条件で説明したように、Edge UI を使用するには、事前に 外部 IDP ですつまり、ユーザー認証は IDP によって制御されます。IDP では、 メールアドレスをユーザー ID として使用します。そのため、すべての Edge UI ユーザーは、 IDP に登録されている必要があります。

従来の UI（Apigee Edge for Private Cloud とともにインストールされるデフォルト UI）では、外部 IdP。IDP 認証または基本認証を使用できます。つまり、次のいずれかを行うことができます。

• Edge 上、および Classic UI と Edge UI の両方で外部 IDP のサポートを有効にします。

  このシナリオでは、すべての Classic UI ユーザーと Edge UI ユーザーが IDP に登録されます。対象 IDP への新規ユーザーの追加について詳しくは、以下をご覧ください。 新しい Edge ユーザーを登録します。

• Edge で外部 IDP のサポートを有効にするが、基本認証は有効のままにする。Edge UI では IDP が使用され、従来の UI では引き続き基本認証が使用されます。

  このシナリオでは、すべての Classic UI ユーザーが Basic 認証情報でログインします。 Edge OpenLDAP データベースに認証情報が保存されます。Edge UI ユーザーは、 SAML または LDAP を使用してログインします。

  ただし、Classic UI ユーザーは、ユーザーを追加するまで Edge UI にログインできません。 そのユーザーを IDP に登録します。詳しくは、新しい Edge の登録 できます。

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

次のベータ版リリースからのインストール手順の変更点に注意してください: Edge UI。

MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

# Shoehorn/Classic 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 構成ファイル

次の構成ファイルには、Terraform のインストールと構成に必要な 新しい Edge UI を構成します。同じ構成ファイルを使用して、両方をインストールして構成できます。 Edge UI です。

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

# IP of the Edge UI node.
IP2=edge_UI_server_IP

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

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

#
# Edge UI configuration.
#

# Enable the Edge UI.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the Edge UI.
# The management UI port must be open for requests to the Edge UI
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Set to 'OPDK' to specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=http

# Location of Edge UI.
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=YOUR_CSRF_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 Edge UI.
MANAGEMENT_UI_SSO_ENABLED=y

# Only required if MANAGEMENT_UI_SSO_ENABLED is 'y'
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y

MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=your_client_sso_secret

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the Edge UI.
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 Edge UI.
#

# 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 your IDP on the Classic 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

# Apigee SSO Component configuration
# 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 Apigee SSO module.
# If Apigee 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 Apigee SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=your_sso_admin_secret

#
##      SSO Configuration (define external IDP)           #
#
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                        #
#  - LDAP Direct Binding configuration properties         #
#  - LDAP Indirect Binding configuration properties       #

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect)

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

Edge UI をインストールする

構成ファイルを作成して変更したら、そのファイルに新しい Edge UI をインストールできます。 作成します。

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

1. クラスタに新しいノードを追加します。
2. 新しいノードに管理者としてログインします。
3. 4.51.00 バージョンの apigee-setup ユーティリティをノードにインストールします。 Edge apigee-setup のインストール、 ユーティリティです。
4. 次のコマンドを実行して、Yum でキャッシュに保存されたすべての情報を消去します。

   sudo yum clean all

5. New Edge UI 構成ファイルを参照し、このファイルが「apigee」によって所有されていることを確認します。user:

   chown apigee:apigee configFile

   構成ファイルは、必ず次のように編集してください。

   • MANAGEMENT_UI_SSO_CSRF_SECRET プロパティの値を次のように変更します。 CSRF シークレットに追加します。
   • 次のいずれかを使用するように Edge を構成します（新しい Edge UI には外部 IDP が必要です）。 <ph type="x-smartling-placeholder">
     </ph>
     • SAML
     • LDAP

     詳細については、外部 IDP の概要をご覧ください。 認証をご覧ください。

6. Edge UI へのアクセス権を付与するユーザーで外部 IDP を構成します。対象 詳細については、新しい Edge ユーザーを登録するをご覧ください。
7. 新しいノードで、次のコマンドを実行します。

   /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

   apigee-setup ユーティリティは Classic UI をインストールします。従来の UI に加えて Edge UI がインストールされます。

8. ブラウザで次の URL を開き、Edge UI にログインします。

   http://new_edge_UI_IP:3001

   ここで、new_edge_UI_IP は新しい Edge をホストするノードの IP アドレスです。 UI です。

   外部 IDP の認証情報の入力を求められます。

9. 認証情報を入力します。

   新しい Edge UI が表示されます。Edge UI の使用方法については、Private Cloud 用の新しい Edge UI をご覧ください。

   Edge UI が表示されない場合は、ポート 3001 が 外部接続にも使用できます。

新しい UI をアンインストールする

ノードから新しい UI をアンインストールするには、新しい Edge UI と UI のインストール時にノードにインストールされた従来のベース UI（靴ホーン） プロセスです

新しい Edge UI をアンインストールするには:

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

ベースとなるクラシック UI（靴ホーン）をアンインストールするには:

/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