Administración de Managed Runtime

Managed Runtime facilita la gestión de sus organizaciones, proyectos, entornos y paquetes asociados a su storefront de PWA Kit. Esta guía describe la creciente lista de tareas de administración posibles con la herramienta web de Runtime Admin. (Todas las tareas de administración descritas en esta guía, y muchas más, también pueden llevarse a cabo con la Managed Runtime API).

Antes de continuar, asegúrese de tener acceso a Managed Runtime y a Runtime Admin. Para aprovisionar Managed Runtime, póngase en contacto con su Success Manager. Para el Runtime Admin, póngase en contacto con su administrador de Commerce Cloud y pídale que añada alguno de los siguientes roles a su cuenta a través del Account Manager: Usuario de Managed Runtime o Managed Runtime Admin.

Los proyectos le ayudan a gestionar múltiples entornos dentro de una organización. Cada proyecto de PWA Kit necesita un proyecto correspondiente dentro de Managed Runtime para implementar y alojar el código del storefront en la infraestructura de la nube pública de Salesforce.

Para crear un proyecto en Runtime Admin:

  1. Inicie sesión en Runtime Admin.
  2. Haga clic en New Project (Proyecto nuevo).
  3. Escriba un nombre para el proyecto.
  4. Haga clic en Create a Project (Crear un proyecto).

Al crear un proyecto por primera vez, el sitio no es accesible en la web hasta que se implementa la infraestructura necesaria en la nube. Este proceso de implementación puede tardar hasta 40 minutos.

Las instrucciones para el resto de las tareas de administración en esta guía están planteadas asumiendo que se inicia desde la página de Overview (Visión general) del proyecto en Runtime Admin.

Para encontrar un proyecto existente y abrir la página de Overview (Visión general) de este, haga lo siguiente:

  1. Inicie sesión en Runtime Admin.
  2. De ser necesario, seleccione una organización desde el menú de organizaciones (arriba a la izquierda).
  3. Haga clic en el nombre del proyecto. (Para ver el proyecto en cuestión, debe tener asignado alguno de los roles de proyecto descritos anteriormente).

Captura de pantalla asociada

Para pasar rápidamente de un proyecto a otro, utilice el menú de proyectos situado en la parte superior de la página.

Desde la página de Project Settings (Configuración del proyecto) se pueden realizar las siguientes tareas:

  • Buscar el código de identificación del proyecto para asegurarse de que coincida con una configuración de PWA Kit.
  • Editar el código de identificación del proyecto.
  • Ver y editar el nombre y la URL del proyecto.
  • Borrar el proyecto.
  • Gestionar las notificaciones de implementación. (Consulte la sección siguiente).

Para acceder a la página de Project Settings (Configuración del proyecto), haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en Project Settings (Configuración del proyecto) en el menú de navegación de la izquierda.

Para editar la configuración, haga clic en Edit (Editar), haga los cambios deseados y haga clic en Update (Actualizar). Para rechazar los cambios, haga clic en Cancel (Cancelar).

Para borrar un proyecto, haga clic en Delete (Eliminar), escriba el nombre del proyecto para confirmar la acción y haga clic en Yes, Delete (Sí, eliminar). Para conservar el proyecto, haga clic en No, Keep (No, conservar).

Puede elegir si desea recibir una notificación por correo electrónico cada vez que se produzca alguno de los siguientes eventos de implementación:

  • Comienzo de la implementación
  • Implementación exitosa
  • Implementación fallida

Para agregar una notificación, haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en Project Settings (Configuración del proyecto) en el menú de navegación de la izquierda.
  3. Haga clic en Add Notification (Agregar notificación).
  4. Seleccione uno o más entornos sobre los que desea recibir notificaciones.
  5. Seleccione uno o más eventos de implementación.
  6. Escriba una dirección de correo electrónico para cada receptor de las notificaciones.
  7. Haga clic en Add Notification (Agregar notificación).

Captura de pantalla asociada

Para editar una notificación, haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en Project Settings (Configuración del proyecto) en el menú de navegación de la izquierda.
  3. Haga clic en el botón ... al lado de la notificación.
  4. Haga clic en Edit (Editar).
  5. Cambie cualquiera de las configuraciones de la notificación.
  6. Haga clic en Update Notification (Actualizar notificación).

Captura de pantalla asociada

Para quitar una notificación:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en Project Settings (Configuración del proyecto) en el menú de navegación de la izquierda.
  3. Haga clic en el botón ... al lado de la notificación.
  4. Haga clic en Remove (Eliminar).
  5. Haga clic en Yes, Remove (Sí, eliminar).

Captura de pantalla asociada

