Cài đặt phiên bản Edge mới

Edge for Private Cloud phiên bản 4.19.01

Tài liệu này mô tả cách cài đặt trải nghiệm Edge mới cho Edge cho Đám mây riêng tư. Trải nghiệm Edge mới là giao diện người dùng thế hệ tiếp theo cho Edge.

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

  • Bật SAML trên Edge. Phiên bản Edge mới chỉ hỗ trợ SAML làm cơ chế xác thực.
  • Cài đặt trải nghiệm Edge mới trên nút riêng. Bạn không thể cài đặt giao diện người dùng mới trên một nút chứa các thành phần Edge khác, bao gồm cả nút chứa giao diện người dùng Edge hiện có. Nếu bạn làm vậy, người dùng sẽ không thể đăng nhập vào giao diện người dùng Edge phiên bản cũ.

Để biết thêm thông tin về trải nghiệm Edge mới, hãy xem bài viết Trải nghiệm Edge mới cho Private Cloud.

Tổng quan về quy trình cài đặt

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

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

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

  • Bạn phải bật SAML trên Edge trước khi cài đặt trải nghiệm Edge mới. Phiên bản Edge mới 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ư.

  • Trải nghiệm Edge mới chỉ hỗ trợ TLS phiên bản 1.2. Vì bạn kết nối với IDP SAML qua TLS, nên IDP SAML của bạn phải hỗ trợ TLS phiên bản 1.2.

  • Bạn phải cài đặt trải nghiệm Edge mới trên nút riêng của nó. Bạn không thể cài đặt thành phần này trên một nút chứa các thành phần Edge khác, bao gồm cả nút chứa giao diện người dùng Edge hiện có.

    Nút này phải đáp ứng các yêu cầu sau:

    • JAVA 1.8
    • RAM 4 GB
    • 2 lõi
    • Dung lượng ổ đĩa 60 GB
    • Trước tiên, bạn phải cài đặt phiên bản 4.19.01 của tiện ích apigee-setup trên nút như mô tả trong phần Cài đặt tiện ích apigee-setup của Edge.
    • Bạn phải mở cổng 3001. Đây là cổng mặc định được dùng cho các yêu cầu đối với trải nghiệm New Edge. Nếu bạn thay đổi cổng bằng cách sử dụng các thuộc tính được mô tả bên dưới, hãy đảm bảo rằng cổng đó đang mở.

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

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

Giao diện người dùng cũ của Edge, 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. Bạn có thể sử dụng SAML hoặc phương thức xác thực cơ bản. Điều đó có nghĩa là bạn có thể:

  • Bật tính năng hỗ trợ SAML trên Edge, cả trên 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 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 IDP SAML, hãy xem bài viết Đăng ký người dùng Edge mới.

  • Bật tính năng hỗ trợ SAML trên Edge, nhưng vẫn bật phương thức 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ũ đề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 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ũ không thể đăng nhập vào trải nghiệm Edge mới cho đến khi bạn thêm người dùng đó vào IDP SAML như mô tả trong phần Đăng ký người dùng Edge mới.

Các thay đổi về cấu hình cài đặt so với các bản phát hành trước

Hãy lưu ý những thay đổi sau đây đối với quy trình cài đặt trong bản phát hành thử nghiệm của trải nghiệm Edge mới.

Thay đổi về cấu hình cài đặt từ Edge 4.18.05

Bản phát hành Edge 4.19.01 của trải nghiệm Edge mới có những thay đổi sau đây đối với tệp cấu hình của bản phát hành Edge 4.18.05:

Loại thay đổi Cơ sở lưu trú bị ảnh hưởng
Đã xoá 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

Thuộc tính đó có giá trị được xác định trước là 0,5 (30 phút) và không thể thay đổi.
Đã thêm Giờ đây, bạn có thể sử dụng các thuộc tính để bật TLS trên trải nghiệm Edge mới. Hãy xem bài viết Định cấu hình TLS cho trải nghiệm Edge mới để biết thêm thông tin.

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

Bản phát hành Edge 4.19.01 của trải nghiệm Edge mới có những thay đổi sau đây đối với tệp cấu hình của bản phát hành Edge 4.18.01:

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
Đã xoá 
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Đã 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 Edge mới. 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 Edge mới.

Dưới đây là ví dụ về tệp cấu hình:

# 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.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=CHANGE_TO_YOUR_SECRET
# Duration of CSRF token.
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
# Defaults to 8760 hours, or 365 days.
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=8760

# 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
#
# Set to http even if you enable TLS on the New Edge experience.
SHOEHORN_SCHEME=http
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 Edge cơ bản (shoehorn)

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

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

  1. Cài đặt phiên bản 4.19.01 của tiện ích apigee-setup trên nút như mô tả trong phần Cài đặt tiện ích apigee-setup của Edge.
  2. Dọn dẹp Yum: 
    sudo yum clean all
  3. Tạo tệp cấu hình như mô tả ở trên và đảm bảo rằng tệp đó thuộc quyền 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 phần Tệp cấu hình cài đặt.

  4. Thay đổi giá trị của thuộc tính MANAGEMENT_UI_SSO_CSRF_SECRET trong tệp cấu hình thành khoá bí mật CSRF của bạn.
  5. 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
  6. Đị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
  7. 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 trải nghiệm Edge mới

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

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

  1. Cài đặt trải nghiệm Edge mới: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Chuyển sang thư mục edge-management-ui: 
    cd /opt/apigee/edge-management-ui
  3. Định cấu hình trải nghiệm Edge mới: 
    /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 phần 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 Edge mới bằng cách mở URL sau trong trình duyệt: 
    http://newEdgeExperienceIP:3001

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

  6. Hãy xem Trải nghiệm Edge mới cho đám mây riêng tư để biết thêm thông tin, bao gồm cả các đường liên kết đến thông tin về cách sử dụng trải nghiệm Edge mới.

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

Cách gỡ cài đặt phiên bản Edge mới:

/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ơ bản (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ả 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