Integrazione di Cloud Deploy con il tuo sistema CI

Questo documento descrive come richiamare la pipeline di distribuzione di Cloud Deploy dal sistema di integrazione continua (CI).

L'integrazione di Cloud Deploy con il sistema CI è semplice come aggiungere una chiamata a gcloud CLI di Cloud Deploy. Questa chiamata si verifica nel punto della pipeline CI in cui l'applicazione è pronta per il deployment.

Prima di iniziare

Le istruzioni riportate in questa pagina presuppongono che tu soddisfi già le seguenti condizioni:

Hai abilitato le API applicabili
Hai definito e registrato almeno una pipeline di distribuzione con Cloud Deploy.
Hai definito almeno una destinazione, e la pipeline di distribuzione fa riferimento a questa destinazione.

Chiamare Cloud Deploy dalla pipeline CI

Il comando seguente crea una nuova release, richiamando quindi un'istanza della pipeline di distribuzione:

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

Dove...

RELEASE_NAME

è un nome che assegni a questa release. Questo valore è obbligatorio.

Puoi specificare nomi di release dinamici includendo '$DATE' o '$TIME' o entrambi. Ad esempio, se chiami questo comando alle 15:07 UTC, 'rel-$TIME' viene risolto in rel-1507. '$DATE' e '$TIME' devono essere racchiusi tra virgolette singole.
PIPELINE_NAME

è il nome della pipeline di distribuzione registrata. Questo valore è obbligatorio.
REGION

è la regione in cui stai creando questa release. La regione non deve essere la stessa in cui alla fine esegui il deployment dell'applicazione.
[KEY=VALUE,...]

è un elenco facoltativo di una o più annotazioni da applicare alla release, sotto forma di coppie chiave-valore.

Puoi utilizzare le annotazioni per monitorare la provenienza della release, ad esempio passando un'annotazione come commitId=0065ca0. Tutte le annotazioni sulla release vengono restituite quando list o get la release e vengono visualizzate con la release nella Google Cloud console, in modo da poter visualizzare anche la provenienza della release.
[IMAGE_LIST]

è un elenco separato da virgole di sostituzioni da nome immagine a percorso immagine. Ad esempio: --images=image1=path/to/image1:v1@sha256:45db24,image2=path/to/image2:v1@sha256:55xy18.

Questo valore non è obbligatorio se passi --build-artifacts, che identifica un file di output degli artefatti di build di Skaffold.

Quando Cloud Deploy esegue il rendering del manifest, il nome dell'immagine nel manifest non sottoposto a rendering viene sostituito con il riferimento completo all'immagine nel manifest sottoposto a rendering. Ovvero, image1, in questo esempio, si trova nel manifest non sottoposto a rendering e viene sostituito nel manifest sottoposto a rendering con path/to/image1:v1@sha256:45db24.

Esempio che utilizza il riferimento diretto all'immagine

Il comando seguente crea una nuova release, passando un riferimento all'immagine direttamente, anziché un file di artefatti di build:

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

In questo esempio, my-release è il nome della release. Se vuoi generare un nome di release in base alla data o all'ora, puoi includere '$DATE' o 'TIME' o entrambi. L'ora è l'ora UTC della macchina in cui chiami il comando. '$DATE' e '$TIME' devono essere racchiusi tra virgolette singole.

Ecco un esempio:

gcloud deploy releases create rel-'$DATE'-'$TIME' \
  --delivery-pipeline=web-app \
  --region=us-central1 \
  --images=image1=path/to/image1:v1@sha256:45db24

In questo esempio, il comando genera un nome di release con il prefisso rel-, più la data e l'ora, ad esempio: rel-20220131-1507.

È anche comune utilizzare lo SHA di Git in un nome di release. Consulta gli esempi di Cloud Build e Docker in questo documento.

Artefatti di build rispetto alle immagini

Nel comando gcloud deploy releases create, puoi passare un insieme di riferimenti alle immagini o un riferimento a un file di artefatti di build.

Utilizza --images=[NAME=TAG,...] per fare riferimento a una o più immagini container singole.

Questo valore è un riferimento a una raccolta di sostituzioni da nome immagine a percorso completo dell'immagine. Ecco un esempio:

gcloud deploy releases create my-release --images=image1=path/to/image1:v1@sha256:45db24
Utilizza --build-artifacts= per puntare a un file di output degli artefatti di build di Skaffold.

Esempi di Cloud Build, passaggio di un file di artefatti di build

Esempio di build di Docker

Il seguente file YAML mostra Cloud Build per un build Docker push dell'immagine e, in ultima analisi, crea una release di Cloud Deploy.

Questo esempio crea ed esegue il push di un'immagine in un repository di artefatti e crea un comando per creare una release, con un nome di release basato sullo SHA di commit breve. Questo esempio deve essere utilizzato come trigger SCM di Cloud Build perché si basa sulla variabile $COMMIT_SHA.

Questo esempio esegue il push di un'immagine in un tag Docker uguale all'hash di commit del repository di origine. Poi, lo stesso hash di commit, come tag Docker, viene fatto riferimento dagli argomenti del comando di release.

steps:
# 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}"
    ]

Tieni presente che il nome dell'immagine alla fine di questo esempio, "--images", "IMAGE_NAME= viene sostituito nel manifest sottoposto a rendering con il riferimento completo all'immagine.

Un esempio di configurazione di compilazione di Cloud Build che utilizza Skaffold

Il seguente file YAML è il contenuto di una configurazione di compilazione di Cloud Build che include una chiamata a Cloud Deploy per creare una release, con un nome di release basato sulla data. Questo esempio mostra anche Skaffold utilizzato per la build.

steps:
- 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"
    ]

Connettere GitHub Actions a Cloud Deploy

Se utilizzi GitHub Actions per l'integrazione continua o altre attività correlate alla distribuzione del software, puoi connetterti a Cloud Deploy per la distribuzione continua utilizzando l'azione GitHub create-cloud-deploy-release.

Connettere GitLab a Cloud Deploy

Se utilizzi GitLab per l'integrazione continua, puoi utilizzare il componente GitLab Cloud Deploy create-cloud-deploy-release per creare una release di Cloud Deploy.

Puoi anche provare il tutorial end-to-end per l'utilizzo di GitLab con Google Cloud.

Utilizzare le annotazioni per monitorare la provenienza della release

Il flag --annotations= consente di applicare una o più coppie chiave-valore arbitrarie alla release creata da questo comando. Devi aggiungere questo flag al comando gcloud deploy releases create.

Ad esempio, puoi utilizzare le seguenti coppie chiave-valore per monitorare l'origine dell'immagine di cui eseguire il deployment.