Migra las propiedades de la IU clásica a la IU de Edge nueva

En Apigee Edge para nube privada 4.54.00, se quita la IU clásica (el componente edge-ui) y ya no está disponible. La IU de Edge nueva (el componente edge-management-ui) es la única IU de Edge para nube privada.

No puedes usar edge-ui en Edge para nube privada 4.54.00. Si personalizaste la IU clásica configurando propiedades en /opt/apigee/customer/application/ui.properties, la nueva IU de Edge no leerá ese archivo. Después de actualizar a la versión 4.54.00, debes establecer las propiedades equivalentes en /opt/apigee/customer/application/management-ui.properties.

En esta página, se enumeran las propiedades de la IU clásica documentadas para ui.properties, las propiedades equivalentes para la IU de New Edge y las propiedades de la IU clásica que no se admiten en la IU de New Edge.

La nueva IU de Edge usa el mismo mecanismo de código con configuración (CwC) que otros componentes de Edge. Para obtener más información, consulta Cómo configurar Edge.

Compara las configuraciones de la IU clásica y la nueva IU de Edge

La nueva IU de Edge reemplaza el componente de IU clásica, el archivo de propiedades, el nombre del servicio, el puerto predeterminado y el formato del certificado TLS. Revisa la siguiente tabla para actualizar tus secuencias de comandos de automatización, reglas de firewall y archivos TLS antes de migrar tus propiedades:

Configuración IU clásica (4.53.01 y versiones anteriores) Nueva IU de Edge (4.54.00)
Nombre del componente edge-ui edge-management-ui
Archivo de propiedades /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
Comando de reinicio apigee-service edge-ui restart apigee-service edge-management-ui restart
Puerto predeterminado 9000 3001
Configuración de TLS Archivo de almacén de claves de Java (JKS) Archivos de certificado y clave PEM Consulta Configura TLS para la IU de Edge nueva.

Establece propiedades para la nueva IU de Edge

Establece las propiedades de configuración de la IU de New Edge en /opt/apigee/customer/application/management-ui.properties y reinicia el servicio edge-management-ui para que los cambios se apliquen.

Para establecer una propiedad para la IU de Edge nueva, sigue estos pasos:

  1. Abre el archivo management-ui.properties en un editor. Si el archivo no existe, créalo:
    vi /opt/apigee/customer/application/management-ui.properties
    
  2. Establece la propiedad. Por ejemplo:
    conf_uebe_disableGeoMap=true
  3. Guarda los cambios.
  4. Asegúrate de que el archivo sea propiedad del usuario apigee:
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
    
  5. Reinicia la nueva IU de Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
    

Sigue estas reglas de formato cuando configures las propiedades de la IU de Edge nueva:

  • Los nombres de las propiedades distinguen mayúsculas de minúsculas. Por ejemplo, conf_uebe_disableGeoMap es válido, pero conf_uebe_disablegeomap no lo es.
  • Encierra los valores de cadena entre comillas dobles, por ejemplo, conf_uebe_branding_companyNameShort="My Company".
  • No encierres entre comillas los valores booleanos (true o false) ni los valores numéricos. Si un valor booleano o numérico está entre comillas, la IU de Edge nueva no se inicia.

Para verificar el valor actual de una propiedad, usa la opción -search. Por ejemplo:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

Asigna las propiedades de la IU clásica a la nueva IU de Edge

En las siguientes tablas, se asigna cada propiedad de la IU clásica admitida en ui.properties a su propiedad equivalente de la IU de Edge nueva en management-ui.properties. En la columna Predeterminado, se muestra el valor predeterminado en la IU de Edge nueva.

Configura las propiedades de los componentes

Asigna las marcas de función de la IU clásica a las propiedades de conf_uebe_* correspondientes en management-ui.properties:

Propiedad de la IU clásica Nueva propiedad de la IU de Edge Predeterminado Notas
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false Establécelo en true para ocultar los mapas geográficos. En la IU clásica de Edge para nube privada, los mapas geográficos estaban inhabilitados de forma predeterminada. Si no habilitaste la agregación geográfica, establece esta propiedad en true. Consulta Cómo habilitar la agregación geográfica y los mapas geográficos.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false Establécelo en true para ocultar el vínculo Restablecer contraseña en la página de acceso.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true Establécelo en false para permitir informes personalizados para un período de más de 14 días.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false Establece en true para permitir que la herramienta Trace envíe solicitudes a direcciones IP locales o internas.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false Se establece en true para permitir que se importen especificaciones de OpenAPI desde direcciones IP locales o internas.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false Establece en true para permitir que los archivos WSDL se importen desde direcciones IP locales o internas.

