Integra Google Cloud Deploy en tu sistema de CI

En este documento, se describe cómo invocar la canalización de entrega de Google Cloud Deploy desde el sistema de integración continua (CI).

Integrar Google Cloud Deploy en tu sistema de CI es tan simple como agregar una llamada a Google Cloud Deploygcloud CLI. Esta llamada ocurre en el punto de tu canalización de CI en el que tu aplicación está lista para implementarse.

Antes de comenzar

En las instrucciones de esta página, se supone que ya cumples con las siguientes condiciones:

Llama a Google Cloud Deploy desde tu canalización de CI

Con el siguiente comando, se crea una versión nueva que invoca una instancia de canalización de entrega:

gcloud deploy releases create RELEASE_NAME \
  --delivery-pipeline=PIPELINE_NAME \
  --region=REGION
  --annotations=[KEY=VALUE,...]
  --images=[IMAGE_LIST]

En el ejemplo anterior, se ilustra lo siguiente:

  • RELEASE_NAME

    es el nombre que asignas a esta versión. Es obligatorio ingresar este valor.

  • PIPELINE_NAME

    Es el nombre de tu canalización de entrega registrada. Es obligatorio ingresar este valor.

  • REGION

    Es la región en la que crearás esta versión. No es necesario que la región sea la misma en la que implementas tu aplicación.

  • [KEY=VALUE,...]

    es una lista opcional de una o más anotaciones para aplicar a la versión, en forma de pares clave-valor.

    Puedes usar anotaciones para realizar un seguimiento de la procedencia de la actualización, por ejemplo, si pasas una anotación como commitId=0065ca0. Todas las anotaciones de la versión se muestran cuando list o get la versión, y se muestran con la versión en Google Cloud Console, para que también puedas ver la procedencia de la versión allí.

  • [IMAGE_LIST]

    es una lista separada por comas de reemplazos de imágenes, nombres y rutas. Por ejemplo: --images=image1=path/to/image1:v1@sha256:45db24,image2=path/to/image2:v1@sha256:55xy18

    Este valor no es obligatorio si pasas --build-artifacts, que identifica un archivo de salida de artefactos de compilación de Skaffold.

    Cuando Google Cloud Deploy procesa el manifiesto, el nombre de la imagen en el manifiesto no procesado se reemplaza por la referencia de la imagen completa en el manifiesto procesado. Es decir, image1, en este ejemplo, está en el manifiesto sin procesar y se reemplaza en el manifiesto procesado con path/to/image1:v1@sha256:45db24.

Ejemplo en el que se usa la referencia directa de imagen

Con el siguiente comando, se crea una versión nueva y se pasa una referencia de imagen directamente, en lugar de un archivo de artefactos de compilación:

gcloud deploy releases create my-release \
  --delivery-pipeline=web-app \
  --region=us-central1
  --images=image1=path/to/image1:v1@sha256:45db24

Artefactos de compilación frente a imágenes

En el comando gcloud deploy releases create, puedes pasar un conjunto de referencias de imágenes o una referencia de archivo de artefactos de compilación.

  • Usa --images=[NAME=TAG,...] para hacer referencia a una o más imágenes de contenedores individuales.

    Este valor es una referencia a una colección de nombres de imágenes individuales para reemplazar los rutas de acceso completas de las imágenes. Por ejemplo:

    gcloud deploy releases create my-release --images=image1=path/to/image1:v1@sha256:45db24

  • Usa --build-artifacts= para que apunte a un archivo de salida de artefactos de compilación de Skaffold.

Ejemplos de Cloud Build, pasando un archivo de artefactos de compilación

Ejemplo de compilación de Docker

En el siguiente archivo YAML, se muestra Cloud Build para un envío de una imagen de compilación de Docker y, por lo general, crea una versión de implementación de Google Cloud.

En este ejemplo, se compila y se envía una imagen a un repositorio de artefactos y se construye un comando para crear una versión, con un nombre de versión basado en el SHA de confirmación corto. Este ejemplo se debe usar como un activador de SCM de Cloud Build porque se basa en la variable $COMMIT_SHA.

En este ejemplo, se envía una imagen a una etiqueta de Docker que es igual al hash de confirmación del repositorio de origen. Luego, se hace referencia al mismo hash de confirmación, como una etiqueta de Docker, desde los argumentos del comando de actualización.

# Build and tag using commit sha
- name: 'gcr.io/cloud-builders/docker'
  args: ['build', '.', '-t', 'REPO_LOCATION/$PROJECT_ID/IMAGE_NAME:${COMMIT_SHA}', '-f', 'Dockerfile']
# Push the container image
- name: 'gcr.io/cloud-builders/docker'
  args: ['push', 'REPO_LOCATION/$PROJECT_ID/IMAGE_NAME:${COMMIT_SHA}']
# Create release in Google Cloud Deploy
- name: gcr.io/google.com/cloudsdktool/cloud-sdk
  entrypoint: gcloud
  args:
    [
      "deploy", "releases", "create", "rel-${SHORT_SHA}",
      "--delivery-pipeline", "PIPELINE_NAME",
      "--region", "us-central1",
      "--annotations", "commitId=${REVISION_ID}",
      "--images", "IMAGE_NAME=REPO_LOCATION/$PROJECT_ID/IMAGE_NAME:${COMMIT_SHA}"
    ]

Ten en cuenta que el nombre de la imagen al final de este ejemplo, "--images", "IMAGE_NAME= se sustituye en el manifiesto procesado con la referencia de la imagen completa.

Ejemplo de configuración de Cloud Build con Skaffold

El siguiente archivo YAML es el contenido de una configuración de compilación de Cloud Build que incluye una llamada a Google Cloud Deploy para crear una versión, con un nombre de versión basado en la fecha. En este ejemplo, también se muestra Skaffold usado para la compilación.

- name: gcr.io/k8s-skaffold/skaffold
  args:
    - skaffold
    - build
    - '--interactive=false'
    - '--file-output=/workspace/artifacts.json'
- name: gcr.io/google.com/cloudsdktool/cloud-sdk
  entrypoint: gcloud
  args:
    [
      "deploy", "releases", "create", "rel-${SHORT_SHA}",
      "--delivery-pipeline", "PIPELINE_NAME",
      "--region", "us-central1",
      "--annotations", "commitId=${REVISION_ID}",
      "--build-artifacts", "/workspace/artifacts.json"
    ]

Usa anotaciones para realizar un seguimiento de la procedencia de la versión

La marca --annotations= te permite aplicar uno o más pares clave-valor arbitrarios a la versión que crea este comando. Deberías agregar esta marca al comando gcloud deploy releases create.

Por ejemplo, puedes usar los siguientes pares clave-valor para hacer un seguimiento de la fuente de la imagen que se implementará.

Por ejemplo:

gcloud deploy releases create web-app-1029rel \
  --delivery-pipeline=web-app \
  --region=us-central1
  --annotations=commitId=0065ca0,author=user@company.com
  --images=image1=path/to/image1:v1@sha256:45db24

También puedes crear una anotación cuyo valor sea la URL que apunta a la solicitud de extracción, por ejemplo. Para obtener más información, consulta Usa etiquetas y anotaciones con Google Cloud Deploy.