كيفية ضبط Edge

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

تشير Apigee إلى أسلوب تعديل ملفات .properties في صورة رمز برمجي مع config (يُختصر أحيانًا باسم 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 وملفات الخصائص التي يمكنك تعديلها لإعداد هذه المكوّنات:

المكوِّن اسم المكوّن ملف إعداد قابل للتعديل
من الفئة العمرية 31-45 apigee-cassandra /opt/apigee/customer/application/cassandra.properties
الدخول الموحّد (SSO) لخدمة Apigee 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
واجهة المستخدم الكلاسيكية (لا تؤثر على واجهة مستخدم Edge الجديدة) edge-ui /opt/apigee/customer/application/ui.properties
واجهة مستخدم Edge (واجهة مستخدم Edge الجديدة فقط، ولا تؤثر على واجهة المستخدم الكلاسيكية) 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 على "10 آلاف":
    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

ضبط الخادم الوكيل لإعادة التوجيه للطلبات من قسم "إرسال الطلبات" في واجهة مستخدم التتبُّع

يوضِّح هذا القسم كيفية ضبط الخادم الوكيل لإعادة التوجيه للطلبات من قسم "إرسال الطلبات" من واجهة مستخدم التتبُّع باستخدام بيانات اعتماد الخادم الوكيل الاختيارية. لضبط الخادم الوكيل لإعادة التوجيه:

  1. عدِّل /opt/apigee/customer/application/ui.properties وتأكَّد من أنّ الملف ملك apigee:apigee.
  2. أضِف عمليات التجاوز التالية (تغيير القيم إلى إعدادات الخادم الوكيل المحدّدة):
    conf_application_http.proxyhost=proxy.example.com
    conf_application_http.proxyport=8080
    conf_application_http.proxyuser=apigee
    conf_application_http.proxypassword=Apigee123!
  3. حفظ واجهة المستخدم الكلاسيكية وإعادة تشغيلها

إضافة تنسيق سجلّ مخصَّص في Apigee Router/Nginx

في بعض الحالات، كان عليك إمّا تغيير تنسيق سجلّ Apigee Router/Nginx التلقائي أو إضافة متغيّرات. لتحديث الإعدادات التلقائية لجهاز توجيه Apigee/تنسيق سجلّ Nginx:

  1. أنشئ ملف router.properties، إذا لم يكن متوفّرًا، بالمسار الموضّح أدناه:
    /opt/apigee/customer/application/router.properties
  2. أضِف المحتوى التالي إلى ملف router.properties لإنشاء إعداد log_format جديد باسم router_new:
    conf_load_balancing_load.balancing.driver.nginx.global.http.parameters.template.extra=log_format router_new 'time_iso8601\\\\thostname\\\\tremote_addr:remote_port\\\\t'\\\\n\\n 'upstream_addr\\\\trequest_time\\\\t-\\\\t-\\\\t'\\\\n\\n 'status\\\\tupstream_status\\\\trequest_length\\\\t'\\\\n\\n 'body_bytes_sent\\\\t'\\\\n\\n 'request\\\\tupstream_http_x_apigee_message_id\\\\t'\\\\n\\n 'http_user_agent\\\\thost\\thostname-pid-connection-connection_requests\\\\tmy_nginx_var_xff\\t'\\\\n\\n 'upstream_http_x_apigee_fault_flag\\\\tupstream_http_x_apigee_fault_source\\\\tupstream_http_x_apigee_fault_code\\\\t'\\\\n\\n 'upstream_http_x_apigee_fault_policy\\tupstream_http_x_apigee_fault_flow\\tupstream_http_x_apigee_fault_revision\\t'\\\\n\\n 'upstream_http_x_apigee_dp_color\\\\tmy_x_apigee_target_latency\\\\t'\\\\n\\n 'upstream_http_x_apigee_proxy\\\\tupstream_http_x_apigee_proxy_basepath\\\\t'\\\\n\\n 'self_region\\\\tself_pod\\\\tself_color\\\\tssl_protocol\\\\tssl_client_verify\\\\tssl_session_id\\\\tssl_session_reused\\\\tupstream_pod\\\\tupstream_region';\\\\n\\n\n
    conf_load_balancing_load.balancing.driver.nginx.access.log={conf_load_balancing_load.balancing.driver.nginx.log.dir}/{org}~{env}.{port}_access_log router_new

    عدِّل المتغيرات في الأوامر أعلاه حسب الحاجة. ويمكنك العثور على قيم الضبط التلقائية لـ log_format في الملف أدناه:

    /opt/apigee/edge-router/conf/load_balancing.properties

    يتم عرض قائمة بمتغيرات Nginx على http://nginx.org/en/docs/varindex.html.

  3. أعِد تشغيل جهاز التوجيه لتطبيق الإعدادات الجديدة:
    apigee-service edge-router restart
  4. تأكَّد مما إذا تمت إضافة إعدادات log_format الجديدة (router_new) إلى ملف /opt/nginx/conf.d/0-default.conf:
        
    cat /opt/nginx/conf.d/0-default.conf | grep router_new -A 10
    .
  5. أرسِل بعض طلبات البيانات من واجهة برمجة التطبيقات إلى خادم وكيل لواجهة برمجة التطبيقات وتحقَّق من تنسيق السجلّ الجديد في الملف.
    /opt/apigee/var/log/edge-router/nginx/${org}~${env}.${port}_access_log file