Los entornos se utilizan para separar su storefront de producción de otros storefronts que se implementan para otros fines, como el desarrollo o la ejecución de pruebas. Para obtener más información sobre los entornos y otros conceptos relacionados, consulte la Visión general Managed Runtime.

Para crear un entorno en Runtime Admin, haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en New Environment (Nuevo entorno).
  3. Escriba un nombre para el entorno.
  4. Seleccione una región para la implementación en la infraestructura de nube pública de Salesforce.
  5. Si el entorno es un entorno de producción, márquelo como producción. Si alcanzó el límite de entornos de producción, comuníquese con Soporte.
  6. Haga clic en Create Environment (Crear entorno).

La región predeterminada para los nuevos entornos es la del este de los Estados Unidos (norte de Virginia) porque es la más cercana a los on-demand sandboxes, que suelen asociarse a los entornos de desarrollo y de prueba.

Para cualquier sitio que utilice un PWA Kit y Managed Runtime, solo se puede designar un paquete a la vez para su implementación en cada entorno.

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en el nombre del entorno en el que desea llevar a cabo la implementación. Por ejemplo, Production.
  3. En el encabezado Bundles (Paquetes), haga clic en el botón Deploy (Implementar) al lado del paquete que desea implementar.
  4. Haga clic en Confirm Deploy (Confirmar implementación).
  5. Espere a que la implementación se haya completado.

Una vez que la implementación se haya completado con éxito, el paquete aparece debajo del encabezado Deployed Bundle (Paquete implementado). (Para su primera implementación en un nuevo entorno, el proceso puede tardar hasta una hora en completarse).

La página de Configuración del entorno es el lugar desde donde se pueden llevar a cabo muchas tareas de administración desde un solo lugar, incluidas las siguientes:

  • Cambiar el nombre de un entorno o el código de identificación de un entorno.
  • Cambiar la región de implementación.
  • Permitir que determinadas direcciones IP accedan al entorno.
  • Configurar conexiones de proxy para el entorno. Consulte Solicitudes de conexión del proxy para obtener más información.
  • Marque un entorno como de producción.
  • Borrar un entorno.

Para acceder a la página Environment Settings (Configuración del entorno), haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en el nombre del entorno cuya configuración desea editar.
  3. Haga clic en Environment Settings (Configuración del entorno) en el menú de navegación de la izquierda.

Para comenzar a editar, haga clic en el botón Edit (Editar) al lado de configuración General o Advanced (Avanzada). Al finalizar la edición, haga clic en Update (Actualizar) para guardar los cambios o en Cancel (Cancelar) para descartarlos.

Las variables de entorno le permiten agregar variables al proceso de la aplicación que se ejecute en un entorno, sin tener que cambiar el código. Las variables de entorno se almacenan de forma segura, lo que hace que sean ideales casos de uso como los siguientes:

  • Claves API para integraciones de terceros
  • Indicadores de características para lógica de la aplicación
  • Configuración que difiere entre entornos

Las variables de entorno pueden gestionarse utilizando la API de Managed Runtime y se puede acceder a ellas en Node.js utilizando process.env.

Para configurar, actualizar y desconfigurar las variables de entorno, utilice projects_target_env_var_partial_update:

Seleccione nombres de variables de entorno que tengan sentido para su aplicación. Los valores de las variables de entorno pueden ser un booleano, un número entero o una cadena. Para configurar valores complejos, codifique JSON en una cadena.

Para desconfigurar una variable de entorno existente, establezca su valor como null.

La modificación de variables de entorno provoca una reimplementación del paquete actual para el entorno.

Para configurar todas las variables de entorno en un entorno, utilice projects_target_env_var_list:

El uso de las variables de entorno está sujeto a las siguientes restricciones:

  • Cada entorno tiene un límite de 100 variables de entorno.
  • El tamaño máximo de los valores de las variables de entorno configuradas para un entorno es 32 kb.
  • Los nombres de las variables de entorno deben tener 512 caracteres o menos, y no pueden comenzar con los prefijos reservados: AWS, MRT, X_MRT, MOBIFY, X_MOBIFY, SSR_PROXY.
  • Los nombres de las variables de entorno no pueden utilizar ningún nombre reservado: BUNDLE_ID, DEPLOY_ID, DEPLOY_TARGET, EXTERNAL_DOMAIN_NAME, HANDLER, LAMBDA_RUNTIME_DIR, LAMBDA_TASK_ROOT, NODE_ENV, REDIRECT_BUCKET, REDIRECT_KEY, REDIRECT_UPDATE, REMOTE, X_AMZN_TRACE_ID.

