ติดตั้ง Edge UI ใหม่

เอกสารนี้อธิบายวิธีติดตั้ง Edge UI สำหรับ Apigee Edge สำหรับ Private Cloud Edge UI เป็น UI รุ่นถัดไปสำหรับ Edge

ข้อกำหนดเบื้องต้น

หากต้องการลองใช้ Edge UI ใหม่ในการติดตั้ง Apigee Edge สำหรับ Private Cloud คุณต้องทำดังนี้

  • ติดตั้ง Edge UI ในโหนดของตัวเอง คุณไม่สามารถติดตั้งในโหนดที่มีคอมโพเนนต์ Edge อื่นๆ รวมถึงโหนดที่มี UI แบบคลาสสิกอยู่ การดำเนินการนี้จะทำให้ผู้ใช้เข้าสู่ระบบ UI แบบคลาสสิกไม่ได้

    โหนดของ Edge UI ต้องเป็นไปตามข้อกำหนดต่อไปนี้

    • JAVA 1.8
    • RAM ขนาด 4 GB
    • 2 คอร์
    • พื้นที่ในดิสก์ 60 GB
    • คุณต้องติดตั้งยูทิลิตี apigee-setup เวอร์ชัน 4.50.00 ในโหนดก่อนตามที่อธิบายไว้ในหัวข้อติดตั้งยูทิลิตี apigee-setup ของ Edge
    • พอร์ต 3001 ต้องเปิดอยู่ นี่คือพอร์ตเริ่มต้นที่ใช้สำหรับคำขอไปยัง Edge UI หากคุณเปลี่ยนพอร์ตโดยใช้พร็อพเพอร์ตี้ที่อธิบายไว้ในไฟล์การกำหนดค่า UE ใหม่ ให้ตรวจสอบว่าพอร์ตนั้นเปิดอยู่
  • เปิดใช้ IDP ภายนอกใน Edge Edge UI รองรับ SAML หรือ LDAP เป็นกลไกการตรวจสอบสิทธิ์
  • (SAML IDP เท่านั้น) Edge UI รองรับเฉพาะ TLS v1.2 เนื่องจากคุณเชื่อมต่อกับ SAML IDP ผ่าน TLS หากคุณใช้ SAML ดังนั้น IDP ของคุณจึงต้องรองรับ TLS v1.2

ดูข้อมูลเพิ่มเติมเกี่ยวกับ Edge UI ได้ที่Edge UI ใหม่สำหรับ Private Cloud

ภาพรวมการติดตั้ง

โดยรวมแล้ว ขั้นตอนการติดตั้ง Edge UI สำหรับ Apigee Edge สำหรับ Private Cloud มีดังนี้

  • เพิ่มโหนดใหม่ลงในคลัสเตอร์
  • เข้าสู่ระบบโหนดใหม่
  • ดาวน์โหลดยูทิลิตี apigee-setup
  • สร้างไฟล์การกำหนดค่าและแก้ไขด้วยการตั้งค่าของคุณ
  • เรียกใช้ยูทิลิตี apigee-setup
  • เข้าสู่ระบบและทดสอบ UE ใหม่

เมื่อดำเนินการในโหนดใหม่ ยูทิลิตี apigee-setup จะทำดังนี้

  • ติดตั้ง Classic UI พื้นฐานที่เรียกว่า shoehorn และกำหนดค่า Classic UI ให้ใช้ IDP ภายนอกเพื่อตรวจสอบสิทธิ์กับ Edge
  • ติดตั้ง Edge UI ใหม่ และกำหนดค่า Edge UI ให้ใช้ IDP ภายนอกเพื่อตรวจสอบสิทธิ์กับ Edge

สิ่งที่ควรพิจารณาก่อนติดตั้ง Edge UI ใหม่

ตามที่อธิบายไว้ข้างต้นในข้อกำหนดเบื้องต้น Edge UI กำหนดให้คุณต้องเปิดใช้ IDP ภายนอกใน Edge ซึ่งหมายความว่าการตรวจสอบสิทธิ์ผู้ใช้จะควบคุมโดย IDP ซึ่งคุณกำหนดค่าให้ใช้อีเมลเป็นรหัสผู้ใช้ ดังนั้น ผู้ใช้ Edge UI ทุกคนต้องลงทะเบียนใน IDP

