การติดตั้งประสบการณ์ Edge ใหม่ (เบต้า)

Edge for Private Cloud v4.18.01

เอกสารนี้อธิบายวิธีติดตั้ง Edge เวอร์ชันเบต้าสำหรับ Edge สำหรับ Private Cloud ประสบการณ์การใช้งาน Edge ใหม่คือ UI รุ่นถัดไปสำหรับ Edge

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

• เปิดใช้ SAML ใน Edge ประสบการณ์การใช้งาน Edge ใหม่รองรับเฉพาะ SAML เป็นกลไกการตรวจสอบสิทธิ์เท่านั้น
• ติดตั้งประสบการณ์การใช้งาน Edge ใหม่ในโหนดของตัวเอง คุณไม่สามารถติดตั้งในโหนดที่มีคอมโพเนนต์ Edge อื่นๆ

ดูข้อมูลเพิ่มเติมเกี่ยวกับประสบการณ์การใช้งาน Edge ใหม่ได้ที่ประสบการณ์การใช้งาน Edge ใหม่สำหรับ Private Cloud

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

หากต้องการติดตั้งประสบการณ์การใช้งาน Edge ใหม่เวอร์ชันเบต้าสำหรับ Edge สำหรับ Private Cloud คุณต้องทำตามขั้นตอนการติดตั้ง 2 ขั้นตอนที่แตกต่างกัน ดังนี้

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

สิ่งที่ต้องดำเนินการก่อนการติดตั้ง

• คุณต้องเปิดใช้ SAML ใน Edge ก่อนติดตั้งประสบการณ์การใช้งาน Edge ใหม่ ประสบการณ์การใช้งาน Edge ใหม่รองรับเฉพาะ SAML เป็นกลไกการตรวจสอบสิทธิ์เท่านั้น
  
  หมายเหตุ: ในสภาพแวดล้อมฮาร์ดแวร์และซอฟต์แวร์ที่ไม่ใช่เวอร์ชันที่ใช้งานจริง คุณสามารถเปิดใช้การตรวจสอบสิทธิ์พื้นฐานใน Edge ไว้เพื่อให้ผู้ใช้ UI แบบคลาสสิกและ Edge API ยังคงใช้การตรวจสอบสิทธิ์พื้นฐานได้
  
  ดูข้อมูลเกี่ยวกับการเปิดใช้ SAML ใน Edge ได้ที่หัวข้อ การรองรับ SAML ใน Edge สำหรับ Private Cloud
• คุณต้องติดตั้งประสบการณ์การใช้งาน Edge ใหม่ในโหนดของตัวเอง คุณไม่สามารถติดตั้งบนโหนดที่มีคอมโพเนนต์ Edge อื่นๆ โหนดต้องเป็นไปตามข้อกำหนดต่อไปนี้
  • JAVA 1.8
  • RAM ขนาด 4 GB
  • 2 คอร์
  • พื้นที่ในดิสก์ 60 GB
  • คุณต้องติดตั้งยูทิลิตี apigee-setup เวอร์ชัน 4.18.01 ในโหนดก่อนตามที่อธิบายไว้ในหัวข้อติดตั้งยูทิลิตี apigee-setup ของ Edge

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

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

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

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

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

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

ไฟล์การกำหนดค่าการติดตั้ง

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

ตัวอย่างไฟล์การกำหนดค่ามีดังนี้

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

# IP of the New Edge experience node.
IP2=22.222.222.222 

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

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

# URLs for the different UIs.
# URL of classic Edge UI.
ROUTES_CLASSICUI="http://$IP1:9000"
# URL of New Edge experience.
ROUTES_SHOEHORN="http://$IP2:9000"

# New Edge experience configuration.
# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Access port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_APP_ENV=OPDK
MANAGEMENT_UI_IP=$IP2
# Disable TLS on the New Edge experience.
# This release does not support TLS.
MANAGEMENT_UI_USE_HTTPS=n

# SSO configuration for the New Edge experience.
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y
MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret111

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

# Edge SSO configuration.
# Some settings are for the classic UI, 
# but are still required to configure the New Edge experience.
# Enable SSO.
EDGEUI_SSO_ENABLED=y