Un redireccionamiento le permite reenviar una solicitud desde la URL solicitada a una URL diferente. Los redireccionamientos pueden ayudar a evitar alteraciones en la experiencia del usuario causadas por cambios aplicados al storefront. Por ejemplo, imagine una página de campaña estacional para la primavera. Una vez que la campaña de primavera termina y esta se sustituye por una de verano, usted puede redirigir desde la URL de primavera a la de verano.

Los redireccionamientos son una característica poderosa que pueden tener consecuencias significativas para la seguridad de su storefront, incluido el redireccionamiento a URL o activos maliciosos. Tenga cuidado al asignar roles a sus usuarios que les brinden acceso a Redireccionamiento.

Antes de crear un redireccionamiento en un entorno de producción, se recomienda crearlo primero en un entorno de staging.

Para crear un redireccionamiento, haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en el nombre del entorno en el que desea establecer el redireccionamiento.
  3. Haga clic en URL Redirects (Redireccionamientos de URL) en el menú de navegación de la izquierda.
  4. Haga clic en Create Redirect (Crear redireccionamiento).
  5. En el campo Redirect From (Redirigir desde), escriba una ruta de URL relativa. Por ejemplo, para redirigir a los visitantes desde la URL www.example.com/winter, escriba /winter.
  6. En el campo Redirect To (Redirigir a), escriba una ruta de URL relativa.
  7. De ser necesario, active el reenvío de parámetros de consulta y la ruta comodín. (Más adelante se proporciona más información sobre la configuración del reenvío).
  8. En el menú desplegable Redirect Type (Tipo de redireccionamiento), seleccione un tipo de redirección basado en el código de estado HTTP. (Más adelante se proporciona más información sobre códigos de estado).
  9. Haga clic en Create Redirect (Crear redireccionamiento).

Veamos las opciones para crear un redireccionamiento con mayor detalle.

El valor que se introduce en el campo Redirect From debe ser siempre una ruta relative. El campo Redirect To puede ser una ruta relativa o una URL completa. Por ejemplo, supongamos que queremos redirigir a los visitantes de www.example.com/spring a www.example.com/summer. El campo Redirect From debe ser /spring. El campo Redirect To puede ser /summer o www.example.com/summer.

