كيفية ضبط Edge

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

لضبط Edge بعد التثبيت، يمكنك استخدام مجموعة من ملفات .properties وأدوات Edge المساعدة. على سبيل المثال، لضبط بروتوكول أمان طبقة النقل (TLS)/طبقة المقابس الآمنة (SSL) على واجهة مستخدم Edge، عليك تعديل ملفات .properties لضبط السمات اللازمة. تتطلّب التغييرات على ملفات .properties إعادة تشغيل مكوّن Edge المتأثر.

تشير Apigee إلى أسلوب تعديل ملفات .properties على أنّه رمز برمجي مع إعدادات (يُشار إليه أحيانًا بالاختصار CwC). بشكل أساسي، الرمز الذي يتضمّن إعدادات هو أداة بحث عن المفاتيح/القيم استنادًا إلى الإعدادات في ملفات .properties. في الرمز البرمجي الذي يتضمّن إعدادات، يُشار إلى المفاتيح باسم الرموز المميّزة. لذلك، لضبط Edge، عليك ضبط الرموز المميّزة في ملفات .properties.

يتيح الرمز البرمجي مع الإعداد لمكوّنات Edge ضبط القيم التلقائية التي يتم شحنها مع المنتج، ويتيح لفريق التثبيت إلغاء هذه الإعدادات استنادًا إلى مخطط التثبيت، ثم يتيح للعملاء إلغاء أي خصائص يختارونها.

إذا فكرت في الأمر على أنه تسلسل هرمي، فسيتم ترتيب الإعدادات على النحو التالي، مع إعدادات العميل التي لها الأولوية القصوى لتجاوز أي إعدادات من فريق المثبت أو Apigee:

  1. العميل
  2. أداة التثبيت
  3. المكوّن

تحديد القيمة الحالية للرمز المميّز

قبل ضبط قيمة جديدة لرمز مميّز في ملف .properties، عليك أولاً تحديد قيمته الحالية باستخدام الأمر التالي:

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

حيث component_name هو اسم المكوّن، وtoken هو الرمز المميّز الذي سيتم فحصه.

يبحث هذا الأمر في التسلسل الهرمي لملفات .properties الخاصة بالمكوّن لتحديد القيمة الحالية للرمز المميّز.

يتحقّق المثال التالي من القيمة الحالية للرمز المميّز conf_http_HTTPRequest.line.limit لجهاز التوجيه:

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

من المفترض أن تظهر لك نتيجة مثل ما يلي:

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

إذا كانت قيمة الرمز المميّز تبدأ بـ #، يعني ذلك أنّه تمت الإشارة إلى أسطر رموز باعتبارها تعليقًا ويجب استخدام صيغة خاصة لتغييره. لمزيد من المعلومات، يُرجى الاطّلاع على ضبط رمز مميّز تمّت الإشارة إليه حاليًا باعتباره تعليقًا.

إذا كنت لا تعرف الاسم الكامل للرمز المميّز، استخدِم أداة مثل grep للبحث حسب اسم السمة أو الكلمة الرئيسية. لمزيد من المعلومات، يُرجى الاطّلاع على تحديد مكان رمز مميّز.

ملفات الخصائص

هناك ملفات إعداد مكوّنات قابلة للتعديل وغير قابلة للتعديل. ويوضّح هذا القسم هذه الملفات.

ملفات إعداد المكوّنات القابلة للتعديل

يسرد الجدول التالي مكوّنات Apigee وملفات المواقع التي يمكنك تعديلها لضبط هذه المكوّنات:

المكوّن اسم المكوّن ملف إعداد قابل للتعديل
Cassandra apigee-cassandra /opt/apigee/customer/application/cassandra.properties
Edge UI edge-ui /opt/apigee/customer/application/ui.properties
Edge SSO apigee-sso /opt/apigee/customer/application/sso.properties
خادم الإدارة edge-management-server /opt/apigee/customer/application/management-server.properties
معالج الرسائل edge-message-processor /opt/apigee/customer/application/message-processor.properties
apigee-monit apigee-monit /opt/apigee/customer/application/monit.properties
تجربة مستخدم جديدة apigee-management-ui لا ينطبق (استخدِم ملف إعدادات التثبيت)
OpenLDAP apigee-openldap /opt/apigee/customer/application/openldap.properties
خادم Postgres edge-postgres-server /opt/apigee/customer/application/postgres-server.properties
قاعدة بيانات PostgreSQL apigee-postgresql /opt/apigee/customer/application/postgressql.properties
خادم Qpid edge-qpid-server /opt/apigee/customer/application/qpid-server.properties
Qpidd apigee-qpidd /opt/apigee/customer/application/qpidd.properties
جهاز التوجيه edge-router /opt/apigee/customer/application/router.properties
حارس حديقة حيوانات apigee-zookeeper /opt/apigee/customer/application/zookeeper.properties