UI แบบคลาสสิกซึ่งเป็น UI เริ่มต้นที่คุณติดตั้งด้วย Apigee Edge สำหรับ Private Cloud ไม่จำเป็นต้องใช้ IDP ภายนอก โดยจะใช้การตรวจสอบสิทธิ์ IDP หรือการตรวจสอบสิทธิ์พื้นฐานก็ได้ ซึ่งหมายความว่าคุณจะทำสิ่งต่อไปนี้ได้

  • เปิดใช้การรองรับ IDP ภายนอกใน Edge และทั้งใน UI แบบคลาสสิกและ UI ของ Edge

    ในสถานการณ์นี้ ผู้ใช้ Classic UI และ Edge UI ทั้งหมดจะลงทะเบียนใน IDP ดูข้อมูลเกี่ยวกับการเพิ่มผู้ใช้ใหม่ใน IDP ได้ที่หัวข้อลงทะเบียนผู้ใช้ Edge ใหม่

  • เปิดใช้การรองรับ IDP ภายนอกใน Edge แต่เปิดใช้การตรวจสอบสิทธิ์แบบพื้นฐานไว้ Edge UI จะใช้ IDP และ Classic UI จะยังคงใช้การตรวจสอบสิทธิ์พื้นฐาน

    ในสถานการณ์นี้ ผู้ใช้ Classic UI ทั้งหมดจะเข้าสู่ระบบด้วยข้อมูลรับรองการตรวจสอบสิทธิ์พื้นฐาน โดยระบบจะจัดเก็บข้อมูลรับรองไว้ในฐานข้อมูล Edge OpenLDAP ผู้ใช้ Edge UI จะลงทะเบียนใน IDP และเข้าสู่ระบบโดยใช้ SAML หรือ LDAP

    อย่างไรก็ตาม ผู้ใช้ Classic UI จะเข้าสู่ระบบ Edge UI ไม่ได้จนกว่าคุณจะเพิ่มผู้ใช้รายนั้นลงใน IDP ตามที่อธิบายไว้ในหัวข้อลงทะเบียนผู้ใช้ Edge ใหม่

การเปลี่ยนแปลงการกำหนดค่าการติดตั้งจากรุ่นก่อนหน้า

โปรดทราบถึงการเปลี่ยนแปลงต่อไปนี้ในขั้นตอนการติดตั้งจาก Edge UI รุ่นเบต้า

ไฟล์การกำหนดค่า Edge UI ใหม่

ไฟล์การกำหนดค่าต่อไปนี้มีข้อมูลทั้งหมดที่จำเป็นในการติดตั้งและกำหนดค่า Edge UI ใหม่ คุณสามารถใช้ไฟล์การกำหนดค่าเดียวกันเพื่อติดตั้งและกำหนดค่าทั้ง Shoehorn/Classic UI และ Edge UI

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

# IP of the Edge UI node.
IP2=edge_UI_server_IP

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

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

#
# Edge UI configuration.
#

# Enable the Edge UI.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the Edge UI.
# The management UI port must be open for requests to the Edge UI
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Set to 'OPDK' to specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=http

# Location of Edge UI.
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=YOUR_CSRF_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 Edge UI.
MANAGEMENT_UI_SSO_ENABLED=y

# Only required if MANAGEMENT_UI_SSO_ENABLED is 'y'
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y

MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=your_client_sso_secret

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the Edge UI.
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 Edge UI.
#

# 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 your IDP on the Classic 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

# Apigee SSO Component configuration
# 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 Apigee SSO module.
# If Apigee 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 Apigee SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=your_sso_admin_secret

#
##      SSO Configuration (define external IDP)           #
#
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                        #
#  - LDAP Direct Binding configuration properties         #
#  - LDAP Indirect Binding configuration properties       #

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect)

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

ติดตั้ง Edge UI

หลังจากสร้างและแก้ไขไฟล์การกำหนดค่าแล้ว คุณจะติดตั้ง Edge UI ใหม่ในโหนดใหม่นั้นได้

