Entornos de desarrollo rápido rapid-development-environments
Para implementar cambios, los entornos de desarrollo de nube actuales requieren el uso de un proceso que emplea amplias reglas de calidad y seguridad de código denominadas canalización CI/CD. Para situaciones en las que se necesitan cambios rápidos e iterativos, Adobe ha introducido entornos de desarrollo rápido (RDE, por sus siglas en inglés).
Los RDE permiten a los desarrolladores implementar y revisar los cambios rápidamente, minimizando la cantidad de tiempo necesario para probar las funciones que han demostrado funcionar en un entorno de desarrollo local.
Una vez que los cambios se han probado en un RDE, pueden implementarse en un entorno de desarrollo de nube normal a través de la canalización de Cloud Manager.
Puede ver vídeos adicionales que muestran cómo configurarlo, cómo utilizarlo y el ciclo de vida de desarrollo mediante RDE.
Introducción introduction
Los RDE se pueden utilizar para configuraciones de código, contenido y Apache o Dispatcher. A diferencia de los entornos de desarrollo de nube normales, los desarrolladores pueden utilizar herramientas de línea de comandos locales para sincronizar el código creado localmente en un RDE.
Cada programa está aprovisionado con un RDE. Si hay cuentas de zona protegida, hibernan después de unas horas de no uso.
Una vez creados, los RDE se establecen en la última versión de Adobe Experience Manager (AEM) disponible. Un restablecimiento de RDE, que se puede realizar con Cloud Manager, ciclos el RDE y lo establece en la última versión de AEM disponible.
Normalmente, un solo desarrollador utiliza un RDE en un momento determinado para probar y depurar una función específica. Cuando se completa la sesión de desarrollo, el RDE se puede restablecer a un estado predeterminado para el siguiente uso.
Los RDE adicionales pueden tener licencia para programas de Producción (que no sean de zonas protegidas).
Habilitar RDE en un programa enabling-rde-in-a-program
-
Inicie sesión en Cloud Manager en my.cloudmanager.adobe.com y seleccione la organización adecuada.
-
Haga clic en el programa al que desee agregar un RDE para mostrar sus detalles.
- Los RDE se pueden agregar a programas de zona protegida y a programas de producción.
-
En la página Resumen del programa, en la tarjeta Entornos, haga clic en Agregar entorno.
-
La opción Agregar entorno también está disponible en la pestaña Entornos.
-
La opción Agregar entorno se puede desactivar debido a la falta de permisos o dependiendo de los recursos con licencia.
-
-
En el cuadro de diálogo Agregar entorno, haga lo siguiente:
- Seleccione Desarrollo rápido en el encabezado Seleccionar tipo de entorno.
- El número de entornos disponibles/utilizados se muestra entre paréntesis detrás del tipo de entorno.
- Proporcione un Nombre para el entorno.
- Proporcione una descripción opcional para el entorno.
- Seleccione una Región de nube.
- Seleccione Desarrollo rápido en el encabezado Seleccionar tipo de entorno.
-
Haga clic en Guardar para agregar el entorno especificado.
La pantalla Información general ahora muestra su nuevo entorno en la tarjeta Entornos.
Una vez creados, los RDE se establecen en la versión de AEM más reciente disponible. Un restablecimiento de RDE, que también se puede realizar con Cloud Manager, ciclo el RDE y lo establece en la última versión de AEM disponible.
Para obtener más información sobre cómo usar Cloud Manager para crear entornos, administrar quién tiene acceso a ellos y asignar dominios personalizados, consulte Programas y tipos de programas en la documentación de Cloud Manager.
Instale las herramientas de línea de comandos de RDE installing-the-rde-command-line-tools
Después de agregar un RDE para el programa mediante Cloud Manager, puede interactuar con él configurando las herramientas de línea de comandos como se describe en los pasos siguientes:
-
Instale las herramientas CLI de AIO según este procedimiento.
-
Instale las herramientas CLI de AIO del complemento AEM RDE:
code language-none aio plugins:install @adobe/aio-cli-plugin-aem-rde aio plugins:update
-
Inicie sesión con el cliente de Adobe I/O (AIO).
code language-none aio login
La información de inicio de sesión (token) se almacena en la configuración de aio global y, por lo tanto, solo admite un inicio de sesión y una organización. Si desea utilizar varios RDE que necesiten diferentes inicios de sesión u organizaciones, siga el siguiente ejemplo para presentar contextos.
accordion Siga este ejemplo para configurar un contexto local para uno de sus inicios de sesión de RDE Ahora, cree un contexto llamado m
ycontext
que usted establezca como contexto predeterminado usando el complemento auth antes de llamar al comando login.code language-none aio config set --json -l "ims.contexts.mycontext" "{ cli.bare-output: false }" aio auth ctx -s mycontext aio login --no-open
note note NOTE El comando de inicio de sesión con la opción --no-open
genera una dirección URL en el terminal en lugar de abrir el explorador predeterminado. Puede copiarlo y abrirlo con una ventana de incógnito de su explorador. Esta capacidad garantiza que la sesión actual en la ventana principal del explorador no se vea afectada, lo que le permite iniciar sesión con la cuenta y organización específicas necesarias para la tarea.El primer comando crea una nueva configuración de contexto de inicio de sesión, denominada
mycontext
, en el archivo de configuración.aio
local (el archivo se crea si es necesario). El segundo comando establece el contextomycontext
como el contexto "actual"; es decir, el contexto predeterminado.Con esta configuración en su lugar, el comando login almacena automáticamente los tokens de inicio de sesión en el contexto
mycontext
, por lo que lo mantiene local.Se pueden administrar varios contextos manteniendo las configuraciones locales en varias carpetas. Alternativamente, también es posible configurar varios contextos dentro de un solo archivo de configuración y cambiar entre ellos cambiando el contexto "actual".
-
Configure el complemento RDE para utilizar su organización, programa y entorno. El siguiente comando setup proporciona al usuario de forma interactiva una lista de los programas de su organización y muestra los entornos de RDE de ese programa para elegir.
code language-none aio aem:rde:setup
Puede omitir el paso de configuración si utiliza un entorno con scripts. En ese caso, incluya los valores de organización, programa y entorno directamente en cada comando. Consulte los comandos de RDE más abajo para obtener más información.
Configuración interactiva installing-the-rde-command-line-tools-interactive
El comando setup pregunta si la configuración proporcionada debe almacenarse local o globalmente.
Setup the CLI configuration necessary to use the RDE commands.
? Do you want to store the information you enter in this setup procedure locally? (y/N)
Elija no
para
- almacene la organización, el programa y el entorno globalmente en su configuración de aio.
- trabajar sólo con un único RDE.
Elija yes
para hacer lo siguiente:
- Almacene la organización, el programa y el entorno localmente en el directorio actual, en un archivo de
.aio
. Este método es adecuado si desea enviar el archivo al control de versiones para que otros usuarios que clonen el repositorio de Git puedan utilizarlo. - Poder trabajar con muchos RDE, de modo que cambiar a otro directorio utilice esa configuración en su lugar.
- Utilice la configuración en un contexto programático como un script, que puede hacer referencia a ella.
Una vez seleccionada la configuración local o global, el comando setup intenta leer el ID de su organización de inicio de sesión actual y, a continuación, leer los programas de la organización. Si no se encuentra la organización, puede introducirla manualmente junto con algunas directrices.
Selected only organization: XYXYXYXYXYXYXYXXYY
retrieving programs of your organization ...
Una vez recuperados los programas, el usuario puede seleccionar de la lista y también escribir para filtrar. Cuando se selecciona el programa, se muestra una lista de entornos RDE para elegir. Si solo hay un programa, o solo un entorno RDE disponible, o ambos, se selecciona automáticamente.
Para ver el contexto del entorno actual, ejecute lo siguiente:
aio aem rde setup --show
El comando responde con un resultado similar al siguiente:
Current configuration: cm-p1-e1: programName - environmentName (organization: ...@AdobeOrg)
Procedimiento de configuración manual en un entorno no interactivo manual-setup
En entornos en los que ningún usuario puede ejecutar el comando setup de forma interactiva (como CI/CD o secuencias de comandos), se requiere la configuración manual. Puede establecer los parámetros de organización, programa y entorno siguiendo los pasos a continuación.
-
Configure su ID de organización y sustituya la cadena alfanumérica por su propio ID de organización.
aio config:set cloudmanager_orgid 4E03EQC05D34GL1A0B49421C@AdobeOrg
- Puede buscar su propio identificador de organización con el método documentado en Ver su identificador de organización.
-
A continuación, configure su ID de programa:
aio config:set cloudmanager_programid 12345
-
A continuación, configure el ID de entorno al que se va a adjuntar el RDE:
aio config:set cloudmanager_environmentid 123456
-
Cuando haya terminado de configurar el complemento, inicie sesión realizando las siguientes acciones
aio login
Estos pasos requieren que sea miembro del perfil de producto Desarrollador - Cloud Service de Cloud Manager. Consulte Asignar integrantes del equipo a perfiles de producto de Cloud Manager - Asignar el perfil de producto del desarrollador para obtener más información.
Para obtener más información y demostración, vea el tutorial en vídeo cómo configurar un RDE (06:24).
Utilizar RDE al desarrollar una nueva función using-rde-while-developing-a-new-feature
Adobe recomienda el siguiente flujo de trabajo para desarrollar una nueva función:
-
Cuando se alcance un hito intermedio y se valide correctamente localmente con AEM as a Cloud Service SDK, confirme el código a una rama de características de Git. La rama aún no debe formar parte de la línea principal, aunque comprometerse con Git es opcional. Lo que constituye un "hito intermedio" varía en función de los hábitos del equipo. Algunos ejemplos son unas pocas líneas de código nuevas, medio día de trabajo o completar una subfunción.
-
Restablezca el RDE si lo ha utilizado otra característica y desea restablecerlo a un estado predeterminado. El restablecimiento tarda unos minutos y se elimina todo el contenido y código existentes. Puede utilizar el comando Estado de RDE para confirmar que el RDE está listo. El RDE vuelve con la versión más reciente del lanzamiento de AEM.
note important IMPORTANT Si los entornos de ensayo y producción no reciben actualizaciones automáticas de la versión de AEM y están detrás de la última versión, RDE puede ejecutar una versión diferente de AEM. Como resultado, es posible que el comportamiento del código en RDE no coincida con su funcionamiento en ensayo y producción. En ese caso, es importante realizar pruebas exhaustivas del código en el ensayo antes de implementarlo en la producción. -
Mediante la interfaz de línea de comandos de RDE, sincronice el código local con RDE. Puede instalar varios tipos de archivos, incluidos los siguientes:
- Paquetes de contenido
- Paquetes específicos
- Archivos de configuración de OSGi
- Archivos de contenido
- Archivos ZIP que contienen configuraciones de Apache/Dispatcher
También es posible hacer referencia a un paquete de contenido remoto. Consulte Herramientas de línea de comandos RDE para obtener más información. Puede utilizar el comando status para validar que la implementación se realizó correctamente. De forma opcional, utilice el Administrador de paquetes para instalar paquetes de contenido.
-
Pruebe el código en el RDE. Las direcciones URL de autor y publicación están disponibles en Cloud Manager.
-
Si el código no se comporta como se espera, utilice técnicas de depuración estándar para comprender el problema y realizar los cambios correspondientes. Sin confirmar las modificaciones de código en Git (ya que no se han validado), utilice la CLI local para sincronizar el código con el RDE. Siga iterando hasta que se resuelva el problema.
-
Una vez que el código se comporte según lo esperado, confírmelo en la rama de características de Git.
-
El código sincronizado con RDE no utiliza una canalización de Cloud Manager, por lo que ahora debe utilizar una canalización que no sea de producción de Cloud Manager para implementar la rama de características de Git en el entorno de desarrollo de la nube. Este proceso valida que el código pasa las puertas de calidad de Cloud Manager y le permite estar seguro de que el código se implementará correctamente más adelante mediante la canalización de producción de Cloud Manager.
-
Repita los pasos anteriores para cada hito intermedio hasta que todo el código de la función esté listo y se ejecute correctamente en el entorno de RDE y de desarrollo en la nube.
-
Implemente el código en producción mediante la canalización de producción de Cloud Manager.
Usar RDE para depurar una función existente use-rde-to-debug-an-existing-feature
El flujo de trabajo es similar al desarrollo de una nueva función. La diferencia es que el código sincronizado con RDE refleja la etiqueta Git de lo que se insertó en el entorno en el que se produjo el problema. Este flujo de trabajo ayuda a garantizar la coherencia al investigar o reproducir el problema. Además, puede resultar útil implementar contenido que coincida con el entorno de flujo ascendente. Este enfoque se puede lograr mediante la exportación e importación de paquetes de contenido.
Varios desarrolladores que colaboran en el mismo RDE multiple-developers-collaborating-on-the-same-rde
Un RDE admite un solo proyecto a la vez. Dado que el código se sincroniza desde un entorno de desarrollo local al entorno de RDE, es más natural que un desarrollador lo utilice por su cuenta en un momento determinado.
Sin embargo, con una coordinación cuidadosa, es posible que más de un desarrollador valide una función específica o depure un problema específico. La clave es que cada desarrollador mantenga sus proyectos locales sincronizados para que los demás desarrolladores absorban los cambios de código realizados por un desarrollador en particular. De lo contrario, un desarrollador podría sobrescribir inadvertidamente el código del otro. La estrategia recomendada es que cada desarrollador confirme sus cambios en una rama de Git compartida antes de sincronizarse con RDE, de modo que los demás desarrolladores extraigan los cambios antes de realizar sus propios cambios.
Herramientas de línea de comandos de RDE Comandos rde-cli-commands
Ayuda/Información general help
-
Para obtener una lista de comandos, escriba:
aio aem:rde
-
Para obtener ayuda detallada sobre un comando, escriba:
aio aem rde <command> --help
Indicadores globales global-flags
-
Para una salida menos detallada, utilice el indicador quiet:
aio aem rde <command> --quiet
Este indicador elimina ciertos elementos, como los giros y las barras de progreso, y limita la necesidad de que el usuario introduzca datos.
-
Para JSON en lugar de para la salida del registro de la consola, utilice el indicador json:
aio aem rde <command> --json
Este indicador devuelve un JSON válido mientras se suprime cualquier salida de la consola. Consulte los ejemplos de JSON más adelante.
-
Para evitar configurar la información de conexión de RDE mediante el comando setup o cualquier creación de configuración de aio, utilice los tres indicadores para organización, programa y entorno:
aio aem rde <command> --organizationId=<value> --programId=<value> --environmentId=<value>
Requiere que se realice un
aio login
.
Implementar en RDE deploying-to-rde
En esta sección se explica cómo utilizar la CLI de RDE para implementar, instalar o actualizar varios recursos. Estos recursos incluyen lo siguiente:
- Paquetes de contenido
- Configuraciones de OSGi
- Paquetes
- Archivos de contenido
- Configuraciones de Apache o Dispatcher
El patrón de uso general es aio aem:rde:install <artifact>
.
Puede encontrar algunos ejemplos a continuación:
Implementación de un paquete de contenido deploy-content-package
aio aem:rde:install sample.demo.ui.apps.all-1.0.0-SNAPSHOT.zip
La respuesta para una implementación correcta es similar a la siguiente:
...
#1: deploy completed for content-package sample.demo.ui.apps.all-1.0.0-SNAPSHOT.zip on author,publish - done by 9E072FC75D54FE1A2B49431C@AdobeID at 2022-09-13T11:32:06.229Z
Opcionalmente, puede hacer referencia a un repositorio remoto:
aio aem:rde:install -t content-package "https://repo1.maven.org/maven2/com/adobe/aem/guides/aem-guides-wknd.all/2.1.0/aem-guides-wknd.all-2.1.0.zip"
De manera predeterminada, los artefactos se implementan en los niveles de creación y publicación, pero el indicador -s
se puede usar para dirigirse a un nivel específico.
Se puede implementar cualquier paquete de AEM, como paquetes con código, contenido o un paquete contenedor (también denominado paquete "todo").
Implementar una configuración OSGI deploy-OSGI-config
aio aem:rde:install com.adobe.granite.demo.MyServlet.cfg.json
Donde la respuesta para una implementación correcta es similar a la siguiente:
...
#2: deploy completed for osgi-config com.adobe.granite.demo.MyServlet.cfg.json on author,publish - done by 9E0725C05D54FE1A0B49431C@AdobeID at 2022-09-13T11:54:36.390Z
Implementación de un paquete deploy-bundle
Para implementar un paquete, utilice:
aio aem:rde:install ~/.m2/repository/org/apache/felix/org.apache.felix.gogo.jline/1.1.8/org.apache.felix.gogo.jline-1.1.8.jar
Donde la respuesta para una implementación correcta es similar a la siguiente:
...
#3: deploy staged for osgi-bundle org.apache.felix.gogo.jline-1.1.8.jar on author,publish - done by 9E0725C05D53BE1A0B49431C@AdobeID at 2022-09-14T07:54:28.882Z
Implementación de un archivo de contenido deploy-content-file
Para implementar un archivo de contenido, utilice:
aio aem:rde:install world.txt -p /apps/hello.txt
Donde la respuesta para una implementación correcta es similar a la siguiente:
..
#4: deploy completed for content-file world.txt on author,publish - done by 9E0729C05C54FE1A0B49431C@AdobeID at 2022-09-14T07:49:30.644Z
Implementar una configuración de Apache/Dispatcher deploy-apache-config
Toda la estructura de carpetas debe estar en forma de archivo zip para este tipo de configuración.
Desde el módulo dispatcher
de un proyecto de AEM, puede comprimir la configuración de Dispatcher ejecutando el siguiente comando de Maven:
mvn clean package
O utilizando el siguiente comando zip del directorio src
del módulo dispatcher
:
zip -y -r dispatcher.zip .
A continuación, implemente la configuración mediante este comando:
aio aem:rde:install target/aem-guides-wknd.dispatcher.cloud-X.X.X-SNAPSHOT.zip
X.X.X
con el número de versión del proyecto WKND correspondiente o el número de versión específico del proyecto al implementar la configuración de Dispatcher del proyecto.Una implementación correcta genera una respuesta similar a la siguiente:
..
#5 deploy completed for dispatcher-config dispatcher.zip on author,publish - done by 9E0735C05T54FE1A0B49431C@AdobeID at 2022-10-03T10:26:31.286Z
Logs:
Cloud manager validator 2.0.49
2022/10/03 10:26:37 No issues found
Syntax OK
El código implementado en RDE no se somete a una canalización de Cloud Manager y a sus puertas de calidad asociadas. Sin embargo, el código pasa por algún análisis, que informa de los errores, como se muestra en el ejemplo de código siguiente:
$ aio aem:rde:install ~/.m2/repository/org/apache/felix/org.apache.felix.gogo.jline/1.1.8/org.apache.felix.gogo.jline-1.1.8.jar
...
#19: deploy staged for osgi-bundle org.apache.felix.gogo.jline-1.1.8.jar on author,publish - done by 9E0725C05D74FR1A0B49431C@AdobeID at 2022-09-14T07:54:28.882Z
Logs:
The analyser found the following errors for author :
[requirements-capabilities] com.adobe.aem.temp:org.apache.felix.gogo.jline:1.1.8: Artifact com.adobe.aem.temp:org.apache.felix.gogo.jline:1.1.8 requires [org.apache.felix.gogo.jline/1.1.8] org.apache.felix.gogo; filter:="(&(org.apache.felix.gogo=command.implementation)(version>=1.0.0)(!(version>=2.0.0)))"; effective:=active in start level 20 but no artifact is providing a matching capability in this start level.
[api-regions-exportsimports] com.adobe.aem.temp:org.apache.felix.gogo.jline:1.1.8: Bundle org.apache.felix.gogo.jline:1.1.8 is importing package(s) [org.jline.builtins, org.jline.utils, org.apache.felix.service.command, org.apache.felix.service.threadio, org.jline.terminal, org.jline.reader, org.apache.felix.gogo.runtime, org.jline.reader.impl] in start level 20 but no bundle is exporting these for that start level.
The analyser found the following errors for publish :
[requirements-capabilities] com.adobe.aem.temp:org.apache.felix.gogo.jline:1.1.8: Artifact com.adobe.aem.temp:org.apache.felix.gogo.jline:1.1.8 requires [org.apache.felix.gogo.jline/1.1.8] org.apache.felix.gogo; filter:="(&(org.apache.felix.gogo=command.implementation)(version>=1.0.0)(!(version>=2.0.0)))"; effective:=active in start level 20 but no artifact is providing a matching capability in this start level.
[api-regions-exportsimports] com.adobe.aem.temp:org.apache.felix.gogo.jline:1.1.8: Bundle org.apache.felix.gogo.jline:1.1.8 is importing package(s) [org.jline.builtins, org.jline.utils, org.apache.felix.service.command, org.apache.felix.service.threadio, org.jline.terminal, org.jline.reader, org.apache.felix.gogo.runtime, org.jline.reader.impl] in start level 20 but no bundle is exporting these for that start level.
El ejemplo de código anterior ilustra el comportamiento si un paquete no se resuelve. En cuyo caso, se "almacena en zona intermedia" y solo se instala si sus requisitos (importaciones que faltan, en este caso) se satisfacen mediante la instalación de otro código.
Implementar la configuración relacionada con la canalización de configuración (configuraciones yaml) deploy-config-pipeline
Las configuraciones específicas del entorno (uno o más archivos yaml) descritas en el artículo Uso de canalizaciones de configuración se pueden implementar de la siguiente manera:
aio aem:rde:install -t env-config ./my-config-folder
Donde my-config-folder
es la carpeta principal que contiene las configuraciones de yaml.
También es posible instalar un archivo zip que contenga el árbol de carpetas de configuración:
aio aem:rde:install -t env-config config.zip
Tenga en cuenta que la matriz envTypes del archivo yaml incluye el valor rde
, como en el ejemplo siguiente:
kind: "CDN"
version: "1"
metadata:
envTypes: ["rde"]
Implementar código front-end basado en temas de sitio y plantillas de sitio deploying-themes-to-rde
Los RDE admiten código front-end generado con temas del sitio y plantillas de sitio. En lugar de usar la canalización front-end de Cloud Manager como otros tipos de entorno, los RDE implementan paquetes front-end usando una directiva de línea de comandos.
Como de costumbre, cree su paquete front-end utilizando npm:
npm run build
Genera una carpeta dist/
, de modo que la carpeta del paquete front-end contiene un archivo package.json
y una carpeta dist
:
ls ./path-to-frontend-pkg-folder/
...
dist
package.json
Ahora está listo para implementar el paquete front-end en RDE señalando la carpeta de paquetes front-end de la siguiente manera:
aio aem:rde:install -t frontend ./path-to-frontend-pkg-folder/
...
#1: deploy completed for frontend frontend-pipeline.zip on author,publish - done by ... at 2024-01-18T15:33:22.898Z
Logs:
> Deployed artifact wknd-1.0.0-1705592008-26e7ec1a
> with workspace hash 692021864642a20d6d298044a927d66c0d9cf2adf42d4cca0c800a378ac3f8d3
También puede comprimir el archivo package.json
y la carpeta dist
e implementar ese archivo zip:
zip -r frontend-pkg.zip ./path-to-frontend-pkg-folder/dist ./path-to-frontend-pkg-folder/package.json
aio aem:rde:install -t frontend frontend-pkg.zip
...
#1: deploy completed for frontend frontend-pipeline.zip on author,publish - done by ... at 2024-01-18T15:33:22.898Z
Logs:
> Deployed artifact wknd-1.0.0-1705592008-26e7ec1a
> with workspace hash 692021864642a20d6d298044a927d66c0d9cf2adf42d4cca0c800a378ac3f8d3
- carpeta
dist
, para la carpeta npm build output package package.json
archivo, para el paquete de dependencias npm
UNEXPECTED_API_ERROR
al utilizar la función front-end por primera vez, puede deberse a una configuración obsoleta. Para resolver este problema, elimine el entorno y cree uno nuevo.Comprobar el estado de RDE checking-rde-status
Puede utilizar la CLI de RDE para comprobar si el entorno está listo para implementarse en, ya que las implementaciones se han realizado mediante el complemento de RDE.
Ejecutar lo siguiente:
aio aem:rde:status
Devuelve lo siguiente:
Info for cm-p12345-e987654
Environment: Ready
- Bundles Author:
com.adobe.granite.sample.demo-1.0.0.SNAPSHOT
- Bundles Publish:
com.adobe.granite.sample.demo-1.0.0.SNAPSHOT
- Configurations Author:
com.adobe.granite.demo.MyServlet
- Configurations Publish:
com.adobe.granite.demo.MyServlet
Si el comando devuelve una nota sobre la implementación de instancias, aún puede continuar y realizar la siguiente actualización, pero es posible que la última aún no esté visible en la instancia.
Mostrar historial de implementación show-deployment-history
Puede comprobar el historial de implementaciones realizadas en RDE ejecutando:
aio aem:rde:history
Que devuelve una respuesta en forma de:
#1: deploy completed for content-package aem-guides-wknd.all-2.1.0.zip on author,publish - done by 029039A55D4DE16A0A494025@AdobeID at 2022-09-12T14:41:55.393Z
Eliminar de RDE deleting-from-rde
Puede utilizar la herramienta CLI para eliminar configuraciones y paquetes que haya implementado anteriormente en RDE. Utilice el comando status
para obtener una lista de lo que se puede eliminar, que incluye bsn
para paquetes y pid
para configuraciones a las que se hará referencia en el comando eliminar.
Por ejemplo, si se ha instalado com.adobe.granite.demo.MyServlet.cfg.json
, bsn
es solo com.adobe.granite.demo.MyServlet
, sin el sufijo cfg.json.
No se admite la eliminación de paquetes de contenido o archivos de contenido. Para eliminarlos, restablezca el RDE, que lo devuelve a un estado predeterminado.
Consulte el ejemplo siguiente para obtener más información:
aio aem:rde:delete com.adobe.granite.csrf.impl.CSRFFilter
#13: delete completed for osgi-config com.adobe.granite.csrf.impl.CSRFFilter on author - done by karl at 2022-09-12T22:01:01.955Z
#14: delete completed for osgi-config com.adobe.granite.csrf.impl.CSRFFilter on publish - done by karl at 2022-09-12T22:01:12.979Z
Para obtener más información y demostración, vea el tutorial en vídeo cómo usar comandos RDE (10:01).
Implementar en un RDE desde proveedores de Git externos deploy-to-rde
Cloud Manager admite la implementación de código en RDE directamente desde proveedores de Git externos al usar la configuración Traer su propio Git (BYOG).
La implementación en RDE desde un repositorio Git externo requiere lo siguiente:
- El uso de un repositorio Git externo integrado con Cloud Manager (configuración BYOG).
- El proyecto debe tener uno o más entornos RDE aprovisionados.
- Si usa
github.com
, debe revisar y aceptar la instalación actualizada de la aplicación GitHub para conceder los nuevos permisos necesarios.
Notas de uso
- Actualmente, la implementación en RDE solo es compatible con contenido de AEM y paquetes de Dispatcher.
- Aún no se admite la implementación de otros tipos de paquetes (por ejemplo, paquetes de aplicaciones de AEM completos).
- Actualmente, no se admite el restablecimiento de un entorno RDE mediante un comentario. En su lugar, debe usar el comando reset de la CLI de AIO existente, como se describe aquí.
Funcionamiento
-
Mensaje de validación de calidad del código.
Cuando una solicitud de extracción (PR) déclencheur la ejecución de una canalización de calidad de código, los resultados de validación indican si la implementación puede continuar en un entorno RDE.
Aspecto de GitHub Enterprise:
Aspecto de GitLab:
Cómo se ve en Bitbucket:
-
Implementación de Déclencheur mediante un comentario.
Para iniciar la implementación, agregue un comentario al PR con el siguiente formato:
deploy on rde-environment-<envName>
El
<envName>
debe coincidir con el nombre de un entorno RDE existente. Si no se encuentra el nombre, se devuelve un comentario que indica que el entorno no es válido.Si el estado del entorno no está listo, se obtiene el siguiente comentario:
-
Comprobación del entorno e implementación de artefactos.
Si el RDE está listo, Cloud Manager publica un nuevo cheque en el PR.
Aspecto de GitHub Enterprise:
Aspecto de GitLab:
Cómo se ve en Bitbucket:
-
Mensaje de implementación correcto.
Cuando se completa la implementación, Cloud Manager publica un mensaje de éxito en el que se resumen los artefactos implementados en el entorno de destino.
Aspecto de GitHub Enterprise:
Aspecto de GitLab:
Cómo se ve en Bitbucket:
Registros rde-logging
Al igual que otros tipos de entornos, los niveles de registro se pueden establecer modificando las configuraciones de OSGi, aunque, como se ha descrito anteriormente, el modelo de implementación para RDE implica una línea de comandos en lugar de una implementación de Cloud Manager. Consulte la documentación de registro para obtener más información sobre cómo ver, descargar e interpretar los registros.
La CLI de RDE también tiene su propio comando de registro que se utiliza para configurar rápidamente qué clases y paquetes se registran, y en qué nivel de registro. Estas configuraciones pueden verse como efímeras, ya que no modifican las propiedades OSGI en el control de versiones. Esta función se centra en rastrear registros en tiempo real, en lugar de buscar registros del pasado distante.
El siguiente ejemplo ilustra cómo rastrear el nivel de creación, con un paquete establecido en un nivel de registro de depuración y dos paquetes (separados por espacios) establecidos en un nivel de depuración de información. La salida que incluye un paquete auth está resaltada.
aio aem:rde:logs --target=author --debug=org.apache.sling --info=org.apache.sling.commons.threads.impl org.apache.sling.jcr.resource.internal.helper.jcr -H .auth.
RDECLI:UNEXPECTED_API_ERROR
al reproducir con los comandos de registro para el servicio de creación, restablezca el entorno e inténtelo de nuevo. Este error se produce si la última operación de restablecimiento fue antes de finales de mayo de 2024.code language-none |
---|
|
Consulte aio aem:rde:logs --help
para ver el conjunto completo de opciones de línea de comandos.
Las funciones incluyen lo siguiente:
- declarar niveles de registro en un nivel por paquete o clase
- personalizar el formato de salida del registro
- hasta cuatro configuraciones de registro actuales, cada una en su propio terminal
- resaltar registros específicos
Tenga en cuenta que los registros se almacenan en la memoria en el RDE y estos registros se reciclan y, por lo tanto, se descartan si no se siguen o si la red es demasiado lenta.
Restablecer el RDE reset-rde
Al restablecer el editor de texto enriquecido, se eliminan todos los códigos personalizados, las configuraciones y el contenido de las instancias de autor y publicación. Restablecer el RDE es útil cuando ha terminado de probar una función y desea devolver el entorno a un estado predeterminado antes de probar otra.
Un restablecimiento establece el RDE en la última versión de AEM disponible.
Puede restablecer el RDE usando Cloud Manager o la línea de comandos. El restablecimiento tarda unos minutos y todo el contenido y el código existentes se eliminan del editor de código.
Restablezca el RDE utilizando la línea de comandos reset-the-rde-command-line
Puede restablecer el RDE y devolverlo a un estado predeterminado ejecutando lo siguiente:
aio aem:rde:reset
Este proceso suele tardar unos minutos y genera un informe de Environment reset.
si se realiza correctamente o de Failed to reset the environment.
si hay errores. Para obtener un resultado estructurado, consulte el capítulo sobre el resultado --json
que aparece a continuación.
Utilice el comando status para comprobar si el entorno está listo de nuevo.
Restablecer el RDE en Cloud Manager reset-the-rde-cloud-manager
Puede utilizar Cloud Manager para restablecer su RDE siguiendo los pasos siguientes:
-
Inicie sesión en Cloud Manager en my.cloudmanager.adobe.com y seleccione la organización adecuada.
-
Haga clic en el programa para el que desea restablecer el RDE.
-
En la página Información general, haga clic en la pestaña Entornos en la parte superior de la pantalla.
-
También puede hacer clic en el botón Mostrar todo en la tarjeta Entornos para ir directamente a la pestaña Entornos.
-
-
Se abre la ventana Entornos y se enumeran todos los entornos del programa.
-
Haga clic en el botón de los tres puntos del RDE que desee restablecer y, a continuación, seleccione Restablecer.
-
Confirme que desea restablecer el RDE haciendo clic en Restablecer en el cuadro de diálogo.
-
Cloud Manager confirma mediante una notificación tipo banner que se ha iniciado el proceso de restablecimiento.
Una vez que se inicia el restablecimiento de RDE, normalmente se tardan unos minutos en completar y restaurar el entorno a su estado predeterminado. Puede ver el estado de restablecimiento en cualquier momento en la columna Estado de la tarjeta o ventana de Entornos.
También puede restablecer el RDE usando el botón de puntos suspensivos directamente desde la tarjeta Entornos en la página Información general.
Para obtener más información sobre cómo usar Cloud Manager para administrar sus entornos, consulte la documentación de Cloud Manager.
Comandos compatibles con la salida JSON json-commands
La mayoría de los comandos admiten el indicador global --json
, que suprime la salida de la consola y devuelve un json válido para procesarlo en los scripts. A continuación se muestran algunos comandos admitidos, con ejemplos de la salida json.
Estado status
Un RDE limpio clean-rde
$ aio aem rde status --json
code language-json |
---|
|
Un RDE con algunos paquetes instalados rde-installed-bundles
$ aio aem rde status --json
code language-json |
---|
|
Instalar install
$ aio aem rde install ~/Downloads/hotdev.demo.ui.apps.all-1.0.0-SNAPSHOT.zip --json
code language-json |
---|
|
Eliminar delete
$ aio aem rde delete com.adobe.granite.hotdev.demo-1.0.0.SNAPSHOT --json
code language-json |
---|
|
Historia history
$ aio aem rde history --json
code language-json |
---|
|
Restablecer reset
Fuego y olvido, sin esperar fire-no-wait
$ aio aem rde reset --no-wait --json
code language-json |
---|
|
Esperar a que se complete, restablecer correctamente wait-success
$ aio aem rde reset --json
code language-json |
---|
|
Esperar a la finalización, error al restablecer wait-failed
$ aio aem rde reset --json
code language-json |
---|
|
Reiniciar restart
$ aio aem rde restart --json
code language-json |
---|
|
Modos de ejecución runmodes
La configuración OSGI específica de RDE se puede aplicar utilizando sufijos en el nombre de la carpeta, como en los ejemplos siguientes:
config.rde
config.author.rde
config.publish.rde
Consulte la documentación sobre el modo de ejecución para obtener información general sobre los modos de ejecución.
dev
del paquete.Los RDE son distintos de otros entornos en los que el contenido se puede instalar en una carpeta install.rde
(o install.author.rde
o install.publish.rde
) en /apps
. Esta capacidad le permite enviar contenido a Git y enviarlo al editor de texto enriquecido (RDE) mediante las herramientas de la línea de comandos.
Rellenar con contenido populating-content
Cuando se restablece un RDE, se elimina todo el contenido y, por lo tanto, si lo desea, se debe realizar una acción explícita para añadir contenido. Como práctica recomendada, considere la posibilidad de combinar un conjunto de contenido para utilizarlo como contenido de prueba para validar o depurar funciones en el editor de experiencias visuales. Existen varias estrategias posibles para rellenar el RDE con ese contenido:
-
Sincronizar el paquete de contenido explícitamente con RDE mediante las herramientas de la línea de comandos
-
Coloque y confirme el contenido de muestra en Git dentro de una carpeta
install.rde
en/apps
y, a continuación, sincronice el paquete de contenido global con RDE mediante las herramientas de la línea de comandos. -
Use la herramienta de copia de contenido para copiar un conjunto de contenido definido desde entornos de producción, ensayo o desarrollo, o desde otro RDE.
-
Uso del Administrador de paquetes
Se encuentra limitado a 1 GB al sincronizar paquetes de contenido.
¿En qué se diferencian los RDE de los entornos de desarrollo en la nube? how-are-rds-different-from-cloud-development-environments
Aunque el RDE es similar en muchos aspectos a un entorno de desarrollo en la nube, existen algunas diferencias arquitectónicas menores que permiten una sincronización rápida del código. El mecanismo para obtener código en RDE es diferente: para RDE, se sincroniza código de un entorno de desarrollo local, mientras que para los entornos de desarrollo en la nube, se implementa código a través de Cloud Manager.
Por estos motivos, se recomienda que después de validar el código en un entorno RDE, implemente el código en un entorno de desarrollo de nube mediante la canalización que no sea de producción. Finalmente, pruebe el código antes de implementarlo con la canalización de producción.
Tenga en cuenta también las siguientes consideraciones:
- Los RDE no incluyen un nivel de previsualización
- Actualmente, los RDE no son compatibles con el canal de prelanzamiento.
¿Cuántos RDE necesito? how-many-rds-do-i-need
Hay disponible un RDE para cada solución con licencia y Adobe también ofrece RDE adicionales, con licencia para programas de Producción (que no sean de zonas protegidas).
El número de RDE necesarios depende de la composición y los procesos de una organización. El modelo más flexible es donde una organización compra un RDE dedicado para cada uno de sus desarrolladores de AEM Cloud Service. En este modelo, cada desarrollador puede probar su código en RDE sin coordinarse con otros integrantes del equipo para saber si hay un entorno RDE disponible.
En el otro extremo, un equipo con un solo RDE puede confiar en la coordinación interna para decidir qué desarrollador utiliza el entorno en un momento determinado. Este método funciona bien cuando un desarrollador alcanza un hito en la funcionalidad y necesita validar su trabajo en un entorno de nube con la flexibilidad de realizar cambios rápidos.
Un modelo intermedio es aquel en el que una organización compra varios RDE, de modo que existe una mayor probabilidad de que esté disponible un RDE no utilizado. Una estrategia podría ser asignar un RDE por equipo de depuración o función principal. Se pueden utilizar procesos internos para coordinar el uso de los entornos.
¿En qué se diferencia un AEM Forms Cloud Service RDE de otros entornos? how-are-forms-rds-different-from-cloud-development-environments
Los desarrolladores de Forms pueden utilizar el entorno de desarrollo rápido Cloud Service de AEM Forms para desarrollar Forms adaptable, flujos de trabajo y personalizaciones rápidas, como la personalización de componentes principales, integraciones con sistemas de terceros y mucho más. El entorno de desarrollo rápido (RDE) de AEM Forms Cloud Service no es compatible con las API de comunicación. Tampoco es compatible con las funciones y capacidades que requieren el documento de registro, como la generación de un documento de registro al enviar un formulario adaptable. Las siguientes funciones de AEM Forms no están disponibles en un entorno de desarrollo rápido (RDE):
- Configurar un documento de registro para un formulario adaptable
- Generar un documento de registro al enviar un formulario adaptable o con un paso del flujo de trabajo
- Enviar documento de registro como archivo adjunto con la acción de envío Correo electrónico o con el paso Correo electrónico en un flujo de trabajo
- Usar Adobe Sign en un formulario adaptable o en un paso del flujo de trabajo
- API de comunicación
Tutorial de RDE
Para obtener más información sobre RDE en AEM as a Cloud Service, vea el tutorial en vídeo que muestra cómo configurarlo, cómo utilizarlo y el ciclo de vida de desarrollo (01:25).
Solución de problemas troubleshooting
Solucionar problemas de RDE (#rde-troublehooting)
Cómo obtener la última versión de AEM para un RDE existente get-latest-aem-version
Una vez creados, los RDE se establecen en la última versión de Adobe Experience Manager (AEM) disponible. Un restablecimiento de RDE, que se puede realizar mediante Cloud Manager o el comando aio aem:rde:reset
, ciclos el RDE y lo establece en la última versión de AEM disponible.
Solucionar problemas del complemento aio RDE aio-rde-plugin-troubleshooting
Errores relacionados con permisos insuficientes insufficient-permissions
Para usar el complemento RDE, es necesario que seas miembro del perfil de producto de Desarrollador - Cloud Service de Cloud Manager. Consulte Asignar integrantes del equipo a perfiles de producto de Cloud Manager - Asignar el perfil de producto del desarrollador para obtener más información.
También puede confirmar que tiene esta función de desarrollador si inicia sesión en la consola de desarrollador ejecutando el siguiente comando:
aio cloudmanager:environment:open-developer-console
Warning: cloudmanager:* is not a aio command.
, debe instalar aio-cli-plugin-cloudmanager ejecutando el siguiente comando:code language-none |
---|
|
Compruebe que el inicio de sesión se haya completado correctamente ejecutando lo siguiente:
aio cloudmanager:list-programs
Este proceso enumera todos los programas de la organización configurada y confirma que tiene asignada la función correcta.
Usar contexto obsoleto aio-cli-plugin-cloudmanager
aio-rde-plugin-troubleshooting-deprecatedcontext
Debido al historial de aio-cli-plugin-aem-rde
, el nombre de contexto aio-cli-plugin-cloudmanager
se utilizó durante algún tiempo. El complemento RDE ahora utiliza el método IMS para administrar la información de contexto, lo que le permite almacenar el contexto de forma global o local. También puede configurar un contexto predeterminado para que se aplique automáticamente a todas las llamadas de AIO. El contexto predeterminado configurado se almacena localmente y permite a los desarrolladores realizar un seguimiento y utilizar contextos individuales y su información dentro de una carpeta. Para obtener más información, lea el ejemplo anterior para configurar un contexto local.
Los desarrolladores que usan ambos complementos, aio-cli-plugin-cloudmanager
y aio-cli-plugin-aem-rde
y desean mantener toda la información en el mismo contexto, tienen dos opciones en este momento:
Seguir usando el contexto aio-cli-plugin-cloudmanager
El contexto aún se puede utilizar. Se muestra una advertencia de obsolescencia en el complemento RDE. Esta advertencia se puede omitir utilizando el modo --quiet
. Las versiones más recientes del complemento RDE ya no ofrecen la alternativa de leer el contexto aio-cli-plugin-cloudmanager
. Para seguir usándolo, simplemente configure el contexto predeterminado en aio-cli-plugin-cloudmanager
. Consulte el ejemplo para configurar un contexto local más arriba.
Utilice también cualquier otro nombre de contexto para el complemento de Cloud Manager
Los complementos de Cloud Manager ofrecen un parámetro para definir el contexto que se va a utilizar. Todavía no admite la configuración de contexto predeterminada de IMS. Para ello, configure el complemento RDE con el ejemplo para configurar un contexto local e indique al complemento de Cloud Manager que use myContext
como --imsContextName=myContext
en cada llamada a él.