В этом документе описывается, как установить пользовательский интерфейс Edge для Apigee Edge для частного облака. Пользовательский интерфейс Edge — это новое поколение пользовательского интерфейса Edge.
Предварительные условия
Чтобы опробовать новый пользовательский интерфейс Edge в установке Apigee Edge для частного облака, вам необходимо:
- Установите пользовательский интерфейс Edge на отдельный узел. Вы не можете установить его на узел, содержащий другие компоненты Edge, включая узел, на котором находится существующий классический пользовательский интерфейс. В противном случае пользователи не смогут войти в классический интерфейс.
Узел Edge UI должен соответствовать следующим требованиям:
- ЯВА 1.8
- 4 ГБ ОЗУ
- 2-ядерный
- 60 ГБ дискового пространства
- Сначала необходимо установить на узле версию 4.51.00 утилиты
apigee-setup
, как описано в разделе Установка утилиты Edge apigee-setup . - Порт 3001 должен быть открыт. Это порт по умолчанию, используемый для запросов к пользовательскому интерфейсу Edge. Если вы меняете порт с помощью свойств, описанных в файле конфигурации нового UE , убедитесь, что порт открыт.
- Включите внешнего IDP на Edge. Пользовательский интерфейс Edge поддерживает SAML или LDAP в качестве механизма аутентификации.
- (Только SAML IDP) Edge UI поддерживает только TLS v1.2. Поскольку вы подключаетесь к IDP SAML через TLS, если вы используете SAML, ваш IDP должен поддерживать TLS v1.2.
Дополнительные сведения о пользовательском интерфейсе Edge см. в разделе Новый интерфейс Edge для частного облака .
Обзор установки
На высоком уровне процесс установки пользовательского интерфейса Edge для Apigee Edge для частного облака выглядит следующим образом:
- Добавьте новый узел в свой кластер
- Войдите в новый узел
- Загрузите утилиту
apigee-setup
- Создайте файл конфигурации и измените его своими настройками.
- Запустите утилиту
apigee-setup
- Войдите в систему и протестируйте новое UE.
При запуске на новом узле утилита apigee-setup
:
- Устанавливает базовый классический пользовательский интерфейс , называемый Shoehorn , и настраивает классический пользовательский интерфейс для использования внешнего IDP для аутентификации в Edge.
- Устанавливает новый пользовательский интерфейс Edge и настраивает пользовательский интерфейс Edge для использования внешнего IDP для аутентификации в Edge.
Что следует учитывать перед установкой нового пользовательского интерфейса Edge
Как описано выше в разделе «Предварительные требования», для пользовательского интерфейса Edge необходимо включить внешнего IDP в Edge. Это означает, что аутентификация пользователя контролируется IDP, где вы настраиваете его на использование адресов электронной почты в качестве идентификатора пользователя. Поэтому все пользователи Edge UI должны быть зарегистрированы в IDP.
Классический пользовательский интерфейс, пользовательский интерфейс по умолчанию, который вы установили с Apigee Edge для частного облака, не требует внешнего IDP. Он может использовать либо IDP, либо базовую аутентификацию. Это означает, что вы можете:
- Включите поддержку внешнего IDP в Edge, а также в классическом пользовательском интерфейсе и пользовательском интерфейсе Edge.
В этом сценарии все пользователи классического пользовательского интерфейса и пользовательского интерфейса Edge регистрируются в IDP. Информацию о добавлении новых пользователей в IDP см. в разделе Регистрация новых пользователей Edge .
- Включите поддержку внешнего IDP на Edge, но оставьте базовую аутентификацию включенной. Пользовательский интерфейс Edge использует IDP, а классический пользовательский интерфейс по-прежнему использует базовую проверку подлинности.
В этом сценарии все пользователи классического пользовательского интерфейса входят в систему с учетными данными базовой проверки подлинности, где их учетные данные хранятся в базе данных Edge OpenLDAP. Пользователи Edge UI регистрируются в IDP и входят в систему с помощью SAML или LDAP.
Однако пользователь классического пользовательского интерфейса не может войти в пользовательский интерфейс Edge, пока вы не добавите этого пользователя в IDP, как описано в разделе Регистрация новых пользователей Edge .
Изменения конфигурации установки по сравнению с предыдущими выпусками
Обратите внимание на следующие изменения в процедуре установки бета-версий пользовательского интерфейса Edge.
Новый файл конфигурации пользовательского интерфейса Edge
Следующий файл конфигурации содержит всю информацию, необходимую для установки и настройки нового пользовательского интерфейса Edge. Вы можете использовать один и тот же файл конфигурации для установки и настройки как рожка для обуви/классического пользовательского интерфейса, так и пользовательского интерфейса 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. 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 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:
- Добавьте новый узел в свой кластер.
- Войдите в новый узел как администратор.
- Установите на узел версию 4.51.00 утилиты
apigee-setup
, как описано в разделе Установка утилиты Edge apigee-setup . - Очистите всю кэшированную информацию с помощью Yum, выполнив следующую команду:
sudo yum clean all
- Создайте файл конфигурации, как описано в файле конфигурации пользовательского интерфейса New Edge , и убедитесь, что он принадлежит пользователю «apigee»:
chown apigee:apigee configFile
Обязательно внесите следующие изменения в файл конфигурации:
- Измените значение свойства
MANAGEMENT_UI_SSO_CSRF_SECRET
в файле конфигурации на свой секрет CSRF. - Настройте Edge для использования одного из следующих действий (для нового пользовательского интерфейса Edge требуется внешний IDP):
- SAML
- ЛДАП
Дополнительную информацию см. в разделе Обзор аутентификации внешних IDP .
- Измените значение свойства
- Настройте внешний IDP для пользователей, которым вы хотите предоставить доступ к пользовательскому интерфейсу Edge. Дополнительную информацию см. в разделе Регистрация новых пользователей Edge .
- На новом узле выполните следующую команду:
/opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile
Утилита
apigee-setup
устанавливает классический пользовательский интерфейс. Затем поверх классического пользовательского интерфейса установщик устанавливает интерфейс Edge. - Войдите в пользовательский интерфейс Edge, открыв в браузере следующий URL-адрес:
http://new_edge_UI_IP:3001
Где new_edge_UI_IP — это IP-адрес узла, на котором размещен новый интерфейс Edge.
Edge запросит у вас учетные данные внешнего IDP.
- Введите свои учетные данные.
Появится новый пользовательский интерфейс Edge. Информацию об использовании пользовательского интерфейса Edge см. в разделе Новый интерфейс Edge для частного облака .
Если пользовательский интерфейс Edge не отображается, убедитесь, что порт 3001 открыт для внешних подключений.
Удалить новый пользовательский интерфейс
Чтобы удалить новый пользовательский интерфейс с его узла, необходимо удалить как новый пользовательский интерфейс Edge, так и базовый классический пользовательский интерфейс ( рожок для обуви ), который был установлен на узле во время процесса установки пользовательского интерфейса.
Чтобы удалить новый интерфейс Edge:
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui uninstall
Чтобы удалить базовый классический интерфейс ( рожок для обуви ):
/opt/apigee/apigee-service/bin/apigee-service edge-ui uninstall
Чтобы удалить все компоненты Edge из узла:
- Остановите все службы Edge, работающие на компьютере:
/opt/apigee/apigee-service/bin/apigee-all stop
- Очистите кеш yum:
sudo yum clean all
- Удалите все RPM Apigee:
sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
- Удалите корневой каталог установки:
sudo rm -rf /opt/apigee