كيفية ضبط Edge

لضبط إعدادات 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 وملفات الخصائص التي يمكنك تعديلها لضبط هذه المكوّنات:

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

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

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

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

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

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

/opt/apigee/token

/opt/apigee/component_name/conf

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

يمكنك تعديل ملفات .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 المكوّن.

على سبيل المثال، إذا كنت تعلم أنّك في إصدار سابق من Edge ضبطت السمة session.maxAge وتريد معرفة قيمة الرمز المميّز المستخدَمة لضبطها، يمكنك استخدام 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 Router/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