تثبيت واجهة مستخدم Edge الجديدة

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

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

لتجربة واجهة مستخدم Edge الجديدة في Apigee Edge لتثبيت Private Cloud، عليك اتّباع الخطوات التالية:

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

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

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

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

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

فيما يلي خطوات تثبيت واجهة مستخدم Edge لـ Apigee Edge for Private Cloud بشكل عام:

• إضافة عقدة جديدة إلى المجموعة
• تسجيل الدخول إلى العقدة الجديدة
• تنزيل أداة apigee-setup المساعدة
• إنشاء ملف إعداد وتعديله باستخدام إعداداتك
• نفِّذ الأداة المساعدة apigee-setup
• تسجيل الدخول واختبار تجربة المستخدم الجديدة

عند تنفيذها على العقدة الجديدة، تؤدي الأداة المساعدة apigee-setup إلى:

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

اعتبارات قبل تثبيت واجهة مستخدم Edge الجديدة

As described above in the prerequisites, the Edge UI requires that you enable an external IDP on Edge. وهذا يعني أنّ موفّر الهوية يتحكّم في مصادقة المستخدمين، حيث يمكنك ضبطه لاستخدام عناوين البريد الإلكتروني كأرقام تعريف للمستخدمين. لذلك، يجب تسجيل جميع مستخدمي Edge UI في موفِّر الهوية.

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

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

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

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

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

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

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

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

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

ملف إعداد واجهة مستخدم Edge الجديد

يحتوي ملف الإعداد التالي على جميع المعلومات اللازمة لتثبيت واجهة مستخدم Edge الجديدة وإعدادها. يمكنك استخدام ملف الإعداد نفسه لتثبيت وإعداد كل من shoehorn/واجهة المستخدم الكلاسيكية وواجهة مستخدم 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

بعد إنشاء ملف الإعداد وتعديله، يمكنك تثبيت واجهة مستخدم Edge الجديدة على هذه العقدة الجديدة.

لتثبيت واجهة مستخدم Edge:

1. أضِف عقدة جديدة إلى مجموعتك.
2. سجِّل الدخول إلى العقدة الجديدة بصفتك مشرفًا.
3. ثبِّت الإصدار 4.50.00 من أداة apigee-setup المساعدة على العقدة، كما هو موضّح في تثبيت أداة Edge apigee-setup المساعدة.
4. امسح جميع المعلومات المخزّنة مؤقتًا باستخدام Yum من خلال تنفيذ الأمر التالي:

   sudo yum clean all

5. أنشئ ملف الإعداد كما هو موضّح في ملف إعداد واجهة مستخدم Edge الجديد وتأكَّد من أنّه مملوك للمستخدم "apigee":

   chown apigee:apigee configFile

   تأكَّد من إجراء التعديلات التالية على ملف الإعداد:

   • غيِّر قيمة السمة MANAGEMENT_UI_SSO_CSRF_SECRET في ملف الإعداد إلى رمز CSRF السري.
   • اضبط Edge لاستخدام أحد الخيارات التالية (تتطلّب واجهة مستخدم Edge الجديدة موفِّر هوية خارجي):
     • SAML
     • LDAP

     لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على مصادقة موفّري الهوية الخارجيين.

6. اضبط موفِّر الهوية الخارجي مع المستخدمين الذين تريد منحهم إذن الوصول إلى واجهة مستخدم Edge. لمزيد من المعلومات، يُرجى الاطّلاع على تسجيل مستخدمي Edge الجدد.
7. على العقدة الجديدة، نفِّذ الأمر التالي:

   /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

   تثبّت الأداة المساعدة apigee-setup واجهة المستخدم الكلاسيكية. بالإضافة إلى واجهة المستخدم الكلاسيكية، تثبِّت أداة التثبيت واجهة مستخدم Edge.

8. سجِّل الدخول إلى واجهة مستخدم Edge من خلال فتح عنوان URL التالي في المتصفّح:

   http://new_edge_UI_IP:3001

   حيث يمثّل new_edge_UI_IP عنوان IP للعقدة التي تستضيف واجهة مستخدم Edge الجديدة.

   يطلب منك Edge إدخال بيانات اعتماد موفِّر الهوية الخارجي.

9. أدخِل بيانات الاعتماد.

   ستظهر واجهة مستخدم Edge الجديدة. للحصول على معلومات عن استخدام واجهة مستخدم Edge، يُرجى الاطّلاع على واجهة مستخدم Edge الجديدة لـ Private Cloud.

   إذا لم تظهر واجهة مستخدم Edge، تأكَّد من أنّ المنفذ 3001 مفتوح للاتصالات الخارجية.

إلغاء تثبيت واجهة المستخدم الجديدة

لإلغاء تثبيت واجهة المستخدم الجديدة من العقدة، عليك إلغاء تثبيت كل من واجهة مستخدم Edge الجديدة وواجهة المستخدم الكلاسيكية الأساسية (shoehorn) التي تم تثبيتها على العقدة أثناء عملية تثبيت واجهة المستخدم.

لإلغاء تثبيت واجهة مستخدم Edge الجديدة:

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

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