Compila, prueba y aloja en contenedores aplicaciones de Java

En esta página, se explica cómo usar Cloud Build para compilar, probar y alojar en contenedores aplicaciones basadas en Java, subir tus imágenes de contenedor a Artifact Registry y generar procedencia de compilación.

Antes de comenzar

• Familiarízate con la creación de aplicaciones basadas en Java.
• Ten listo tu proyecto de Java, incluido un Dockerfile.
• Tener un repositorio de Docker en Artifact Registry o crea uno nuevo.
• Familiarízate con la escritura de un archivo de configuración de Cloud Build.
• Para ejecutar los comandos de gcloud en esta página, instala Google Cloud CLI.

Usa las imágenes de maven o gradle

Puedes configurar Cloud Build para compilar aplicaciones de Java mediante la imagen de maven o la imagen de gradle de Docker Hub.

Para ejecutar tus tareas en las imágenes de maven o gradle, especifica la URL de la imagen y la versión etiquetada de la imagen en el campo name del archivo de configuración de compilación. Si no especificas la etiqueta de imagen, Cloud Build usa la imagen latest de forma predeterminada. Cloud Build inicia la imagen especificada en name mediante el punto de entrada predeterminado de la imagen. Para anular el punto de entrada predeterminado y para invocar maven o gradle como un punto de entrada, especifica mvn o gradle en el campo entrypoint.

En el siguiente archivo de configuración de compilación, se especifica el entrypoint de las imágenes de maven o gradle y se muestra la versión de la herramienta de compilación:

maven

  steps:
  - name: maven:3.3-jdk-8
    entrypoint: mvn
    args: ['--version']

gradle

  steps:
  - name: gradle:5.6.2-jdk8
    entrypoint: gradle
    args: ['--version']

Configura compilaciones de Java

1. En el directorio raíz del proyecto, crea un archivo de configuración de compilación llamado cloudbuild.yaml.

2. Ejecuta pruebas: maven y gradle proporcionan maven test y gradle test, que descargan dependencias, compilan las aplicaciones y ejecutan las pruebas especificadas en el código fuente. En el campo args de un paso de compilación, se toma una lista de argumentos y se los pasa a la imagen a la que se hace referencia en el campo name.

   En el archivo de configuración de compilación, agrega test al campo args para invocar test dentro de maven y gradle:

   maven

    steps:
    - name: maven:3.3-jdk-8
      entrypoint: mvn
      args: ['test']
   

   gradle

    steps:
    - name: gradle:5.6.2-jdk8
      entrypoint: gradle
      args: ['test']
   

3. Empaqueta la aplicación: A fin de empaquetar la aplicación en un archivo JAR para la imagen de maven, especifica el comando package en el campo args. El comando package compila un archivo JAR en /workspace/target/.

   Con el fin de empaquetar la aplicación en un archivo JAR para la imagen de gradle, especifica el comando assemble en el campo args. El comando assemble compila un archivo JAR en workspace/build/libs.

   En el siguiente paso de compilación, se empaqueta la aplicación de Java:

   maven

    steps:
    - name: maven:3.3-jdk-8
      entrypoint: mvn
      args: ['package','-Dmaven.test.skip=true']
   

   Nota: El comando package vuelve a ejecutar las pruebas. Si agregas -Dmaven.test.skip=true al campo args, se omitirán las pruebas.

   gradle

   steps:
   - name: gradle:5.6.2-jdk8
     entrypoint: gradle
     args: ['assemble']
   

