ติดตั้ง 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.52.01 บนโหนดตามที่อธิบายไว้ในติดตั้งยูทิลิตีการตั้งค่า Edge Apigee ก่อน
    • ต้องเปิดพอร์ต 3001 ซึ่งเป็นพอร์ตเริ่มต้นที่ใช้สำหรับคำขอไปยัง Edge UI หากคุณเปลี่ยนพอร์ตโดยใช้พร็อพเพอร์ตี้ที่อธิบายไว้ในไฟล์การกำหนดค่า UE ใหม่ โปรดตรวจสอบว่าพอร์ตนั้นเปิดอยู่
  • เปิดใช้ IDP ภายนอกใน Edge Edge UI รองรับ SAML หรือ LDAP เป็นกลไกการตรวจสอบสิทธิ์
  • (IdP ของ SAML เท่านั้น) Edge UI รองรับเฉพาะ TLS v1.2 เนื่องจากคุณเชื่อมต่อกับผู้ให้บริการข้อมูลประจำตัว SAML ผ่าน 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 จะทำงานดังนี้

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

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

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

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

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

    ในกรณีนี้ ผู้ใช้ UI แบบคลาสสิกและ Edge UI ทั้งหมดจะลงทะเบียนใน IdP โปรดดูข้อมูลเกี่ยวกับการเพิ่มผู้ใช้ใหม่ใน IdP ที่หัวข้อลงทะเบียนผู้ใช้ Edge ใหม่

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

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

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

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

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

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

ไฟล์การกำหนดค่าต่อไปนี้มีข้อมูลทั้งหมดที่จำเป็นต่อการติดตั้งและกำหนดค่า Edge UI ใหม่ คุณสามารถใช้ไฟล์การกำหนดค่าเดียวกันเพื่อติดตั้งและกำหนดค่าทั้ง UI ของ Shoehorn/Classic และ 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.52.01 บนโหนดตามที่อธิบายไว้ในติดตั้งยูทิลิตี Edge Apigee-setup
  4. ทำความสะอาดข้อมูลที่แคชไว้ทั้งหมดด้วย Yum โดยเรียกใช้คำสั่งต่อไปนี้ 
    sudo yum clean all
  5. สร้างไฟล์การกำหนดค่าตามที่อธิบายไว้ในไฟล์การกำหนดค่า UI ของ Edge ใหม่ และตรวจสอบว่าไฟล์ดังกล่าวเป็นของผู้ใช้ "apigee" หรือไม่ โดยทำดังนี้ 
    chown apigee:apigee configFile

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/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