Configura las propiedades de sesión y TLS

Asigna el tiempo de espera de la sesión de la IU clásica y las propiedades de TLS a sus equivalentes de la IU de Edge nueva en management-ui.properties:

Propiedad de la IU clásica Nueva propiedad de la IU de Edge Predeterminado Notas
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (horas) Es el tiempo después del cual vence una sesión de usuario tras el acceso. Especifica una cantidad de horas (por ejemplo, 12 o 0.5) o una duración con la unidad h (horas) o m (minutos) (por ejemplo, 24h o 90m). Los valores 12 y 12h son equivalentes. No se admite la unidad d (días). Por ejemplo, reemplaza 1d por 24h. Si el valor no es válido, se usa el valor predeterminado de 12 horas y no se informa ningún error. Se aplica a las sesiones que usan autenticación básica.
conf_application_session.secure No se requiere ninguna acción No aplicable La IU de Edge nueva establece la marca Secure en las cookies de sesión automáticamente cuando se habilita TLS (conf_uebe_usehttps=true) o cuando la finalización de TLS se produce en un balanceador de cargas (conf_uebe_tlsoffload=true).
conf/application.conf+trustxforwarded conf_uebe_usehttps=true y conf_uebe_tlsoffload=true false Establece ambas propiedades cuando la finalización de TLS se produzca en un balanceador de cargas. El balanceador de cargas debe reenviar solicitudes a la nueva IU de Edge a través de HTTP y establecer el encabezado X-Forwarded-Proto. El comando configure-ssl establece estas propiedades cuando MANAGEMENT_UI_SCHEME=https y MANAGEMENT_UI_TLS_OFFLOAD=y. Consulta Configura TLS para la IU de Edge nueva.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false Establece en true solo si el servidor de administración usa un certificado autofirmado. Consulta Configura TLS para la API de administración.

Configura las propiedades y plantillas de correo electrónico

Asigna las propiedades de remitente, asunto, desarrollo de la marca, URL del host y vencimiento del vínculo del correo electrónico de la IU clásica de Map a la nueva IU de Edge:

Propiedad de la IU clásica Nueva propiedad de la IU de Edge Predeterminado Notas
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com> o el valor de SMTPMAILFROM especificado en el momento de la instalación No modificada
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request Observa el segmento de propiedad passwordReset en formato camelCase.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} Observa el segmento de propiedad userAddedExisting en formato camelCase.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} Observa el segmento de propiedad userAddedNew en formato camelCase.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee Establece el valor del marcador de posición {companyNameShort} en los asuntos y las plantillas de correo electrónico.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl Ninguno No modificada Si no se establece, los vínculos para restablecer la contraseña usan la URL de la IU de Edge nueva que se especificó en el momento de la instalación, y los vínculos de invitación de usuario usan el nombre de host de la solicitud. Establece esta propiedad si los usuarios acceden a la IU de Edge nueva a través de un balanceador de cargas o un nombre de DNS, por ejemplo, conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 Se aplica a los vínculos para restablecer la contraseña y los vínculos de invitación de usuarios.

La nueva IU de Edge usa plantillas de correo electrónico integradas. Para usar las plantillas que personalizaste para la IU clásica, haz lo siguiente:

  1. Crea el directorio /opt/apigee/edge-management-ui/email-templates.
  2. Copia los archivos personalizados password-reset.html, user-added-existing.html y user-added-new.html del directorio de copia de seguridad que creaste antes de la actualización (por ejemplo, /opt/apigee/customer/backup/) a /opt/apigee/edge-management-ui/email-templates. Los nombres de los archivos de plantilla y los marcadores de posición son los mismos que en la IU clásica.
  3. Asegúrate de que el directorio y los archivos pertenezcan al usuario apigee.
  4. Reinicia la IU de New Edge.

Para obtener más información, consulta Personaliza plantillas de correo electrónico de Edge.

Configura las propiedades de las contraseñas generadas automáticamente

Asigna las propiedades de contraseña generadas de forma automática de la IU clásica a la IU de New Edge:

Propiedad de la IU clásica Nueva propiedad de la IU de Edge Predeterminado
conf_apigee-base_apigee.forgotPassword.underscore.minimum conf_apigee_apigee.forgotPassword.underscore.minimum 0
conf_apigee-base_apigee.forgotPassword.specialchars.minimum conf_apigee_apigee.forgotPassword.specialchars.minimum 0
conf_apigee-base_apigee.forgotPassword.lowecase.minimum conf_apigee_apigee.forgotPassword.lowecase.minimum 0
conf_apigee-base_apigee.forgotPassword.uppercase.minimum conf_apigee_apigee.forgotPassword.uppercase.minimum 0

