كيفية ضبط Edge

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

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

إذا كنت تريد تعيين خاصية في أحد ملفات التهيئة المكونة هذه، ولكن لا الموجودة أعلاه، يمكنك إنشاؤها في المكان الموضح أعلاه.

بالإضافة إلى ذلك، يجب التأكّد من أنّ ملف الخصائص يملكه "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. للحصول على قائمة كاملة بملفات الخصائص، يُرجى الاطّلاع على موقع ملفات .property.

لإنشاء ملف .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

في نهاية الملف، سترى السمة set (مجموعة الخصائص) على النحو التالي:

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