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

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

ข้อควรพิจารณาก่อนติดตั้ง Edge ใหม่ อินเทอร์เฟซผู้ใช้

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

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

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

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

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

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

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

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

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

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

ไฟล์การกำหนดค่าต่อไปนี้มีข้อมูลทั้งหมดที่จำเป็นในการติดตั้งและ กำหนดค่า Edge UI ใหม่ คุณใช้ไฟล์การกำหนดค่าเดียวกันเพื่อติดตั้งและกำหนดค่าทั้ง 2 ไฟล์ได้ UI คลาสสิกและ Soehorn/ป้ายใช้รูปแบบ กับ 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

# Enable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=https

# 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

# CSRF configuration.
MANAGEMENT_UI_SSO_CSRF_SECRET=YOUR_CSRF_SECRET
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24

# Strict Transport Security configuration.
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 be deleted and a 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.00 ในโหนด ตามที่อธิบายไว้ที่ติดตั้งการตั้งค่า Apigee ของ 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 แบบคลาสสิก นอกเหนือจาก 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