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

Edge for Private Cloud نسخه 4.17.01

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

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

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

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

1. مشتری
2. نصب کننده
3. اپیگی

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

به عنوان یک مشتری، فقط می توانید فایل های .properties را در پوشه /opt/apigee/customer/application تغییر دهید. هر جزء دارای فایل .properties خود در آن دایرکتوری است. به عنوان مثال، router.properties و management-server.properties .

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

برای تنظیم یک ویژگی برای یک کامپوننت، فایل .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 وجود دارد: مالک نصب و مشتریان. مکان های پیش فرض در جدول زیر نشان داده شده است:

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

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

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

> /opt/apigee/apigee-service/bin/apigee-service comp configure -search token

که در آن comp نام کامپوننت است و توکن نشانه ای برای بازرسی است.

این دستور سلسله مراتب فایل های .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 راه اندازی مجدد
3. ارزش توکن را بررسی کنید:
   
   > /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

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

برخی از نشانه ها لیستی از مقادیر جدا شده با کاما را می گیرند. برای مثال، توکن conf_security_rbac.restricted.resources فهرستی از URI های محدود شده را می گیرد تا فقط sysadmin بتواند آنها را فراخوانی کند. برای دیدن مقدار 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 را در پوشه منبع کامپوننت انجام دهید.

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

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