Ejecutar una transformación en la línea de comandos con Amazon Q Developer - Amazon Q Developer
Requisitos previosPaso 1: Elija el método de autenticación y añada los permisosPaso 2: Instalar la herramientaPaso 3: Cree un archivo de actualización de dependencias (opcional)Paso 4: Configurar y autenticarPaso 5: Ejecuta una transformaciónPausa o cancela una transformación

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejecutar una transformación en la línea de comandos con Amazon Q Developer

Complete estos pasos para transformar el código en la línea de comandos con la herramienta de línea de comandos Amazon Q Developer.

Requisitos previos

Antes de iniciar una transformación en la línea de comandos, se deben cumplir los siguientes requisitos previos:

Paso 1: Elija el método de autenticación y añada los permisos

Puede autenticar el IAM Identity Center para ejecutar las transformaciones en la línea de comandos. Asegúrese de tener los permisos adecuados.

nota

Las claves administradas por el cliente no son compatibles con las transformaciones que se realizan en la línea de comandos.

Agregar permisos

La identidad de IAM asociada a la suscripción de Amazon Q Developer que utilice para autenticarse debe tener permisos para realizar transformaciones en la línea de comandos. Antes de continuar, asegúrese de que su identidad de IAM tiene los permisos definidos en. Permita a los usuarios ejecutar transformaciones en la línea de comandos

Autenticarse con el Centro de Identidad de IAM mediante una suscripción a Amazon Q Developer

Para autenticarse en el IAM Identity Center, su administrador debe suscribirse a Amazon Q Developer Pro como usuario de plantilla y debe proporcionar la URL de inicio para autenticarse mediante la suscripción. Usted o su administrador pueden encontrar la URL de inicio en la consola de Amazon Q Developer. Para obtener más información, consulte, Búsqueda de la URL de inicio para usarla con Amazon Q Developer.

Para añadir los permisos necesarios, consulteAgregar permisos.

Introduce la URL de inicio enPaso 4: Configurar y autenticar.

Paso 2: Instalar la herramienta

  1. Descarga la herramienta de línea de comandos Amazon Q para realizar transformaciones y descomprímela.

    Para descargar una versión anterior de la herramienta de línea de comandos, consulteHistorial de versiones.

  2. Se recomienda configurar un entorno virtual en Python para instalar la herramienta. Para crear un entorno virtual, abra una ventana de terminal en el directorio en el que desee instalar la herramienta y ejecute:

    python -m venv qct-cli

  3. Para activar el entorno virtual, ejecute: 

    source qct-cli/bin/activate

  4. Para instalar la herramienta en la línea de comandos, ejecute el siguiente comando con la ruta en la que descomprimió la herramienta, en función de la arquitectura de la máquina:

    Linux_aarch64
    pip install <path/to/unzipped-tool>/Linux_aarch64/amzn_qct_cli-1.2.0-py3-none-any.whl
    Linux_x86_64
    pip install <path/to/unzipped-tool>/Linux_x86_64/amzn_qct_cli-1.2.0-py3-none-any.whl
    nota

    Si utiliza una versión anterior de la herramienta de línea de comandos para las transformaciones, 1.2.0 sustitúyala por la versión que descargó.

  5. Para comprobar que la herramienta está instalada, ejecute:

    which qct

Paso 3: Cree un archivo de actualización de dependencias (opcional)

Puede proporcionar a Amazon Q un archivo de actualización de dependencias, un archivo YAML que muestre las dependencias de su proyecto y las versiones a las que debe actualizarse durante una transformación. Al proporcionar un archivo de actualización de dependencias, puede especificar dependencias de terceros y propias que Amazon Q no sabría actualizar de otro modo.

Las dependencias propias se refieren a las bibliotecas, complementos y marcos que mantiene su organización y que solo están disponibles localmente o en la red privada de su organización. Amazon Q puede acceder a sus dependencias propias cuando realiza compilaciones en su entorno local. Para obtener más información, consulte Crear código en su entorno local. Las dependencias de terceros están disponibles públicamente o son dependencias de código abierto que no son exclusivas de su organización.

Puede especificar las dependencias propias que desee actualizar en un archivo YAML y Amazon Q las actualizará durante la actualización del JDK (por ejemplo, de Java 8 a 17). Puede iniciar una transformación independiente (del 17 al 17 o del 21 al 21) después de la actualización inicial del JDK para actualizar las dependencias de terceros.

