كيفية ضبط 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 الخاص بالمكوّن.

على سبيل المثال، إذا كنت تعلم أنّك ضبطت 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

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

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

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