Как установить новую версию Edge (бета)

Edge for Private Cloud v4.18.01

В этом документе рассказывается, как установить бета-версию нового интерфейса Edge для частного облака. Новый интерфейс Edge – это следующее поколение интерфейса Edge.

Чтобы попробовать новый интерфейс Edge в установке Edge для частного облака, необходимо:

  • Включите SAML в Edge. В новом интерфейсе Edge в качестве механизма аутентификации поддерживается только SAML.
  • Установите New Edge на отдельном узле. Его нельзя установить на узле, который содержит другие компоненты Edge.

Подробнее о новом интерфейсе Edge для частного облака…

Обзор установки

Чтобы установить бета-версию нового интерфейса Edge для частного облака, выполните два разных процесса установки:

  • Установите базовый интерфейс Edge, который называется shoehorn, и настройте его для аутентификации в Edge с помощью SAML.
  • Установите новый интерфейс Edge и настройте его для аутентификации в Edge с помощью SAML. После установки New Edge вы можете войти в систему и использовать его для работы с Edge.

Требования к установке

  • Прежде чем устанавливать New Edge, необходимо включить SAML в Edge. В новом интерфейсе Edge в качестве механизма аутентификации поддерживается только SAML.

    Примечание. В непроизводственной среде можно оставить базовую аутентификацию включенной в Edge, чтобы пользователи классического интерфейса и Edge API могли по-прежнему использовать ее.

    Информацию о том, как включить SAML в Edge, можно найти в статье Поддержка SAML в Edge для частного облака.
  • Новый интерфейс Edge необходимо установить на отдельном узле. Его нельзя установить на узле, который содержит другие компоненты Edge. Узел должен соответствовать следующим требованиям:
    • JAVA 1.8
    • 4 ГБ ОЗУ.
    • 2 ядра
    • 60 ГБ на диске
    • Сначала необходимо установить утилиту apigee-setup версии 4.18.01 на узле, как описано в разделе Установка утилиты Edge apigee-setup.

Что нужно учесть перед установкой нового интерфейса Edge

Как описано в разделе "Требования" выше, для нового интерфейса Edge необходимо включить SAML в Edge. Это означает, что аутентификация пользователей контролируется поставщиком идентификационной информации SAML, в котором вы настраиваете использование адресов электронной почты в качестве идентификаторов пользователей. Поэтому все пользователи New Edge должны быть зарегистрированы в поставщике идентификационной информации на основе SAML.

Классический интерфейс Edge, который по умолчанию устанавливается вместе с Edge для частного облака, не требует SAML. Он может использовать SAML или базовую аутентификацию. Это означает, что вы можете:

  • Включите поддержку SAML в Edge и в классическом интерфейсе, и в новом интерфейсе Edge.

    В этом сценарии все пользователи классического интерфейса и нового интерфейса Edge зарегистрированы в поставщике идентификационной информации SAML. Информацию о том, как добавить новых пользователей в стороннего поставщика идентификационной информации SAML, можно найти в статье Как зарегистрировать новых пользователей Edge.
  • Включите поддержку SAML в Edge, но оставьте базовую аутентификацию включенной. В новом интерфейсе Edge используется SAML, а в классическом – базовая аутентификация.

    В этом сценарии все пользователи классического интерфейса входят в систему с помощью учетных данных для базовой аутентификации, которые хранятся в базе данных Edge OpenLDAP. Пользователи нового интерфейса Edge регистрируются у поставщика идентификационной информации SAML и входят в систему с помощью SAML.

    Однако пользователь классического интерфейса не сможет войти в новый интерфейс Edge, пока вы не добавите его в поставщика идентификационной информации SAML, как описано в разделе Регистрация новых пользователей Edge.

Файл конфигурации установки

Файл конфигурации содержит всю информацию, необходимую для установки и настройки New Edge. Вы можете использовать один и тот же файл конфигурации для установки и настройки как базового интерфейса, так и нового интерфейса 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

# URLs for the different UIs.
# URL of classic Edge UI.
ROUTES_CLASSICUI="http://$IP1:9000"
# URL of New Edge experience.
ROUTES_SHOEHORN="http://$IP2:9000"

# New Edge experience configuration.
# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Access port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_APP_ENV=OPDK
MANAGEMENT_UI_IP=$IP2
# Disable TLS on the New Edge experience.
# This release does not support TLS.
MANAGEMENT_UI_USE_HTTPS=n

# 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

# 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

# Edge SSO configuration.
# Some settings are for the classic UI, 
# but are still required to configure the New Edge experience.
# Enable SSO.
EDGEUI_SSO_ENABLED=y

# Information about Classic UI
EDGEUI_PUBLIC_URIS=http://$IP1:9000
# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS
# 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".
# MANAGEMENT_UI_SKIP_VERIFY=y
SSO_PUBLIC_URL_SCHEME=http
# 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)

Прежде чем устанавливать новый интерфейс Edge, необходимо установить базовый интерфейс Edge под названием shoehorn.

Чтобы установить базовый интерфейс:

  1. Установите утилиту apigee-setup версии 4.18.01 на узле, как описано в разделе Установка утилиты apigee-setup Edge.
  2. Чистый Yum: 
    > sudo yum clean all
  3. Создайте файл конфигурации, как описано выше, и убедитесь, что его владельцем является пользователь apigee: 
    > chown apigee:apigee configFile

    где configFile – это файл конфигурации, описанный выше в разделе Файл конфигурации установки.

  4. Установите версию Shoehorn для интерфейса Edge: 
    > /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: 
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Как установить новый интерфейс Edge

После установки базового интерфейса Edge можно установить и настроить новый интерфейс Edge.

Чтобы установить новый интерфейс Edge:

  1. Чтобы установить новый интерфейс Edge: 
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Перейдите в каталог edge-management-ui: 
    > cd /opt/apigee/edge-management-ui
  3. Настройте новый интерфейс Edge: 
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    где configFile – это файл конфигурации, описанный выше в разделе Файл конфигурации установки.

  4. Чтобы включить SAML в новом интерфейсе Edge, выполните следующие действия: 
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Войдите в New Edge, открыв в браузере следующий URL: 
    http://newEdgeExperienceIP:3001

    где newEdgeExperienceIP – IP-адрес узла, на котором размещен новый интерфейс Edge. Вам будет предложено ввести учетные данные SAML. После ввода учетных данных откроется новый интерфейс Edge.

  6. Дополнительную информацию, в том числе ссылки на статьи об использовании нового интерфейса Edge, можно найти в разделе Новый интерфейс Edge для частного облака (бета-версия).

Как удалить новый интерфейс Edge

Чтобы удалить новый интерфейс 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-|baas)")
  4. Удалите корневой каталог установки: 
    > sudo rm -rf /opt/apigee