إذا أردت ضبط سمة في أحد ملفات إعداد المكوّنات هذه ولكنّها غير متوفّرة، يمكنك إنشاؤها في الموقع المذكور أعلاه.

بالإضافة إلى ذلك، يجب التأكّد من أنّ ملف السمات مملوك للمستخدم "apigee":

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

ملفات إعداد المكوّنات غير القابلة للتعديل

بالإضافة إلى ملفات إعداد المكوّنات القابلة للتعديل، هناك أيضًا ملفات إعداد لا يمكنك تعديلها.

تشمل الملفات الإعلامية (غير القابلة للتعديل) ما يلي:

المالك اسم الملف أو الدليل
تثبيت 
/opt/apigee/token
المكوّن 
/opt/apigee/component_name/conf

حيث يحدّد component_name المكوّن. تشتمل القيم المحتملة ما يلي:

  • apigee-cassandra (كاساندرا)
  • apigee-openldap (OpenLDAP)
  • apigee-postgresql (قاعدة بيانات PostgreSQL)
  • apigee-qpidd (Qbidd)
  • apigee-sso (الدخول الموحّد في Edge)
  • apigee-zookeeper (ZooKeeper)
  • edge-management-server (خادم الإدارة)
  • edge-management-ui (واجهة مستخدم Edge الجديدة)
  • edge-message-processor (معالج الرسائل)
  • edge-postgres-server (خادم Postgres)
  • edge-qpid-server (خادم Qbid)
  • edge-router (جهاز توجيه الحواف)
  • edge-ui (واجهة المستخدم الكلاسيكية)

ضبط قيمة رمز مميّز

يمكنك فقط تعديل ملفات .properties في دليل /opt/apigee/customer/application. ويحتوي كل مكوّن على ملف .properties الخاص به في هذا الدليل. على سبيل المثال، router.properties وmanagement-server.properties. للحصول على قائمة كاملة بملفات المواصفات، يُرجى الاطّلاع على موقع ملفات ‎ .properties.

لإنشاء ملف .properties:

  1. أنشئ ملفًا نصيًا جديدًا في محرّر. يجب أن يتطابق اسم الملف مع القائمة المعروضة في الجدول أعلاه لملفات العملاء.
  2. غيِّر مالك الملف إلى "apigee:apigee"، كما هو موضّح في المثال التالي: 
    chown apigee:apigee /opt/apigee/customer/application/router.properties

    إذا غيّرت المستخدم الذي يشغّل خدمة Edge من المستخدم "apigee"، استخدِم chown لتغيير الملكية إلى المستخدم الذي يشغّل خدمة Edge.

عند ترقية Edge، تتم قراءة ملفات .properties في دليل /opt/apigee/customer/application. وهذا يعني أنّ الترقية ستحتفظ بأي خصائص تضبطها على المكوّن.

