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

В этом документе рассказывается, как установить интерфейс Edge для Apigee Edge Private Cloud. Интерфейс Edge – это интерфейс Edge нового поколения.

Требования

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

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

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

  • JAVA 1.8
  • 4 ГБ ОЗУ.
  • 2 ядра
  • 60 ГБ на диске
  • Сначала установите на узле утилиту apigee-setup версии 4.53.01, как описано в разделе Установка утилиты apigee-setup Edge.
  • Порт 3001 должен быть открыт. Это порт по умолчанию, используемый для запросов к интерфейсу Edge. Если вы измените порт, используя свойства, описанные в разделе Новый файл конфигурации UE, убедитесь, что порт открыт.
• Включите внешний IDP в Edge. В интерфейсе Edge поддерживается аутентификация с помощью SAML или LDAP.
• (Только для поставщика идентификационной информации SAML) Интерфейс Edge поддерживает только TLS версии 1.2. Поскольку вы подключаетесь к поставщику идентификационной информации SAML по протоколу TLS, если вы используете SAML, ваш поставщик идентификационной информации должен поддерживать TLS версии 1.2.

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

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

Процесс установки интерфейса Edge для Apigee Edge для частного облака можно условно разделить на следующие этапы:

• Как добавить в кластер новый узел
• Войдите в новый узел
• Скачайте утилиту apigee-setup
• Создайте файл конфигурации и измените его настройки.
• Как запустить утилиту apigee-setup
• Войдите в аккаунт и проверьте новый интерфейс

При выполнении на новом узле утилита apigee-setup:

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

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

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

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

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

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

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

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

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

Если сервер управления и сервер нового интерфейса Edge находятся за балансировщиком нагрузки с разгрузкой TLS, убедитесь, что конфигурация отражает свойства, выделенные в разделе Настройка интерфейса Edge, когда TLS завершается на балансировщике нагрузки.

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

Обратите внимание на следующие изменения в процедуре установки по сравнению с бета-версиями интерфейса 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

В следующем файле конфигурации содержится вся информация, необходимая для установки и настройки нового интерфейса Edge. Вы можете использовать один и тот же файл конфигурации для установки и настройки как интерфейса Shoehorn/Classic, так и интерфейса Edge.

# 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 since new edge UI makes internal calls to 
# shoehorn UI hosted on the same node.
SHOEHORN_SCHEME=http
# Should be set to the IP of the New Edge UI server OR the DNS name of the New Edge UI server.
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. Установите утилиту apigee-setup версии 4.53.01 на узле, как описано в разделе Установка утилиты Edge apigee-setup.
4. Чтобы очистить всю кешированную информацию с помощью Yum, выполните следующую команду:

   sudo yum clean all

5. Создайте файл конфигурации, как описано в разделе Новый файл конфигурации интерфейса Edge, и убедитесь, что его владельцем является пользователь apigee:

   chown apigee:apigee configFile

   Внесите в файл конфигурации следующие изменения:

   • Измените значение свойства MANAGEMENT_UI_SSO_CSRF_SECRET в файле конфигурации на секретный ключ CSRF.
   • Настройте Edge так, чтобы использовать один из следующих вариантов (для нового интерфейса Edge требуется внешний поставщик идентификационной информации):
     • SAML
     • LDAP

     Подробнее об аутентификации с помощью внешних поставщиков идентификационной информации…

6. Настройте внешний поставщик идентификационной информации для пользователей, которым вы хотите предоставить доступ к интерфейсу Edge. Подробнее о том, как зарегистрировать новых пользователей Edge…
7. На новом узле выполните следующую команду:

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

   Утилита apigee-setup устанавливает классический интерфейс. Поверх классического интерфейса установщик устанавливает интерфейс Edge.

8. Войдите в интерфейс Edge, открыв в браузере следующий URL:

   http://new_edge_UI_IP:3001

   где new_edge_UI_IP – IP-адрес узла, на котором размещен новый интерфейс Edge.

   Edge запросит учетные данные внешнего поставщика идентификационной информации.

9. Введите учетные данные.

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

   Если интерфейс Edge не отображается, убедитесь, что порт 3001 открыт для внешних подключений.

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

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

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

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

Чтобы удалить базовый классический интерфейс (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