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

يصف هذا المستند طريقة تثبيت واجهة مستخدم Edge في Apigee Edge for Private Cloud. واجهة مستخدم Edge هي الجيل التالي من UI for Edge.

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

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

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

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

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

لمزيد من المعلومات حول واجهة مستخدم Edge، يُرجى الاطّلاع على واجهة مستخدم Edge الجديدة للسحابة الإلكترونية الخاصة.

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

على مستوى عالٍ، تكون عملية تثبيت واجهة مستخدم Edge في Apigee Edge for Private Cloud على النحو التالي:

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

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

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

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

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

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

• إتاحة دعم موفِّر الهوية (idP) الخارجي على Edge وعلى كل من واجهة المستخدم الكلاسيكية وواجهة مستخدم Edge.

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

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

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

  ومع ذلك، لا يمكن لمستخدم واجهة المستخدم الكلاسيكية تسجيل الدخول إلى واجهة مستخدم Edge حتى تتم إضافة هذا المستخدم إلى موفِّر الهوية (idP) كما هو موضح في تسجيل مستخدمي 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 الجديدة وتهيئتها. يمكنك استخدام ملف الإعداد نفسه لتثبيت وإعداد كل من واجهة المستخدم الكلاسيكية أو واجهة المستخدم الكلاسيكية وكذلك واجهة مستخدم 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.52.02 من الأداة 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 الجديدة موفِّر الهوية (idP) خارجي):
     • SAML
     • LDAP

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

6. اضبط موفِّر الهوية (idP) الخارجي للمستخدمين الذين تريد منحهم إذن الوصول إلى واجهة مستخدم 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 بيانات اعتماد موفِّر الهوية (idP) الخارجية.

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

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

   إذا لم يتم عرض واجهة مستخدم 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:

   sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")

4. أزِل الدليل الجذري للتثبيت:

   sudo rm -rf /opt/apigee