Di chuyển các thuộc tính trên giao diện người dùng Cổ điển sang giao diện người dùng Edge mới

Trong Apigee Edge cho đám mây riêng tư phiên bản 4.54.00, Giao diện người dùng cũ (thành phần edge-ui) sẽ bị xoá và không còn hoạt động nữa. Giao diện người dùng New Edge (thành phần edge-management-ui) là giao diện người dùng duy nhất cho Edge for Private Cloud.

Bạn không thể sử dụng edge-ui trong Edge cho đám mây riêng tư 4.54.00. Nếu bạn tuỳ chỉnh Giao diện người dùng cũ bằng cách đặt các thuộc tính trong /opt/apigee/customer/application/ui.properties, thì Giao diện người dùng Edge mới sẽ không đọc tệp đó. Sau khi cập nhật lên phiên bản 4.54.00, bạn phải đặt các thuộc tính tương đương trong /opt/apigee/customer/application/management-ui.properties.

Trang này liệt kê các thuộc tính của Giao diện người dùng cũ được ghi lại cho ui.properties, các thuộc tính tương đương cho Giao diện người dùng Edge mới và các thuộc tính của Giao diện người dùng cũ không được hỗ trợ trong Giao diện người dùng Edge mới.

Giao diện người dùng Edge mới sử dụng cùng một mã với cơ chế cấu hình (CwC) như các thành phần Edge khác. Để biết thêm thông tin, hãy xem bài viết Cách định cấu hình Edge.

So sánh cấu hình của Giao diện người dùng cũ và Giao diện người dùng mới của Edge

Giao diện người dùng Edge mới thay thế thành phần Giao diện người dùng cũ, tệp thuộc tính, tên dịch vụ, cổng mặc định và định dạng chứng chỉ TLS. Hãy xem bảng sau để cập nhật tập lệnh tự động hoá, quy tắc tường lửa và tệp TLS trước khi di chuyển tài sản:

Cài đặt Giao diện người dùng cũ (phiên bản 4.53.01 trở xuống) Giao diện người dùng mới của Edge (4.54.00)
Tên thành phần edge-ui edge-management-ui
Tệp thuộc tính /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
Lệnh khởi động lại apigee-service edge-ui restart apigee-service edge-management-ui restart
Cổng mặc định 9000 3001
Cấu hình TLS Tệp kho khoá Java (JKS) Tệp khoá và chứng chỉ PEM. Xem phần Định cấu hình TLS cho giao diện người dùng Edge mới.

Đặt thuộc tính cho giao diện người dùng Edge mới

Đặt các thuộc tính cấu hình Giao diện người dùng Edge mới trong /opt/apigee/customer/application/management-ui.properties và khởi động lại dịch vụ edge-management-ui để các thay đổi có hiệu lực.

Cách đặt thuộc tính cho Giao diện người dùng Edge mới:

  1. Mở tệp management-ui.properties trong một trình chỉnh sửa. Nếu tệp không tồn tại, hãy tạo tệp:
    vi /opt/apigee/customer/application/management-ui.properties
    
  2. Đặt thuộc tính. Ví dụ:
    conf_uebe_disableGeoMap=true
  3. Lưu thay đổi.
  4. Đảm bảo tệp thuộc quyền sở hữu của người dùng apigee:
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
    
  5. Khởi động lại giao diện người dùng New Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
    

Hãy tuân thủ các quy tắc định dạng sau đây khi bạn thiết lập các thuộc tính cho giao diện người dùng New Edge:

  • Tên thuộc tính có phân biệt chữ hoa chữ thường. Ví dụ: conf_uebe_disableGeoMap là hợp lệ, nhưng conf_uebe_disablegeomap thì không.
  • Đặt các giá trị chuỗi trong dấu ngoặc kép, ví dụ: conf_uebe_branding_companyNameShort="My Company".
  • Đừng đặt các giá trị boolean (true hoặc false) hoặc giá trị số trong dấu ngoặc kép. Nếu giá trị boolean hoặc số được đặt trong dấu ngoặc kép, thì Giao diện người dùng Edge mới sẽ không khởi động.

