نحوه پیکربندی Edge

Edge for Private Cloud نسخه ۴.۱۸.۰۵

برای پیکربندی Edge پس‌از نصب، از ترکیبی از فایل‌های .properties و ابزارهای کمکی Edge استفاده می‌کنید. برای مثال، برای پیکربندی TLS/SSL در Edge UI، فایل‌های .properties را برای تنظیم ویژگی‌های لازم ویرایش می‌کنید. تغییرات در .properties فایل‌ها مستلزم این است که مؤلفه Edge تحت‌تأثیر قرارگرفته را بازراه‌اندازی کنید.

Apigee به تکنیک ویرایش فایل‌های .properties به‌عنوان کد با پیکربندی اشاره دارد. در اصل، کد با پیکربندی ابزاری برای جستجوی کلید/مقدار براساس تنظیمات در فایل‌های .properties است. در کد با پیکربندی، کلیدها به‌عنوان نشان شناخته می‌شوند. بنابراین، برای پیکربندی Edge، باید توکن‌ها را در فایل‌های .properties تنظیم کنید.

کد با پیکربندی به مؤلفه‌های Edge اجازه می‌دهد مقادیر پیش‌فرضی را تنظیم کنند که با محصول ارسال می‌شود، به تیم نصب اجازه می‌دهد آن تنظیمات را براساس توپولوژی نصب لغو کند، و سپس به مشتریان اجازه می‌دهد هر ویژگی‌ای را که انتخاب می‌کنند لغو کنند.

اگر آن را به‌عنوان یک سلسله‌مراتب درنظر بگیرید، تنظیمات به‌صورت زیر مرتب می‌شوند و تنظیمات مشتری بالاترین اولویت را برای لغو هرگونه تنظیمات از تیم نصب‌کننده یا Apigee دارد:

  1. مشتری
  2. نصب‌کننده
  3. Apigee

نحوه استفاده از فایل‌های properties.

به‌عنوان مشتری، فقط می‌توانید فایل‌های .properties را در فهرست راهنمای /opt/apigee/customer/application اصلاح کنید. هر مؤلفه فایل .properties خودش را در آن فهرست راهنما دارد. برای مثال، router.properties و management-server.properties.

برای مثال، برای ایجاد فایل .properties:

  1. فایل را در ویرایشگر به‌عنوان هر کاربری ایجاد کنید.
  2. از chown برای تغییر مالک فایل به «apigee:apigee» استفاده کنید یا اگر کاربری را که سرویس Edge را اجرا می‌کند از کاربر «apigee» تغییر دادید، فایل را به کاربری که سرویس Edge را اجرا می‌کند chown کنید.

برای تنظیم ویژگی برای مؤلفه، فایل .properties مربوطه را ویرایش کنید تا نشانه‌ای تنظیم شود، سپس مؤلفه را بازراه‌اندازی کنید:

/opt/apigee/apigee-service/bin/apigee-service component restart

برای مثال، پس‌از ویرایش router.properties، «رهیاب» را بازراه‌اندازی کنید:

/opt/apigee/apigee-service/bin/apigee-service edge-router restart

وقتی Edge را ارتقا می‌دهید، فایل‌های .properties در دایرکتوری /opt/apigee/customer/application خوانده می‌شوند. یعنی ارتقا دادن باعث می‌شود هر ویژگی‌ای که برای مؤلفه تنظیم کرده‌اید حفظ شود.

مکان فایل‌های properties.

سه دایرکتوری سطح بالا برای فایل‌های .properties برای مؤلفه‌های Edge وجود دارد: نصب، مالک، و مشتریان. مکان‌های پیش‌فرض در جدول زیر نشان داده شده است:

مالک دایرکتوری ریشه پیش‌فرض توکن
مؤلفه 
/opt/apigee/component_name/conf

