تثبيت تجربة Edge الجديدة

Edge for Private Cloud الإصدار 4.19.01

يوضّح هذا المستند كيفية تثبيت تجربة Edge الجديدة لـ Edge لـ Private Cloud. تجربة Edge الجديدة هي الجيل التالي من واجهة المستخدم في Edge.

لتجربة New Edge في تثبيت Edge for Private Cloud، عليك إجراء ما يلي:

  • فعِّل SAML على Edge. لا تتيح تجربة Edge الجديدة سوى استخدام SAML كآلية مصادقة.
  • ثبِّت تجربة Edge الجديدة على العقدة الخاصة بها. لا يمكنك تثبيتها على عقدة تحتوي على مكوّنات Edge أخرى، بما في ذلك العقدة التي تتضمّن واجهة مستخدم Edge الحالية. سيؤدي ذلك إلى عدم تمكُّن المستخدمين من تسجيل الدخول إلى واجهة مستخدم Edge الكلاسيكية.

لمزيد من المعلومات حول تجربة New Edge، يُرجى الاطّلاع على تجربة New Edge لـ Private Cloud.

نظرة عامة على عملية التثبيت

لتثبيت تجربة Edge الجديدة لـ Edge for the Private Cloud، عليك تنفيذ عمليتَي تثبيت مختلفتَين:

  • ثبِّت واجهة مستخدم Edge الأساسية، والتي تُسمى shoehorn، واضبط واجهة مستخدم Edge الأساسية لاستخدام SAML للمصادقة مع Edge.
  • ثبِّت تجربة New Edge، واضبط تجربة New Edge لاستخدام SAML للمصادقة مع Edge. بعد تثبيت تجربة New Edge، يمكنك تسجيل الدخول واستخدامها للعمل مع Edge.

المتطلّبات الأساسية للتثبيت

  • يجب تفعيل SAML على Edge قبل تثبيت تجربة Edge الجديدة. لا تتيح تجربة Edge الجديدة سوى SAML كآلية مصادقة.

    للحصول على معلومات حول تفعيل SAML على Edge، يُرجى الاطّلاع على إتاحة SAML على Edge for Private Cloud.

  • لا تتوافق تجربة Edge الجديدة إلا مع الإصدار 1.2 من بروتوكول أمان طبقة النقل (TLS). بما أنّك تتصل بموفِّر الهوية (IDP) المستنِد إلى SAML عبر بروتوكول أمان طبقة النقل (TLS)، يجب أن يتوافق موفِّر الهوية (IDP) المستنِد إلى SAML مع الإصدار 1.2 من بروتوكول أمان طبقة النقل (TLS).
  • يجب تثبيت تجربة Edge الجديدة على العقدة الخاصة بها. لا يمكنك تثبيته على عقدة تحتوي على مكوّنات Edge أخرى، بما في ذلك العقدة التي تتوفّر عليها واجهة مستخدم Edge الحالية.

    يجب أن تستوفي العقدة المتطلبات التالية:

    • JAVA 1.8
    • ذاكرة وصول عشوائي (RAM) بسعة 4 غيغابايت
    • نواة مزدوجة
    • مساحة قرص تبلغ 60 غيغابايت
    • يجب أولاً تثبيت الإصدار 4.19.01 من أداة apigee-setup المساعدة على العقدة كما هو موضّح في مقالة تثبيت أداة apigee-setup المساعدة في Edge.
    • يجب أن يكون المنفذ 3001 مفتوحًا. هذا هو المنفذ التلقائي المستخدَم للطلبات المرسَلة إلى تجربة New Edge. إذا غيّرت المنفذ باستخدام السمات الموضّحة أدناه، تأكَّد من أنّ المنفذ مفتوح.

اعتبارات قبل تثبيت تجربة Edge الجديدة

كما هو موضّح أعلاه في المتطلبات الأساسية، تتطلّب تجربة Edge الجديدة تفعيل SAML على Edge. وهذا يعني أنّ مصادقة المستخدم يتم التحكّم فيها من خلال موفِّر هوية SAML، حيث يمكنك ضبط موفِّر هوية SAML لاستخدام عناوين البريد الإلكتروني كأرقام تعريف للمستخدمين. لذلك، يجب تسجيل جميع مستخدمي تجربة New Edge في موفِّر الهوية المستند إلى SAML.