Để kiểm tra giá trị hiện tại của một thuộc tính, hãy sử dụng lựa chọn -search. Ví dụ:

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

Liên kết các thuộc tính của giao diện người dùng cũ với giao diện người dùng mới của Edge

Các bảng sau đây liên kết từng thuộc tính được hỗ trợ trong Giao diện người dùng cũ trong ui.properties với thuộc tính tương đương trong Giao diện người dùng mới trong management-ui.properties. Cột Mặc định cho biết giá trị mặc định trong Giao diện người dùng mới của Edge.

Định cấu hình các thuộc tính của đối tượng

Liên kết cờ tính năng của giao diện người dùng cũ với các thuộc tính conf_uebe_* tương ứng trong management-ui.properties:

Tài sản giao diện người dùng cũ Thuộc tính giao diện người dùng mới của Edge Mặc định Ghi chú
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false Đặt thành true để ẩn Bản đồ địa lý. Trong Giao diện người dùng cũ cho Edge cho đám mây riêng tư, Bản đồ địa lý bị tắt theo mặc định. Nếu bạn chưa bật tính năng tổng hợp theo vị trí địa lý, hãy đặt thuộc tính này thành true. Xem phần Bật tính năng tổng hợp dữ liệu địa lý và bản đồ địa lý.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false Đặt thành true để ẩn đường liên kết Đặt lại mật khẩu trên trang đăng nhập.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true Đặt thành false để cho phép báo cáo tùy chỉnh cho phạm vi ngày hơn 14 ngày.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false Đặt thành true để cho phép công cụ Trace gửi yêu cầu đến địa chỉ IP cục bộ hoặc IP nội bộ.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false Đặt thành true để cho phép nhập thông số kỹ thuật OpenAPI từ địa chỉ IP cục bộ hoặc IP nội bộ.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false Đặt thành true để cho phép nhập tệp WSDL từ địa chỉ IP cục bộ hoặc IP nội bộ.

Định cấu hình các thuộc tính phiên và TLS

Liên kết thời gian hết hạn phiên và các thuộc tính TLS trên Giao diện người dùng cổ điển với các thuộc tính tương đương trên Giao diện người dùng New Edge trong management-ui.properties:

Tài sản trên giao diện người dùng cũ Thuộc tính giao diện người dùng mới của Edge Mặc định Ghi chú
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (giờ) Thời gian mà sau đó phiên của người dùng sẽ hết hạn sau khi đăng nhập. Chỉ định số giờ (ví dụ: 12 hoặc 0.5) hoặc thời lượng theo đơn vị h (giờ) hoặc m (phút) (ví dụ: 24h hoặc 90m). Giá trị 12 và 12h tương đương nhau. Đơn vị d (ngày) không được hỗ trợ; ví dụ: thay thế 1d bằng 24h. Nếu giá trị không hợp lệ, thì giá trị mặc định là 12 giờ sẽ được sử dụng và không có lỗi nào được báo cáo. Áp dụng cho các phiên sử dụng phương thức xác thực cơ bản.
conf_application_session.secure Không bắt buộc Không áp dụng Giao diện người dùng Edge mới tự động đặt cờ Secure trên cookie phiên khi TLS được bật (conf_uebe_usehttps=true) hoặc khi TLS chấm dứt trên trình cân bằng tải (conf_uebe_tlsoffload=true).
conf/application.conf+trustxforwarded conf_uebe_usehttps=true và conf_uebe_tlsoffload=true false Đặt cả hai thuộc tính khi TLS chấm dứt trên trình cân bằng tải. Trình cân bằng tải phải chuyển tiếp các yêu cầu đến Giao diện người dùng Edge mới qua HTTP và đặt tiêu đề X-Forwarded-Proto. Lệnh configure-ssl sẽ đặt các thuộc tính này khi MANAGEMENT_UI_SCHEME=https và MANAGEMENT_UI_TLS_OFFLOAD=y. Xem bài viết Định cấu hình TLS cho giao diện người dùng Edge mới.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false Chỉ đặt thành true nếu Máy chủ quản lý sử dụng chứng chỉ tự ký. Xem phần Định cấu hình TLS cho API quản lý.

