Apigee Edge for Private Cloud 4.54.00 では、従来の UI（edge-ui コンポーネント）が削除され、使用できなくなりました。New Edge UI（edge-management-ui コンポーネント）は、Edge for Private Cloud の唯一の UI です。
Edge for Private Cloud 4.54.00 では edge-ui を使用できません。/opt/apigee/customer/application/ui.properties でプロパティを設定して Classic UI をカスタマイズした場合、新しい Edge UI はそのファイルを読み取りません。4.54.00 に更新したら、/opt/apigee/customer/application/management-ui.properties で同等のプロパティを設定する必要があります。
このページでは、ui.properties でドキュメント化されている Classic UI のプロパティ、New Edge UI の同等のプロパティ、New Edge UI でサポートされていない Classic UI のプロパティについて説明します。
New Edge UI は、他の Edge コンポーネントと同じコードと構成（CwC）メカニズムを使用します。詳細については、Edge の構成方法をご覧ください。
Classic UI と新しい Edge UI の構成を比較する
新しい Edge UI は、Classic UI コンポーネント、プロパティ ファイル、サービス名、デフォルト ポート、TLS 証明書形式を置き換えます。次の表を確認して、プロパティを移行する前に自動化スクリプト、ファイアウォール ルール、TLS ファイルを更新してください。
| 設定 | 従来の UI（4.53.01 以前） | 新しい Edge UI（4.54.00） |
|---|---|---|
| コンポーネント名 | edge-ui |
edge-management-ui |
| プロパティ ファイル | /opt/apigee/customer/application/ui.properties |
/opt/apigee/customer/application/management-ui.properties
|
| restart コマンド | apigee-service edge-ui restart |
apigee-service edge-management-ui restart |
| デフォルト ポート | 9000 | 3001 |
| TLS 構成 | Java キーストア（JKS）ファイル | PEM 証明書と鍵ファイル。新しい Edge UI の TLS を構成するをご覧ください。 |
新しい Edge UI のプロパティを設定する
/opt/apigee/customer/application/management-ui.properties で新しい Edge UI 構成プロパティを設定し、edge-management-ui サービスを再起動して変更を有効にします。
新しい Edge UI のプロパティを設定するには:
-
management-ui.propertiesファイルをエディタで開きます。ファイルが存在しない場合は作成します。vi /opt/apigee/customer/application/management-ui.properties
-
プロパティを設定します。次に例を示します。
conf_uebe_disableGeoMap=true
- 変更を保存します。
-
ファイルが
apigeeユーザーによって所有されていることを確認します。chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
-
新しい Edge UI を再起動します。
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
New Edge UI のプロパティを設定する際は、次の書式設定ルールに従ってください。
-
プロパティ名では大文字と小文字が区別されます。たとえば、
conf_uebe_disableGeoMapは有効ですが、conf_uebe_disablegeomapは無効です。 -
文字列値は二重引用符で囲みます（例:
conf_uebe_branding_companyNameShort="My Company"）。 -
ブール値（
trueまたはfalse）や数値を引用符で囲まないでください。ブール値または数値が引用符で囲まれている場合、新しい Edge UI は起動しません。
プロパティの現在の値を確認するには、-search オプションを使用します。次に例を示します。
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \ configure -search conf_uebe_disableGeoMap
Classic UI のプロパティを新しい Edge UI にマッピングする
次の表に、ui.properties でサポートされている従来の UI プロパティと、management-ui.properties でそれに対応する新しい Edge UI プロパティを示します。[デフォルト] 列には、新しい Edge UI のデフォルト値が表示されます。
フィーチャー プロパティを構成する
従来の UI のフィーチャー トグルを management-ui.properties の対応する conf_uebe_* プロパティにマッピングします。
| 従来の UI プロパティ | 新しい Edge UI プロパティ | デフォルト | メモ |
|---|---|---|---|
conf_apigee_apigee.feature.disablegeomap |
conf_uebe_disableGeoMap |
false |
地域マップを非表示にするには、true に設定します。Edge for Private Cloud のクラシック UI では、地域マップはデフォルトで無効になっていました。地域情報の集計を有効にしていない場合は、このプロパティを true に設定します。地域別集計と GeoMap の有効化をご覧ください。 |
conf_apigee_apigee.feature.disablepasswordreset |
conf_uebe_disablePasswordReset |
false |
true に設定すると、ログイン ページの [パスワードをリセット] リンクが非表示になります。 |
conf_apigee-base_apigee.feature.enableforcerangelimit
|
conf_uebe_enableForceRangeLimit |
true |
14 日を超える期間のカスタム レポートを許可する場合は、false に設定します。 |
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses
|
conf_uebe_trace_for_internal_addresses |
false |
Trace ツールがローカルまたは内部 IP アドレスにリクエストを送信できるようにするには、true に設定します。 |
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses
|
conf_uebe_openapi_for_internal_addresses |
false |
true に設定すると、OpenAPI 仕様をローカル IP アドレスまたは内部 IP アドレスからインポートできます。 |
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses
|
conf_uebe_wsdl_for_internal_addresses |
false |
ローカルまたは内部 IP アドレスから WSDL ファイルをインポートできるようにするには、true に設定します。 |
セッションと TLS のプロパティを構成する
従来の UI のセッション タイムアウトと TLS プロパティを、management-ui.properties の同等の New Edge UI にマッピングします。
| 従来の UI プロパティ | 新しい Edge UI プロパティ | デフォルト | メモ |
|---|---|---|---|
conf_application_session.maxage |
conf_uebe_authsessiontimeout |
12（時間） |
ログイン後にユーザー セッションが期限切れになるまでの時間。時間数（12 や 0.5 など）または h（時間）や m（分）の単位で期間（24h や 90m など）を指定します。12 と 12h の値は同等です。d（日）単位はサポートされていません。たとえば、1d を 24h に置き換えます。値が無効な場合は、デフォルトの 12 時間が使用され、エラーは報告されません。基本認証を使用するセッションに適用されます。 |
conf_application_session.secure |
不要 | 該当なし |
新しい Edge UI では、TLS が有効になっている場合（conf_uebe_usehttps=true）または TLS がロードバランサで終了する場合（conf_uebe_tlsoffload=true）に、セッション Cookie に Secure フラグが自動的に設定されます。 |
conf/application.conf+trustxforwarded |
conf_uebe_usehttps=true、conf_uebe_tlsoffload=true |
false |
TLS がロードバランサで終端される場合は、両方のプロパティを設定します。ロードバランサは、HTTP 経由でリクエストを新しい Edge UI に転送し、X-Forwarded-Proto ヘッダーを設定する必要があります。configure-ssl コマンドは、MANAGEMENT_UI_SCHEME=https と MANAGEMENT_UI_TLS_OFFLOAD=y のときにこれらのプロパティを設定します。新しい Edge UI の TLS を構成するをご覧ください。 |
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate
|
conf_uebe_skipverify |
false |
Management Server が自己署名証明書を使用している場合にのみ、true に設定します。管理 API の TLS の構成をご覧ください。 |
メールのプロパティとテンプレートを構成する
Classic UI のメールの送信者、件名、ブランディング、ホスト URL、リンクの有効期限のプロパティを新しい Edge UI にマッピングします。
| 従来の UI プロパティ | 新しい Edge UI プロパティ | デフォルト | メモ |
|---|---|---|---|
conf_apigee_apigee.mgmt.mailfrom |
conf_apigee_apigee.mgmt.mailfrom |
Apigee <sales@apigee.com>、またはインストール時に指定された SMTPMAILFROM の値 |
変更なし。 |
conf_apigee-base_apigee.emails.passwordreset.subject
|
conf_apigee_apigee.emails.passwordReset.subject |
Password Reset Request |
キャメルケースの passwordReset プロパティ セグメントに注目してください。 |
conf_apigee-base_apigee.emails.useraddedexisting.subject
|
conf_apigee_apigee.emails.userAddedExisting.subject |
You Have Been Added to an Organization {organization}
|
camelCase の userAddedExisting プロパティ セグメントに注目してください。 |
conf_apigee-base_apigee.emails.useraddednew.subject |
conf_apigee_apigee.emails.userAddedNew.subject |
An Account Has been Created for You at {companyNameShort}
|
キャメルケースの userAddedNew プロパティ セグメントに注目してください。 |
conf_apigee_apigee.branding.companynameshort |
conf_uebe_branding_companyNameShort |
Apigee |
メールの件名とテンプレートの {companyNameShort} プレースホルダの値を設定します。 |
conf_apigee_apigee.emails.hosturl |
conf_apigee_apigee.emails.hosturl |
なし |
変更なし。設定されていない場合、パスワードの再設定リンクはインストール時に指定された新しい Edge UI の URL を使用し、ユーザー招待リンクはリクエストのホスト名を使用します。ユーザーがロードバランサまたは DNS 名（conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com" など）を介して新しい Edge UI にアクセスする場合は、このプロパティを設定します。 |
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds
|
conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds
|
600 |
パスワードの再設定リンクとユーザー招待リンクに適用されます。 |
新しい Edge UI では、組み込みのメール テンプレートが使用されます。Classic UI 用にカスタマイズしたテンプレートを使用するには:
-
/opt/apigee/edge-management-ui/email-templatesディレクトリを作成します。 -
カスタマイズした
password-reset.html、user-added-existing.html、user-added-new.htmlファイルを、更新前に作成したバックアップ ディレクトリ（/opt/apigee/customer/backup/など）から/opt/apigee/edge-management-ui/email-templatesにコピーします。テンプレート ファイル名とプレースホルダは、従来の UI と同じです。 -
ディレクトリとファイルの所有者が
apigeeユーザーであることを確認します。 - 新しい Edge UI を再起動します。
詳細については、Edge メール テンプレートのカスタマイズをご覧ください。
自動生成されたパスワードのプロパティを構成する
Classic UI の自動生成されたパスワード プロパティを新しい Edge UI にマッピングします。
| 従来の UI プロパティ | 新しい Edge UI プロパティ | デフォルト |
|---|---|---|
conf_apigee-base_apigee.forgotPassword.underscore.minimum
|
conf_apigee_apigee.forgotPassword.underscore.minimum
|
0 |
conf_apigee-base_apigee.forgotPassword.specialchars.minimum
|
conf_apigee_apigee.forgotPassword.specialchars.minimum
|
0 |
conf_apigee-base_apigee.forgotPassword.lowecase.minimum
|
conf_apigee_apigee.forgotPassword.lowecase.minimum |
0 |
conf_apigee-base_apigee.forgotPassword.uppercase.minimum
|
conf_apigee_apigee.forgotPassword.uppercase.minimum |
0 |
Management Server の接続と共有シークレットのプロパティを構成する
従来の UI の Management Server の接続、認証情報、アプリケーション シークレットのプロパティを新しい Edge UI にマッピングします。
| 従来の UI プロパティ | 新しい Edge UI プロパティ | メモ |
|---|---|---|
conf_apigee_apigee.mgmt.baseurl |
mgmt_baseurl |
Management API の URL（例: https://FQ_domain_name:port/v1）。このプロパティ名は conf_ で始まっていません。Management Server が自己署名証明書を使用している場合は、conf_uebe_skipverify=true も設定します。 |
conf_apigee_apigee.mgmt.credential |
conf_uebe_mgmtCredential |
暗号化された sysadmin 認証情報。./bin/management-ui --encrypt を使用して、新しい Edge UI の認証情報を再度暗号化する必要があります。
さまざまな sysadmin 認証情報に必要な構成をご覧ください。 |
conf_apigee_mail.smtp.credential |
conf_apigee_mail.smtp.credential |
暗号化された SMTP 認証情報。 |
conf_application_application.secret |
conf_uebe_applicationsecret |
認証情報とセッション Cookie の暗号化に使用されるシークレット。インストール時に生成されます。 |
対応不要な Classic UI プロパティを削除
次の Classic UI プロパティは、動作が常に有効になっているため、新しい Edge UI には対応するプロパティがありません。これらのプロパティは management-ui.properties に含めないでください（自動構成スクリプトから削除してください）。
| 従来の UI プロパティ | 新しい Edge UI での動作 |
|---|---|
conf_apigee_apigee.feature.expireSessionCookiesInternally
|
セッションの有効期限は常にサーバーで検証されます。 |
conf_apigee_apigee.feature.trackSessionCookies |
セッション情報は常にサーバーメモリに保存されます。ロードバランサの背後で New Edge UI の複数のインスタンスを使用する場合は、スティッキー セッションを使用するようにロードバランサを構成します。 |
サポートされていない Classic UI プロパティを削除する
次の従来の UI プロパティはサポートされておらず、新しい Edge UI に同等のものはありません。これらのプロパティは management-ui.properties に含めないでください（自動構成スクリプトから削除してください）。
| 従来の UI のプロパティ | 説明 |
|---|---|
conf_apigee_apigee.feature.apitimeout、conf_apigee_play.ws.timeout.idle、conf_apigee_play.ws.timeout.connection |
新しい Edge UI では、管理 API 呼び出しのタイムアウトを構成できません。 |
conf_application_http.proxyhost、conf_application_http.proxyport、conf_application_http.proxyuser、conf_application_http.proxypassword |
新しい Edge UI は、Trace ツール リクエストの転送プロキシをサポートしていません。 |
conf_apigee-base_apigee.feature.enableconsentbanner、conf_apigee-base_apigee.consentbanner.buttoncaption、conf_apigee-base_apigee.consentbanner.body |
同意モードのバナーは、新しい Edge UI ではサポートされていません。 |
conf_apigee-base_apigee.feature.apiproxypaginationenabled、conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize |
New Edge UI では、API プロキシのリストは常にページ単位で読み込まれます。ページサイズは構成できません。 |
conf_logger_settings_application_log_level、conf_logger_settings_play_log_level、conf_application_logger.application |
ログレベルは、新しい Edge UI では構成できません。ログファイルは /opt/apigee/var/log/edge-management-ui に書き込まれます。 |
bin_setenv_min_mem、bin_setenv_max_mem、bin_setenv_meta_space_size、bin_setenv_ext_jvm_opts |
新しい Edge UI は Java 仮想マシンで実行されません。Java メモリ設定は適用されません。 |
移行の例を確認する
次の例では、従来の UI の ui.properties ファイルと、新しい Edge UI の同等の management-ui.properties ファイルを比較します。
従来の UI、/opt/apigee/customer/application/ui.properties:
conf_apigee_apigee.feature.disablegeomap=false conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true" conf_application_session.maxage="1d" conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password" conf_apigee_apigee.branding.companynameshort="My Company" conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"
新しい Edge UI、/opt/apigee/customer/application/management-ui.properties:
conf_uebe_disableGeoMap=false conf_uebe_trace_for_internal_addresses=true conf_uebe_authsessiontimeout=24 conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password" conf_uebe_branding_companyNameShort="My Company" conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"
ブール値 true は引用符で囲まれておらず、セッションのタイムアウト 1d は 24 に置き換えられます。
ファイルを保存したら、新しい Edge UI を再起動します。
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
概要チェックリスト
Apigee Edge for Private Cloud 4.54.00 で New Edge UI への移行を完了するには、次のチェックリストを使用します。
-
アップグレードする前に、
/opt/apigee/customer/application/ui.propertiesと/opt/apigee/edge-ui/email-templatesのカスタマイズされたメール テンプレートをバックアップします。 -
ブール値または数値を引用符で囲まずに、マッピングされたプロパティを
/opt/apigee/customer/application/management-ui.propertiesに追加し、サポートされていない従来の UI プロパティを省略します。 -
バックアップ ディレクトリから
/opt/apigee/edge-management-ui/email-templatesにカスタマイズしたメール テンプレートをコピーします。 -
conf_uebe_mgmtCredentialを設定した場合は、./bin/management-ui --encryptを使用して sysadmin 認証情報を再暗号化します。 -
ファイルの所有権を
apigee:apigeeに設定し、edge-management-uiを再起動します。