درحال نصب «تجربه جدید Edge» (نسخه بتا)

Edge for Private Cloud نسخه ۴.۱۸.۰۵

این سند نحوه نصب نسخه Beta از تجربه New Edge برای Edge for the Private Cloud را شرح می‌دهد. تجربه New Edge نسل بعدی واسط کاربر برای Edge است.

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

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

برای اطلاعات بیشتر درباره تجربه New Edge، به تجربه New Edge برای 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 را در گره خودش نصب کنید. نمی‌توانید آن را روی گره‌ای نصب کنید که حاوی مؤلفه‌های دیگر Edge است. گره باید شرایط زیر را داشته باشد:
    • JAVA 1.8
    • ‫۴ گیگابایت RAM
    • ‫۲ هسته‌ای
    • ‫۶۰ گیگابایت فضای دیسک
    • ابتدا باید نسخه ۴.۱۸.۰۵ ابزار کمکی apigee-setup را در گره نصب کنید، همان‌طور که در نصب ابزار کمکی apigee-setup در Edge شرح داده شده است.

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

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

میانای کاربری کلاسیک Edge، میانای کاربری پیش‌فرضی که با 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 وارد شود تا زمانی که آن کاربر را به SAML IDP اضافه کنید، همان‌طور که در ثبت کاربران جدید Edge توضیح داده شده است.

تغییرات پیکربندی نصب از Edge 4.18.01

نسخه Edge 4.18.05 از تجربه 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.
# This release does not support TLS.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

# 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.
#

# The first two properties use the same values as the New Edge experience.
SHOEHORN_SCHEME=$MANAGEMENT_UI_SCHEME
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 پایه (shoehorn)

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

برای نصب کردن میانای کاربر پایه:

  1. نسخه ۴.۱۸.۰۵ ابزار apigee-setup را طبق توضیحات نصب ابزار Edge apigee-setup در گره نصب کنید.
  2. پاک کردن Yum: 
    sudo yum clean all
  3. فایل پیکربندی را همان‌طور که در بالا توضیح داده شده است ایجاد کنید و مطمئن شوید که متعلق به کاربر «apigee» است: 
    chown apigee:apigee configFile

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

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

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

پس‌از نصب Edge UI پایه، می‌توانید تجربه 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. با باز کردن نشانی وب زیر در مرورگر، به سیستم تجربه New Edge وارد شوید: 
    http://newEdgeExperienceIP:3001

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

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

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

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

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

برای حذف نصب کردن واسط کاربر Edge پایه (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. همه RPMهای Apigee را بردارید: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. دایرکتوری ریشه نصب را بردارید: 
    sudo rm -rf /opt/apigee