Invia una build tramite interfaccia a riga di comando e API

Questa pagina descrive come avviare manualmente una build in Cloud Build utilizzando Google Cloud CLI e l'API Cloud Build.

Prima di iniziare

  • Se vuoi utilizzare gli esempi di riga di comando di questa guida, installa Google Cloud CLI.
  • Per creare utilizzando la configurazione di compilazione di Cloud Build, crea un file di configurazione di compilazione.
  • Per creare utilizzando un Dockerfile, tieni a portata di mano il tuo Dockerfile.
  • Se la build richiede codice sorgente, tieni a portata di mano il codice sorgente.

Autorizzazioni IAM richieste

Per istruzioni sulla concessione dei ruoli IAM, consulta Configurare l'accesso alle risorse di Cloud Build.

Esecuzione delle build

Puoi specificare l'origine della build utilizzando il campo Origine build. Il campo Origine build è uno dei seguenti: storage_source, repo_source, git_source e connected_repository.

Invia build con storage_source

gcloud

Utilizzo di un Dockerfile:

Dockerfile contiene tutte le informazioni necessarie per creare un'immagine Docker utilizzando Cloud Build.

Per eseguire una richiesta di build utilizzando Dockerfile, esegui questo comando dalla directory contenente il codice dell'applicazione, Dockerfile ed eventuali altri asset:

gcloud builds submit --region=us-west2 --tag gcr.io/PROJECT_ID/IMAGE_NAME .

Dove:

  • PROJECT_ID è il nome del tuo progetto Google Cloud.
  • IMAGE_NAME è l'immagine da creare.
  • . specifica che il codice sorgente si trova nella directory di lavoro corrente.

Il nome completo dell'immagine da creare è gcr.ioPROJECT_ID/IMAGE_NAME. Le immagini di cui è stato eseguito il push su Container Registry utilizzano il formato del nome del Registro di sistema.

Il comando gcloud builds submit:

  • Comprime il codice dell'applicazione, Dockerfile, e qualsiasi altro asset nella directory corrente, come indicato da .;
  • carica i file in un bucket Cloud Storage;
  • avvia una build nella posizione us-west2 utilizzando i file caricati come input;
  • tagga l'immagine utilizzando il nome fornito
  • esegue il push dell'immagine creata in Container Registry.

Man mano che la build avanza, il relativo output viene visualizzato nella shell o nella finestra del terminale. Al termine della build, dovresti vedere un output simile al seguente:

    DONE
    ---------------------------------------------------------------------------------
    ID                                    CREATE_TIME                DURATION STATUS
    $BUILD_ID                             2023-10-28T15:21:18+00:00  12S      SUCCESS

dove $BUILD_ID è l'identificatore univoco della build.

Utilizzo del file di configurazione della build di Cloud Build:

Per inviare una build utilizzando la configurazione della build, esegui questo comando:

    gcloud builds submit --region=us-west2 --config BUILD_CONFIG SOURCE

Dove:

  • BUILD_CONFIG è il percorso del file di configurazione della build.
  • SOURCE è il percorso o il codice sorgente dell'URL.

Quando esegui gcloud builds submit per la prima volta in un progetto Google Cloud, Cloud Build crea un bucket Cloud Storage denominato [YOUR_PROJECT_NAME]_cloudbuild in quel progetto. Cloud Build usa questo bucket per archiviare qualsiasi codice sorgente che potresti usare per le tue build. Cloud Build non elimina automaticamente i contenuti di questo bucket. Per eliminare gli oggetti che non utilizzi più per le build, puoi impostare la configurazione del ciclo di vita nel bucket o eliminare manualmente gli oggetti.

Il comando seguente mostra come inviare una richiesta di build cloudbuild.yaml utilizzando il codice sorgente archiviato in un bucket Cloud Storage.

    gcloud builds submit --region=us-west2 --config cloudbuild.yaml \
        gs://BUCKET/SOURCE.tar.gz

Dove:

  • BUCKET è il nome del bucket in Cloud Storage contenente il codice sorgente da creare.
  • SOURCE è il nome del tuo file di codice sorgente compresso.

Puoi utilizzare . per specificare che il codice sorgente si trova nella directory di lavoro corrente:

    gcloud builds submit --region=us-west2 --config=cloudbuild.yaml .

