نصب واسط کاربر جدید Edge

این سند نحوه نصب کردن «میانای کاربر Edge» را برای Apigee Edge for Private Cloud شرح می‌دهد. «واسط کاربر Edge» نسل بعدی واسط کاربر برای Edge است.

پیش‌نیازها

برای امتحان کردن «واسط کاربر Edge» جدید در نصب Apigee Edge for Private Cloud، باید:

• «واسط کاربر Edge» را در گره خودش نصب کنید. نمی‌توانید آن را روی گرهی که شامل دیگر عناصر Edge است نصب کنید، ازجمله گرهی که «میانای کاربر کلاسیک» موجود در آن قرار دارد. انجام این کار باعث می‌شود کاربران نتوانند به سیستم «واسط کاربر کلاسیک» وارد شوند.

  گره «میانای کاربری Edge» باید الزامات زیر را برآورده کند:

  • JAVA 1.8
  • ‫۴ گیگابایت حافظه دسترسی تصادفی
  • ‫۲ هسته‌ای
  • ‫۶۰ گیگابایت فضای دیسک
  • ابتدا باید نسخه 4.53.01 ابزار apigee-setup را در گره نصب کنید، همان‌طور که در نصب ابزار Edge apigee-setup توضیح داده شده است.
  • درگاه ۳۰۰۱ باید باز باشد. این درگاه پیش‌فرضی است که برای درخواست‌های مربوط به «واسط کاربر Edge» استفاده می‌شود. اگر بااستفاده از دارایی‌های شرح‌داده‌شده در فایل پیکربندی UE جدید درگاه را تغییر می‌دهید، مطمئن شوید که درگاه باز باشد.
• IDP خارجی را در Edge فعال کنید. «میانای کاربر Edge» از SAML یا LDAP به‌عنوان سازوکار اصالت‌سنجی پشتیبانی می‌کند.
• (فقط SAML IDP) «میانای کاربری Edge» فقط از TLS v1.2 پشتیبانی می‌کند. ازآنجایی‌که ازطریق «امنیت لایه انتقال» به SAML IDP متصل می‌شوید، اگر از SAML استفاده می‌کنید، IDP شما باید از TLS v1.2 پشتیبانی کند.

برای اطلاعات بیشتر درباره «واسط کاربر Edge»، به واسط کاربر جدید Edge برای «ابر خصوصی» مراجعه کنید.

نمای کلی نصب

در سطح بالا، فرایند نصب «میانای کاربر Edge» برای Apigee Edge for Private Cloud به‌صورت زیر است:

• افزودن گره جدید به خوشه
• ورود به سیستم گره جدید
• بارگیری ابزار apigee-setup
• فایل پیکربندی ایجاد کنید و آن را با تنظیمات خودتان اصلاح کنید
• اجرای ابزار apigee-setup
• وارد سیستم شوید و UE جدید را آزمایش کنید

وقتی در گره جدید اجرا می‌شود، ابزار apigee-setup:

• «میانای کاربر کلاسیک» پایه، که shoehorn نامیده می‌شود، را نصب می‌کند و «میانای کاربر کلاسیک» را پیکربندی می‌کند تا از IDP خارجی برای اصالت‌سنجی با Edge استفاده کند.
• واسط کاربر جدید Edge را نصب می‌کند، و واسط کاربر Edge را پیکربندی می‌کند تا از IDP خارجی شما برای اصالت‌سنجی با Edge استفاده کند.

ملاحظات قبل‌از نصب میانای کاربری جدید Edge

همان‌طور که در پیش‌نیازهای بالا توضیح داده شد، واسط کاربر Edge نیازمند این است که یک IDP خارجی را در Edge فعال کنید. این یعنی احراز هویت کاربر توسط IDP کنترل می‌شود، جایی که آن را پیکربندی می‌کنید تا از نشانی‌های ایمیل به‌عنوان شناسه کاربر استفاده کند. بنابراین همه کاربران «میانای کاربری Edge» باید در «ارائه‌دهنده هویت» ثبت شده باشند.

«میانای کاربر کلاسیک»، میانای کاربر پیش‌فرضی که با Apigee Edge برای «ابر خصوصی» نصب کرده‌اید، به IDP خارجی نیاز ندارد. می‌تواند از «ارائه‌دهنده هویت» یا «اصالت‌سنجی پایه» استفاده کند. یعنی می‌توانید:

• پشتیبانی از IDP خارجی را در Edge و در هر دو «واسط کاربر کلاسیک» و «واسط کاربر Edge» فعال کنید.

  در این سناریو، همه کاربران «واسط کاربر کلاسیک» و «واسط کاربر Edge» در IDP ثبت شده‌اند. برای اطلاعات مربوط به افزودن کاربران جدید به IDP، به ثبت کاربران جدید Edge مراجعه کنید.

