Klasik kullanıcı arayüzü özelliklerini yeni Edge kullanıcı arayüzüne taşıma

Apigee Edge for Private Cloud 4.54.00'da Klasik kullanıcı arayüzü (edge-ui bileşeni) kaldırıldı ve artık kullanılamıyor. Yeni Edge kullanıcı arayüzü (edge-management-ui bileşeni), Private Cloud için Edge'in tek kullanıcı arayüzüdür.

Edge for Private Cloud 4.54.00'da edge-ui kullanamazsınız. Klasik kullanıcı arayüzünü /opt/apigee/customer/application/ui.properties içinde özellikler ayarlayarak özelleştirdiyseniz yeni Edge kullanıcı arayüzü bu dosyayı okumaz. 4.54.00 sürümüne güncelledikten sonra /opt/apigee/customer/application/management-ui.properties içinde eşdeğer özellikleri ayarlamanız gerekir.

Bu sayfada, ui.properties için belgelenen klasik kullanıcı arayüzü özellikleri, yeni Edge kullanıcı arayüzündeki eşdeğer özellikler ve yeni Edge kullanıcı arayüzünde desteklenmeyen klasik kullanıcı arayüzü özellikleri listelenmektedir.

Yeni Edge kullanıcı arayüzü, diğer Edge bileşenleriyle aynı yapılandırmalı kod (CwC) mekanizmasını kullanır. Daha fazla bilgi için Edge'i yapılandırma başlıklı makaleyi inceleyin.

Klasik kullanıcı arayüzü ile yeni Edge kullanıcı arayüzü yapılandırmalarını karşılaştırma

Yeni Edge kullanıcı arayüzü; klasik kullanıcı arayüzü bileşeninin, özellikler dosyasının, hizmet adının, varsayılan bağlantı noktasının ve TLS sertifikası biçiminin yerini alır. Mülklerinizi taşımadan önce otomasyon komut dosyalarınızı, güvenlik duvarı kurallarınızı ve TLS dosyalarınızı güncellemek için aşağıdaki tabloyu inceleyin:

Ayar Klasik kullanıcı arayüzü (4.53.01 ve önceki sürümler) Yeni Edge kullanıcı arayüzü (4.54.00)
Bileşen adı edge-ui edge-management-ui
Özellikler dosyası /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
Yeniden başlatma komutu apigee-service edge-ui restart apigee-service edge-management-ui restart
Varsayılan bağlantı noktası 9000 3001
TLS yapılandırması Java anahtar deposu (JKS) dosyası PEM sertifikası ve anahtar dosyaları Yeni Edge kullanıcı arayüzü için TLS'yi yapılandırma başlıklı makaleyi inceleyin.

Yeni Edge kullanıcı arayüzü için özellikleri ayarlama

/opt/apigee/customer/application/management-ui.properties ve edge-management-ui hizmetini yeniden başlatarak değişikliklerinizin geçerli olmasını sağlayın.

Yeni Edge kullanıcı arayüzü için bir özellik ayarlamak istiyorsanız:

  1. management-ui.properties dosyasını bir düzenleyicide açın. Dosya yoksa oluşturun: 
    vi /opt/apigee/customer/application/management-ui.properties
  2. Özelliği ayarlayın. Örneğin: 
    conf_uebe_disableGeoMap=true
  3. Değişikliklerinizi kaydedin.
  4. Dosyanın apigee kullanıcısına ait olduğundan emin olun: 
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. Yeni Edge kullanıcı arayüzünü yeniden başlatın: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

Yeni Edge kullanıcı arayüzü için özellikleri ayarlarken aşağıdaki biçimlendirme kurallarına uyun:

  • Tesis adları büyük/küçük harfe duyarlıdır. Örneğin, conf_uebe_disableGeoMap geçerlidir ancak conf_uebe_disablegeomap geçerli değildir.
  • Dize değerlerini çift tırnak içine alın. Örneğin: conf_uebe_branding_companyNameShort="My Company".
  • Boole değerlerini (true veya false) ya da sayısal değerleri tırnak içine almayın. Boole veya sayısal değer tırnak işaretleri içine alınırsa yeni Edge kullanıcı arayüzü başlatılmaz.