Una vez que Amazon Q realice una actualización mínima de JDK, puede iniciar una transformación independiente para actualizar todas las dependencias de terceros. Como alternativa, puede especificar las dependencias de terceros y sus versiones en un archivo YAML para actualizar únicamente esas dependencias durante la transformación de la actualización de la biblioteca.

Amazon Q le pedirá que proporcione un archivo de actualización de dependencias durante la transformación. Si desea proporcionar uno, primero asegúrese de haber configurado el archivo correctamente. Los siguientes campos son obligatorios en el archivo YAML:

  • nombre: el nombre del archivo de actualización de la dependencia.

  • descripción (opcional): descripción del archivo de actualización de la dependencia y de qué transformación.

  • DependencyManagement: contiene la lista de dependencias y complementos que se deben actualizar.

  • dependencias: contiene el nombre y la versión de las bibliotecas que se van a actualizar.

  • complementos: contiene los nombres y las versiones de los complementos que se van a actualizar.

  • identificador: el nombre de la biblioteca, el complemento u otra dependencia.

  • TargetVersion: la versión de la dependencia a la que se va a actualizar.

  • versionProperty (opcional): la versión de la dependencia que estás definiendo, tal como se establece con la properties etiqueta del archivo de pom.xml tu aplicación.

  • OriginType: si la dependencia es propia o de un tercero, especificada por FIRST_PARTY o THIRD_PARTY.

A continuación se muestra un ejemplo de un archivo YAML de actualización de dependencias y la configuración necesaria para que Amazon Q lo analice:

name: dependency-upgrade
  
description: "Custom dependency version management for Java migration from JDK 8/11/17 to JDK 17/21"
  
  
dependencyManagement:
  
  dependencies:
  
    - identifier: "com.example:library1"
  
      targetVersion: "2.1.0"
  
      versionProperty: "library1.version"  # Optional
  
      originType: "FIRST_PARTY"   
  
    - identifier: "com.example:library2"
  
      targetVersion: "3.0.0"
  
      originType: "THIRD_PARTY"
  
  plugins:
  
    - identifier: "com.example.plugin"
  
      targetVersion: "1.2.0"
  
      versionProperty: "plugin.version"  # Optional
            
      originType: "THIRD_PARTY"

Paso 4: Configurar y autenticar

Antes de iniciar una transformación, debe autenticarse en el Centro de identidades de IAM y proporcionar los detalles de configuración de la transformación.

  1. Para iniciar el proceso de configuración de la transformación, ejecute el siguiente comando:

    qct configure

  2. Se le solicitará que introduzca una ruta de JDK para cada versión de Java compatible. Solo necesita especificar la ruta al JDK de la versión de origen de la aplicación Java, no de la versión de destino.

  3. A continuación, para autenticarse en el Centro de identidades de IAM, se le pedirá que introduzca la URL de inicio de su perfil de suscripción a Amazon Q Developer Pro.

    Luego, introduzca el Región de AWS lugar al que se suscribió en el siguiente formato:. us-east-1 Para obtener una lista de las regiones admitidas, consulte Regiones compatibles. Para obtener una lista de códigos de región, consulte los puntos finales regionales en la Referencia general de AWS guía.

  4. Las preferencias de configuración se guardan en un archivo configuration.ini.

Paso 5: Ejecuta una transformación

Elija el tipo de transformación que va a realizar para ver la configuración y los comandos necesarios.

nota

No apagues ni cierres la máquina local durante la transformación del código, ya que la compilación del lado del cliente requiere una conexión de red estable.

Java upgrade

Modificar el plan de transformación

Durante las actualizaciones de las versiones de Java, Amazon Q genera un plan de transformación que puede revisar antes de que comience la transformación. Tiene la opción de solicitar los siguientes cambios en el plan:

  • Qué bibliotecas actualiza Amazon Q, de la lista incluida en el plan

    • Ejemplos de indicaciones:

      • Solo actualice <dependency1><dependency2>, y <dependency5>

      • No actualice <dependency1>o <dependency2>

  • La versión de destino a la que se va a actualizar una biblioteca

    • Ejemplos de solicitudes:

      • En su lugar<dependency>, actualice a esta versión <version>

  • Qué pasos debe realizar Amazon Q

    • Ejemplos de indicaciones:

      • Complete únicamente los pasos 1 a 7

      • No ejecute los pasos 5 a 9

  • Agregue dependencias adicionales para actualizar (solo es una opción cuando se actualiza a una versión más reciente de JDK)

    • Ejemplos de indicaciones:

      • <dependency1>Actualice también a <version2>