# Information about Classic UI
EDGEUI_PUBLIC_URIS=http://$IP1:9000
# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS
# 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 SAML on the classic Edge 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

# Information about Edge SSO module.
# 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 Edge SSO module.
# If Edge SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
# MANAGEMENT_UI_SKIP_VERIFY=y
SSO_PUBLIC_URL_SCHEME=http
# SSO admin credentials as set when you installed Edge SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

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

ติดตั้ง Edge UI พื้นฐาน (Shoehorn)

คุณต้องติดตั้ง Edge UI พื้นฐานที่เรียกว่า shoehorn ก่อนจึงจะติดตั้งประสบการณ์การใช้งาน Edge ใหม่ได้

วิธีติดตั้ง UI พื้นฐาน

1. ติดตั้งยูทิลิตี apigee-setup เวอร์ชัน 4.18.01 ในโหนดตามที่อธิบายไว้ในติดตั้งยูทิลิตี apigee-setup ของ Edge
2. Clean Yum:

   > sudo yum clean all

3. สร้างไฟล์การกำหนดค่าตามที่อธิบายไว้ข้างต้น และตรวจสอบว่าผู้ใช้ "apigee" เป็นเจ้าของไฟล์ดังกล่าว

   > chown apigee:apigee configFile

   โดยที่ configFile คือไฟล์การกำหนดค่าที่อธิบายไว้ข้างต้นในไฟล์การกำหนดค่าการติดตั้ง

4. ติดตั้ง Edge UI เวอร์ชัน Shoehorn โดยทำดังนี้

   > /opt/apigee/apigee-service/bin/apigee-service edge-ui install

5. กำหนดค่า Edge UI ดังนี้

   > /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile

6. เปิดใช้ SAML ใน Edge UI โดยทำดังนี้

   > /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

ติดตั้งประสบการณ์การใช้งาน Edge ใหม่

หลังจากติดตั้ง Edge UI พื้นฐานแล้ว คุณจะติดตั้งและกำหนดค่าประสบการณ์การใช้งาน Edge ใหม่ได้

วิธีติดตั้งประสบการณ์การใช้งาน Edge ใหม่

1. ติดตั้งประสบการณ์การใช้งาน Edge ใหม่โดยทำดังนี้

   > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install

2. เปลี่ยนเป็นไดเรกทอรี edge-management-ui:

   > cd /opt/apigee/edge-management-ui

3. กำหนดค่าประสบการณ์การใช้งาน Edge ใหม่โดยทำดังนี้

   > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

   โดยที่ configFile คือไฟล์การกำหนดค่าที่อธิบายไว้ข้างต้นในไฟล์การกำหนดค่าการติดตั้ง

4. เปิดใช้ SAML ในประสบการณ์การใช้งาน Edge ใหม่โดยทำดังนี้

   > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile

5. เข้าสู่ระบบประสบการณ์การใช้งาน Edge ใหม่โดยเปิด URL ต่อไปนี้ในเบราว์เซอร์

   http://newEdgeExperienceIP:3001

   โดยที่ newEdgeExperienceIP คือที่อยู่ IP ของโหนดที่โฮสต์ประสบการณ์การใช้งาน Edge ใหม่ ระบบจะแจ้งให้คุณป้อนข้อมูลเข้าสู่ระบบ SAML หลังจากป้อนข้อมูลเข้าสู่ระบบแล้ว ประสบการณ์การใช้งาน Edge ใหม่จะปรากฏขึ้น

6. ดูข้อมูลเพิ่มเติม รวมถึงลิงก์สำหรับข้อมูลเกี่ยวกับการใช้ประสบการณ์การใช้งาน Edge ใหม่ได้ที่ประสบการณ์การใช้งาน Edge ใหม่สำหรับ Private Cloud (เบต้า)

ถอนการติดตั้งประสบการณ์การใช้งาน Edge ใหม่

วิธีถอนการติดตั้งประสบการณ์การใช้งาน Edge ใหม่

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

วิธีถอนการติดตั้ง Edge 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-|baas)")

4. นำไดเรกทอรีรากของการติดตั้งออกโดยทำดังนี้

   > sudo rm -rf /opt/apigee