Установка нового интерфейса Edge

Edge для частного облака v4.19.01

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

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

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

Дополнительные сведения о возможностях New Edge см. в разделе Новые возможности Edge для частного облака .

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

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

  • Установите базовый пользовательский интерфейс 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 для частного облака .

  • Интерфейс New Edge поддерживает только TLS v1.2. Поскольку вы подключаетесь к IDP SAML через TLS, ваш IDP SAML должен поддерживать TLS v1.2.

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

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

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

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

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

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

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

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

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

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

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

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

Обратите внимание на следующие изменения в процедуре установки бета-версии 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. Установите на узел версию 4.19.01 утилиты apigee-setup , как описано в разделе Установка утилиты Edge 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. Войдите в систему New Edge, открыв в браузере следующий URL-адрес: 
    http://newEdgeExperienceIP:3001

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

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

Удалите интерфейс 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