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

เอกสารนี้อธิบายวิธีติดตั้ง UI ของ Edge สําหรับ Apigee Edge สําหรับ Private Cloud UI ของ Edge คือ UI รุ่นใหม่สำหรับ Edge

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

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

  • ติดตั้ง UI ของ Edge ในโหนดของตนเอง คุณไม่สามารถติดตั้งในโหนดที่มีคอมโพเนนต์ 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 เท่านั้น) UI ของ Edge รองรับเฉพาะ TLS v1.2 เนื่องจากคุณเชื่อมต่อกับ IdP ของ SAML ผ่าน TLS หากคุณใช้ SAML แสดงว่า IdP ต้องรองรับ TLS v1.2

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

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

กระบวนการติดตั้ง UI ของ Edge สําหรับ Apigee Edge สําหรับ Private Cloud มีขั้นตอนคร่าวๆ ดังนี้

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

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

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

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

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

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

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

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

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

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

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

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

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

ไฟล์การกําหนดค่า UI ของ Edge เวอร์ชันใหม่

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

# 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"

ติดตั้ง UI ของ Edge

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

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

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

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

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

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

  6. กำหนดค่า IdP ภายนอกให้กับผู้ใช้ที่ต้องการให้เข้าถึง UI ของ Edge โปรดดูข้อมูลเพิ่มเติมที่หัวข้อลงทะเบียนผู้ใช้ 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 ของโหนดที่โฮสต์ UI ของ Edge เวอร์ชันใหม่

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

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

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

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

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

หากต้องการถอนการติดตั้ง UI ใหม่จากโหนด คุณจะต้องถอนการติดตั้งทั้ง UI ของ Edge เวอร์ชันใหม่และ 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. นำ Apigee RPM ทั้งหมดออกดังนี้ 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. นําไดเรกทอรีรูทของการติดตั้งออก: 
    sudo rm -rf /opt/apigee