Bir özelliğin geçerli değerini kontrol etmek için -search seçeneğini kullanın. Örneğin:

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

Klasik kullanıcı arayüzü özelliklerini yeni Edge kullanıcı arayüzüyle eşleme

Aşağıdaki tablolarda, ui.properties içindeki desteklenen her klasik kullanıcı arayüzü özelliği, management-ui.properties içindeki eşdeğer yeni Edge kullanıcı arayüzü özelliğiyle eşlenir. Varsayılan sütunu, yeni Edge kullanıcı arayüzündeki varsayılan değeri gösterir.

Özellik niteliklerini yapılandırma

Klasik kullanıcı arayüzü özellik bayraklarını management-ui.properties'daki ilgili conf_uebe_* özellikleriyle eşleyin:

Klasik kullanıcı arayüzü mülkü Yeni Edge kullanıcı arayüzü mülkü Varsayılan Notlar
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false Coğrafi haritaları gizlemek için true olarak ayarlayın. Özel Bulut için Edge'in klasik kullanıcı arayüzünde, coğrafi haritalar varsayılan olarak devre dışı bırakılıyordu. Coğrafi toplamayı etkinleştirmediyseniz bu özelliği true olarak ayarlayın. Coğrafi toplama ve coğrafi haritaları etkinleştirme başlıklı makaleyi inceleyin.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false Oturum açma sayfasında Şifreyi sıfırla bağlantısını gizlemek için true olarak ayarlayın.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true 14 günden uzun bir tarih aralığı için özel raporlara izin vermek üzere false olarak ayarlayın.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false İzleme aracının yerel veya dahili IP adreslerine istek göndermesine izin vermek için true olarak ayarlayın.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false OpenAPI spesifikasyonlarının yerel veya dahili IP adreslerinden içe aktarılmasına izin vermek için true olarak ayarlayın.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false WSDL dosyalarının yerel veya dahili IP adreslerinden içe aktarılmasına izin vermek için true olarak ayarlayın.

Oturum ve TLS özelliklerini yapılandırma

Klasik kullanıcı arayüzü oturum zaman aşımı ve TLS özelliklerini management-ui.properties içindeki yeni Edge kullanıcı arayüzü eşdeğerleriyle eşleyin:

Klasik kullanıcı arayüzü özelliği Yeni Edge kullanıcı arayüzü mülkü Varsayılan Notlar
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (saat) Giriş yapıldıktan sonra kullanıcı oturumunun sona ereceği süre. Saat sayısını (ör. 12 veya 0.5) ya da h (saat) veya m (dakika) birimiyle bir süre (ör. 24h veya 90m) belirtin. 12 ve 12h değerleri eşdeğerdir. d (gün) birimi desteklenmiyor. Örneğin, 1d yerine 24h kullanın. Değer geçerli değilse varsayılan 12 saat değeri kullanılır ve hata bildirilmez. Temel kimlik doğrulama kullanan oturumlar için geçerlidir.
conf_application_session.secure Gerekli değil Geçerli değil Yeni Edge kullanıcı arayüzü, TLS etkinleştirildiğinde (conf_uebe_usehttps=true) veya TLS bir yük dengeleyicide sonlandırıldığında (conf_uebe_tlsoffload=true) oturum çerezlerinde Secure işaretini otomatik olarak ayarlar.
conf/application.conf+trustxforwarded conf_uebe_usehttps=true ve conf_uebe_tlsoffload=true false TLS bir yük dengeleyicide sonlandırıldığında her iki özelliği de ayarlayın. Yük dengeleyici, istekleri HTTP üzerinden yeni Edge kullanıcı arayüzüne yönlendirmeli ve X-Forwarded-Proto başlığını ayarlamalıdır. configure-ssl komutu, MANAGEMENT_UI_SCHEME=https ve MANAGEMENT_UI_TLS_OFFLOAD=y olduğunda bu özellikleri ayarlar. Yeni Edge kullanıcı arayüzü için TLS'yi yapılandırma başlıklı makaleyi inceleyin.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false Yalnızca Yönetim Sunucusu kendinden imzalı bir sertifika kullanıyorsa true olarak ayarlayın. Yönetim API'si için TLS'yi yapılandırma başlıklı makaleyi inceleyin.

