Memigrasikan properti UI Klasik ke UI Edge Baru

Di Apigee Edge for Private Cloud 4.54.00, UI Klasik (komponen edge-ui) dihapus dan tidak lagi tersedia. UI Edge Baru (komponen edge-management-ui) adalah satu-satunya UI untuk Edge for Private Cloud.

Anda tidak dapat menggunakan edge-ui di Edge for Private Cloud 4.54.00. Jika Anda menyesuaikan UI Klasik dengan menetapkan properti di /opt/apigee/customer/application/ui.properties, UI Edge Baru tidak akan membaca file tersebut. Setelah mengupdate ke 4.54.00, Anda harus menetapkan properti yang setara di /opt/apigee/customer/application/management-ui.properties.

Halaman ini mencantumkan properti UI Klasik yang didokumentasikan untuk ui.properties, properti yang setara untuk UI Edge Baru, dan properti UI Klasik yang tidak didukung di UI Edge Baru.

UI Edge Baru menggunakan mekanisme kode dengan konfigurasi (CwC) yang sama dengan komponen Edge lainnya. Untuk mengetahui informasi selengkapnya, lihat Cara mengonfigurasi Edge.

Membandingkan konfigurasi UI Klasik dan UI Edge Baru

UI Edge Baru menggantikan komponen UI Klasik, file properti, nama layanan, port default, dan format sertifikat TLS. Tinjau tabel berikut untuk memperbarui skrip otomatisasi, aturan firewall, dan file TLS sebelum memigrasikan properti Anda:

Setelan UI Klasik (4.53.01 dan yang lebih lama) UI Edge Baru (4.54.00)
Nama komponen edge-ui edge-management-ui
File properti /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
Perintah mulai ulang apigee-service edge-ui restart apigee-service edge-management-ui restart
Port default 9000 3001
Konfigurasi TLS File Java keystore (JKS) File kunci dan sertifikat PEM. Lihat Mengonfigurasi TLS untuk UI Edge Baru.

Menetapkan properti untuk UI Edge Baru

Tetapkan properti konfigurasi UI Edge Baru di /opt/apigee/customer/application/management-ui.properties dan mulai ulang layanan edge-management-ui agar perubahan Anda diterapkan.

Untuk menetapkan properti untuk UI Edge Baru:

  1. Buka file management-ui.properties di editor. Jika file tidak ada, buat file: 
    vi /opt/apigee/customer/application/management-ui.properties
  2. Tetapkan properti. Contoh: 
    conf_uebe_disableGeoMap=true
  3. Simpan perubahan.
  4. Pastikan file tersebut dimiliki oleh pengguna apigee: 
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. Mulai ulang UI Edge Baru: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

Ikuti aturan pemformatan berikut saat Anda menetapkan properti untuk UI Edge Baru:

  • Nama properti peka huruf besar/kecil. Misalnya, conf_uebe_disableGeoMap valid, tetapi conf_uebe_disablegeomap tidak valid.
  • Sertakan nilai string dalam tanda petik ganda, misalnya conf_uebe_branding_companyNameShort="My Company".
  • Jangan mengapit nilai boolean (true atau false) atau nilai numerik dalam tanda petik. Jika nilai boolean atau numerik diapit tanda petik, UI Edge Baru tidak akan dimulai.

Untuk memeriksa nilai properti saat ini, gunakan opsi -search. Contoh:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

Memetakan properti UI Klasik ke UI Edge Baru

Tabel berikut memetakan setiap properti UI Klasik yang didukung di ui.properties ke properti New Edge UI yang setara di management-ui.properties. Kolom Default menampilkan nilai default di UI Edge Baru.

Mengonfigurasi properti fitur

Petakan tombol fitur UI Klasik ke properti conf_uebe_* yang sesuai di management-ui.properties:

