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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ملف إعداد واجهة مستخدِم 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.51.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 الجديدة موفِّر الهوية (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 بيانات اعتماد موفِّر الهوية الخارجي.

  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. أزِل جميع حِزم RPM في Apigee: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. أزِل الدليل الجذر للتثبيت: 
    sudo rm -rf /opt/apigee