วิธีติดตั้ง Edge UI

  1. เพิ่มโหนดใหม่ลงในคลัสเตอร์
  2. เข้าสู่ระบบโหนดใหม่ในฐานะผู้ดูแลระบบ
  3. ติดตั้งยูทิลิตี apigee-setup เวอร์ชัน 4.50.00 ในโหนดตามที่อธิบายไว้ในติดตั้งยูทิลิตี apigee-setup ของ Edge
  4. ล้างข้อมูลที่แคชไว้ทั้งหมดด้วย Yum โดยเรียกใช้คำสั่งต่อไปนี้ 
    sudo yum clean all
  5. สร้างไฟล์การกำหนดค่าตามที่อธิบายไว้ในไฟล์การกำหนดค่า Edge UI ใหม่ และตรวจสอบว่าผู้ใช้ "apigee" เป็นเจ้าของไฟล์ดังกล่าว 
    chown apigee:apigee configFile

    ตรวจสอบว่าคุณได้แก้ไขไฟล์การกำหนดค่าดังต่อไปนี้

    • เปลี่ยนค่าของพร็อพเพอร์ตี้ MANAGEMENT_UI_SSO_CSRF_SECRET ในไฟล์การกำหนดค่าเป็นข้อมูลลับ CSRF
    • กำหนดค่า Edge ให้ใช้รายการใดรายการหนึ่งต่อไปนี้ (UI ใหม่ของ Edge ต้องใช้ IDP ภายนอก)
      • SAML
      • LDAP

      ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของการตรวจสอบสิทธิ์ IDP ภายนอก

  6. กำหนดค่า IDP ภายนอกด้วยผู้ใช้ที่คุณต้องการให้เข้าถึง Edge UI ได้ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อลงทะเบียนผู้ใช้ Edge ใหม่
  7. ในโหนดใหม่ ให้เรียกใช้คำสั่งต่อไปนี้ 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    ยูทิลิตี apigee-setup จะติดตั้ง UI แบบคลาสสิก จากนั้นโปรแกรมติดตั้งจะติดตั้ง Edge UI ไว้ด้านบนของ Classic UI

  8. เข้าสู่ระบบ Edge UI โดยเปิด URL ต่อไปนี้ในเบราว์เซอร์ 
    http://new_edge_UI_IP:3001

    โดยที่ new_edge_UI_IP คือที่อยู่ IP ของโหนดที่โฮสต์ Edge UI ใหม่

    Edge จะแจ้งให้คุณป้อนข้อมูลเข้าสู่ระบบ IDP ภายนอก

  9. ป้อนข้อมูลเข้าสู่ระบบของคุณ

    UI ใหม่ของ Edge จะปรากฏขึ้น ดูข้อมูลเกี่ยวกับการใช้ Edge UI ได้ที่Edge UI ใหม่สำหรับ Private Cloud

    หาก Edge UI ไม่แสดง ให้ตรวจสอบว่าพอร์ต 3001 เปิดอยู่สำหรับการเชื่อมต่อภายนอก

ถอนการติดตั้ง UI ใหม่

หากต้องการถอนการติดตั้ง UI ใหม่จากโหนด คุณต้องถอนการติดตั้งทั้ง Edge UI ใหม่และ Classic UI พื้นฐาน (shoehorn) ที่ติดตั้งในโหนดระหว่างกระบวนการติดตั้ง UI

วิธีถอนการติดตั้ง UI ใหม่ของ Edge

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

วิธีถอนการติดตั้ง UI แบบคลาสสิกพื้นฐาน (shoehorn)

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

วิธีนำคอมโพเนนต์ Edge ทั้งหมดออกจากโหนด

  1. หยุดบริการ Edge ทั้งหมดที่ทำงานในเครื่อง โดยทำดังนี้ 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. ล้างแคช yum โดยทำดังนี้ 
    sudo yum clean all
  3. นำ RPM ของ Apigee ทั้งหมดออกโดยทำดังนี้ 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. นำไดเรกทอรีรากของการติดตั้งออกโดยทำดังนี้ 
    sudo rm -rf /opt/apigee