E-posta özelliklerini ve şablonlarını yapılandırma

Klasik kullanıcı arayüzü e-posta gönderen, konu, markalama, ana makine URL'si ve bağlantı geçerlilik süresi özelliklerini yeni Edge kullanıcı arayüzüyle eşleyin:

Klasik kullanıcı arayüzü özelliği Yeni Edge kullanıcı arayüzü mülkü Varsayılan Notlar
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com> veya yükleme sırasında belirtilen SMTPMAILFROM değeri Değiştirilmemiş.
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request camelCase passwordReset özellik segmentine dikkat edin.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} camelCase userAddedExisting özellik segmentine dikkat edin.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} camelCase userAddedNew özellik segmentine dikkat edin.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee E-posta konularında ve şablonlarında {companyNameShort} yer tutucusunun değerini ayarlar.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl Yok Değiştirilmemiş. Ayarlanmazsa şifre sıfırlama bağlantıları, yükleme sırasında belirtilen yeni Edge kullanıcı arayüzünün URL'sini, kullanıcı davet bağlantıları ise isteğin ana makine adını kullanır. Kullanıcılar yeni Edge kullanıcı arayüzüne bir yük dengeleyici veya DNS adı (ör. conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com") üzerinden erişiyorsa bu özelliği ayarlayın.
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 Şifre sıfırlama bağlantıları ve kullanıcı davet bağlantıları için geçerlidir.

Yeni Edge kullanıcı arayüzünde yerleşik e-posta şablonları kullanılır. Klasik kullanıcı arayüzü için özelleştirdiğiniz şablonları kullanmak üzere:

  1. /opt/apigee/edge-management-ui/email-templates dizinini oluşturun.
  2. Özelleştirilmiş password-reset.html, user-added-existing.html ve user-added-new.html dosyalarınızı, güncellemeden önce oluşturduğunuz yedekleme dizininden (örneğin, /opt/apigee/customer/backup/) /opt/apigee/edge-management-ui/email-templates'e kopyalayın. Şablon dosya adları ve yer tutucular, klasik kullanıcı arayüzündekilerle aynıdır.
  3. Dizinin ve dosyaların apigee kullanıcısına ait olduğundan emin olun.
  4. Yeni Edge kullanıcı arayüzünü yeniden başlatın.

Daha fazla bilgi için Edge e-posta şablonlarını özelleştirme başlıklı makaleyi inceleyin.

Otomatik olarak oluşturulan şifre özelliklerini yapılandırma

Klasik kullanıcı arayüzünde otomatik olarak üretilmiş şifre özelliklerini yeni Edge kullanıcı arayüzüyle eşleyin:

Klasik kullanıcı arayüzü özelliği Yeni Edge kullanıcı arayüzü mülkü Varsayılan
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

Yönetim sunucusu bağlantısını ve paylaşılan gizli özelliklerini yapılandırma

Klasik kullanıcı arayüzü yönetim sunucusu bağlantısı, kimlik bilgisi ve uygulama gizli anahtarı özelliklerini yeni Edge kullanıcı arayüzüyle eşleyin:

