نصب New Edge Experience، نصب New Edge Experience

Edge for Private Cloud نسخه 4.19.01

این سند نحوه نصب تجربه New Edge را برای Edge برای Private Cloud توضیح می‌دهد. تجربه New Edge نسل بعدی رابط کاربری برای Edge است.

برای امتحان تجربه New Edge در نصب Edge برای Private Cloud، باید:

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

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

نمای کلی نصب

برای نصب تجربه New Edge برای Edge برای Private Cloud، دو فرآیند نصب مختلف را انجام می دهید:

  • رابط کاربری پایه Edge را که به نام shoehorn نامیده می شود، نصب کنید و رابط کاربری Edge پایه را برای استفاده از SAML برای احراز هویت با Edge پیکربندی کنید.
  • تجربه New Edge را نصب کنید و تجربه New Edge را برای استفاده از SAML برای احراز هویت با Edge پیکربندی کنید. پس از نصب تجربه New Edge، می توانید وارد شوید و از آن برای کار با Edge استفاده کنید.

پیش نیازهای نصب

  • قبل از نصب تجربه New Edge باید SAML را در Edge فعال کنید. تجربه New Edge تنها از SAML به عنوان مکانیزم احراز هویت پشتیبانی می‌کند.

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

  • تجربه New Edge فقط از TLS نسخه 1.2 پشتیبانی می کند. از آنجایی که شما از طریق TLS به SAML IDP متصل می شوید، بنابراین SAML IDP شما باید از TLS نسخه 1.2 پشتیبانی کند.

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

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

    • جاوا 1.8
    • 4 گیگابایت رم
    • 2 هسته ای
    • 60 گیگابایت فضای دیسک
    • ابتدا باید نسخه 4.19.01 ابزار apigee-setup را همانطور که در Install the Edge apigee-setup utility توضیح داده شد، روی گره نصب کنید.
    • پورت 3001 باید باز باشد. این پورت پیش‌فرض است که برای درخواست‌های تجربه New Edge استفاده می‌شود. اگر پورت را با استفاده از ویژگی های توضیح داده شده در زیر تغییر می دهید، مطمئن شوید که پورت باز است.

ملاحظات قبل از نصب تجربه New Edge

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

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

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

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

  • پشتیبانی SAML را در Edge فعال کنید، اما تأیید اولیه را فعال کنید. تجربه New Edge از SAML استفاده می کند و رابط کاربری کلاسیک هنوز از احراز هویت اولیه استفاده می کند.

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

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

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

از تغییرات زیر در روند نصب از نسخه بتا تجربه New Edge آگاه باشید.

پیکربندی نصب نسبت به Edge 4.18.05 تغییر می کند

نسخه Edge 4.19.01 تجربه New Edge شامل تغییرات زیر در فایل پیکربندی نسخه Edge 4.18.05 است:

تغییر نوع خواص تحت تأثیر
حذف شد
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

این ویژگی دارای مقدار از پیش تعریف شده 0.5 (30 دقیقه) است و قابل تغییر نیست.

اضافه شد اکنون می توانید از ویژگی ها برای فعال کردن TLS در تجربه New Edge استفاده کنید. برای اطلاعات بیشتر به پیکربندی TLS برای تجربه New Edge مراجعه کنید.

پیکربندی نصب نسبت به Edge 4.18.01 تغییر می کند

نسخه Edge 4.19.01 تجربه New Edge شامل تغییرات زیر در فایل پیکربندی نسخه Edge 4.18.01 است:

تغییر نوع خواص تحت تأثیر
اضافه شد
# Shoehorn 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

فایل پیکربندی نصب

فایل پیکربندی شامل تمام اطلاعات لازم برای نصب و پیکربندی تجربه New Edge است. می‌توانید از همان فایل پیکربندی برای نصب و پیکربندی رابط کاربری پایه و تجربه New Edge استفاده کنید.

نمونه فایل پیکربندی در زیر نشان داده شده است: 

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

# IP of the New Edge experience node.
IP2=22.222.222.222

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

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

#
# New Edge experience configuration.
#

# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the New Edge experience.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
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=CHANGE_TO_YOUR_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 New Edge experience.
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y
MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret111

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the New Edge experience.
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 New Edge experience.
#

# 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 SAML on the classic Edge 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

# Information about Edge SSO module.
# 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 Edge SSO module.
# If Edge 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 Edge SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

#
# Required SMTP information.
#

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

رابط کاربری Edge پایه (شاخ کفش) را نصب کنید

قبل از اینکه بتوانید تجربه New Edge را نصب کنید، باید رابط کاربری پایه Edge، به نام shoehorn را نصب کنید.

برای نصب رابط کاربری پایه:

  1. همانطور که در Install the Edge apigee-setup utility توضیح داده شد، نسخه 4.19.01 ابزار apigee-setup را روی گره نصب کنید.
  2. یام تمیز: 
    sudo yum clean all
  3. فایل پیکربندی را همانطور که در بالا توضیح داده شد ایجاد کنید و مطمئن شوید که متعلق به کاربر "apigee" است: 
    chown apigee:apigee configFile

    که در آن configFile فایل پیکربندی است که در فایل پیکربندی نصب در بالا توضیح داده شد.

  4. مقدار ویژگی MANAGEMENT_UI_SSO_CSRF_SECRET در فایل پیکربندی را به راز CSRF خود تغییر دهید.
  5. نسخه Shoehorn رابط کاربری Edge را نصب کنید: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. رابط کاربری Edge را پیکربندی کنید: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. SAML را در رابط کاربری Edge فعال کنید: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

تجربه New Edge را نصب کنید

پس از نصب رابط کاربری پایه Edge، می‌توانید تجربه New Edge را نصب و پیکربندی کنید.

برای نصب تجربه New Edge:

  1. تجربه New Edge را نصب کنید: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. تغییر به دایرکتوری edge-management-ui : 
    cd /opt/apigee/edge-management-ui
  3. پیکربندی تجربه New Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    که در آن configFile فایل پیکربندی است که در فایل پیکربندی نصب در بالا توضیح داده شد.

  4. SAML را در تجربه New Edge فعال کنید: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. با باز کردن URL زیر در مرورگر، وارد تجربه New Edge شوید: 
    http://newEdgeExperienceIP:3001

    جایی که newEdgeExperienceIP آدرس IP گره ای است که تجربه New Edge را میزبانی می کند. از شما خواسته می شود اعتبار SAML خود را دریافت کنید. پس از وارد کردن اعتبار، تجربه New Edge ظاهر می شود.

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

تجربه New Edge را حذف نصب کنید

برای حذف نصب تجربه New Edge:

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

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

/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