انتقال دارایی‌های «میانای کاربری کلاسیک» به «میانای کاربری Edge جدید»

در Apigee Edge برای Private Cloud نسخه ۴.۵۴.۰۰، «رابط کاربری کلاسیک» (مؤلفه edge-ui) برداشته شده است و دیگر دردسترس نیست. «واسط کاربر New Edge» (مؤلفه edge-management-ui) تنها واسط کاربر برای Edge for Private Cloud است.

نمی‌توانید از edge-ui در Edge برای Private Cloud نسخه ۴.۵۴.۰۰ استفاده کنید. اگر واسط کاربر کلاسیک را با تنظیم کردن دارایی‌ها در /opt/apigee/customer/application/ui.properties سفارشی‌سازی کرده باشید، واسط کاربر «لبه جدید» آن فایل را نمی‌خواند. پس‌از به‌روزرسانی به نسخه ۴.۵۴.۰۰، باید ویژگی‌های معادل را در /opt/apigee/customer/application/management-ui.properties تنظیم کنید.

این صفحه خصوصیات «واسط کاربر کلاسیک» مستندشده برای ui.properties، خصوصیات معادل برای «واسط کاربر New Edge»، و خصوصیات «واسط کاربر کلاسیک» را که در «واسط کاربر New Edge» پشتیبانی نمی‌شوند فهرست می‌کند.

«رابط کاربری Edge» جدید از همان سازوکار کد با پیکربندی (CwC) استفاده می‌کند که دیگر مؤلفه‌های Edge استفاده می‌کنند. برای اطلاعات بیشتر، به نحوه پیکربندی Edge مراجعه کنید.

مقایسه پیکربندی‌های «میانای کاربری کلاسیک» و «میانای کاربری New Edge»

واسط کاربر New Edge جایگزین مؤلفه واسط کاربر Classic، فایل ویژگی‌ها، نام سرویس، درگاه پیش‌فرض، و قالب گواهی TLS می‌شود. برای به‌روزرسانی کردن فایل‌های «امنیت لایه انتقال»، قوانین دیوار آتش، و نوشته‌های خودکارسازی قبل‌از انتقال دارایی‌هایتان، جدول زیر را مرور کنید:

تنظیم واسط کاربر کلاسیک (نسخه ۴.۵۳.۰۱ و نسخه‌های قدیمی‌تر) New Edge UI (4.54.00)
نام مؤلفه edge-ui edge-management-ui
فایل ویژگی‌ها /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
بازراه‌اندازی فرمان apigee-service edge-ui restart apigee-service edge-management-ui restart
درگاه پیش‌فرض 9000 3001
پیکربندی «امنیت لایه انتقال» فایل Java keystore (JKS) گواهی PEM و فایل‌های کلید. به پیکربندی TLS برای واسط کاربر New Edge مراجعه کنید.

تنظیم کردن ویژگی‌ها برای New Edge UI

ویژگی‌های پیکربندی New Edge UI را در /opt/apigee/customer/application/management-ui.properties تنظیم کنید و سرویس edge-management-ui را بازراه‌اندازی کنید تا تغییراتتان اعمال شود.

برای تنظیم دارایی برای «واسط کاربر Edge جدید»:

  1. فایل management-ui.properties را در ویرایشگر باز کنید. اگر فایل وجود ندارد، آن را ایجاد کنید: 
    vi /opt/apigee/customer/application/management-ui.properties
  2. خصوصیت را تنظیم کنید. برای مثال: 
    conf_uebe_disableGeoMap=true
  3. تغییراتتان را ذخیره کنید.
  4. مطمئن شوید فایل متعلق به کاربر apigee باشد: 
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. بازراه‌اندازی واسط کاربر Edge جدید: 
    /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) یا مقادیر عددی را در علامت نقل‌قول قرار ندهید. اگر مقدار بولی یا عددی در علامت نقل‌قول قرار گرفته باشد، New Edge UI شروع نمی‌شود.

برای بررسی مقدار فعلی یک ویژگی، از گزینه -search استفاده کنید. برای مثال:

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

نگاشت کردن ویژگی‌های واسط کاربر کلاسیک به واسط کاربر Edge جدید

جدول‌های زیر هریک از دارایی‌های پشتیبانی‌شده «واسط کاربر کلاسیک» در ui.properties را به دارایی معادل آن در «واسط کاربر New Edge» در management-ui.properties نگاشت می‌کنند. ستون پیش‌فرض مقدار پیش‌فرض را در «رابط کاربری Edge جدید» نشان می‌دهد.