• پشتیبانی از IDP خارجی را در Edge فعال کنید، اما «اصالت‌سنجی پایه» را فعال نگه دارید. «واسط کاربر Edge» از IDP استفاده می‌کند و «واسط کاربر کلاسیک» همچنان از «اصالت‌سنجی پایه» استفاده می‌کند.

  در این سناریو، همه کاربران «میانای کاربری کلاسیک» با اطلاعات اعتباری «اصالت‌سنجی پایه» به سیستم وارد می‌شوند، درحالی‌که اطلاعات اعتباری آن‌ها در پایگاه داده Edge SymasLDAP ذخیره می‌شود. کاربران Edge UI در IDP ثبت شده‌اند و بااستفاده از SAML یا LDAP به سیستم وارد می‌شوند.

  بااین‌حال، کاربر «واسط کاربر کلاسیک» نمی‌تواند تا زمانی که آن کاربر را به IDP اضافه نکرده‌اید به سیستم «واسط کاربر Edge» وارد شود، همان‌طور که در ثبت کاربران جدید Edge توضیح داده شده است.

اگر سرور مدیریت و سرور «واسط کاربر New Edge» شما پشت ترازکننده بار با برون‌سپاری «امنیت لایه انتقال» قرار دارند که در ترازکننده بار انجام می‌شود، مطمئن شوید پیکربندی ویژگی‌های برجسته را در پیکربندی «واسط کاربر Edge» وقتی «امنیت لایه انتقال» در ترازکننده بار پایان می‌یابد منعکس می‌کند.

تغییرات پیکربندی نصب از نسخه‌های پخش قبلی

از تغییرات زیر در روند نصب از نسخه‌های بتای «میانای کاربر Edge» آگاه باشید.

MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

# Shoehorn/Classic UI configurations.
SHOEHORN_SCHEME
SHOEHORN_IP
SHOEHORN_PORT

# Classic UI configurations.
CLASSIC_UI_SCHEME
CLASSIC_UI_IP
CLASSIC_UI_PORT

# Information about Edge SSO module.
MANAGEMENT_UI_SKIP_VERIFY

ROUTES_SHOEHORN
ROUTES_CLASSICUI

MANAGEMENT_UI_USE_HTTPS

MANAGEMENT_UI_SCHEME

فایل پیکربندی واسط کاربر جدید Edge

فایل پیکربندی زیر حاوی همه اطلاعات لازم برای نصب و پیکربندی واسط کاربر جدید Edge است. می‌توانید از همان فایل پیکربندی برای نصب و پیکربندی هر دو میانای کاربر shoehorn/Classic و میانای کاربر Edge استفاده کنید.

# IP of the Edge Management Server.
# This node also hosts the Apigee SSO module and the current, or Classic UI.
IP1=management_server_IP

# IP of the Edge UI node.
IP2=edge_UI_server_IP

# Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=your_password    # If omitted, you are prompted for it.

# Edge Management Server information.
APIGEE_PORT_HTTP_MS=8080
MSIP=$IP1
MS_SCHEME=http

#
# Edge UI configuration.
#

# Enable the Edge UI.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the Edge UI.
# The management UI port must be open for requests to the Edge UI
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Set to 'OPDK' to specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=http

# Location of Edge UI.
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=YOUR_CSRF_SECRET
# Duration of CSRF token.
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
# Defaults to 8760 hours, or 365 days.
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=8760

## SSO configuration for the Edge UI.
MANAGEMENT_UI_SSO_ENABLED=y

# Only required if MANAGEMENT_UI_SSO_ENABLED is 'y'
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y

MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=your_client_sso_secret

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the Edge UI since new edge UI makes internal calls to 
# shoehorn UI hosted on the same node.
SHOEHORN_SCHEME=http
# Should be set to the IP of the New Edge UI server OR the DNS name of the New Edge UI server.
SHOEHORN_IP=$MANAGEMENT_UI_IP
SHOEHORN_PORT=9000

#
# Edge Classic UI configuration.
# Some settings are for the Classic UI, but are still required to configure the Edge UI.
#

# These settings assume that Classic UI is installed on the Management Server.
CLASSIC_UI_IP=$MSIP
CLASSIC_UI_PORT=9000
CLASSIC_UI_SCHEME=http
EDGEUI_PUBLIC_URIS=$CLASSIC_UI_SCHEME://$CLASSIC_UI_IP:$CLASSIC_UI_PORT

# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS

# Enable SSO
EDGEUI_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso.
# The default client name is 'edgeui'.
# Apigee recommends that you use the same settings as you used
# when enabling your IDP on the Classic UI.
EDGEUI_SSO_CLIENT_NAME=edgeui
# Oauth client password using uppercase, lowercase, number, and special chars.
EDGEUI_SSO_CLIENT_SECRET=ssoClient123
# If set, existing EDGEUI client will deleted and new one will be created.
EDGEUI_SSO_CLIENT_OVERWRITE=y

