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

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

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

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

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

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

  • JAVA 1.8
  • RAM ขนาด 4 GB
  • 2 แกน
  • พื้นที่ในดิสก์ 60 GB
  • คุณต้องติดตั้งยูทิลิตี apigee-setup เวอร์ชัน 4.53.01 ในโหนดก่อนตามที่อธิบายไว้ในติดตั้ง ยูทิลิตี apigee-setup ของ Edge
  • ต้องเปิดพอร์ต 3001 นี่คือพอร์ตเริ่มต้นที่ใช้สำหรับคำขอไปยัง Edge UI หากคุณเปลี่ยนพอร์ตโดยใช้พร็อพเพอร์ตี้ที่อธิบายไว้ในไฟล์การกำหนดค่า UE ใหม่ โปรดตรวจสอบว่าพอร์ตเปิดอยู่
• เปิดใช้ IDP ภายนอกใน Edge UI ของ Edge รองรับ SAML หรือ LDAP เป็น กลไกการตรวจสอบสิทธิ์
• (เฉพาะ IdP ของ SAML) 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

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

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

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

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

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

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

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

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

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

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

MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

# Shoehorn/Classic 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

ROUTES_SHOEHORN
ROUTES_CLASSICUI

MANAGEMENT_UI_USE_HTTPS

MANAGEMENT_UI_SCHEME

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

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

ติดตั้ง Edge UI

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

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

1. เพิ่มโหนดใหม่ลงในคลัสเตอร์
2. เข้าสู่ระบบโหนดใหม่ในฐานะผู้ดูแลระบบ
3. ติดตั้งยูทิลิตี apigee-setup เวอร์ชัน 4.53.01 ในโหนด ตามที่อธิบายไว้ในติดตั้งยูทิลิตี apigee-setup ของ 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 แบบคลาสสิก โปรแกรมติดตั้งจะติดตั้ง UI ของ Edge

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 ใหม่สำหรับ Private Cloud

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

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

หากต้องการถอนการติดตั้ง UI ใหม่จากโหนด คุณต้องถอนการติดตั้งทั้ง UI ใหม่ของ Edge และ 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