Klasik kullanıcı arayüzü özelliği Yeni Edge kullanıcı arayüzü mülkü Notlar
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl Yönetim API'sinin URL'si (ör. https://FQ_domain_name:port/v1). Bu özellik adı conf_ ile başlamıyor. Yönetim sunucusu kendinden imzalı bir sertifika kullanıyorsa conf_uebe_skipverify=true ayarını da yapın.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential Şifrelenmiş sistem yöneticisi kimlik bilgileri. ./bin/management-ui --encrypt kullanarak yeni Edge kullanıcı arayüzü için kimlik bilgilerini tekrar şifrelemeniz gerekir. Farklı sysadmin kimlik bilgileri için gereken yapılandırma bölümüne bakın.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential Şifrelenmiş SMTP kimlik bilgileri.
conf_application_application.secret conf_uebe_applicationsecret Kimlik bilgilerini ve oturum çerezlerini şifrelemek için kullanılan gizli anahtar. Yükleme sırasında oluşturulur.

İşlem gerektirmeyen klasik kullanıcı arayüzü özelliklerini kaldırma

Aşağıdaki Klasik kullanıcı arayüzü özelliklerinin Yeni Edge kullanıcı arayüzünde eşdeğeri yoktur. Bunun nedeni, davranışın her zaman etkin olmasıdır. Bu özellikleri management-ui.properties dosyasına eklemeyin (ve otomatik yapılandırma komut dosyalarından kaldırın):

Klasik kullanıcı arayüzü özelliği Yeni Edge kullanıcı arayüzündeki davranış
conf_apigee_apigee.feature.expireSessionCookiesInternally Oturumun sona erme süresi her zaman sunucuda doğrulanır.
conf_apigee_apigee.feature.trackSessionCookies Oturum bilgileri her zaman sunucu belleğinde saklanır. Bir yük dengeleyicinin arkasında yeni Edge kullanıcı arayüzünün birden fazla örneğini kullanıyorsanız yük dengeleyiciyi yapışkan oturumlar kullanacak şekilde yapılandırın.

Desteklenmeyen klasik kullanıcı arayüzü özelliklerini kaldırma

Aşağıdaki klasik kullanıcı arayüzü özellikleri desteklenmez ve yeni Edge kullanıcı arayüzünde eşdeğeri yoktur. Bu özellikleri management-ui.properties'e eklemeyin (ve bunları tüm otomatik yapılandırma komut dosyalarından kaldırın):

Klasik kullanıcı arayüzü özelliği Açıklama
conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection Yönetim API'si çağrıları için zaman aşımı, yeni Edge kullanıcı arayüzünde yapılandırılamaz.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword Yeni Edge kullanıcı arayüzü, İzleme aracı istekleri için ileri proxy'yi desteklemez.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body İzin banner'ı yeni Edge kullanıcı arayüzünde desteklenmez.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize Yeni Edge kullanıcı arayüzünde, API proxy listesi her zaman sayfalara yüklenir. Sayfa boyutu yapılandırılamaz.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application Günlük düzeyi, yeni Edge kullanıcı arayüzünde yapılandırılamaz. Günlük dosyaları /opt/apigee/var/log/edge-management-ui konumuna yazılır.
bin_setenv_min_mem, bin_setenv_max_mem, bin_setenv_meta_space_size, bin_setenv_ext_jvm_opts Yeni Edge kullanıcı arayüzü, Java sanal makinesinde çalışmaz. Java bellek ayarları uygulanmaz.

Taşıma örneğini inceleme

Aşağıdaki örnekte, Klasik kullanıcı arayüzü ui.properties dosyası ile Yeni Edge kullanıcı arayüzü için eşdeğer management-ui.properties dosyası karşılaştırılmaktadır.

Klasik kullanıcı arayüzü, /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"

Yeni Edge kullanıcı arayüzü, /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"

Boole değeri true tırnak içine alınmaz ve oturum zaman aşımının 1d yerine 24 yazılır.

Dosyayı kaydettikten sonra yeni Edge kullanıcı arayüzünü yeniden başlatın:

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

Özet kontrol listesi

Apigee Edge for Private Cloud 4.54.00'te yeni Edge kullanıcı arayüzüne geçişinizi tamamlamak için aşağıdaki yapılacaklar listesini kullanın:

  1. Yeni sürüme geçmeden önce /opt/apigee/customer/application/ui.properties ve /opt/apigee/edge-ui/email-templates uygulamasındaki tüm özelleştirilmiş e-posta şablonlarını yedekleyin.
  2. /opt/apigee/customer/application/management-ui.properties Eşlenmiş özellikleri ekleyin. Boole veya sayısal değerleri alıntılamadan ve desteklenmeyen Klasik kullanıcı arayüzü özelliklerini atlayın.
  3. Yedekleme dizininizdeki özelleştirilmiş e-posta şablonlarını /opt/apigee/edge-management-ui/email-templates dizinine kopyalayın.
  4. Sistem yöneticisi kimlik bilgilerini yeniden şifreleyin ./bin/management-ui --encrypt ile conf_uebe_mgmtCredential ayarlarsanız.
  5. Dosya sahipliğini apigee:apigee olarak ayarlayın ve edge-management-ui'ı yeniden başlatın.