Định cấu hình các thuộc tính và mẫu email

Liên kết người gửi email, tiêu đề, thương hiệu, URL máy chủ lưu trữ và thuộc tính hết hạn của đường liên kết trong Giao diện người dùng cũ với Giao diện người dùng mới:

Tài sản trên giao diện người dùng cũ Thuộc tính giao diện người dùng mới của Edge Mặc định Ghi chú
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com> hoặc giá trị của SMTPMAILFROM được chỉ định tại thời điểm cài đặt Không thay đổi.
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request Lưu ý phân đoạn thuộc tính passwordReset camelCase.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} Lưu ý phân đoạn thuộc tính userAddedExisting theo quy tắc camelCase.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} Lưu ý phân đoạn thuộc tính userAddedNew camelCase.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee Đặt giá trị của phần giữ chỗ {companyNameShort} trong tiêu đề và mẫu email.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl Không có Không thay đổi. Nếu không được đặt, đường liên kết đặt lại mật khẩu sẽ sử dụng URL của giao diện người dùng Edge mới được chỉ định tại thời điểm cài đặt và đường liên kết của lời mời người dùng sẽ sử dụng tên máy chủ lưu trữ của yêu cầu. Đặt thuộc tính này nếu người dùng truy cập vào Giao diện người dùng Edge mới thông qua một trình cân bằng tải hoặc tên DNS, ví dụ: conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 Áp dụng cho đường liên kết đặt lại mật khẩu và đường liên kết của lời mời người dùng.

Giao diện người dùng mới của Edge sử dụng các mẫu email tích hợp sẵn. Cách sử dụng các mẫu mà bạn đã tuỳ chỉnh cho Giao diện người dùng cổ điển:

  1. Tạo thư mục /opt/apigee/edge-management-ui/email-templates.
  2. Sao chép các tệp password-reset.html, user-added-existing.html và user-added-new.html tuỳ chỉnh của bạn từ thư mục sao lưu mà bạn đã tạo trước khi cập nhật (ví dụ: /opt/apigee/customer/backup/) sang /opt/apigee/edge-management-ui/email-templates. Tên tệp và phần giữ chỗ của mẫu giống như trong Giao diện người dùng cũ.
  3. Đảm bảo thư mục và tệp thuộc sở hữu của người dùng apigee.
  4. Khởi động lại giao diện người dùng Edge mới.

Để biết thêm thông tin, hãy xem bài viết Tuỳ chỉnh mẫu email Edge.

Định cấu hình các thuộc tính mật khẩu được tạo tự động

Liên kết các thuộc tính mật khẩu được tạo tự động trong Giao diện người dùng cũ với Giao diện người dùng Edge mới:

Tài sản trên giao diện người dùng cũ Thuộc tính giao diện người dùng mới của Edge Mặc định
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

Định cấu hình kết nối Máy chủ quản lý và các thuộc tính khoá bí mật dùng chung

Liên kết mối kết nối, thông tin đăng nhập và các thuộc tính bí mật của ứng dụng trên Máy chủ quản lý giao diện người dùng cổ điển với Giao diện người dùng Edge mới:

Tài sản trên giao diện người dùng cũ Thuộc tính giao diện người dùng mới của Edge Ghi chú
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl URL của API quản lý, ví dụ: https://FQ_domain_name:port/v1. Tên thuộc tính này không bắt đầu bằng conf_. Nếu Máy chủ quản lý sử dụng chứng chỉ tự ký, hãy đặt cả conf_uebe_skipverify=true.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential Thông tin đăng nhập của quản trị viên hệ thống đã mã hoá. Bạn phải mã hoá lại thông tin đăng nhập cho Giao diện người dùng Edge mới bằng cách sử dụng ./bin/management-ui --encrypt; xem Cấu hình bắt buộc cho thông tin đăng nhập khác của quản trị viên hệ thống.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential Thông tin đăng nhập SMTP đã mã hoá.
conf_application_application.secret conf_uebe_applicationsecret Khoá bí mật dùng để mã hoá thông tin xác thực và cookie phiên. Được tạo tại thời điểm cài đặt.

