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

Edge for Private Cloud 4.19.01

В этом документе описывается, как установить New Edge experience для Edge for the Private Cloud. Новый интерфейс Edge – это интерфейс Edge следующего поколения.

Чтобы попробовать New Edge в установке Edge для частного облака, вы должны:

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

Подробнее о новом интерфейсе Edge для Private Cloud…

Общие сведения об установке

Чтобы установить новый интерфейс Edge для Edge for Private Cloud, необходимо выполнить два разных процесса установки:

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

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

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

    Информацию о том, как включить SAML в Edge, можно найти в статье Поддержка SAML в Edge для частного облака.

  • Новая версия Edge поддерживает только TLS 1.2. Поскольку вы подключаетесь к поставщику идентификационной информации SAML по протоколу TLS, он должен поддерживать TLS версии 1.2.

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

    Узел должен соответствовать следующим требованиям:

    • JAVA 1.8
    • 4 ГБ ОЗУ;
    • 2-ядерный
    • 60 ГБ места на диске;
    • Сначала необходимо установить утилиту apigee-setup версии 4.19.01 на узел, как описано в разделе Установка утилиты apigee-setup для Edge.
    • Порт 3001 должен быть открыт. Этот порт используется по умолчанию для запросов к New Edge. Если вы измените порт с помощью описанных ниже свойств, убедитесь, что он открыт.

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

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

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

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

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

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

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

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

Изменения в конфигурации установки по сравнению с предыдущими выпусками

Обратите внимание на следующие изменения в процедуре установки по сравнению с бета-версией нового интерфейса Edge.

Изменения в конфигурации установки по сравнению с Edge 4.18.05

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

Пример файла конфигурации приведен ниже.

# 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 (shoehorn)

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

Чтобы установить базовый интерфейс, выполните следующие действия:

  1. Установите на узел утилиту apigee-setup версии 4.19.01, как описано в разделе Установка утилиты apigee-setup для Edge.
  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 UI: 
    /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

Установите новый браузер 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. Настройте 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, открыв в браузере следующий URL: 
    http://newEdgeExperienceIP:3001

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

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

Как удалить новую версию 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