Actualice el código Java

  1. Ejecute el siguiente comando para iniciar una transformación para una actualización de Java. <path-to-folder>Sustitúyala por la ruta a la carpeta por el código que estás transformando y <your-target-java-version> por una JAVA_17 oJAVA_21.

    qct transform --source_folder <path-to-folder>
    --target_version <your-target-java-version>

    Opciones de comando adicionales:

    • Si está especificando las dependencias que desea actualizar, añada la --dependency_upgrade_file opción con la ruta al archivo de actualización de dependencias.

    • Si no desea revisar o actualizar el plan de transformación, añada la --no-interactive marca a su comando. Amazon Q no te pedirá comentarios sobre el plan y no tendrás la oportunidad de solicitar cambios.

  2. Tu versión de Maven se verifica antes de que comience la transformación. Si tiene al menos la versión mínima compatible, verá el siguiente resultado: 

    Running command: mvn --version at: path/to/current/directory 
Your Maven version is supported for transformations.

    Si no tienes una versión compatible de Maven, debes actualizarla para continuar. Para obtener más información, consulte la Requisitos previos.

  3. Si no has añadido la --no-interactive marca, Amazon Q te pedirá que envíes tu opinión sobre el plan de transformación. Puedes explicar los cambios que deseas realizar en inglés y Amazon Q actualizará el plan si puede admitir los cambios que solicites.

  4. Amazon Q inicia la transformación. Generará actualizaciones de estado a lo largo de la transformación. Cuando se completa, Amazon Q proporciona la ruta en la que se generan los resultados de la transformación, los registros y los archivos de configuración.

    El código actualizado se asignará a la nueva sucursal que Amazon Q creó. Amazon Q confirmará el código en una o varias confirmaciones, en función de la selección que hayas hecho al ejecutar la ejecuciónqct configure.

  5. Si va a ejecutar otra transformación después de actualizar su versión de Java, inicie la segunda transformación en la misma rama en la que realizó los cambios de la primera transformación.

SQL conversion

Antes de empezar, asegúrate de haber leído Conversión de SQL embebido en aplicaciones Java con Amazon Q Developer para entender los requisitos previos de este tipo de transformación.

  1. Para convertir el SQL incrustado, primero debe crear un archivo YAML que contenga la ruta al archivo de metadatos del esquema de la conversión de AWS DMS esquemas.

    El siguiente es el formato obligatorio del archivo: 

    schema_conv_metadata_path: <path-to-metadata-zip-file>

  2. Ejecute el siguiente comando para iniciar una transformación para una conversión a SQL. <path-to-folder>Sustitúyala por la ruta a la carpeta por el código que estás transformando y <path-to-sql-config-file> por la ruta al archivo YAML que creaste en el paso 1.

    qct transform --source_folder <path-to-folder>
    --sql_conversion_config_file <path-to-sql-config-file>

  3. Si Amazon Q encuentra varios esquemas en el archivo de metadatos del esquema, detendrá la transformación y proporcionará una lista de los esquemas detectados. Elija el esquema que desee utilizar para la conversión de SQL y, a continuación, añada un campo nuevo schema: <schema-name> al archivo YAML.

  4. Amazon Q inicia la transformación. Generará actualizaciones de estado a lo largo de la transformación. Cuando se completa, Amazon Q proporciona la ruta en la que se generan los resultados de la transformación, los registros y los archivos de configuración.

    El código actualizado se asignará a la nueva sucursal que Amazon Q creó.

Pausa o cancela una transformación

Puede optar por pausar o cancelar su trabajo de transformación actual. Puede pausar un trabajo de transformación durante un máximo de 12 horas antes de poder reanudarlo de nuevo.

Para pausar o cancelar un trabajo de transformación de código

  1. En su terminal CLI, presione Ctrl+C en el teclado.

  2. Seleccione si desea pausar o cancelar la transformación.

    • Introduzca 1 si desea pausar el trabajo de transformación de código. Puede reanudar el trabajo en 12 horas para continuar con la transformación del código mediante el siguiente comando QCT:. `qct transform --source_folder=≤/Path/Given/Originally/To/QCT>`

    • Introduzca 2 si desea cancelar el trabajo de transformación de código.