Instala la nueva IU de Edge

En este documento, se describe cómo instalar la IU de Edge para Apigee Edge para una nube privada. La IU de Edge es la nueva generación de IU para Edge.

Requisitos previos

Si deseas probar la nueva IU de Edge en una instalación de Apigee Edge para la nube privada, debes seguir estos pasos:

  • Instala la IU de Edge en su propio nodo. No puedes instalarla en un nodo que contenga otros componentes de Edge, incluido el nodo en el que reside la IU clásica existente. Si lo haces, los usuarios no podrán acceder a la IU clásica.

    El nodo de la IU de Edge debe cumplir con los siguientes requisitos:

    • JAVA 1.8
    • 4 GBytes de RAM
    • 2 núcleos
    • 60 GB de espacio en disco
    • Primero, debes instalar la versión 4.50.00 de la utilidad apigee-setup en el nodo, como se describe en Cómo instalar la utilidad apigee-setup de Edge.
    • El puerto 3001 debe estar abierto. Este es el puerto predeterminado que se usa para las solicitudes a la IU de Edge. Si cambias el puerto mediante las propiedades que se describen en el archivo de configuración de UE nuevo, asegúrate de que el puerto esté abierto.
  • Habilita un IDP externo en Edge. La IU de Edge admite SAML o LDAP como mecanismo de autenticación.
  • (Solo IdP de SAML) La IU de Edge solo admite TLS v1.2. Debido a que te conectas al IdP de SAML a través de TLS, si usas SAML, tu IdP debe admitir TLS v1.2.

Para obtener más información sobre la IU de Edge, consulta La nueva IU de Edge para la nube privada.

Descripción general de instalación

En términos generales, el proceso para instalar la IU de Edge para Apigee Edge para la nube privada es el siguiente:

  • Agrega un nodo nuevo a tu clúster
  • Accede al nodo nuevo
  • Descarga la utilidad apigee-setup
  • Crea un archivo de configuración y modifícalo con tu configuración
  • Ejecuta la utilidad apigee-setup
  • Accede y prueba la nueva UE

Cuando se ejecuta en el nodo nuevo, la utilidad apigee-setup hace lo siguiente:

  • Instala la IU clásica básica, llamada shoehorn, y configura la IU clásica para usar un IdP externo para autenticarse con Edge.
  • Instala la nueva IU de Edge y la configura para usar tu IdP externo a fin de autenticar con Edge.

Consideraciones antes de instalar la nueva IU de Edge

Como se describió anteriormente en los requisitos previos, la IU de Edge requiere que habilites una IDP externa en Edge. Eso significa que la autenticación del usuario está controlada por la IDP, en la que la configuras para que use direcciones de correo electrónico como el ID de usuario. Por lo tanto, todos los usuarios de la IU de Edge deben estar registrados en la IDP.

La IU clásica, la IU predeterminada que instalaste con Apigee Edge para una nube privada, no requiere un IdP externo. Puede usar una IdP o una autenticación básica. Esto significa que puedes hacer lo siguiente:

  • Habilita la compatibilidad con IdP externos en Edge y en la IU clásica y la IU de Edge.

    En esta situación, todos los usuarios de la IU clásica y la IU de Edge están registrados en la IDP. Para obtener información sobre cómo agregar usuarios nuevos al IdP, consulta Registra usuarios de Edge nuevos.

  • Habilita la compatibilidad con la IDP externa en Edge, pero deja habilitada la autenticación básica. La IU de Edge usa la IDP y la IU clásica aún usa la autenticación básica.

    En esta situación, todos los usuarios de la IU clásica acceden con credenciales de autenticación básica, en las que sus credenciales se almacenan en la base de datos OpenLDAP de Edge. Los usuarios de la IU de Edge están registrados en la IdP y acceden con SAML o LDAP.

    Sin embargo, un usuario de la IU clásica no puede acceder a la IU de Edge hasta que lo hayas agregado al IdP, como se describe en Registra usuarios de Edge nuevos.

Cambios en la configuración de instalación de versiones anteriores

Ten en cuenta los siguientes cambios en el procedimiento de instalación de las versiones beta de la IU de Edge.

Nuevo archivo de configuración de la IU de Edge

El siguiente archivo de configuración contiene toda la información necesaria para instalar y configurar la nueva IU de Edge. Puedes usar el mismo archivo de configuración para instalar y configurar la IU clásica y de shoehorn, y la de 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"

Instala la IU de Edge

Después de crear y modificar el archivo de configuración, puedes instalar la nueva IU de Edge en ese nodo nuevo.

Para instalar la IU de Edge, haz lo siguiente:

  1. Agrega un nodo nuevo a tu clúster.
  2. Accede al nodo nuevo como administrador.
  3. Instala la versión 4.50.00 de la utilidad apigee-setup en el nodo, como se describe en Instala la utilidad apigee-setup de Edge.
  4. Ejecuta el siguiente comando para limpiar toda la información almacenada en caché con Yum: 
    sudo yum clean all
  5. Crea el archivo de configuración como se describe en Nuevo archivo de configuración de la IU de Edge y asegúrate de que sea propiedad del usuario "apigee": 
    chown apigee:apigee configFile

    Asegúrate de realizar las siguientes ediciones en el archivo de configuración:

    • Cambia el valor de la propiedad MANAGEMENT_UI_SSO_CSRF_SECRET en el archivo de configuración por tu secreto CSRF.
    • Configura Edge para usar una de las siguientes opciones (la nueva IU de Edge requiere un IdP externo):
      • SAML
      • LDAP

      Para obtener más información, consulta Descripción general de la autenticación de IdP externos.

  6. Configura tu IdP externo con los usuarios que deseas que tengan acceso a la IU de Edge. Para obtener más información, consulta Cómo registrar usuarios nuevos de Edge.
  7. En el nodo nuevo, ejecuta el siguiente comando: 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    La utilidad apigee-setup instala la IU clásica. Además de la IU clásica, el instalador instala la IU de Edge.

  8. Para acceder a la IU de Edge, abre la siguiente URL en un navegador: 
    http://new_edge_UI_IP:3001

    En el ejemplo anterior, new_edge_UI_IP es la dirección IP del nodo que aloja la nueva IU de Edge.

    Edge te solicitará tus credenciales de IdP externo.

  9. Ingresa tus credenciales.

    Aparecerá la nueva IU de Edge. Para obtener información sobre el uso de la IU de Edge, consulta La nueva IU de Edge para la nube privada.

    Si no se muestra la IU de Edge, asegúrate de que el puerto 3001 esté abierto para las conexiones externas.

Cómo desinstalar la IU nueva

Para desinstalar la IU nueva de su nodo, debes desinstalar la IU nueva de Edge y la IU clásica básica (ajuste forzoso) que se instaló en el nodo durante el proceso de instalación de la IU.

Para desinstalar la nueva IU de Edge, sigue estos pasos:

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

Para desinstalar la IU clásica base (forzar):

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

Para quitar todos los componentes de Edge del nodo, haz lo siguiente:

  1. Detén todos los servicios de Edge que se ejecutan en la máquina: 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Borra la caché de yum: 
    sudo yum clean all
  3. Quita todos los RPM de Apigee: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Quita el directorio raíz de instalación: 
    sudo rm -rf /opt/apigee