Properti UI klasik Properti UI Edge baru Default Catatan
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false Tetapkan ke true untuk menyembunyikan Peta Geografis. Di UI Klasik untuk Edge for Private Cloud, Peta Geografis dinonaktifkan secara default. Jika Anda belum mengaktifkan penggabungan geografis, tetapkan properti ini ke true. Lihat Mengaktifkan agregasi geografis dan peta geografis.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false Setel ke true untuk menyembunyikan link Reset sandi di halaman login.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true Setel ke false untuk mengizinkan laporan kustom untuk rentang tanggal lebih dari 14 hari.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false Setel ke true untuk mengizinkan alat Trace mengirim permintaan ke alamat IP lokal atau IP internal.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false Tetapkan ke true untuk mengizinkan spesifikasi OpenAPI diimpor dari alamat IP lokal atau IP internal.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false Tetapkan ke true untuk mengizinkan file WSDL diimpor dari alamat IP lokal atau IP internal.

Mengonfigurasi properti sesi dan TLS

Petakan waktu tunggu sesi dan properti TLS UI Klasik ke padanannya di UI Edge Baru di management-ui.properties:

Properti UI klasik Properti UI Edge baru Default Catatan
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (jam) Waktu berakhirnya sesi pengguna setelah login. Tentukan jumlah jam (misalnya, 12 atau 0.5) atau durasi dengan unit h (jam) atau m (menit) (misalnya, 24h atau 90m). Nilai 12 dan 12h setara. Unit d (hari) tidak didukung; misalnya, ganti 1d dengan 24h. Jika nilai tidak valid, nilai default 12 jam akan digunakan dan tidak ada error yang dilaporkan. Berlaku untuk sesi yang menggunakan autentikasi dasar.
conf_application_session.secure Tidak ada persyaratan Tidak berlaku UI Edge Baru menetapkan flag Secure pada cookie sesi secara otomatis saat TLS diaktifkan (conf_uebe_usehttps=true) atau saat TLS termination pada load balancer (conf_uebe_tlsoffload=true).
conf/application.conf+trustxforwarded conf_uebe_usehttps=true dan conf_uebe_tlsoffload=true false Tetapkan kedua properti saat TLS termination di load balancer. Load balancer harus meneruskan permintaan ke UI Edge Baru melalui HTTP dan menetapkan header X-Forwarded-Proto. Perintah configure-ssl menetapkan properti ini saat MANAGEMENT_UI_SCHEME=https dan MANAGEMENT_UI_TLS_OFFLOAD=y. Lihat Mengonfigurasi TLS untuk UI Edge Baru.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false Tetapkan ke true hanya jika Server Pengelolaan menggunakan sertifikat yang ditandatangani sendiri. Lihat Mengonfigurasi TLS untuk API pengelolaan.

Mengonfigurasi properti dan template email

Petakan properti pengirim email, subjek, branding, URL host, dan masa berlaku link UI Klasik ke UI Edge Baru:

Properti UI klasik Properti UI Edge baru Default Catatan
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com>, atau nilai SMTPMAILFROM yang ditentukan pada waktu penginstalan Tidak berubah.
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request Perhatikan segmen properti passwordReset camelCase.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} Perhatikan segmen properti userAddedExisting camelCase.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} Perhatikan segmen properti userAddedNew camelCase.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee Menetapkan nilai placeholder {companyNameShort} di subjek dan template email.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl Tidak ada Tidak berubah. Jika tidak ditetapkan, link reset sandi akan menggunakan URL UI Edge Baru yang ditentukan pada waktu penginstalan, dan link undangan pengguna akan menggunakan nama host permintaan. Tetapkan properti ini jika pengguna mengakses UI Edge Baru melalui load balancer atau nama DNS, misalnya conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 Berlaku untuk link reset sandi dan link undangan pengguna.

UI Edge Baru menggunakan template email bawaan. Untuk menggunakan template yang Anda sesuaikan untuk UI Klasik:

  1. Buat direktori /opt/apigee/edge-management-ui/email-templates.
  2. Salin file password-reset.html, user-added-existing.html, dan user-added-new.html yang sudah disesuaikan dari direktori cadangan yang Anda buat sebelum melakukan update (misalnya, /opt/apigee/customer/backup/) ke /opt/apigee/edge-management-ui/email-templates. Nama file dan placeholder template sama seperti di UI Klasik.
  3. Pastikan direktori dan file dimiliki oleh pengguna apigee.
  4. Mulai ulang UI Edge Baru.

Untuk informasi selengkapnya, lihat Menyesuaikan template email Edge.

Mengonfigurasi properti sandi yang dibuat otomatis

