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

در این سند نحوه نصب رابط کاربری Edge برای Apigee Edge برای Private Cloud توضیح داده شده است. رابط کاربری Edge نسل بعدی رابط کاربری برای Edge است.

پیش نیازها

برای امتحان کردن رابط کاربری جدید Edge در نصب Apigee Edge برای Private Cloud، باید:

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

  گره رابط کاربری Edge باید شرایط زیر را برآورده کند:

  • جاوا 1.8
  • 4 گیگابایت رم
  • 2 هسته ای
  • 60 گیگابایت فضای دیسک
  • ابتدا باید نسخه 4.50.00 ابزار apigee-setup را همانطور که در Install the Edge apigee-setup utility توضیح داده شد، روی گره نصب کنید.
  • پورت 3001 باید باز باشد. این پورت پیش‌فرض است که برای درخواست‌ها به رابط کاربری Edge استفاده می‌شود. اگر پورت را با استفاده از ویژگی های توضیح داده شده در فایل پیکربندی جدید UE تغییر می دهید، مطمئن شوید که پورت باز است.
• یک IDP خارجی را در Edge فعال کنید. رابط کاربری Edge از SAML یا LDAP به عنوان مکانیزم احراز هویت پشتیبانی می کند.
• (فقط SAML IDP) Edge UIonly از TLS نسخه 1.2 پشتیبانی می کند. از آنجایی که شما از طریق TLS به SAML IDP متصل می شوید، اگر از SAML استفاده می کنید، بنابراین IDP شما باید از TLS نسخه 1.2 پشتیبانی کند.

برای اطلاعات بیشتر در مورد رابط کاربری Edge، به رابط کاربری جدید Edge برای Private Cloud مراجعه کنید.

نمای کلی نصب

در سطح بالا، فرآیند نصب رابط کاربری Edge برای Apigee Edge برای Private Cloud به شرح زیر است:

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

هنگامی که در گره جدید اجرا می شود، ابزار apigee-setup :

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

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

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

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

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

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

• پشتیبانی IDP خارجی را در Edge فعال کنید، اما احراز هویت اولیه را فعال بگذارید. رابط کاربری Edge از IDP استفاده می کند و رابط کاربری کلاسیک هنوز از احراز هویت اولیه استفاده می کند.

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

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

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

از تغییرات زیر در مراحل نصب از نسخه های بتا رابط کاربری 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 UI

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

# 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.
SHOEHORN_SCHEME=http
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. همانطور که در Install the Edge apigee-setup utility توضیح داده شده است، نسخه 4.50.00 ابزار apigee-setup را روی گره نصب کنید.
4. با اجرای دستور زیر تمام اطلاعات کش شده را با Yum پاک کنید:

   sudo yum clean all

5. فایل پیکربندی را همانطور که در فایل پیکربندی New Edge UI توضیح داده شده است ایجاد کنید و مطمئن شوید که متعلق به کاربر "apigee" است:

   chown apigee:apigee configFile

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

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

     برای اطلاعات بیشتر، به بررسی اجمالی احراز هویت IDPهای خارجی مراجعه کنید.

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

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

   ابزار apigee-setup رابط کاربری کلاسیک را نصب می کند. در بالای رابط کاربری کلاسیک، نصب کننده سپس رابط کاربری Edge را نصب می کند.

8. با باز کردن URL زیر در مرورگر وارد رابط کاربری Edge شوید:

   http://new_edge_UI_IP:3001

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

   Edge از شما می‌خواهد اعتبار IDP خارجی خود را دریافت کنید.

9. مدارک خود را وارد کنید

   رابط کاربری جدید Edge ظاهر می شود. برای اطلاعات در مورد استفاده از رابط کاربری Edge، به رابط کاربری جدید Edge برای Private Cloud مراجعه کنید.

   اگر رابط کاربری Edge نمایش داده نمی شود، مطمئن شوید که پورت 3001 برای اتصالات خارجی باز است.

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

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

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

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

برای حذف نصب رابط کاربری کلاسیک پایه ( شاخ کفش ):

/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. تمام RPM های Apigee را حذف کنید:

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

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

   sudo rm -rf /opt/apigee