Cài đặt Trải nghiệm Edge mới (Beta)

Edge cho đám mây riêng tư phiên bản 4.18.05

Tài liệu này mô tả cách cài đặt bản phát hành Beta của trải nghiệm New Edge trên Edge trong Đám mây riêng tư. Trải nghiệm New Edge là thế hệ giao diện người dùng mới cho Edge.

Để thử trải nghiệm New Edge trong một bản cài đặt Edge dành cho đám mây riêng tư, bạn phải:

  • Bật SAML trên Edge. Trải nghiệm New Edge chỉ hỗ trợ SAML làm cơ chế xác thực.
  • Cài đặt giao diện New Edge trên nút riêng. Bạn không thể cài đặt ứng dụng này trên một nút chứa các thành phần khác của Edge.

Để biết thêm về trải nghiệm New Edge, hãy xem phần Trải nghiệm Edge mới dành cho đám mây riêng tư.

Tổng quan về việc cài đặt

Để cài đặt phiên bản Beta của trải nghiệm Edge mới trên Edge cho Đám mây riêng tư, bạn sẽ thực hiện 2 quy trình cài đặt khác nhau:

  • Cài đặt giao diện người dùng cơ sở của Edge (được gọi là shoehorn) rồi định cấu hình giao diện người dùng Edge cơ sở nhằm sử dụng SAML để xác thực với Edge.
  • Cài đặt phiên bản New Edge và định cấu hình trải nghiệm New Edge nhằm sử dụng SAML để xác thực với Edge. Sau khi cài đặt phiên bản New Edge, bạn có thể đăng nhập và sử dụng phiên bản này để làm việc với Edge.

Điều kiện tiên quyết về việc cài đặt

  • Bạn phải bật SAML trên Edge trước khi cài đặt trải nghiệm New Edge. Trải nghiệm New Edge chỉ hỗ trợ SAML làm cơ chế xác thực.

    Để biết thông tin về cách bật SAML trên Edge, hãy xem bài viết Hỗ trợ SAML trên Edge cho đám mây riêng tư.

  • Bạn phải cài đặt giao diện New Edge trên nút riêng. Bạn không thể cài đặt ứng dụng này trên một nút chứa các thành phần Edge khác. Nút này phải đáp ứng các yêu cầu sau:

Những điều cần cân nhắc trước khi cài đặt trải nghiệm New Edge

Như đã mô tả ở trên trong các điều kiện tiên quyết, trải nghiệm New Edge yêu cầu bạn bật SAML trên Edge. Điều đó có nghĩa là quá trình xác thực người dùng sẽ do một Nhà cung cấp danh tính (SAML) của SAML IDP kiểm soát, trong đó bạn sẽ định cấu hình Nhà cung cấp danh tính (SAML) để dùng địa chỉ email làm mã nhận dạng người dùng. Do đó, tất cả người dùng trải nghiệm Edge mới phải được đăng ký trong SAML IDP.

Giao diện người dùng của Edge phiên bản cũ (giao diện người dùng mặc định mà bạn cài đặt bằng Edge cho Đám mây riêng tư) không yêu cầu SAML. Tính năng này có thể sử dụng SAML hoặc phương thức xác thực cơ bản. Tức là bạn có thể:

  • Bật tính năng hỗ trợ SAML trên Edge và trên cả giao diện người dùng cũ và trải nghiệm Edge mới.

    Trong trường hợp này, tất cả người dùng sử dụng giao diện người dùng cũ và trải nghiệm Edge mới đều được đăng ký trong SAML IDP. Để biết thông tin về cách thêm người dùng mới vào SAML IDP, hãy xem phần Đăng ký người dùng Edge mới.

  • Bật hỗ trợ SAML trên Edge, nhưng vẫn bật tính năng xác thực cơ bản. Trải nghiệm Edge mới sử dụng SAML và giao diện người dùng cũ vẫn sử dụng phương thức xác thực cơ bản.

    Trong trường hợp này, tất cả người dùng giao diện người dùng cổ điển đều đăng nhập bằng thông tin xác thực cơ bản, trong đó thông tin xác thực của họ được lưu trữ trong cơ sở dữ liệu của Edge OpenLDAP. Người dùng trải nghiệm Edge mới được đăng ký trong SAML IDP và đăng nhập bằng SAML.

    Tuy nhiên, người dùng giao diện người dùng cũ sẽ không thể đăng nhập vào trải nghiệm New Edge cho đến khi bạn thêm người dùng đó vào SAML IDP như mô tả trong phần Đăng ký người dùng Edge mới.

Thay đổi cấu hình cài đặt từ Edge 4.18.01

Bản phát hành Edge 4.18.05 của trải nghiệm New Edge có chứa những thay đổi sau đối với tệp cấu hình trong bản phát hành Edge 4.18.01. Các thuộc tính này được mô tả chi tiết trong phần sau:

Loại thay đổi Cơ sở lưu trú bị ảnh hưởng
Đã thêm
# Shoehorn UI configurations.
SHOEHORN_SCHEME
SHOEHORN_IP
SHOEHORN_PORT

# Classic UI configurations.
CLASSIC_UI_SCHEME
CLASSIC_UI_IP
CLASSIC_UI_PORT

# Information about Edge SSO module.
MANAGEMENT_UI_SKIP_VERIFY
Đã xóa
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Thời điểm thay thế
MANAGEMENT_UI_USE_HTTPS
Được thay thế bằng:
MANAGEMENT_UI_SCHEME