لضبط قيمة رمز مميّز:

  1. عدِّل ملف .properties الخاص بالمكوّن.
  2. أضِف قيمة الرمز المميّز أو غيِّرها. يضبط المثال التالي قيمة السمة conf_http_HTTPRequest.line.limit على "10k": 
    conf_http_HTTPRequest.line.limit=10k

    إذا كان الرمز المميّز يتضمّن قيمًا متعددة، افصل بين كل قيمة بفاصلة، كما هو موضّح في المثال التالي:

    conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

    لإضافة قيمة جديدة إلى قائمة مثل هذه، عادةً ما يتم إلحاق القيمة الجديدة بنهاية القائمة.

  3. أعِد تشغيل المكوّن: 
    /opt/apigee/apigee-service/bin/apigee-service component_name restart

    حيث تكون السمة component_name إحدى القيم التالية:

    • apigee-cassandra (كاساندرا)
    • apigee-openldap (OpenLDAP)
    • apigee-postgresql (قاعدة بيانات PostgreSQL)
    • apigee-qpidd (Qbidd)
    • apigee-sso (الدخول الموحّد في Edge)
    • apigee-zookeeper (ZooKeeper)
    • edge-management-server (خادم الإدارة)
    • edge-management-ui (واجهة مستخدم Edge الجديدة)
    • edge-message-processor (معالج الرسائل)
    • edge-postgres-server (خادم Postgres)
    • edge-qpid-server (خادم Qbid)
    • edge-router (جهاز توجيه الحواف)
    • edge-ui (واجهة المستخدم الكلاسيكية)

    على سبيل المثال، بعد تعديل router.properties، أعِد تشغيل جهاز التوجيه:

    /opt/apigee/apigee-service/bin/apigee-service edge-router restart
  4. (اختياري) تأكَّد من ضبط قيمة الرمز المميّز على القيمة الجديدة باستخدام الخيار configure -search. على سبيل المثال: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

    لمزيد من المعلومات حول configure -search، يُرجى الاطّلاع على تحديد القيمة الحالية لرمز مميّز.

العثور على رمز مميّز

في معظم الحالات، يتم تحديد الرموز المميّزة التي تحتاج إلى ضبطها في هذا الدليل. ومع ذلك، إذا كنت بحاجة إلى إلغاء قيمة رمز مميّز حالي لست متأكدًا من اسمه الكامل أو موقعه الجغرافي، استخدِم grep للبحث في دليل source الخاص بالمكوّن.

على سبيل المثال، إذا كنت تعلم أنّك ضبطت السمة session.maxAge في إصدار سابق من Edge وأردت معرفة قيمة الرمز المميّز المستخدَمة لضبطها، يمكنك grep للسمة في دليل /opt/apigee/edge-ui/source:

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

من المفترض أن تظهر لك نتيجة بالشكل التالي:

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

يوضّح المثال التالي قيمة الرمز المميّز session.maxAge لواجهة المستخدم:

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

السلسلة بين علامتَي {T}{/T} هي اسم الرمز المميّز الذي يمكنك ضبطه في ملف .properties الخاص بواجهة المستخدم.

ضبط رمز مميّز تمّت الإشارة إليه حاليًا باعتباره تعليقًا

تمت الإشارة إلى بعض الرموز المميّزة باعتبارها تعليقًا في ملفات إعداد Edge. إذا حاولت ضبط رمز مميّز تمّت الإشارة إلى أسطر رموزه باعتباره تعليقًا في ملف إعدادات التثبيت أو المكوّنات، سيتم تجاهل الإعداد.

لضبط قيمة رمز مميّز تمّت الإشارة إليه باعتباره تعليقًا في ملف إعدادات Edge، استخدِم بنية خاصة بالشكل التالي:

conf/filename+propertyName=propertyValue

على سبيل المثال، لضبط السمة المسماة HTTPClient.proxy.host في "معالج الرسائل"، عليك أولاً grep للسمة لتحديد الرمز المميّز الخاص بها:

grep -ri /opt/apigee/edge-message-processor/ -e "HTTPClient.proxy.host"

يعرض الأمر grep النتائج التي تتضمّن اسم الرمز المميّز. لاحظ كيف تتم الإشارة إلى اسم السمة باعتباره تعليقًا، كما هو موضّح في البادئة #:

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

لضبط قيمة هذه السمة، عدِّل /opt/apigee/customer/application/message-processor.properties، ولكن استخدِم بنية خاصة، كما هو موضّح في المثال التالي:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

في هذه الحالة، يجب إضافة البادئة conf/http.properties+ إلى اسم السمة. هذا هو الموقع الجغرافي واسم ملف الإعداد الذي يحتوي على السمة متبوعة بعلامة "+".

بعد إعادة تشغيل معالج الرسائل، افحص الملف /opt/apigee/edge-message-processor/conf/http.properties:

cat /opt/apigee/edge-message-processor/conf/http.properties

في نهاية الملف، ستظهر لك مجموعة السمات بالشكل التالي:

conf/http.properties:HTTPClient.proxy.host=myhost.name.com