که در آن component_name عنصر را مشخص می‌کند. مقادیر ممکن عبارتند از:

  • ‫apigee-cassandra (Cassandra)
  • ‫apigee-openldap (OpenLDAP)
  • ‫apigee-postgresql (پایگاه داده PostgreSQL)
  • ‫apigee-qpidd (Qpidd)
  • ‫apigee-sso (Edge SSO)
  • ‫apigee-zookeeper (ZooKeeper)
  • ‫edge-management-server (سرور مدیریت)
  • ‫edge-management-ui (میانای کاربر جدید Edge)
  • ‫edge-message-processor (پردازشگر پیام)
  • ‫edge-postgres-server (سرور Postgres)
  • ‫edge-qpid-server (سرور Qpid)
  • ‫edge-router (رهیاب لبه)
  • ‫edge-ui (میانای کاربر کلاسیک)
نصب 
/opt/apigee/token
مشتری 
/opt/apigee/customer

تعیین مقدار فعلی یک توکن

قبل‌از تنظیم کردن یک کد در فایل .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

تنظیم کردن توکن‌ها در فایل‌های properties.

برای لغو کردن مقدار یک کد:

  1. فایل .properties را برای مؤلفه ویرایش کنید تا مقدار کد را تنظیم کنید. اگر فایل وجود ندارد، آن را ایجاد کنید.
  2. عنصر را بازراه‌اندازی کنید.
  3. مقدار کد را بررسی کنید.

برای مثال، برای تنظیم حد خط درخواست برای Edge Router:

  1. فایل /opt/apigee/customer/application/router.properties را ویرایش کنید تا نشان conf_http_HTTPRequest.line.limit را تنظیم کنید: 
    conf_http_HTTPRequest.line.limit=8k
  2. بازراه‌اندازی Edge Router: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router restart
  3. مقدار کد را بررسی کنید: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

تنظیم کردن نشانه‌ای که چند مقدار می‌گیرد

برخی‌از توکن‌ها فهرستی از مقادیر جداشده با کاما را می‌پذیرند. برای مثال، نشان conf_security_rbac.restricted.resources فهرستی از URI-های محدودشده را می‌گیرد تا فقط سرپرست سیستم بتواند آن‌ها را فراخوانی کند. برای دیدن مقدار conf_security_rbac.restricted.resources:

cd /opt/apigee/edge-management-server
grep -ri "conf_security_rbac.restricted.resources" *

خروجی حاوی موارد زیر است:

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

برای تنظیم کردن نشانه‌ای که فهرستی از مقادیر را می‌گیرد، هر مقدار جدید را به مقدار فعلی نشانه در فایل .properties اضافه کنید. بنابراین، برای افزودن URI /myuri/* به conf_security_rbac.restricted.resources، فایل /opt/apigee/customer/application/management-server.properties را به‌صورت نشان‌داده‌شده در زیر ویرایش کنید:

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

پیدا کردن کد

در بیشتر موارد، توکن‌هایی که باید تنظیم کنید در این راهنما مشخص شده‌اند. بااین‌حال، اگر لازم است نشان استفاده‌شده برای لغو ویژگی را تعیین کنید، grep را در پوشه source مؤلفه انجام دهید.

برای مثال، اگر می‌دانید که در نسخه قبلی Edge، ویژگی session.maxAge را تنظیم کرده‌اید و می‌خواهید مقدار توکن استفاده‌شده برای تنظیم آن را بدانید، سپس grep را برای ویژگی در فهرست راهنمای /opt/apigee/edge-ui/source:

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

باید نتیجه‌ای به این شکل ببینید:

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

رشته بین برچسب‌های {T}{/T} همان کدی است که در فایل .properties تنظیم کرده‌اید.

تنظیم کردن نشانه‌ای که درحال‌حاضر به‌صورت نظر درآمده است

برخی‌از توکن‌ها در فایل‌های پیکربندی Edge به‌صورت نظر درآمده‌اند. اگر بخواهید نشانه‌ای را تنظیم کنید که به‌صورت نظر درآمده است، تنظیم نادیده گرفته می‌شود.

برای تنظیم نشانه‌ای که به‌صورت نظر درآمده است، از نحو خاصی به‌شکل زیر استفاده می‌کنید:

conf/file.extension+propertyName=propertyValue

برای مثال، می‌خواهید ویژگی‌ای با نام HTTPClient.proxy.host را در «پردازشگر پیام» تنظیم کنید. سپس برای تعیین کردن توکن دارایی، grep را برای آن انجام می‌دهید:

cd /opt/apigee/edge-message-processor
grep -ri "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