لا تتطلّب واجهة مستخدم Edge الكلاسيكية، وهي واجهة المستخدم التلقائية التي ثبّتها مع Edge for the Private Cloud، استخدام SAML. ويمكنه استخدام إما SAML أو المصادقة الأساسية. هذا يعني أنّه يمكنك تنفيذ أحد الإجراءَين التاليَين:

  • تفعيل دعم SAML على Edge وعلى كل من واجهة المستخدم الكلاسيكية وتجربة Edge الجديدة

    في هذا السيناريو، يتم تسجيل جميع مستخدمي واجهة المستخدم الكلاسيكية وتجربة New Edge في موفِّر هوية SAML. للحصول على معلومات عن إضافة مستخدمين جدد إلى موفِّر الهوية المستنِد إلى SAML، يُرجى الاطّلاع على تسجيل مستخدمي Edge الجدد.

  • تفعيل دعم SAML على Edge، مع إبقاء المصادقة الأساسية مفعَّلة تستخدم تجربة Edge الجديدة بروتوكول SAML، بينما لا تزال واجهة المستخدم الكلاسيكية تستخدم المصادقة الأساسية.

    في هذا السيناريو، يسجّل جميع مستخدمي واجهة المستخدم الكلاسيكية الدخول باستخدام بيانات اعتماد المصادقة الأساسية، حيث يتم تخزين بيانات اعتمادهم في قاعدة بيانات Edge OpenLDAP. يتم تسجيل مستخدمي تجربة Edge الجديدة في موفِّر هوية SAML ويسجّلون الدخول باستخدام SAML.

    ومع ذلك، لا يمكن لمستخدم واجهة المستخدم الكلاسيكية تسجيل الدخول إلى تجربة Edge الجديدة حتى تضيف هذا المستخدم إلى موفّر الهوية (IDP) في SAML كما هو موضّح في تسجيل مستخدمي Edge الجدد.

تغييرات في إعدادات التثبيت من الإصدارات السابقة

يُرجى الانتباه إلى التغييرات التالية في إجراءات التثبيت من الإصدار التجريبي من تجربة Edge الجديدة.

تغييرات إعدادات التثبيت من Edge 4.18.05

يتضمّن الإصدار 4.19.01 من تجربة Edge الجديدة التغييرات التالية على ملف الإعدادات من الإصدار 4.18.05 من Edge:

نوع التغيير المواقع المتأثرة
تمّت إزالته
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

تحتوي هذه السمة على قيمة محدّدة مسبقًا تبلغ 0.5 (30 دقيقة) ولا يمكن تغييرها.

مضاف يمكنك الآن استخدام السمات لتفعيل بروتوكول أمان طبقة النقل (TLS) في تجربة New Edge. لمزيد من المعلومات، يُرجى الاطّلاع على إعداد بروتوكول أمان طبقة النقل (TLS) لتجربة New Edge.

تغييرات في إعدادات التثبيت من Edge 4.18.01

يتضمّن الإصدار 4.19.01 من تجربة 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 وإعدادها. يمكنك استخدام ملف الإعداد نفسه لتثبيت وإعداد كل من واجهة المستخدم الأساسية وتجربة 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 الأساسية (shoehorn)

يجب تثبيت واجهة مستخدم Edge الأساسية، والتي تُسمى shoehorn، قبل أن تتمكّن من تثبيت تجربة Edge الجديدة.

لتثبيت واجهة المستخدم الأساسية، اتّبِع الخطوات التالية:

  1. ثبِّت الإصدار 4.19.01 من أداة apigee-setup المساعدة على العقدة على النحو الموضّح في تثبيت أداة apigee-setup المساعدة في Edge.
  2. Clean Yum:
    sudo yum clean all
  3. أنشئ ملف الإعداد على النحو الموضّح أعلاه وتأكَّد من أنّه مملوك للمستخدم "apigee":
    chown apigee:apigee configFile

    حيث يمثّل configFile ملف الإعداد الموضّح أعلاه في ملف إعداد التثبيت.

  4. غيِّر قيمة السمة MANAGEMENT_UI_SSO_CSRF_SECRET في ملف الإعدادات إلى رمز CSRF السري.
  5. ثبِّت إصدار Shoehorn من واجهة مستخدم Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. اضبط واجهة مستخدم Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. فعِّل SAML في واجهة مستخدم Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

تثبيت تجربة Edge الجديدة

بعد تثبيت واجهة مستخدم Edge الأساسية، يمكنك تثبيت تجربة 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 في تجربة 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. يمكنك الاطّلاع على تجربة Edge الجديدة في Private Cloud لمزيد من المعلومات، بما في ذلك روابط للحصول على معلومات حول استخدام تجربة Edge الجديدة.

إلغاء تثبيت تجربة Edge الجديدة

لإلغاء تثبيت تجربة Edge الجديدة:

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

لإلغاء تثبيت واجهة مستخدم Edge الأساسية (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