Instala la nueva experiencia Edge (beta)

Edge para nube privada v4.18.05

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

Para probar la nueva experiencia de Edge en una instalación de Edge para la nube privada, debes hacer lo siguiente:

  • Habilita SAML en Edge. La nueva experiencia de Edge solo admite SAML como mecanismo de autenticación.
  • Instala la nueva experiencia de Edge en su propio nodo. No puedes instalarlo en un nodo que contenga otros componentes de Edge.

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

Descripción general de instalación

Para instalar la versión beta de la nueva experiencia de Edge para Edge para la nube privada, debes realizar dos procesos de instalación diferentes:

  • Instala la IU de Edge base, llamada shoehorn, y configúrala para que use SAML para autenticarse con Edge.
  • Instala la nueva experiencia de Edge y configúrala para usar SAML para autenticarte con Edge. Después de instalar la nueva experiencia de Edge, puedes acceder y usarla para trabajar con Edge.

Requisitos previos de la instalación

  • Debes habilitar SAML en Edge antes de instalar la nueva experiencia de Edge. La nueva experiencia de Edge solo admite SAML como mecanismo de autenticación.

    Para obtener información sobre cómo habilitar SAML en Edge, consulta Compatibilidad con SAML en Edge para nube privada.

  • Debes instalar la nueva experiencia de Edge en su propio nodo. No puedes instalarlo en un nodo que contenga otros componentes de Edge. El nodo debe cumplir con los siguientes requisitos:
    • JAVA 1.8
    • 4 GB de RAM
    • 2 núcleos
    • 60 GB de espacio en el disco
    • Primero, debes instalar la versión 4.18.05 de la utilidad apigee-setup en el nodo, como se describe en Instala la utilidad apigee-setup de Edge.

Consideraciones antes de instalar la nueva experiencia de Edge

Como se describió anteriormente en los requisitos previos, la nueva experiencia de Edge requiere que habilites SAML en Edge. Esto significa que la autenticación de usuarios se controla mediante un IdP de SAML, en el que configuras el IdP de SAML para que use direcciones de correo electrónico como ID de usuario. Por lo tanto, todos los usuarios de la nueva experiencia de Edge deben estar registrados en el IdP de SAML.

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

  • Habilita la compatibilidad con SAML en Edge y en la IU clásica y la nueva experiencia de Edge.

    En esta situación, todos los usuarios de la IU clásica y de la nueva experiencia de Edge se registran en el IdP de SAML. Para obtener información sobre cómo agregar usuarios nuevos al IdP de SAML, consulta Registra usuarios nuevos de Edge.

  • Habilita la compatibilidad con SAML en Edge, pero deja habilitada la autenticación básica. La nueva experiencia de Edge usa SAML y la IU clásica sigue usando 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 de OpenLDAP de Edge. Los usuarios de la nueva experiencia de Edge se registran en el IdP de SAML y acceden con SAML.

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

Cambios en la configuración de la instalación desde Edge 4.18.01

La versión 4.18.05 de Edge de la nueva experiencia de Edge contiene los siguientes cambios en el archivo de configuración de la versión 4.18.01 de Edge. Estas propiedades se describen en detalle en la siguiente sección:

Tipo de cambio Propiedades afectadas
Agregado 
# 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
Quitada 
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Reemplazado 
MANAGEMENT_UI_USE_HTTPS
 Se reemplazó por lo siguiente: 
MANAGEMENT_UI_SCHEME

Archivo de configuración de la instalación

El archivo de configuración contiene toda la información necesaria para instalar y configurar la nueva experiencia de Edge. Puedes usar el mismo archivo de configuración para instalar y configurar la IU base y la nueva experiencia de Edge.

A continuación, se muestra un ejemplo de archivo de configuración:

# 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.
# This release does not support TLS.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

# 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.
#

# The first two properties use the same values as the New Edge experience.
SHOEHORN_SCHEME=$MANAGEMENT_UI_SCHEME
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"

Instala la IU de Edge base (shoehorn)

Debes instalar la IU de Edge base, llamada shoehorn, antes de poder instalar la nueva experiencia de Edge.

Para instalar la IU base, haz lo siguiente:

  1. Instala la versión 4.18.05 de la utilidad apigee-setup en el nodo, como se describe en Instala la utilidad apigee-setup de Edge.
  2. Clean Yum: 
    sudo yum clean all
  3. Crea el archivo de configuración como se describió anteriormente y asegúrate de que sea propiedad del usuario "apigee": 
    chown apigee:apigee configFile

    donde configFile es el archivo de configuración descrito anteriormente en Archivo de configuración de la instalación.

  4. Instala la versión de Shoehorn de la IU de Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  5. Configura la IU de Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  6. Habilita SAML en la IU de Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Instala la nueva experiencia de Edge

Después de instalar la IU de Edge base, puedes instalar y configurar la nueva experiencia de Edge.

Para instalar la nueva experiencia de Edge, sigue estos pasos:

  1. Instala la nueva experiencia de Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Cambia al directorio edge-management-ui: 
    cd /opt/apigee/edge-management-ui
  3. Configura la nueva experiencia de Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    donde configFile es el archivo de configuración descrito anteriormente en Archivo de configuración de la instalación.

  4. Habilita SAML en la nueva experiencia de Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Para acceder a la nueva experiencia de Edge, abre la siguiente URL en un navegador: 
    http://newEdgeExperienceIP:3001

    donde newEdgeExperienceIP es la dirección IP del nodo que aloja la nueva experiencia de Edge. Se te solicitarán tus credenciales de SAML. Después de ingresar tus credenciales, aparecerá la nueva experiencia de Edge.

  6. Consulta La nueva experiencia de Edge para la nube privada (beta) para obtener más información, incluidos vínculos a información sobre el uso de la nueva experiencia de Edge.

Desinstala la nueva experiencia de Edge

Para desinstalar la nueva experiencia de Edge, haz lo siguiente:

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

Para desinstalar la IU de Edge base (shoehorn), haz lo siguiente:

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

Para quitar Edge por completo 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 la instalación: 
    sudo rm -rf /opt/apigee