Configura la conexión del servidor de administración y las propiedades del secreto compartido

Asigna las propiedades de conexión, credenciales y secreto de la aplicación del servidor de administración de la IU clásica de Edge a la nueva IU de Edge:

Propiedad de la IU clásica Nueva propiedad de la IU de Edge Notas
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl Es la URL de la API de administración, por ejemplo, https://FQ_domain_name:port/v1. Este nombre de propiedad no comienza con conf_. Si el servidor de administración usa un certificado autofirmado, también establece conf_uebe_skipverify=true.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential Son las credenciales encriptadas del administrador del sistema. Debes volver a encriptar las credenciales para la nueva IU de Edge con ./bin/management-ui --encrypt. Consulta Configuración requerida para diferentes credenciales de administrador del sistema.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential Credenciales de SMTP encriptadas
conf_application_application.secret conf_uebe_applicationsecret Es el secreto que se usa para encriptar las credenciales y las cookies de sesión. Se genera en el momento de la instalación.

Quita las propiedades de la IU clásica que no requieren ninguna acción

Las siguientes propiedades de la IU clásica no tienen equivalente en la IU de Edge nueva porque el comportamiento siempre está habilitado. No incluyas estas propiedades en management-ui.properties (y quítalas de cualquier secuencia de comandos de configuración automatizada):

Propiedad de la IU clásica Comportamiento en la nueva IU de Edge
conf_apigee_apigee.feature.expireSessionCookiesInternally El vencimiento de la sesión siempre se valida en el servidor.
conf_apigee_apigee.feature.trackSessionCookies La información de la sesión siempre se almacena en la memoria del servidor. Si usas varias instancias de la IU de Edge nueva detrás de un balanceador de cargas, configúralo para que use sesiones fijas.

Quita las propiedades no compatibles de la IU clásica

Las siguientes propiedades de la IU clásica no son compatibles y no tienen equivalente en la nueva IU de Edge. No incluyas estas propiedades en management-ui.properties (y quítalas de cualquier secuencia de comandos de configuración automatizada):

Propiedad de la IU clásica Descripción
conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection El tiempo de espera para las llamadas a la API de administración no se puede configurar en la IU de Edge nueva.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword La IU de New Edge no admite un proxy de reenvío para las solicitudes de la herramienta Trace.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body El banner de consentimiento no es compatible con la nueva IU de Edge.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize En la nueva IU de Edge, la lista de proxies de API siempre se carga en páginas. El tamaño de la página no se puede configurar.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application El nivel de registro no se puede configurar en la nueva IU de Edge. Los archivos de registro se escriben en /opt/apigee/var/log/edge-management-ui.
bin_setenv_min_mem, bin_setenv_max_mem, bin_setenv_meta_space_size, bin_setenv_ext_jvm_opts La IU de Edge nueva no se ejecuta en una máquina virtual de Java. No se aplica la configuración de memoria de Java.

Revisa un ejemplo de migración

En el siguiente ejemplo, se compara un archivo ui.properties de la IU clásica con el archivo management-ui.properties equivalente para la IU de Edge nueva.

IU clásica, /opt/apigee/customer/application/ui.properties:

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

IU de Edge nueva, /opt/apigee/customer/application/management-ui.properties:

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Ten en cuenta que el valor booleano true no está entre comillas y que el tiempo de espera de la sesión 1d se reemplaza por 24.

Después de guardar el archivo, reinicia la IU de New Edge:

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

Lista de tareas de resumen

Usa la siguiente lista de tareas para completar la migración a la nueva IU de Edge en Apigee Edge para la nube privada 4.54.00:

  1. Crea una copia de seguridad de /opt/apigee/customer/application/ui.properties y de cualquier plantilla de correo electrónico personalizada de /opt/apigee/edge-ui/email-templates antes de actualizar.
  2. Agrega propiedades asignadas a /opt/apigee/customer/application/management-ui.properties sin citar valores booleanos o numéricos, y omite las propiedades de la IU clásica no admitidas.
  3. Copia las plantillas de correo electrónico personalizadas de tu directorio de copia de seguridad a /opt/apigee/edge-management-ui/email-templates.
  4. Vuelve a encriptar las credenciales de administrador del sistema con ./bin/management-ui --encrypt si configuras conf_uebe_mgmtCredential.
  5. Establece la propiedad del archivo en apigee:apigee y reinicia edge-management-ui.