پیکربندی کردن مشخصه‌های ویژگی

پرچم‌های ویژگی «واسط کاربر کلاسیک نقشه» را به conf_uebe_* دارایی‌های مربوطه در management-ui.properties نگاشت کنید:

مشخصه واسط کاربر کلاسیک دارایی واسط کاربر Edge جدید پیش‌فرض یادداشت‌ها
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false برای پنهان کردن «نقشه‌های جغرافیایی»، روی true تنظیم کنید. در «رابط کاربری کلاسیک» برای Edge for Private Cloud، «نقشه‌های جغرافیایی» به‌طور پیش‌فرض غیرفعال بود. اگر تجمیع جغرافیایی را فعال نکرده‌اید، این ویژگی را روی true تنظیم کنید. بخش فعال کردن تجمیع جغرافیایی و نقشه‌های جغرافیایی را ببینید.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false برای پنهان کردن پیوند بازنشانی گذرواژه در صفحه ورود به سیستم، روی true تنظیم کنید.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true برای مجاز کردن گزارش‌های سفارشی برای محدوده تاریخ بیشتر از ۱۴ روز، روی false تنظیم کنید.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false روی true تنظیم کنید تا به ابزار Trace اجازه دهید درخواست‌ها را به نشانی‌های IP محلی یا داخلی ارسال کند.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false روی true تنظیم کنید تا مشخصات OpenAPI بتواند از نشانی‌های IP محلی یا داخلی وارد شود.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false روی true تنظیم کنید تا فایل‌های WSDL بتوانند از نشانی‌های IP محلی یا داخلی وارد شوند.

پیکربندی ویژگی‌های جلسه و TLS

نگاشت مهلت جلسه و ویژگی‌های TLS در «میانای کاربری کلاسیک» Map به معادل‌های آن‌ها در «میانای کاربری New Edge» در management-ui.properties:

مشخصه واسط کاربر کلاسیک دارایی واسط کاربر Edge جدید پیش‌فرض یادداشت‌ها
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (ساعت) مدت زمانی که پس‌از ورود به سیستم، جلسه کاربر منقضی می‌شود. تعداد ساعت (مثلاً 12 یا 0.5) یا مدت‌زمان را با واحد h (ساعت) یا m (دقیقه) مشخص کنید (مثلاً 24h یا 90m). مقادیر 12 و 12h معادل هستند. واحد d (روز) پشتیبانی نمی‌شود؛ برای مثال، 1d را با 24h جایگزین کنید. اگر مقدار معتبر نباشد، مقدار پیش‌فرض ۱۲ ساعت استفاده می‌شود و خطایی گزارش نمی‌شود. برای جلسه‌هایی که از اصالت‌سنجی پایه استفاده می‌کنند اعمال می‌شود.
conf_application_session.secure هیچ‌کدام لازم نیست نامربوط «میانای کاربری Edge جدید» پرچم Secure را به‌طور خودکار روی کوکی‌های جلسه تنظیم می‌کند وقتی TLS فعال باشد (conf_uebe_usehttps=true) یا وقتی TLS در ترازکننده بار (conf_uebe_tlsoffload=true) پایان می‌یابد.
conf/application.conf+trustxforwarded ‫conf_uebe_usehttps=true و conf_uebe_tlsoffload=true false وقتی «امنیت لایه انتقال» در ترازکننده بار پایان می‌یابد، هر دو دارایی را تنظیم کنید. متعادل‌کننده بار باید درخواست‌ها را ازطریق HTTP به New Edge UI بازارسال کند و سرایند X-Forwarded-Proto را تنظیم کند. فرمان configure-ssl این ویژگی‌ها را وقتی MANAGEMENT_UI_SCHEME=https و MANAGEMENT_UI_TLS_OFFLOAD=y باشد تنظیم می‌کند. به پیکربندی TLS برای واسط کاربر New Edge مراجعه کنید.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false فقط درصورتی روی true تنظیم کنید که «سرور مدیریت» از گواهینامه خودامضایی استفاده کند. به پیکربندی «امنیت لایه انتقال» برای میانای برنامه‌سازی کاربردی مدیریت مراجعه کنید.

پیکربندی خواص و الگوهای ایمیل