4. Crea contenedores en la aplicación: Cloud Build proporciona una imagen de Docker precompilada que puedes usar para alojar tu aplicación de Java en contenedores. Para crear contenedores en tu aplicación de Java, sigue estos pasos en tu archivo de configuración de compilación:

   • Agrega un campo name y especifica la imagen precompilada de Docker en gcr.io/cloud-builders/docker.
   • Agrega un campo args y especifica los argumentos build, incluido el nombre de la imagen de contenedor que se compilará y la ruta de acceso a tu artefacto de compilación.
   • Agrega un campo images para enviar la imagen de contenedor compilada a Artifact Registry y generar información de origen de la compilación. Si no usas el campo images, Cloud Build no registrará la información de origen. Por ejemplo, si usas un paso de compilación docker push para subir imágenes a Artifact Registry, tu compilación no tendrá información de origen asociada.

   En el siguiente paso de compilación, se organiza tu aplicación en contenedores, se envía la imagen de contenedor a Artifact Registry y se genera información sobre la procedencia de la compilación.

   maven

   steps:
   - name: gcr.io/cloud-builders/docker
     args: ['build', '-t', 'location-docker.pkg.dev/project-id/repository/image', '--build-arg=JAR_FILE=target/build-artifact', '.']
   images: ['location-docker.pkg.dev/project-id/repository/image']
   

   gradle

   steps:
   - name: gcr.io/cloud-builders/docker
     args: ['build', '-t', 'location-docker.pkg.dev/project-id/repository/image', '--build-arg=JAR_FILE=build/libs/build-artifact', '.']
   images: ['location-docker.pkg.dev/project-id/repository/image']
   

   Donde:

   • location: Es la ubicación regional o multirregional para el repositorio.
   • project-id: Es el ID de tu proyecto de Google Cloud.
   • repository: Es el nombre de tu repositorio de Artifact Registry.
   • image: El nombre de tu imagen de contenedor
   • build-artifact: El nombre de tu archivo JAR creado a partir del paso de compilación.
   Nota: Antes de crear contenedores en la aplicación mediante el paso mencionado con anterioridad, asegúrate de que tu código fuente incluya un Dockerfile. Para obtener más información sobre cómo compilar imágenes de contenedor, consulta Compila imágenes de contenedor.

5. Opcional: Habilita la procedencia para las compilaciones regionales

   Si usas una compilación regional, agrega el campo requestedVerifyOption a options en tu archivo de configuración de compilación. Establece el valor en VERIFIED para habilitar la generación de metadatos de origen. Si no agregas requestedVerifyOption: VERIFIED, Cloud Build solo genera la procedencia de las compilaciones globales.

   options:
     requestedVerifyOption: VERIFIED
   

6. Comienza a compilar: Cuando tengas listo el archivo de configuración de compilación, ingresa el siguiente comando en la terminal para comenzar la compilación:

   gcloud builds submit --region=REGION --config config-file-path source-directory
   

   Donde:

   • config-file-path: Es la ruta de acceso a tu archivo de configuración de compilación. En este ejemplo, el archivo de configuración de compilación se llama cloudbuild.yaml.
   • source-directory: La ruta de acceso o la URL al código fuente.
   • REGION: Es una de las regiones de compilación compatibles.

   Si no se especifica config-file-path ni source-directory en el comando gcloud builds submit, Cloud Build da por hecho que el archivo de configuración y el código fuente están en el directorio de trabajo actual.

   Una vez que se complete la compilación, podrás ver los detalles del repositorio en Artifact Registry.

   También puedes ver los metadatos de origen de la compilación y validar la fuente para ayudar a proteger la cadena de suministro de software.

Ejemplos de código

Estos son algunos repositorios de ejemplo que puedes usar a fin de compilar apps de Java; contienen una aplicación de muestra y un archivo de configuración de compilación para compilar y probar dicha aplicación:

• maven-example: Es una app de Java y un archivo de configuración de compilación de ejemplo para compilar y probar la aplicación con mvn.
• gradle-example: Es una app de Java y un archivo de configuración de compilación de ejemplo para compilar y probar la aplicación con gradle.

¿Qué sigue?

• Aprende a ver resultados de compilación.
• Aprende a proteger compilaciones.
• Aprende a compilar aplicaciones de Java independientes.
• Obtén más información sobre cómo implementar una aplicación en Cloud Run.
• Obtén más información sobre cómo implementar una aplicación en GKE.
• Obtén más información para solucionar errores de compilación.