# Apigee SSO Component configuration
# Externally accessible IP or DNS of Edge SSO module.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on the Apigee SSO module.
# If Apigee SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# SSO admin credentials as set when you installed Apigee SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=your_sso_admin_secret

#
##      SSO Configuration (define external IDP)           #
#
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                        #
#  - LDAP Direct Binding configuration properties         #
#  - LDAP Indirect Binding configuration properties       #

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect)

## SMTP Configuration (required)
#
SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.com
SMTPUSER=your@email.com
SMTPPASSWORD=your_email_password
SMTPSSL=y
SMTPPORT=465      # If no SSL, use a different port, such as 25.
SMTPMAILFROM="My Company myco@company.com"

نصب کردن میانای کاربر Edge

پس‌از ایجاد و اصلاح فایل پیکربندی، می‌توانید «واسط کاربر Edge» جدید را در آن گره جدید نصب کنید.

برای نصب کردن «میانای کاربر Edge»:

1. گره جدیدی به خوشه‌تان اضافه کنید.
2. به‌عنوان سرپرست به سیستم گره جدید وارد شوید.
3. نسخه 4.53.01 ابزار apigee-setup را در گره نصب کنید، همان‌طور که در نصب ابزار Edge apigee-setup توضیح داده شده است.
4. با اجرای فرمان زیر، همه اطلاعات ذخیره‌شده در حافظه نهان را با Yum پاک کنید:

   sudo yum clean all

5. فایل پیکربندی را همان‌طور که در فایل پیکربندی جدید رابط کاربری Edge توضیح داده شده است بسازید و مطمئن شوید که کاربر «apigee» مالک آن است:

   chown apigee:apigee configFile

   مطمئن شوید که ویرایش‌های زیر را در فایل پیکربندی انجام دهید:

   • مقدار دارایی MANAGEMENT_UI_SSO_CSRF_SECRET را در فایل پیکربندی به راز CSRF خود تغییر دهید.
   • ‫Edge را پیکربندی کنید تا از یکی از موارد زیر استفاده کند (واسط کاربر جدید Edge به IDP خارجی نیاز دارد):
     • SAML
     • LDAP

     برای اطلاعات بیشتر، مروری بر اصالت‌سنجی ارائه‌دهندگان هویت خارجی را ببینید.

6. «ارائه‌دهنده هویت خارجی» خود را با کاربرانی که می‌خواهید به «واسط کاربر Edge» دسترسی داشته باشند پیکربندی کنید. برای اطلاعات بیشتر، ثبت کاربران جدید Edge را ببینید.
7. در گره جدید، فرمان زیر را اجرا کنید:

   /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

   ابزار apigee-setup «واسط کاربر کلاسیک» را نصب می‌کند. علاوه‌بر «واسط کاربر کلاسیک»، نصب‌کننده «واسط کاربر Edge» را نیز نصب می‌کند.

8. با باز کردن نشانی وب زیر در مرورگر، به «میانای کاربری Edge» وارد شوید:

   http://new_edge_UI_IP:3001

   که در آن new_edge_UI_IP نشانی IP گرهی است که میزبان واسط کاربر جدید Edge است.

   ‫Edge از شما اطلاعات اعتباری IDP خارجی‌تان را درخواست می‌کند.

9. اعتبارنامه‌هایتان را وارد کنید.

   واسط کاربر جدید Edge ظاهر می‌شود. برای کسب اطلاعات درباره استفاده از «واسط کاربر Edge»، به واسط کاربر جدید Edge برای «ابر خصوصی» مراجعه کنید.

   اگر «میانای کاربر Edge» نمایش داده نمی‌شود، مطمئن شوید که درگاه ۳۰۰۱ برای اتصال‌های خارجی باز باشد.

حذف نصب واسط کاربر جدید

برای حذف نصب واسط کاربر جدید از گره آن، باید هم واسط کاربر جدید Edge و هم واسط کاربر پایه Classic (shoehorn) را که درطول فرایند نصب واسط کاربر روی گره نصب شده است حذف نصب کنید.

برای حذف نصب میانای کاربر جدید Edge:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui uninstall

برای حذف نصب میانای کاربر کلاسیک پایه (shoehorn):

/opt/apigee/apigee-service/bin/apigee-service edge-ui uninstall

برای برداشتن همه عناصر Edge از گره:

1. همه سرویس‌های Edge را که در ماشین اجرا می‌شوند متوقف کنید:

   /opt/apigee/apigee-service/bin/apigee-all stop

2. پاک کردن حافظه نهان yum:

   sudo yum clean all

3. همه Apigee RPM را بردارید:

   sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")

4. دایرکتوری ریشه نصب را بردارید:

   sudo rm -rf /opt/apigee