API

Per inviare la richiesta di build utilizzando curl:

  1. Crea un file denominato request.json con il seguente contenuto:

    {
    "source": {
        "storageSource": {
            "bucket": "BUCKET",
            "object": "SOURCE.tar.gz"
        }
    },
    "steps": [{
        "name": "gcr.io/cloud-builders/docker",
        "args": [
            "build",
            "-t",
            "gcr.io/PROJECT_ID/IMAGE_NAME",
            "."
        ]
    }],
    "images": [
        "gcr.io/PROJECT_ID/IMAGE_NAME"
    ]
}

    Dove:

    • BUCKET è il nome del bucket Cloud Storage che contiene il codice sorgente da creare.
    • SOURCE è il nome del tuo file di codice sorgente compresso.
    • IMAGE_NAME è il nome dell'immagine da creare.

    In questa richiesta di build, Cloud Build chiama il passaggio di build docker con gli argomenti build -t gcr.io/$PROJECT_ID/IMAGE-NAME ..

    Il nome completo dell'immagine da creare è gcr.io/$PROJECT_ID/IMAGE_NAME.

    Le immagini di cui è stato eseguito il push su Container Registry utilizzano il formato del nome del Registro di sistema.

  2. Esegui questo comando dove PROJECT_ID è il tuo ID progetto Google Cloud e REGION è una delle regioni supportate:

    curl -X POST -T request.json -H "Authorization: Bearer $(gcloud config config-helper \
    --format='value(credential.access_token)')" \
    https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/builds

    In questo comando, curl invia request.json in una chiamata POST all'endpoint builds per il metodo API projects.builds.create.

    Il comando visualizza i dettagli della build nella shell o nella finestra del terminale. L'output è una risposta JSON e appare simile al seguente:

        {
        "name": "operations/build/$PROJECT-ID/NmZhZW...",
        "metadata": {
            "@type": "type.googleapis.com/google.devtools.cloudbuild.v1.BuildOperationMetadata",
            "build": {
                "id": $BUILD-ID,
                "status": "QUEUED",
                "source": {
                    "storageSource": {
                        "bucket": "BUCKET",
                        "object": "SOURCE.tar.gz"
                    }
                },
                "createTime": "2017-05-12T18:58:07.341526Z",
                "steps": [
                {
                    "name": "gcr.io/cloud-builders/docker",
                    "args": [
                        "build",
                        "-t",
                        "gcr.io/PROJECT_ID/IMAGE_NAME",
                        "."
                    ]
                }
                ],
                "timeout": "600s",
                "images": [
                    "gcr.io/$PROJECT_ID/IMAGE_NAME"
                ],
                "projectId": $PROJECT-ID,
                "logsBucket": "gs://...",
                "sourceProvenance": {
                    "resolvedStorageSource": {
                        "bucket": "BUCKET",
                        "object": "SOURCE.tar.gz"
                        "generation": "..."
                    }
                },
                "logUrl": "https://console.cloud.google.com/cloud-build/builds/...?project=$PROJECT_ID"
            }
        }
    }

    La risposta JSON viene modellata utilizzando la risorsa Operation nell'API Cloud Build. Il campo metadata è modellato utilizzando la risorsa Build. Lo stato QUEUED indica che la build è in attesa di esecuzione.

Invia build con connected_repository

gcloud

Per eseguire una richiesta di build con origine build da una risorsa repository di seconda generazione, esegui questo comando:

gcloud builds submit REPOSITORY --revision=REVISION --config=BUILD_CONFIG --region=us-west2

