نحوه پیکربندی 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 را در دایرکتوری /<inst_root>/apigee/customer/application اصلاح کنید. هر مؤلفه فایل .properties خودش را در آن فهرست راهنما دارد. برای مثال، router.properties و management-server.properties.

  1. فایل را در ویرایشگر به‌عنوان هر کاربری ایجاد کنید.
  2. Chown the owner of the file to apigee:apigee or, if you changed the user running the Edge service from the apigee user, chown the file to the user who is running the Edge service.

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

> /<inst_root>/apigee/apigee-service/bin/apigee-service component restart

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

> /<inst_root>/apigee/apigee-service/bin/apigee-service edge-router restart

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

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

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

هشدار: مشتریان Edge فقط می‌توانند فایل‌های .properties را در /<inst_root>/apigee/customer اصلاح کنند. درحالی‌که می‌توانید فایل‌ها را در فهرست‌های مؤلفه و نصب مشاهده کنید، هیچ فایلی را تغییر ندهید.

مالک

دایرکتوری ریشه پیش‌فرض کد

مؤلفه

<inst_root>/apigee/<prefix>-<component>/conf

که در آن /<prefix>-<component> مؤلفه را شناسایی می‌کند، مانند edge-router یا apigee-cassandra.

نصب

<inst_root>/apigee/token

مشتری

<inst_root>/apigee/customer

تعیین ارزش فعلی یک توکن

قبل‌از تنظیم کردن یک توکن در فایل .properties برای مؤلفه، ابتدا می‌توانید مقدار فعلی آن را بااستفاده از فرمان زیر تعیین کنید:

> /<inst_dir>/apigee/apigee-service/bin/apigee-service comp configure -search token

که در آن comp نام مؤلفه است و token توکن موردنظر برای بازرسی است.

این فرمان سلسله‌مراتب فایل‌های .properties را جستجو می‌کند تا مقدار فعلی کد را تعیین کند.

برای مثال، برای بررسی مقدار فعلی کد conf_router_HTTP.request.line.limit برای «رهیاب»: 

> /<inst_dir>/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_router_HTTP.request.line.limit

باید برونداد را در این قالب ببینید:

Found key conf_router_HTTP.request.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

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

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

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

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

  1. فایل /<inst_root>/apigee/customer/application/router.properties را ویرایش کنید تا نشانه conf_router_HTTP.request.line.limit تنظیم شود:

    conf_router_HTTP.request.line.limit=8k
  2. Edge Router را بازراه‌اندازی کنید:

    > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-router restart
  3. مقدار کد را بررسی کنید:

    > /<inst_dir>/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_router_HTTP.request.line.limit

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

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

> cd /<inst_root>/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، فایل /<inst_root>/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 را در پوشه منبع مؤلفه اجرا کنید.

For example, if you know that in a previous release of Edge you set the session.maxAge property and want to know the token value used to set it, then grep for the property in the /<inst_root>/apigee/edge-ui/source directory:

> grep -ri "session.maxAge" /<inst_root>/apigee/edge-ui/source

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

/<inst_root>/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=yhost.name.com