Puede añadir un asterisco (*) al final de la URL de Redirect From a modo de comodín. Los comodines reemplazan cualquier carácter (0 o más) en la URL. Por ejemplo, un "redirigir desde" /a/* reemplazaría /a/, /a/b y /a/b/c.

Los caracteres comodín solo pueden usarse al final de la URL de Redirect From.

Managed Runtime procesa primero los redireccionamientos estándar y, luego, los redireccionamientos con comodines.

La mayoría de los redireccionamientos utilizan el código de estado permanente (301), pero también se puede seleccionar el temporal (302). Si no está seguro de qué código de estado HTTP debe utilizar, consulte esta explicación de código de estado de MOZ.com.

Algunas solicitudes contienen parámetros de cadenas de consulta que también debería incluir en la solicitud redirigida. Por ejemplo, a la ruta relativa /spring-landing-page se le puede adjuntar una cadena de consulta para el seguimiento analítico, como /spring-landing-page?gclid=123.

Para habilitar el reenvío de parámetros de consulta, vaya a la sección Forward (Reenviar) del formulario y seleccione Query Parameters (Parámetros de consulta). De lo contrario, los parámetros de la cadena de consulta de la URL de origen no se incluyen en la URL de redireccionamiento.

¿Qué ocurre cuando las URL de Redirect From y Redirect To tienen ambas cadenas de consulta y el reenvío está habilitado? En este caso, la URL de redireccionamiento incluye una combinación de ambas cadenas de consulta. Los parámetros de consulta de la URL de Redirect To se adjuntan a la cadena de consulta de la solicitud. Por ejemplo, suponga que su aplicación recibe una solicitud de la ruta relativa /spring?year=2019. Si eligió redirigir /spring a /summer?year=2020, la URL de redireccionamiento es /summer?year=2019&year=2020 cuando el reenvío está habilitado.

Puede incluir automáticamente cualquier ruta que aparezca después de la parte que actúa como comodín en la URL de Redirect From en la URL de Redirect To. Por ejemplo, si /a/* reemplaza a /a/b/c en la URL de Redirect From y la URL de Redirect To es /z/, la URL de redireccionamiento es /z/b/c.

Para habilitar el reenvío de rutas comodines, vaya a la sección Forward (Reenviar) del formulario y seleccione Wildcard Path (Ruta comodín).

Recomendamos crear siempre los redireccionamientos en un entorno de staging y clonarlos para su producción después de probarlos.

Puede copiar todos los redireccionamientos de un entorno a otro utilizando la característica de clonación de redireccionamientos.

Para clonar un redireccionamiento:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en el nombre del entorno que contiene los redireccionamientos que desea clonar.
  3. Haga clic en URL Redirects (Redireccionamientos de URL) en el menú de navegación de la izquierda.
  4. Haga clic en Clone Redirects (Clonar redireccionamientos). Aparecerá el formulario Clone Redirects. El entorno actual se muestra en From Environment (Entorno de origen).
  5. En To Environment, seleccione el entorno al que desea enviar los redireccionamientos clonados (el destino).
  6. Haga clic en Clone n Redirects (Clonar n Redireccionamientos). (En donde “n” es el número de redireccionamientos que se clonarán).

Al clonar redireccionamientos, estará sustituyendo todos los redireccionamientos del entorno de destino por todos los redireccionamientos del entorno de origen.

Para editar la configuración de un redireccionamiento existente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en el nombre del entorno que contiene el redireccionamiento que desea editar.
  3. Haga clic en URL Redirects (Redireccionamientos de URL) en el menú de navegación de la izquierda.
  4. Haga clic en el botón de puntos suspensivos (...) al lado del redireccionamiento.
  5. Haga clic en Edit (Editar).
  6. Actualice la configuración.
  7. Haga clic en Update Redirect (Actualizar redireccionamiento).

Para borrar un redireccionamiento:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en el nombre del entorno que contiene el redireccionamiento que desea borrar.
  3. Haga clic en URL Redirects (Redireccionamientos de URL) en el menú de navegación de la izquierda.
  4. Haga clic en el botón de puntos suspensivos (...) al lado del redireccionamiento.
  5. Haga clic en Delete (Eliminar).
  6. Haga clic en Yes, Delete Redirect (Sí, eliminar redireccionamiento).

Si algún redireccionamiento no tiene el resultado esperado, pruebe estos pasos para solucionar problemas:

  • Borre la memoria caché del navegador porque los redireccionamientos se almacenan en la caché.
  • Compruebe que esté viendo la configuración del entorno correcto.
  • Edite el redireccionamiento y verifique que los campos Redirect From y Redirect To tengan los valores correctos.

Los redireccionamientos tienen las siguientes limitaciones técnicas:

  • Cada entorno puede tener un máximo de 10,000 redireccionamientos.
  • Cada entorno tiene su propio conjunto de redireccionamientos. Es su responsabilidad mantenerlos sincronizados mediante la clonación.
  • La característica de redireccionamiento admite redireccionamientos simples de una ruta a otra. Para redireccionamientos complejos con condicionales usa el soporte de redireccionamiento de Express.js en ssr.js.
  • Los redireccionamientos creados con la herramienta Runtime Admin o Managed Runtime API no se ejecutan en entornos de desarrollo locales.
  • Los redireccionamientos no se disparan por transiciones de páginas en la aplicación PWA Kit, solo se activan mediante una solicitud de HTTP.

Esta es la forma de administrar sus usuarios.

Para agregar a un usuario a un proyecto, haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en Users & Permissions (Usuarios y permisos) en el menú de navegación de la izquierda.
  3. Haga clic en New User (Nuevo usuario).
  4. Escriba la dirección de correo electrónico del usuario. (Asegúrese de que el usuario sea parte de su organización y que tenga alguno de los siguientes roles en el Account Manager: Managed Runtime User (Usuario de Managed Runtime) o Managed Runtime Admin (Administración de Managed Runtime)).
  5. Seleccione un rol.
  6. Haga clic en Add User (Agregar usuario).

Captura de pantalla asociada

Para cambiar el rol de un usuario, haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en Users & Permissions (Usuarios y permisos) en el menú de navegación de la izquierda.
  3. Haga clic en el botón ... al lado del nombre del usuario.
  4. Haga clic en Edit (Editar).
  5. Seleccione un rol.
  6. Haga clic en el menú emergente que aparece.
  7. Seleccione un nuevo rol.
  8. Haga clic en Save (Guardar).

Captura de pantalla asociada

Para ver una lista de capacidades de usuario asociadas con cada rol, consulte la Visión general de Managed Runtime.

Para quitar a un usuario de un proyecto, haga lo siguiente:

  1. Vaya a la página Overview (Visión general) del proyecto.
  2. Haga clic en Users & Permissions (Usuarios y permisos) en el menú de navegación de la izquierda.
  3. Haga clic en el botón ... al lado del nombre del usuario.
  4. Haga clic en Remove (Eliminar).
  5. Haga clic en Yes, Remove User (Sí, eliminar usuario).

Captura de pantalla asociada