Dove:

  • REPOSITORY è il nome del repository di Google Cloud Build di 2a generazione, nel formato projects/*/locations/*/connections/*repositories/*.
  • REVISION è la revisione da recuperare dal repository Git, ad esempio un ramo, un tag, una SHA del commit o qualsiasi riferimento Git.
  • BUILD_CONFIG è il percorso del file di configurazione della build.

Man mano che la build avanza, il relativo output viene visualizzato nella shell o nella finestra del terminale. Al termine della build, dovresti vedere un output simile al seguente:

    DONE
    ---------------------------------------------------------------------------------
    ID                                    CREATE_TIME                DURATION STATUS
    $BUILD_ID                             2023-10-28T15:21:18+00:00  12S      SUCCESS

dove $BUILD_ID è l'identificatore univoco della build.

gcloudignore: quando includi il codice sorgente per la build, il comando riportato sopra carica tutti i file nella directory specificata in Google Cloud Platform per la creazione. Se vuoi escludere determinati file nella directory, puoi includere un file denominato .gcloudignore nella directory di caricamento di primo livello. I file specificati verranno ignorati. Se nella directory di caricamento di primo livello non è presente alcun file .gcloudignore, ma un file .gitignore lo è, gcloud CLI genererà un file .gcloudignore compatibile con Git che rispetti i tuoi file .gitignore. Per saperne di più, consulta la documentazione di gcloudignore.

Se non hai codice sorgente da passare alla build, utilizza il flag --no-source, dove BUILD_CONFIG è il percorso del file di configurazione della build:

    gcloud builds submit --region=us-west2 --config=BUILD_CONFIG --no-source

API

Per inviare la richiesta di build utilizzando curl:

  1. Crea un file denominato request.json con il seguente contenuto:

    {
    "source": {
        "connectedRepository": {
            "repository": "REPOSITORY",
            "revision": "REVISION"
        }
    },
    "steps": [{
        "name": "gcr.io/cloud-builders/docker",
        "args": [
            "build",
            "-t",
            "gcr.io/PROJECT_ID/IMAGE_NAME",
            "."
        ]
    }],
    "images": [
        "gcr.io/PROJECT_ID/IMAGE_NAME"
    ]
}

    Dove:

    • REPOSITORY è il nome del repository di Google Cloud Build di 2a generazione, nel formato projects/*/locations/*/connections/*repositories/*.
    • REVISION è la revisione da recuperare dal repository Git, ad esempio un ramo, un tag, una SHA del commit o qualsiasi riferimento Git.
    • IMAGE_NAME è il nome dell'immagine da creare.

    In questa richiesta di build, Cloud Build chiama il passaggio di build docker con gli argomenti build -t gcr.io/PROJECT_ID/IMAGE_NAME ..

    Il nome completo dell'immagine da creare è gcr.io/PROJECT_ID/IMAGE_NAME. Le immagini di cui è stato eseguito il push su Container Registry utilizzano il formato del nome del Registro di sistema.

  2. Esegui questo comando dove PROJECT_ID è il tuo ID progetto Google Cloud e REGION è una delle regioni supportate:

    curl -X POST -T request.json -H "Authorization: Bearer $(gcloud config config-helper \
    --format='value(credential.access_token)')" \
    https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/builds

    In questo comando, curl invia request.json in una chiamata POST all'endpoint builds per il metodo API projects.builds.create.

    Il comando visualizza i dettagli della build nella shell o nella finestra del terminale. L'output è una risposta JSON e appare simile al seguente:

        {
        "name": "operations/build/$PROJECT-ID/NmZhZW...",
        "metadata": {
            "@type": "type.googleapis.com/google.devtools.cloudbuild.v1.BuildOperationMetadata",
            "build": {
                "id": $BUILD-ID,
                "status": "QUEUED",
                "source": {
                    "connectedRepository": {
                        "repository": "REPOSITORY",
                        "revision": "REVISION"
                    }
                },
                "createTime": "2017-05-12T18:58:07.341526Z",
                "steps": [
                {
                    "name": "gcr.io/cloud-builders/docker",
                    "args": [
                        "build",
                        "-t",
                        "gcr.io/PROJECT_ID/IMAGE_NAME",
                        "."
                    ]
                }
                ],
                "timeout": "600s",
                "images": [
                    "gcr.io/PROJECT_ID/IMAGE_NAME"
                ],
                "projectId": PROJECT_ID,
                "logsBucket": "gs://...",
                "sourceProvenance": {
                    "resolvedConnectedRepository": {
                        "repository": "REPOSITORY",
                        "revision": "REVISION.tar.gz"
                        "generation": "..."
                    }
                },
                "logUrl": "https://console.cloud.google.com/cloud-build/builds/...?project=PROJECT_ID"
            }
        }
    }

    La risposta JSON viene modellata utilizzando la risorsa Operation nell'API Cloud Build. Il campo metadata è modellato utilizzando la risorsa Build. Lo stato QUEUED indica che la build è in attesa di esecuzione.

Passaggi successivi