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

Edge สำหรับ Private Cloud เวอร์ชัน 4.19.01

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

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

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

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

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

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

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

ข้อกำหนดเบื้องต้นของการติดตั้ง

  • คุณต้องเปิดใช้ SAML ใน Edge ก่อนติดตั้งประสบการณ์ New Edge ประสบการณ์การใช้งาน New Edge รองรับเฉพาะ SAML เป็นกลไกการตรวจสอบสิทธิ์เท่านั้น

    โปรดดูข้อมูลการเปิดใช้ SAML บน Edge ที่หัวข้อการรองรับ SAML ใน Edge สำหรับ Private Cloud

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

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

    • Java 1.8
    • RAM 4 GB
    • 2 แกน
    • พื้นที่ว่างในดิสก์ 60 GB
    • คุณต้องติดตั้งยูทิลิตี apigee-setup เวอร์ชัน 4.19.01 บนโหนดตามที่อธิบายไว้ที่ติดตั้งยูทิลิตี Edge apigee-setup ก่อน
    • ต้องเปิดพอร์ต 3001 พอร์ตนี้เป็นพอร์ตเริ่มต้นที่ใช้สำหรับส่งคำขอไปยังประสบการณ์ New Edge หากคุณเปลี่ยนพอร์ตโดยใช้คุณสมบัติที่อธิบายไว้ด้านล่าง โปรดตรวจสอบว่าพอร์ตนั้นเปิดอยู่

ข้อควรพิจารณาก่อนติดตั้งประสบการณ์ New Edge

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

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

  • เปิดใช้การรองรับ SAML ใน Edge และทั้งใน UI แบบคลาสสิกและประสบการณ์การใช้งาน New Edge

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

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

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

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

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

โปรดรับทราบการเปลี่ยนแปลงต่อไปนี้สำหรับขั้นตอนการติดตั้งจากประสบการณ์การใช้งาน New Edge รุ่นเบต้า

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

ประสบการณ์ Edge 4.19.01 ของ New Edge จะมีการเปลี่ยนแปลงต่อไปนี้ในไฟล์การกำหนดค่าจากรุ่น Edge 4.18.05

ประเภทการเปลี่ยนแปลง ที่พักที่ได้รับผลกระทบ
นำออกแล้ว
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

พร็อพเพอร์ตี้ดังกล่าวมีค่าที่กำหนดล่วงหน้าอยู่ที่ 0.5 (30 นาที) และเปลี่ยนแปลงไม่ได้

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

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

ประสบการณ์ Edge 4.19.01 ของ New Edge จะมีการเปลี่ยนแปลงต่อไปนี้ในไฟล์การกำหนดค่าจากรุ่น Edge 4.18.01

ประเภทการเปลี่ยนแปลง ที่พักที่ได้รับผลกระทบ
เพิ่มแล้ว
# Shoehorn 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

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

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

#
# New Edge experience configuration.
#

# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the New Edge experience.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
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=CHANGE_TO_YOUR_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 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

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the New Edge experience.
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 New Edge experience.
#

# 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 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".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# 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 ก่อนจึงจะติดตั้งประสบการณ์ New Edge ได้

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

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

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

  4. เปลี่ยนค่าของพร็อพเพอร์ตี้ MANAGEMENT_UI_SSO_CSRF_SECRET ในไฟล์การกำหนดค่าเป็นข้อมูลลับ CSRF
  5. ติดตั้ง Edge UI เวอร์ชัน Shoehorn ดังนี้
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. กำหนดค่า Edge UI ดังนี้
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. เปิดใช้ SAML ใน Edge UI:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

ติดตั้งประสบการณ์ New Edge

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

วิธีติดตั้งประสบการณ์ New Edge

  1. ติดตั้งประสบการณ์ New Edge โดยทำดังนี้
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. เปลี่ยนเป็นไดเรกทอรี edge-management-ui:
    cd /opt/apigee/edge-management-ui
  3. กำหนดค่าประสบการณ์ New Edge ดังนี้
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

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

  4. เปิดใช้ SAML ในประสบการณ์การใช้งาน New Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. ลงชื่อเข้าสู่ระบบของ New Edge โดยเปิด URL ต่อไปนี้ในเบราว์เซอร์
    http://newEdgeExperienceIP:3001

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

  6. โปรดดูข้อมูลเพิ่มเติม รวมถึงลิงก์สำหรับข้อมูลการใช้ New Edge ได้ที่ The New Edge Experience สำหรับ Private Cloud

ถอนการติดตั้งประสบการณ์ New Edge

วิธีถอนการติดตั้งประสบการณ์ New 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-)")
  4. นำไดเรกทอรีรูทของการติดตั้งออก:
    sudo rm -rf /opt/apigee