فرستنده ایمیل، موضوع، نمانام‌سازی، نشانی وب میزبان، و ویژگی‌های انقضای پیوند واسط کاربر کلاسیک را به واسط کاربر New Edge نگاشت کنید:

دارایی کلاسیک واسط کاربر دارایی واسط کاربر Edge جدید پیش‌فرض یادداشت‌ها
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 به بخش ویژگی camelCase passwordReset توجه کنید.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} بخش دارایی userAddedExisting camelCase را یادداشت کنید.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} به بخش ویژگی camelCase userAddedNew توجه کنید.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee مقدار جای‌بان {companyNameShort} را در موضوعات و الگوهای ایمیل تنظیم می‌کند.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl هیچ‌کدام بدون تغییر. اگر تنظیم نشده باشد، پیوندهای بازنشانی گذرواژه از نشانی وب «میانای کاربری New Edge» که در زمان نصب مشخص شده است استفاده می‌کنند و پیوندهای دعوت کاربر از نام میزبان درخواست استفاده می‌کنند. اگر کاربران ازطریق ترازکننده بار یا نام ساناد به «واسط کاربر Edge جدید» دسترسی پیدا می‌کنند، برای مثال conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"، این دارایی را تنظیم کنید.
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 برای پیوندهای بازنشانی گذرواژه و پیوندهای دعوت کاربر اعمال می‌شود.

«واسط کاربر Edge جدید» از الگوهای ایمیل داخلی استفاده می‌کند. برای استفاده از الگوهایی که برای «رابط کاربری کلاسیک» سفارشی‌سازی کرده‌اید:

  1. فهرست راهنمای /opt/apigee/edge-management-ui/email-templates را ایجاد کنید.
  2. فایل‌های سفارشی‌شده password-reset.html، user-added-existing.html، و user-added-new.html را از دایرکتوری پشتیبان‌گیری که قبل‌از به‌روزرسانی ایجاد کرده‌اید (برای مثال، /opt/apigee/customer/backup/) در /opt/apigee/edge-management-ui/email-templates کپی کنید. نام فایل‌های الگو و جای‌بان‌ها همانند «رابط کاربری کلاسیک» است.
  3. مطمئن شوید که دایرکتوری و فایل‌ها متعلق به کاربر apigee باشند.
  4. بازراه‌اندازی واسط کاربر New Edge.

برای اطلاعات بیشتر، به سفارشی‌سازی الگوهای ایمیل Edge مراجعه کنید.

پیکربندی ویژگی‌های گذرواژه خودکار تولیدشده

نگاشت ویژگی‌های گذرواژه تولیدشده خودکار واسط کاربر کلاسیک به واسط کاربر New Edge:

مشخصه واسط کاربر کلاسیک دارایی واسط کاربر Edge جدید پیش‌فرض
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

پیکربندی اتصال «سرور مدیریت» و ویژگی‌های رمز مشترک

ویژگی‌های اتصال، اطلاعات کاربری، و رمز برنامه «سرور مدیریت واسط کاربر کلاسیک» Map را به «واسط کاربر New Edge» منتقل کنید:

مشخصه واسط کاربر کلاسیک دارایی جدید واسط کاربر Edge یادداشت‌ها
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl نشانی وب میانای برنامه‌سازی کاربردی مدیریت، برای مثال https://FQ_domain_name:port/v1. این نام دارایی با conf_ شروع نمی‌شود. اگر «سرور مدیریت» از گواهینامه خودامضایی استفاده می‌کند، conf_uebe_skipverify=true را نیز تنظیم کنید.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential اعتبارنامه‌های رمزگذاری‌شده سرپرست سیستم. باید اعتبارنامه‌ها را دوباره برای «واسط کاربر Edge جدید» بااستفاده از ./bin/management-ui --encrypt رمزگذاری کنید؛ پیکربندی موردنیاز برای اعتبارنامه‌های مختلف سرپرست سیستم را ببینید.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential اعتبارنامه SMTP رمزگذاری‌شده.
conf_application_application.secret conf_uebe_applicationsecret رمز استفاده‌شده برای رمزگذاری اطلاعات اعتباری و کوکی‌های جلسه. در زمان نصب تولید شده است.

برداشتن دارایی‌های «واسط کاربر کلاسیک» که نیازی به اقدام ندارند