Tệp cấu hình cài đặt

Tệp cấu hình chứa tất cả thông tin cần thiết để cài đặt và định cấu hình trải nghiệm New Edge. Bạn có thể sử dụng cùng một tệp cấu hình để cài đặt và định cấu hình cả giao diện người dùng cơ sở và trải nghiệm New Edge.

Tệp cấu hình mẫu được hiển thị bên dưới:

# IP of the Edge Management Server.
# This node also hosts the Edge SSO module and the current, or classic, Edge UI.
IP1=11.111.111.111

# IP of the New Edge experience node.
IP2=22.222.222.222

# Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.

# Edge Management Server information.
APIGEE_PORT_HTTP_MS=8080
MSIP=$IP1
MS_SCHEME=http

#
# New Edge experience configuration.
#

# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the New Edge experience.
# This release does not support TLS.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

# SSO configuration for the New Edge experience.
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y
MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret111

#
# Shoehorn UI configuration.
#

# The first two properties use the same values as the New Edge experience.
SHOEHORN_SCHEME=$MANAGEMENT_UI_SCHEME
SHOEHORN_IP=$MANAGEMENT_UI_IP
SHOEHORN_PORT=9000

#
# Edge Classic UI configuration.
# Some settings are for the classic UI,
# but are still required to configure the New Edge experience.
#

# These settings assume that Classic UI is installed on the Management Server.
CLASSIC_UI_IP=$MSIP
CLASSIC_UI_PORT=9000
CLASSIC_UI_SCHEME=http
EDGEUI_PUBLIC_URIS=$CLASSIC_UI_SCHEME://$CLASSIC_UI_IP:$CLASSIC_UI_PORT

# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS

# Enable SSO.
EDGEUI_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is edgeui.
# Apigee recommends that you use the same settings as you used
# when enabling SAML on the classic Edge UI.
EDGEUI_SSO_CLIENT_NAME=edgeui
# Oauth client password using uppercase, lowercase, number, and special chars. 
EDGEUI_SSO_CLIENT_SECRET=ssoClient123
# If set, existing EDGEUI client will deleted and new one will be created.
EDGEUI_SSO_CLIENT_OVERWRITE=y

# Information about Edge SSO module.
# Externally accessible IP or DNS of Edge SSO module.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on the Edge SSO module.
# If Edge SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# SSO admin credentials as set when you installed Edge SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

#
# Required SMTP information.
#

SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.com
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPPORT=465      # If no SSL, use a different port, such as 25.
SMTPMAILFROM="My Company myco@company.com"

Cài đặt giao diện người dùng của Edge cơ bản (shoehorn)

Bạn phải cài đặt giao diện người dùng Edge cơ sở (được gọi là shoehorn) thì mới có thể cài đặt trải nghiệm New Edge.

Cách cài đặt giao diện người dùng cơ sở:

  1. Cài đặt phiên bản 4.18.05 của tiện ích apigee-setup trên nút như mô tả trong phần Cài đặt tiện ích thiết lập apigee của Edge.
  2. Sạch sạch:
    sudo yum clean all
  3. Tạo tệp cấu hình như mô tả ở trên và đảm bảo tệp này thuộc sở hữu của người dùng "apigee":
    chown apigee:apigee configFile

    Trong đó configFile là tệp cấu hình được mô tả ở trên trong mục Tệp cấu hình cài đặt.

  4. Cài đặt phiên bản Shoehorn của giao diện người dùng Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  5. Định cấu hình giao diện người dùng Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  6. Bật SAML trên giao diện người dùng Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Cài đặt New Edge

Sau khi cài đặt giao diện người dùng Edge cơ sở, bạn có thể cài đặt và định cấu hình cho trải nghiệm New Edge.

Cách cài đặt New Edge:

  1. Cài đặt phiên bản New Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Thay đổi đối với thư mục edge-management-ui:
    cd /opt/apigee/edge-management-ui
  3. Định cấu hình trải nghiệm New Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    Trong đó configFile là tệp cấu hình được mô tả ở trên trong mục Tệp cấu hình cài đặt.

  4. Bật SAML trên trải nghiệm Edge mới:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Đăng nhập vào trải nghiệm New Edge bằng cách mở URL sau trên trình duyệt:
    http://newEdgeExperienceIP:3001

    trong đó newEdgeExperienceIP là địa chỉ IP của nút lưu trữ trải nghiệm New Edge. Bạn sẽ được nhắc cung cấp thông tin xác thực SAML. Sau khi bạn nhập thông tin đăng nhập, trải nghiệm New Edge sẽ xuất hiện.

  6. Hãy xem bài viết Trải nghiệm Edge mới dành cho đám mây riêng tư (Beta) để biết thêm thông tin, bao gồm cả các đường liên kết để tìm hiểu thông tin về cách sử dụng phiên bản New Edge.

Gỡ cài đặt trải nghiệm New Edge

Cách gỡ cài đặt trải nghiệm New Edge:

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

Cách gỡ cài đặt giao diện người dùng Edge cơ sở (shoehorn):

/opt/apigee/apigee-service/bin/apigee-service edge-ui uninstall

Cách xoá hoàn toàn Edge khỏi nút:

  1. Dừng tất cả các dịch vụ Edge đang chạy trên máy:
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Xoá bộ nhớ đệm yum:
    sudo yum clean all
  3. Xoá tất cả RPM của Apigee:
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Xoá thư mục gốc cài đặt:
    sudo rm -rf /opt/apigee