Memetakan properti sandi yang dibuat otomatis di UI Klasik ke UI Edge Baru:

Properti UI klasik Properti UI Edge baru Default
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

Mengonfigurasi koneksi Server Pengelolaan dan properti rahasia bersama

Petakan properti rahasia koneksi, kredensial, dan aplikasi Server Pengelolaan UI Klasik ke UI Edge Baru:

Properti UI klasik Properti UI Edge Baru Catatan
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl URL Management API, misalnya https://FQ_domain_name:port/v1. Nama properti ini tidak diawali dengan conf_. Jika Server Pengelolaan menggunakan sertifikat yang ditandatangani sendiri, tetapkan juga conf_uebe_skipverify=true.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential Kredensial admin sistem terenkripsi. Anda harus mengenkripsi kredensial lagi untuk UI Edge Baru menggunakan ./bin/management-ui --encrypt; lihat Konfigurasi yang diperlukan untuk kredensial sysadmin yang berbeda.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential Kredensial SMTP terenkripsi.
conf_application_application.secret conf_uebe_applicationsecret Secret yang digunakan untuk mengenkripsi kredensial dan cookie sesi. Dibuat pada waktu penginstalan.

Menghapus properti UI Klasik yang tidak memerlukan tindakan

Properti UI Klasik berikut tidak memiliki padanan di UI Edge Baru karena perilaku ini selalu diaktifkan. Jangan sertakan properti ini di management-ui.properties (dan hapus dari skrip konfigurasi otomatis):

Properti UI klasik Perilaku di UI Edge Baru
conf_apigee_apigee.feature.expireSessionCookiesInternally Masa berlaku sesi selalu divalidasi di server.
conf_apigee_apigee.feature.trackSessionCookies Informasi sesi selalu disimpan dalam memori server. Jika Anda menggunakan beberapa instance UI Edge Baru di belakang load balancer, konfigurasi load balancer untuk menggunakan sesi persisten.

Menghapus properti UI Klasik yang tidak didukung

Properti UI Klasik berikut tidak didukung dan tidak memiliki padanan di UI Edge Baru. Jangan sertakan properti ini di management-ui.properties (dan hapus dari skrip konfigurasi otomatis):

Properti UI klasik Deskripsi
conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection Waktu tunggu untuk panggilan Management API tidak dapat dikonfigurasi di UI New Edge.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword UI Edge Baru tidak mendukung proxy penerusan untuk permintaan alat Trace.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body Banner izin tidak didukung di UI Edge Baru.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize Di UI Edge Baru, daftar proxy API selalu dimuat di halaman. Ukuran halaman tidak dapat dikonfigurasi.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application Level log tidak dapat dikonfigurasi di UI New Edge. File log ditulis ke /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 UI Edge Baru tidak berjalan di virtual machine Java. Setelan memori Java tidak berlaku.

Meninjau contoh migrasi

Contoh berikut membandingkan file ui.properties UI Klasik dengan file management-ui.properties yang setara untuk UI Edge Baru.

UI Klasik, /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"

UI Edge baru, /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"

Perhatikan bahwa nilai boolean true tidak diapit tanda kutip, dan waktu tunggu sesi 1d diganti dengan 24.

Setelah menyimpan file, mulai ulang UI Edge Baru:

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

Checklist ringkasan

Gunakan checklist berikut untuk menyelesaikan migrasi Anda ke UI Edge Baru di Apigee Edge untuk Private Cloud 4.54.00:

  1. Buat cadangan /opt/apigee/customer/application/ui.properties dan semua template email yang disesuaikan dari /opt/apigee/edge-ui/email-templates sebelum mengupgrade.
  2. Tambahkan properti yang dipetakan ke /opt/apigee/customer/application/management-ui.properties tanpa mengutip nilai boolean atau numerik, dan hapus properti UI Klasik yang tidak didukung.
  3. Salin template email yang disesuaikan dari direktori cadangan Anda ke /opt/apigee/edge-management-ui/email-templates.
  4. Enkripsi ulang kredensial admin sistem dengan ./bin/management-ui --encrypt jika Anda menetapkan conf_uebe_mgmtCredential.
  5. Tetapkan kepemilikan file ke apigee:apigee dan mulai ulang edge-management-ui.