ویژگی‌های «واسط کاربر کلاسیک» زیر معادل «واسط کاربر Edge جدید» ندارند زیرا این رفتار همیشه فعال است. این ویژگی‌ها را در management-ui.properties قرار ندهید (و آن‌ها را از هرگونه اسکریپت پیکربندی خودکار بردارید):

مشخصه واسط کاربر کلاسیک رفتار در واسط کاربر جدید Edge
conf_apigee_apigee.feature.expireSessionCookiesInternally انقضای جلسه همیشه در سرور اعتبارسنجی می‌شود.
conf_apigee_apigee.feature.trackSessionCookies اطلاعات جلسه همیشه در حافظه سرور ذخیره می‌شود. اگر از چند نمونه New Edge UI پشت متعادل‌کننده بار استفاده می‌کنید، متعادل‌کننده بار را پیکربندی کنید تا از جلسه‌های چسبنده استفاده کند.

برداشتن دارایی‌های پشتیبانی‌نشده Classic UI

ویژگی‌های «واسط کاربر قدیمی» زیر پشتیبانی نمی‌شوند و معادلی در «واسط کاربر Edge جدید» ندارند. این ویژگی‌ها را در management-ui.properties قرار ندهید (و آن‌ها را از هرگونه اسکریپت پیکربندی خودکار بردارید):

دارایی کلاسیک واسط کاربر شرح
‫conf_apigee_apigee.feature.apitimeout، ‫conf_apigee_play.ws.timeout.idle، conf_apigee_play.ws.timeout.connection زمان اتمام برای تماس‌های API مدیریت در New Edge UI قابل‌پیکربندی نیست.
‫conf_application_http.proxyhost، ‫conf_application_http.proxyport، ‫conf_application_http.proxyuser، ‫conf_application_http.proxypassword رابط کاربری New Edge از پراکسی پیش‌فرست برای درخواست‌های ابزار Trace پشتیبانی نمی‌کند.
‫conf_apigee-base_apigee.feature.enableconsentbanner، ‫conf_apigee-base_apigee.consentbanner.buttoncaption، conf_apigee-base_apigee.consentbanner.body پرچم رضایت در «رابط کاربری جدید Edge» پشتیبانی نمی‌شود.
conf_apigee-base_apigee.feature.apiproxypaginationenabled، conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize در «واسط کاربر Edge جدید»، فهرست پراکسی میانای برنامه‌سازی کاربردی همیشه در صفحه‌ها بار می‌شود. اندازه صفحه قابل‌پیکربندی نیست.
‫conf_logger_settings_application_log_level، ‫conf_logger_settings_play_log_level، conf_application_logger.application سطح گزارش در «واسط کاربر Edge جدید» قابل‌پیکربندی نیست. فایل‌های گزارش در /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 جدید» در ماشین مجازی Java اجرا نمی‌شود. تنظیمات حافظه Java اعمال نمی‌شود.

مرور نمونه انتقال

مثال زیر فایل ui.properties واسط کاربر کلاسیک را با فایل management-ui.properties معادل برای واسط کاربر New Edge مقایسه می‌کند.

میانای کاربر کلاسیک، /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، /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 جایگزین شده است.

پس‌از ذخیره کردن فایل، «واسط کاربر New Edge» را بازراه‌اندازی کنید:

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

بازبینه خلاصه

از بازبینه زیر برای تکمیل انتقال به «میانای کاربری Edge جدید» در Apigee Edge برای Private Cloud 4.54.00 استفاده کنید:

  1. پیش‌از ارتقا، از /opt/apigee/customer/application/ui.properties و همه الگوهای ایمیل سفارشی‌سازی‌شده /opt/apigee/edge-ui/email-templates پشتیبان‌گیری کنید.
  2. افزودن دارایی‌های نگاشت‌شده به /opt/apigee/customer/application/management-ui.properties بدون نقل کردن مقادیر بولی یا عددی، و دارایی‌های پشتیبانی‌نشده در «میانای کاربری کلاسیک» را حذف کنید.
  3. الگوهای ایمیل سفارشی‌شده را از فهرست راهنمای پشتیبان‌گیری در /opt/apigee/edge-management-ui/email-templates کپی کنید.
  4. اعتبارنامه‌های سرپرست سیستم را با ./bin/management-ui --encrypt دوباره رمزگذاری کنید اگر conf_uebe_mgmtCredential را تنظیم کرده‌اید.
  5. مالکیت فایل را روی apigee:apigee تنظیم کنید و edge-management-ui را بازراه‌اندازی کنید.