Xoá các thuộc tính của Giao diện người dùng cũ không yêu cầu hành động

Các thuộc tính sau đây của Giao diện người dùng cổ điển không có thuộc tính tương đương trong Giao diện người dùng mới của Edge vì hành vi này luôn được bật. Đừng đưa các thuộc tính này vào management-ui.properties (và xoá các thuộc tính này khỏi mọi tập lệnh cấu hình tự động):

Tài sản trên giao diện người dùng cũ Hành vi trong giao diện người dùng mới của Edge
conf_apigee_apigee.feature.expireSessionCookiesInternally Thời gian hết hạn của phiên luôn được xác thực trên máy chủ.
conf_apigee_apigee.feature.trackSessionCookies Thông tin phiên luôn được lưu trữ trong bộ nhớ máy chủ. Nếu bạn sử dụng nhiều phiên bản của Giao diện người dùng Edge mới phía sau một trình cân bằng tải, hãy định cấu hình trình cân bằng tải để sử dụng phiên cố định.

Xoá các thuộc tính Giao diện người dùng cũ không được hỗ trợ

Các thuộc tính sau đây của Giao diện người dùng cổ điển không được hỗ trợ và không có thuộc tính tương đương trong Giao diện người dùng Edge mới. Đừng đưa các thuộc tính này vào management-ui.properties (và xoá các thuộc tính này khỏi mọi tập lệnh cấu hình tự động):

Tài sản giao diện người dùng cũ Mô tả
conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection Bạn không thể định cấu hình thời gian chờ cho các lệnh gọi API quản lý trong Giao diện người dùng New Edge.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword Giao diện người dùng New Edge không hỗ trợ một proxy chuyển tiếp cho các yêu cầu của công cụ Theo dõi.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body Biểu ngữ yêu cầu đồng ý không được hỗ trợ trong giao diện người dùng New Edge.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize Trong giao diện người dùng New Edge, danh sách proxy API luôn được tải trong các trang. Bạn không thể định cấu hình kích thước trang.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application Bạn không thể định cấu hình cấp độ nhật ký trong Giao diện người dùng Edge mới. Tệp nhật ký được ghi vào /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 Giao diện người dùng New Edge không chạy trong máy ảo Java. Chế độ cài đặt bộ nhớ Java không áp dụng.

Xem ví dụ về quá trình di chuyển

Ví dụ sau đây so sánh tệp ui.properties của Giao diện người dùng cổ điển với tệp management-ui.properties tương đương cho Giao diện người dùng Edge mới.

Giao diện người dùng cổ điển, /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"

Giao diện người dùng mới của 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"

Lưu ý rằng giá trị boolean true không được đặt trong dấu ngoặc kép và thời gian chờ của phiên 1d được thay thế bằng 24.

Sau khi bạn lưu tệp, hãy khởi động lại giao diện người dùng Edge mới:

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

Danh sách kiểm tra tóm tắt

Hãy sử dụng danh sách kiểm tra sau đây để hoàn tất quá trình di chuyển sang Giao diện người dùng Edge mới trong Apigee Edge cho đám mây riêng tư 4.54.00:

  1. Sao lưu /opt/apigee/customer/application/ui.properties và mọi mẫu email tuỳ chỉnh từ /opt/apigee/edge-ui/email-templates trước khi nâng cấp.
  2. Thêm các thuộc tính được liên kết vào /opt/apigee/customer/application/management-ui.properties mà không cần trích dẫn các giá trị boolean hoặc giá trị số, đồng thời bỏ qua các thuộc tính Giao diện người dùng cổ điển không được hỗ trợ.
  3. Sao chép mẫu email tuỳ chỉnh từ thư mục sao lưu vào /opt/apigee/edge-management-ui/email-templates.
  4. Mã hoá lại thông tin đăng nhập của quản trị viên hệ thống bằng ./bin/management-ui --encrypt nếu bạn đặt conf_uebe_mgmtCredential.
  5. Đặt quyền sở hữu tệp thành apigee:apigee và khởi động lại edge-management-ui.